software.xdev.chartjs.model.options.elements.Arc Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of chartjs-java-model Show documentation

chartjs-java-model

There is a newer version: 2.5.0

/*
 * 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;

/**
 * 
 * Arcs are used in the polar area, doughnut and pie charts.
 * 
 * 
 * When set, these options apply to all objects of that type unless specifically overridden by the configuration
 * attached to a dataset.
 * 
 */
public class Arc
{
	protected Object backgroundColor;
	
	protected Object borderColor;
	
	protected Integer borderWidth;
	
	/**
	 * @see #setBackgroundColor(Object)
	 */
	public Object getBackgroundColor()
	{
		return this.backgroundColor;
	}
	
	/**
	 * 
	 * Default fill color for arcs. Inherited from the global default
	 * 
	 *
	 * 
	 * Default {@code 'rgba(0,0,0,0.1)'}
	 * 
	 */
	public Arc setBackgroundColor(final Object backgroundColor)
	{
		this.backgroundColor = backgroundColor;
		return this;
	}
	
	/**
	 * @see #setBorderColor(Object)
	 */
	public Object getBorderColor()
	{
		return this.borderColor;
	}
	
	/**
	 * 
	 * Default stroke color for arcs
	 * 
	 *
	 * 
	 * Default {@code '#fff'}
	 * 
	 */
	public Arc setBorderColor(final Object borderColor)
	{
		this.borderColor = borderColor;
		return this;
	}
	
	/**
	 * @see #setBorderWidth(Integer)
	 */
	public Integer getBorderWidth()
	{
		return this.borderWidth;
	}
	
	/**
	 * 
	 * Default stroke width for arcs
	 * 
	 *
	 * 
	 * Default {@code 2}
	 * 
	 */
	public Arc setBorderWidth(final Integer borderWidth)
	{
		this.borderWidth = borderWidth;
		return this;
	}
}