Package org.pepstock.charba.client.options

Contains all elements to configure charts at global level (know as chart global options).

Author:

Andrea "Stock" Stocchero

Interface Summary

Interface	Description
AnimationCollectionKey	Represents the collection to set to configure animation.
AnimationPropertyKey	Represents the property id to set to the configure animation collection items.
ElementFactory<T extends NativeObjectContainer>	Interface to be implemented to load elements from Options.getElements().
HasAnimationOptions	Defines a configuration element which is managing the animation options items, ANIMATION, ANIMATIONS and TRANSITIONS.
HasBarDatasetOptions	Defines a BAR dataset properties of options in order to use the same logic between datasets and options/configuration.
HasEvents	Defines a configuration element which is managing the EVENTS property.
HasFill	Defines a configuration element which is managing the FILL property. It has being used in the options and datasets instances where FILL is required.
HasFont	Interface to map the font and color options.
HasPointStyle	Interface to manage the style of the point options.
HasSpanGaps	Defines a configuration element which is managing the SPANGAPS property. It has being used in the options and datasets instances where SPANGAPS is required.
IsAnimation	Interface to map a animations element, ANIMATIONS name space.
IsAnimations	Interface to map a animations element where animation element properties can be set, ANIMATIONS name space.
IsEvent	RepresentstThe events option defines the browser events that the chart, legend, tooltip or plugins should listen to.
IsFont	Interface to map a font element.
IsImmutableFont	Interface to map a font element in read-only mode, normalized by CHART.JS by Helpers.toFont(org.pepstock.charba.client.items.FontItem), providing also the CSS string of font itself.
IsNumberFormat	Defines a configuration element which is a number format options.
IsPadding	Interface to map a font element.
IsScriptableFontProvider<T extends ChartContext>	Map an object which contains a font instance which can be set by callback, FontCallback.
IsScriptablePaddingProvider<T extends ChartContext>	Map an object which contains a padding instance which can be set by callback, PaddingCallback.
IsTitle	Interface to map a title and subtitle elements.
IsTransitions	Interface to map a transitions element, TRANSITIONS name space.
IsTypedAnimationKey	Represents an animation key which contains a animation type.
ScaleId	Represents the scale id of a scale/axis object.
TransitionKey	Represents the update mode (transition) to set to configure animation.

Class Summary

