Uses of Interface
org.pepstock.charba.client.commons.Key

Packages that use Key

Package	Description
org.pepstock.charba.client	Main package with all charts implementation, global classes and common interfaces.
org.pepstock.charba.client.callbacks	All callbacks interfaces to be implemented, also to use the scriptable options of CHART.JS.
org.pepstock.charba.client.colors	Contains the enumerations of HTML and GWT Material colors, to consume out-of-the-box, and utilities to create and manage own colors and classes to define gradients of patterns for charts.
org.pepstock.charba.client.colors.tiles	Contains all classes to build tiles to use into a canvas patterns or a Charba pattern
org.pepstock.charba.client.commons	Core classes to manage the inter-operations with java script code.
org.pepstock.charba.client.controllers	Contains all classes to manage the implementations of controllers.
org.pepstock.charba.client.data	Contains all elements to configure the datasets of a chart instance (know as chart data at instance level).
org.pepstock.charba.client.datalabels	Contains all classes to activate the DataLabelsPlugin.ID plugin (AKA chartjs-plugin-datalabels.js ) for CHART.js.
org.pepstock.charba.client.datalabels.enums	Contains all enumerations to configure the DataLabelsPlugin.ID plugin.
org.pepstock.charba.client.enums	Contains all enumerations of some chart options where only a specific set of values can be set.
org.pepstock.charba.client.impl.charts	Contains METER and GAUGE charts implementations (based on controllers), available out-of-the box.
org.pepstock.charba.client.impl.plugins	Contains some plugins implementations, available out-of-the box.
org.pepstock.charba.client.impl.plugins.enums	Contains the enumeration items to configure out of the box CHARBA plugins.
org.pepstock.charba.client.options	Contains all elements to configure charts at global level (know as chart global options).
org.pepstock.charba.client.plugins	Contains all classes to manage the plugin implementations.
org.pepstock.charba.client.positioner	Contains all classes to implement a custom tooltip positioner for CHART.JS.

Uses of Key in org.pepstock.charba.client

Subinterfaces of Key in org.pepstock.charba.client

Modifier and Type	Interface and Description
interface	Type Interface to map the type and scale type of a chart.

Classes in org.pepstock.charba.client that implement Key

Modifier and Type	Class and Description
class	ChartType Enumerates all out-of-the-box types of a chart.

Uses of Key in org.pepstock.charba.client.callbacks

Methods in org.pepstock.charba.client.callbacks with type parameters of type Key

Modifier and Type	Method and Description
static <T extends Key> T	ScriptableUtils.getOptionValueAsString(ScriptableContext context, Scriptable<T> callback) Returns the enumeration value as value of the property by invoking a callback which is typed to a key.
static <T extends Key> T	ScriptableUtils.getOptionValueAsString(ScriptableContext context, Scriptable<T> callback, T defaultValue) Returns the enumeration value of the property by invoking a callback which is typed to a key, passing a default value.

Uses of Key in org.pepstock.charba.client.colors

Classes in org.pepstock.charba.client.colors that implement Key

Modifier and Type	Class and Description
class	GradientOrientation Represents the gradient orientation for gradient. Every orientation contains also on which gradient type can be applied.
class	GradientScope A gradient needs to have coordinates and/or radius to be created. The dimension to create a gradient are decided by Charba, automatically based on canvas or chart area element.
class	GradientType A gradient must have a type. The possible types are: LINEAR RADIAL

Uses of Key in org.pepstock.charba.client.colors.tiles

Subinterfaces of Key in org.pepstock.charba.client.colors.tiles

Modifier and Type	Interface and Description
interface	IsShape Defines a shape to draw on the tile.

Classes in org.pepstock.charba.client.colors.tiles that implement Key

Modifier and Type	Class and Description
class	CharacterShape This is a shape which can draw a character on the tile. This object is also a shape drawer. The font size is calculated automatically based on tile size. It designs a char into the following tile sections (A and B):
class	ImageShape This is a shape which can draw an image on the tile. This object is also a shape drawer. The image is scaled to the size of the tile.
class	Shape Enumerates all available shapes applicable onto a tile.

