org.pepstock.charba.client.enums.FillingMode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of charba Show documentation

Charba, GWT Chart library based on CHART.JS

There is a newer version: 6.5-gwt

/**
    Copyright 2017 Andrea "Stock" Stocchero

    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 org.pepstock.charba.client.enums;

import org.pepstock.charba.client.commons.Key;

/**
 * Represents how to fill the area under the line. This is an interfaces implemented on different way, as CHART.JS has implemented.

 * Both line and radar charts support a fill option on the dataset object which can be used to create area between two datasets or a dataset.

 * These are the different kinds of fill you can set:

 * 
 * Predefined values, mapped by {@link Fill}.
 * 
Absolute dataset index, as integer (1,2,3,...)
 * 
Relative dataset index, as string ("-1", "-2", "+1", "+2",...)
 * 
Predefined boolean, if true the fill is applied, othewise false.
 * 
 * 
 * @author Andrea "Stock" Stocchero
 */
public enum FillingMode implements Key
{
	/**
	 * Links datasets by absolute dataset index, as integer (1,2,3,...)
	 */
	ABSOLUTE_DATASET_INDEX("absoluteDatasetIndex"),
	/**
	 * Links datastes by relative dataset index, as string ("-1", "-2", "+1", "+2",...)
	 */
	RELATIVE_DATASET_INDEX("relativeDatasetIndex"),
	/**
	 * Predefined values by {@link Fill}.
	 */
	PREDEFINED("predefined"),
	/**
	 * It is never really used, because the value is boolean.
	 */
	PREDEFINED_BOOLEAN("predefinedBoolean");

	// name value of property
	private final String value;

	/**
	 * Creates with the property value to use in the native object.
	 * 
	 * @param value value of property name
	 */
	private FillingMode(String value) {
		this.value = value;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.pepstock.charba.client.commons.Key#value()
	 */
	@Override
	public String value() {
		return value;
	}

}