Class	Description
AbstractElement<D extends IsDefaultOptionsElement>	Options can be configured for four different types of elements: arc, lines, points, and bars. When set, these options apply to all objects of that type unless specifically overridden by the configuration attached to a dataset.
AbstractElementFactory<T extends NativeObjectContainer>	Abstract implementation to get custom elements from Options.getElements().
AbstractFont	Base class to map the font properties of an element.
AbstractImmutableFont	Base class to map a font element in read-only mode, normalized by CHART.JS by Helpers.toFont(org.pepstock.charba.client.items.FontItem), providing also the CSS string of font itself.
AbstractModel<P extends AbstractModel<?,?>,D>	Base class for all options, which will wraps a native object and manages the relations about parent and children elements. Provides also a set of methods to manages callbacks and events.
AbstractNumberFormat	This is abstract number format object element of the chart options.
AbstractPadding	Base class to map the padding properties of an element.
AbstractReadOnlyFont	Base class to map the font properties of an element, in read-only mode.
AbstractScale	Scales are an integral part of a chart. They are used to determine how data maps to a pixel value on the chart. linear logarithmic category time time series radial linear
AbstractScriptableFont<T extends ChartContext>	Object can be provided with additional configuration by callbacks to define font options at runtime, and with the possibility to reset FontCallback if the IsScriptableFontProvider instance has been set with a FontCallback.
AbstractScriptablePadding<T extends ChartContext>	Object can be provided with additional configuration by callbacks to define padding options at runtime, and with the possibility to reset PaddingCallback if the IsScriptablePaddingProvider instance has been set with a PaddingCallback.
AbstractTitle<T extends IsDefaultAbstractTitle>	Configures the default chart title and subtitle which defines texts to draw at the top of the chart.
Adapters	The following adapters element is used to configure a date adapter, injecting to support time series in the CHART.JS.
AngleLines	It is used to configure angled lines that radiate from the center of the chart to the point labels. Note that these options only apply if display is true.
Animation	It animates charts out of the box. A number of options are provided to configure how the animation looks and how long it takes. This configuration item is configuring the common animation properties, ANIMATION name space.
AnimationCollection	Is the base animation options with common properties for animation properties (property and collections of properties).
AnimationContainer	Manages the ANIMATION, ANIMATIONS and TRANSITIONS properties of options in order to use the same logic among all options/configuration and datasets.
Animations	It animates charts out of the box. A number of options are provided to configure how the animation looks and how long it takes. This configuration item is configuring the common animations properties, ANIMATIONS name space.
AnimationTransition	Abstract options to define the animation for a specific update mode (transition).
Arc	Arcs are used in the polar area, doughnut and pie charts.
Bar	Bar elements are used to represent the bars in a bar chart.
BarDatasetOptionsHandler	Manages the BAR dataset properties of options in order to use the same logic between datasets and options/configuration.
Datasets	Contains the options for the datasets.
Decimation	The decimation plugin can be used with line charts to automatically decimate data at the start of the chart life cycle. To use the decimation plugin, the following requirements must be met: the data set must have an IndexAxis.X the data set must be a LineDataset the X axis for the data set must be either a CartesianLinearAxis or CartesianTimeAxis or CartesianTimeSeriesAxis
DisplayFormats	The display formats are used to configure how different time units are formed in the strings for the axis tick marks.
Elements	Options can be configured for four different types of elements: arc, lines, points, and bars. When set, these options apply to the configuration attached to a dataset.
EventsOptionHandler	Base object which maps EVENTS option.
ExtendedOptions	Options used internally inside the chart configuration. This is the root element of configuration. Extends the normal options (with scales) with all methods to add callbacks and events. It provides also the method to set the CHARBA id when new chart is created.
ExtendedScale	Scale options used internally inside the chart configuration. Extends the normal scale options with all methods to add callbacks and events.
ExtendedScales	Options used internally inside the chart configuration. This is the SCALES element of configuration.
Filler	The filler plugin can be used to fill the datasets.
FillHandler	Manages the FILL property of options in order to use the same logic between line datasets and options/configuration.
Font	Base object to map font options for configuration.
FontContainer	This is the labels configuration of the legend.
Grid	The grid line configuration defines options for the grid that run perpendicular to the axis.
Hover	Definitions about how elements appear in the chart, hovering the chart.
Interaction	Definitions about how the user can interact with chart elements.
Layout	The layout configuration is needed to set the padding.
Legend	The chart legend displays data about the datasets that area appearing on the chart.
LegendLabels	This is the labels configuration of the legend.
LegendTitle	This is the title configuration of the legend.
Line	Line elements are used to represent the line in a line chart.
Major	It defines options for the major tick marks that are generated by the axis.
Options	Base object which maps chart options.
OptionsEnvelop<T>	This object is a container of hidden object to pass to other packages. It can not be instantiated in order that public methods can be invoked in safe mode.
Padding	Maps the additional space to apply to the sides of elements (left, top, right, bottom), in pixels.
Plugins	Definitions about plugins options.
Point	Point elements are used to represent the points in a line chart or a bubble chart.
PointLabels	It is used to configure the point labels that are shown on the perimeter of the scale. Note that these options only apply if display is true.
PointStyleHandler	Base object to to manage point style property in the options.
Scale	Scales are an integral part of a chart. They are used to determine how data maps to a pixel value on the chart. linear logarithmic category time time series radial linear
ScaleBorder	Defines options for the border that run perpendicular to the axis.
ScaleDateAdapter	This is abstract date adapter object element of the chart options.
ScaledOptions	Base object which maps chart options, with scales elements to set axes configurations.
Scales	The configuration element which contains all axes definitions.
ScaleTitle	When creating a chart, you want to tell the viewer what data they are viewing.
Segment	Contains all callbacks defined for a line segment. Is empty because this is only the container of all properties related to callbacks which must be defined in the chart configuration.
SpanGapHandler	Manages the SPANGAPS property of options in order to use the same logic between line datasets and options/configuration.
Subtitle	Configures the default chart subtitle which defines text to draw at the top of the chart.
Ticks	All configuration for ticks of a chart. It defines options for the tick marks that are generated by the axis.
TicksNumberFormat	It applies the number formatting to the ticks of all linear scales.
Time	The time configuration is used to configure how time and time series axes must configure the tick marks.
Title	Configures the default chart title which defines text to draw at the top of the chart.
Tooltips	Configuration element to set all attributes and features of the default tooltip.
TooltipsCallbacks	Contains all callbacks defined for a tooltips. Is empty because this is only the container of all properties related to callbacks which must be defined in the chart configuration.
Transitions	It animates charts out of the box. A number of options are provided to configure how the animation looks and how long it takes. This configuration item is configuring the common transitions properties, TRANSITIONS name space.
TypedDataset	Contains the options for the data sets.

Enum Summary

Enum	Description
BarDatasetOptionsHandler.Property	Name of properties of native object.
FillHandler.Property	Name of properties of native object.
Options.CommonProperty	Name of properties of native object. Properties common with which extends this class.
SpanGapHandler.Property	Name of properties of native object.