Uses of Key in org.pepstock.charba.client.commons

Classes in org.pepstock.charba.client.commons with type parameters of type Key

Modifier and Type	Class and Description
class	ArrayEnumList<E extends Key> The user of this interface has precise control over where in the list each element is inserted.

Classes in org.pepstock.charba.client.commons that implement Key

Modifier and Type	Class and Description
class	Id Enums the property ID used by CHARBA to identify the chart.
class	StandardKey This is a standard implementation of a key of property inside a Java script object. The standard is the key name is a String.

Methods in org.pepstock.charba.client.commons with type parameters of type Key

Modifier and Type	Method and Description
static <T extends Key> T	Key.getKeyByValue(Class<T> clazz, String value) Returns a key into an enumeration by the value.
static <T extends Key> T	Key.getKeyByValue(Class<T> clazz, String value, T defaultKey) Returns a key into an enumeration by the value, or the default key passed as argument.
protected <T extends Key> T	NativeObjectContainer.getValue(Key key, Class<T> clazz, T defaultValue) Returns a value (key) into embedded JavaScript object at specific property.
static <T extends Key> boolean	Key.hasKeyByValue(Class<T> clazz, String value) Returns true if a key into an enumeration is related to the value, otherwise false.
static <E extends Key> ArrayEnumList<E>	ArrayListHelper.list(Class<E> clazz, ArrayString array) Creates a array list of enumeration values by an java script array of strings.
static <E extends Key> ArrayEnumList<E>	ArrayListHelper.list(Class<E> clazz, E[] values) Creates a array list of enumeration values (instance of Key).
protected <T extends Key> void	NativeObjectContainer.setValue(Key key, T value) Sets a value (EnumValue) into embedded JavaScript object at specific property.
static <E extends Key> List<E>	ArrayListHelper.unmodifiableList(Class<E> clazz, ArrayString array) Creates an unmodifiable array list of enumeration values by an java script array of strings.
static <E extends Key> List<E>	ArrayListHelper.unmodifiableList(Class<E> clazz, E[] values) Creates an unmodifiable array list of enumeration values (instance of Key).

Methods in org.pepstock.charba.client.commons that return Key

Modifier and Type	Method and Description
static Key	Key.create(String key) Returns a key instance by its string value.

Methods in org.pepstock.charba.client.commons that return types with arguments of type Key

Modifier and Type	Method and Description
protected List<Key>	NativeObjectContainer.keys() Returns the list of properties names of the object.

Methods in org.pepstock.charba.client.commons with parameters of type Key

