software.xdev.chartjs.model.options.elements.Bar Maven / Gradle / Ivy
/*
* Copyright © 2023 XDEV Software (https://xdev.software)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package software.xdev.chartjs.model.options.elements;
import software.xdev.chartjs.model.enums.BorderSkipped;
/**
*
* Bar elements are used to represent the bars in a bar chart.
*
*
* When set, these options apply to all objects of that type unless specifically overridden by the configuration
* attached to a dataset.
*
*/
public class Bar
{
/**
* @see #setBackgroundColor(Object)
*/
protected Object backgroundColor;
/**
* @see #setBorderWidth(Integer)
*/
protected Integer borderWidth;
/**
* @see #setBorderColor(Object)
*/
protected Object borderColor;
/**
* @see #setBorderSkipped(BorderSkipped)
*/
protected BorderSkipped borderSkipped;
/**
* @see #setBackgroundColor(Object)
*/
public Object getBackgroundColor()
{
return this.backgroundColor;
}
/**
*
* Default bar fill color
*
*
*
* Default {@code 'rgba(0,0,0,0.1)'}
*
*/
public Bar setBackgroundColor(final Object backgroundColor)
{
this.backgroundColor = backgroundColor;
return this;
}
/**
* @see #setBorderWidth(Integer)
*/
public Integer getBorderWidth()
{
return this.borderWidth;
}
/**
*
* Default bar stroke width
*
*
*
* Default {@code 0}
*
*/
public Bar setBorderWidth(final Integer borderWidth)
{
this.borderWidth = borderWidth;
return this;
}
/**
* @see #setBorderColor(Object)
*/
public Object getBorderColor()
{
return this.borderColor;
}
/**
*
* Default bar stroke color
*
*
*
* Default {@code 'rgba(0,0,0,0.1)'}
*
*/
public Bar setBorderColor(final Object borderColor)
{
this.borderColor = borderColor;
return this;
}
/**
* @see #setBorderSkipped(BorderSkipped)
*/
public BorderSkipped getBorderSkipped()
{
return this.borderSkipped;
}
/**
*
* Default skipped (excluded) border for rectangle. Can be one of bottom, left, top, right
*
*
*
* Default {@code 'bottom'}
*
*/
public Bar setBorderSkipped(final BorderSkipped borderSkipped)
{
this.borderSkipped = borderSkipped;
return this;
}
}