Modifier and Type	Method and Description
void	ArrayEnumList.addAll(E[] values) Loads an array of elements into the list
static void	Key.checkIfValid(Key key) Checks if key passed as argument is not null and its value is not null as well.
static int	Key.compare(Key k1, Key k2) Compares the two specified key values.
static boolean	Key.equals(Key k1, Key k2) Returns true if the keys have got the same value.
static ArrayString	ArrayString.fromOrEmpty(Key... items) Creates a java script array of strings starting from array of keys.
static ArrayString	ArrayString.fromOrNull(Key... items) Creates a java script array of strings starting from array of keys.
static int	Id.get(Key key, NativeObject nativeObject) Returns the property value from java script object, when the ID is stored as integer
protected <T extends Array> T	NativeObjectContainer.getArrayValue(Key key) Returns a value (array) into embedded JavaScript object at specific property.
protected NativeObject	NativeObjectContainer.getValue(Key key) Returns a value (JavaScript Object) into embedded JavaScript object at specific property.
protected boolean	NativeObjectContainer.getValue(Key key, boolean defaultValue) Returns a value (boolean) into embedded JavaScript object at specific property.
protected CanvasGradient	NativeObjectContainer.getValue(Key key, CanvasGradient defaultValue) Returns a value (gradient) into embedded JavaScript object at specific property.
protected CanvasPattern	NativeObjectContainer.getValue(Key key, CanvasPattern defaultValue) Returns a value (pattern) into embedded JavaScript object at specific property.
protected <T extends Key> T	NativeObjectContainer.getValue(Key key, Class<T> clazz, T defaultValue) Returns a value (key) into embedded JavaScript object at specific property.
protected Date	NativeObjectContainer.getValue(Key key, Date defaultValue) Returns a value (date) into embedded JavaScript object at specific property.
protected double	NativeObjectContainer.getValue(Key key, double defaultValue) Returns a value (double) into embedded JavaScript object at specific property.
protected ImageElement	NativeObjectContainer.getValue(Key key, ImageElement defaultValue) Returns a value (image) into embedded JavaScript object at specific property.
protected int	NativeObjectContainer.getValue(Key key, int defaultValue) Returns a value (int) into embedded JavaScript object at specific property.
protected String	NativeObjectContainer.getValue(Key key, String defaultValue) Returns a value (string) into embedded JavaScript object at specific property.
protected ArrayGradient	NativeObjectContainer.getValueOrArray(Key key, CanvasGradient defaultValue) Returns a value (array) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a gradient.
protected ArrayPattern	NativeObjectContainer.getValueOrArray(Key key, CanvasPattern defaultValue) Returns a value (array) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a pattern.
protected ArrayDouble	NativeObjectContainer.getValueOrArray(Key key, double defaultValue) Returns a value (array) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a double.
protected ArrayImage	NativeObjectContainer.getValueOrArray(Key key, ImageElement defaultValue) Returns a value (array) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a image.
protected ArrayInteger	NativeObjectContainer.getValueOrArray(Key key, int defaultValue) Returns a value (array) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a integer.
protected ArrayString	NativeObjectContainer.getValueOrArray(Key key, Key defaultValue) Returns a value (array) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a key.
protected ArrayString	NativeObjectContainer.getValueOrArray(Key key, String defaultValue) Returns a value (array) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a string.
protected boolean	NativeObjectContainer.has(Key... keys) Returns true if the embedded JavaScript object contains an element at all properties.
protected boolean	NativeObjectContainer.has(Key key) Returns true if the embedded JavaScript object contains an element at specific property.
static boolean	Key.isValid(Key key) Returns true if key passed as argument is not null and its value is not null as well.
static <E extends Key> ArrayEnumList<E>	ArrayListHelper.list(Class<E> clazz, E[] values) Creates a array list of enumeration values (instance of Key).
protected void	NativeObjectContainer.remove(Key... keys) Removes a set of elements (by keys) from the embedded JavaScript object.
protected void	NativeObjectContainer.remove(Key key) Removes an element (by key) from the embedded JavaScript object.
protected void	NativeObjectContainer.removeIfExists(Key key) Removes an element (by key) from the embedded JavaScript object if exists.
protected void	NativeObjectContainer.setArrayValue(Key key, ArrayObjectContainerList<?> container) Sets a value (Array from a container list) into embedded JavaScript object at specific property.
protected <T extends Array> void	NativeObjectContainer.setArrayValue(Key key, T value) Sets a value (Array) into embedded JavaScript object at specific property.
protected void	NativeObjectContainer.setValue(Key key, boolean value) Sets a value (boolean) into embedded JavaScript object at specific property.
protected void	NativeObjectContainer.setValue(Key key, CallbackProxy.Proxy value) Sets a value (callback proxy function) into embedded JavaScript object at specific property.
protected void	NativeObjectContainer.setValue(Key key, CanvasGradient value) Sets a value (gradient) into embedded JavaScript object at specific property.
protected void	NativeObjectContainer.setValue(Key key, CanvasPattern value) Sets a value (pattern) into embedded JavaScript object at specific property.
protected void	NativeObjectContainer.setValue(Key key, Date value) Sets a value (date) into embedded JavaScript object at specific property.
protected void	NativeObjectContainer.setValue(Key key, double value) Sets a value (double) into embedded JavaScript object at specific property.
protected void	NativeObjectContainer.setValue(Key key, ImageElement value) Sets a value (image) into embedded JavaScript object at specific property.
protected void	NativeObjectContainer.setValue(Key key, int value) Sets a value (int) into embedded JavaScript object at specific property.
protected void	NativeObjectContainer.setValue(Key key, NativeObject value) Sets a value (JavaScript Object) into embedded JavaScript object at specific property.
protected void	NativeObjectContainer.setValue(Key key, NativeObjectContainer value) Sets a value (JavaScript Object) into embedded JavaScript object at specific property by object container.
protected void	NativeObjectContainer.setValue(Key key, String value) Sets a value (string) into embedded JavaScript object at specific property.
protected <T extends Key> void	NativeObjectContainer.setValue(Key key, T value) Sets a value (EnumValue) into embedded JavaScript object at specific property.
protected void	NativeObjectContainer.setValueOrArray(Key key, CanvasGradient... values) Sets a value (Array or gradient) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a gradient.
protected void	NativeObjectContainer.setValueOrArray(Key key, CanvasPattern... values) Sets a value (Array or pattern) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a pattern.
protected void	NativeObjectContainer.setValueOrArray(Key key, double... values) Sets a value (Array or double) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a double.
protected void	NativeObjectContainer.setValueOrArray(Key key, ImageElement... values) Sets a value (Array or image) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a image.
protected void	NativeObjectContainer.setValueOrArray(Key key, int... values) Sets a value (Array or integer) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a integer.
protected void	NativeObjectContainer.setValueOrArray(Key key, IsColor... values) Sets a value (Array or string by colors) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a string.
protected void	NativeObjectContainer.setValueOrArray(Key key, Key... values) Sets a value (Array or string by keys) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a string.
protected void	NativeObjectContainer.setValueOrArray(Key key, Key... values) Sets a value (Array or string by keys) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a string.
protected void	NativeObjectContainer.setValueOrArray(Key key, String... values) Sets a value (Array or string) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a string.
protected ObjectType	NativeObjectContainer.type(Key key) Returns the java script type of the property.
static <E extends Key> List<E>	ArrayListHelper.unmodifiableList(Class<E> clazz, E[] values) Creates an unmodifiable array list of enumeration values (instance of Key).

Uses of Key in org.pepstock.charba.client.controllers

Classes in org.pepstock.charba.client.controllers that implement Key

Modifier and Type	Class and Description
class	ControllerType Represent the type of new controller.

Uses of Key in org.pepstock.charba.client.data

Classes in org.pepstock.charba.client.data that implement Key

Modifier and Type	Class and Description
protected static class	Dataset.Property Name of properties of native object.

Methods in org.pepstock.charba.client.data with parameters of type Key

Modifier and Type	Method and Description
protected void	LiningDataset.applyGradient(Key key, List<CanvasGradient> canvasGradientsList)
protected void	HovingFlexDataset.applyGradient(Key key, List<CanvasGradient> canvasGradientsList)
protected void	HovingDataset.applyGradient(Key key, List<CanvasGradient> canvasGradientsList)
protected abstract void	Dataset.applyGradient(Key key, List<CanvasGradient> canvasGradientsList) Stores the canvas gradients into dataset object by property name passed as key.
protected void	LiningDataset.applyPattern(Key key, List<CanvasPattern> canvasPatternsList)
protected void	HovingFlexDataset.applyPattern(Key key, List<CanvasPattern> canvasPatternsList)
protected void	HovingDataset.applyPattern(Key key, List<CanvasPattern> canvasPatternsList)
protected abstract void	Dataset.applyPattern(Key key, List<CanvasPattern> canvasPatternsList) Stores the canvas patterns into dataset object by property name passed as key.
double	DataPoint.getAttribute(Key key) Returns a custom field value from data point.
void	DataPoint.setAttribute(Key key, double value) Sets a custom field to data point.

Uses of Key in org.pepstock.charba.client.datalabels

Methods in org.pepstock.charba.client.datalabels that return types with arguments of type Key

Modifier and Type	Method and Description
List<Key>	Labels.getLabelKeys() Returns the list of all keys related to stored options.

Methods in org.pepstock.charba.client.datalabels with parameters of type Key

Modifier and Type	Method and Description
DataLabelsOptions	Labels.getLabel(Key key) Returns the stored options for specific key.
boolean	Labels.hasLabel(Key key) Returns true if there is a stored options for specific key.
void	Labels.setLabel(Key key, DataLabelsOptions options) Sets new data labels options with a specific key.

Uses of Key in org.pepstock.charba.client.datalabels.enums

Classes in org.pepstock.charba.client.datalabels.enums that implement Key

Modifier and Type	Class and Description
class	Align The align option defines the position of the label relative to the anchor point position and orientation.
class	Anchor An anchor point is defined by an orientation vector and a position on the data element.
class	Event This DataLabelsPlugin.ID plugin currently supports the below label events. Charba events that need to be enabled in order to get the associated label event working.
class	TextAlign The textAlign option only applies to multi-line labels and specifies the text alignment being used when drawing the label text.
class	Weight The weight sets how thick or thin characters in text should be displayed.

Uses of Key in org.pepstock.charba.client.enums

Subinterfaces of Key in org.pepstock.charba.client.enums

Modifier and Type	Interface and Description
interface	IsFill Represents how to fill the area under the line.
interface	IsTooltipPosition Defines an object which represents the positioning of the tooltip.

Classes in org.pepstock.charba.client.enums that implement Key

Modifier and Type	Class and Description
class	AbsoluteDatasetIndexFill Fill object to configure chart to use an absolute dataset index. Absolute dataset index, as integer, is composed by integer value which must be greater than 0. Here are same examples: (1,2,3,...).
class	AxisType Axes are an integral part of a chart.
class	BorderAlign Property to set the border alignment on chart datasets.
class	BorderSkipped Property to set the border position on chart datasets. This setting is used to avoid drawing the bar stroke at the base of the fill.
class	CapStyle Determines how the end points of every line are drawn. There are three possible values for this property and those are: butt, round and square.
class	CartesianAxisType Can be set to 'x', 'y' to define which directions are used in axis.
class	CubicInterpolationMode Determines the interpolation mode of lines.
class	DataType Enumeration with all possible types of data set into dataset.
class	Display The display option controls the visibility of axis and the display option controls the visibility of data labels plugin. Controls the axis global visibility (visible when true, hidden when false).
class	Easing Easing is acceleration, a change in speed. For further details, see here.
class	Fill 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 and a boundary. These are the constants of predefined filling mode values.
protected static class	Filler.Property Name of properties of native object.
class	FillingMode Represents how to fill the area under the line.
class	FontStyle The font-style property specifies the font style for a text.
class	InteractionAxis Can be set to 'x', 'y', or 'xy' to define which directions are used in calculating distances. Defaults to 'x' for index mode and 'xy' in dataset and nearest modes.
class	InteractionMode When configuring interaction with the graph via hover or tooltips, a number of different modes are available to set which elements appear via tooltip or hover.
class	JoinStyle Determines how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together (degenerate segments with zero lengths, whose specified end points and control points are exactly at the same position, are skipped).
class	LegendAlign Property to set alignment of the legend.
class	PluginOptionsScope Enumeration with all possible plugin options scope, where they are set to the chart or dataset.
class	PointStyle Style of the point.
class	Position Property to set the position's edge of an element to a unit above/below its normal position.
class	RelativeDatasetIndexFill Fill object to configure chart to use a relative dataset index. Relative dataset index, as string, is composed by sign and value, both mandatory. Here are same examples: ("-1", "-2", "+1", "+2",...).
class	ScaleBounds Controls the scale boundary strategy (bypassed by minimum/maximum time options).
class	ScaleDistribution Controls the data distribution along the scale.
class	SteppedLine Property to set if the line is shown as a stepped line.
class	TextDirection Enumerates the text direction that will force the text direction on the canvas for rendering the legend, regardless of the CSS specified on the canvas.
class	TickSource Controls the ticks generation on cartesian time axis.
class	TimeUnit Controls the data distribution along the scale. About available formats, see moment.js.
class	TooltipPosition These are the different modes for positioning of the tooltip.

Uses of Key in org.pepstock.charba.client.impl.charts

Classes in org.pepstock.charba.client.impl.charts that implement Key

Modifier and Type	Class and Description
class	MeterDisplay Determines which information must be displayed into meter or gauge chart.

Methods in org.pepstock.charba.client.impl.charts with parameters of type Key

Modifier and Type	Method and Description
protected void	MeterDataset.applyGradient(Key key, List<CanvasGradient> canvasGradientsList)
protected void	MeterDataset.applyPattern(Key key, List<CanvasPattern> canvasPatternsList)

Uses of Key in org.pepstock.charba.client.impl.plugins

Subinterfaces of Key in org.pepstock.charba.client.impl.plugins

Modifier and Type	Interface and Description
interface	ColorScheme This interface defines what a color scheme must have in terms of methods. A color scheme must have: name is the name of color scheme category is the category of color scheme.

Uses of Key in org.pepstock.charba.client.impl.plugins.enums

Classes in org.pepstock.charba.client.impl.plugins.enums that implement Key

Modifier and Type	Class and Description
class	PointerElement The elements of the chart in scope of ChartPointer.ID plugin.
class	Render Enumeration of available render to use to configure clear selection element.
class	SchemeScope Enumerates the possible values to address coloring of BAR or BUBBLE datasets by a color scheme.

Uses of Key in org.pepstock.charba.client.options

Methods in org.pepstock.charba.client.options with parameters of type Key

Modifier and Type	Method and Description
void	ExtendedScale.setCallback(AbstractTick<?,?> tick, Key property, CallbackProxy.Proxy proxy) Adds a callback proxy function to tick element instance.
void	ExtendedScale.setCallback(Key property, CallbackProxy.Proxy proxy) This method adds new callback function proxy to the element, as property of native java script object.
void	ExtendedOptions.setCallback(Key property, CallbackProxy.Proxy proxy) This method adds new callback function proxy to the element, as property of native java script object.
void	ExtendedOptions.setCallback(LegendLabels labels, Key property, CallbackProxy.Proxy proxy) Adds a event proxy function to legend labels element instance.
void	ExtendedScale.setCallback(PointLabels pointLabels, Key property, CallbackProxy.Proxy proxy) Adds a callback proxy function to point labels element instance.
void	ExtendedOptions.setCallback(TooltipsCallbacks tooltips, Key property, CallbackProxy.Proxy proxy) Adds a event proxy function to tooltips callbacks element instance.
void	ExtendedOptions.setCallback(Tooltips tooltips, Key property, CallbackProxy.Proxy proxy) Adds a event proxy function to tooltips element instance.
void	ExtendedOptions.setEvent(Animation animation, Key property, CallbackProxy.Proxy proxy) Adds a event proxy function to animation element instance.
void	ExtendedOptions.setEvent(Key property, CallbackProxy.Proxy proxy) This method adds new event function proxy to the element, as property of native java script object.
void	ExtendedOptions.setEvent(Legend legend, Key property, CallbackProxy.Proxy proxy) Adds a event proxy function to legend element instance.

Uses of Key in org.pepstock.charba.client.plugins

Methods in org.pepstock.charba.client.plugins that return Key

Modifier and Type	Method and Description
static Key	PluginIdChecker.key(String id) Creates a key by the plugin id as string

Uses of Key in org.pepstock.charba.client.positioner

Classes in org.pepstock.charba.client.positioner that implement Key

Modifier and Type	Class and Description
class	CustomTooltipPosition Custom tooltip position to use into chart options to configure charts. It must not be equals of the out of the box ones.