Package org.pepstock.charba.client.items

Contains all elements generated by CHART.JS, which are mapping java script objects, to use at runtime in plugins, events or controllers.

Author:

Andrea "Stock" Stocchero

Interface Summary

Interface	Description
ChartContextElementFactory	Common interface for all elements which has got a DatasetContext
ChartElementFactory	Maps the methods to implement an factory to map ChartElement, used by each controlloer to draw the chart.
HasLegendText	Interface to map object which contains a text to show inside a legend element. Used by LegendItem and LegendTitle.
IsArea	Defines an area dimensions.
IsBorderRadius	Defines the border radius for element, applies the corner radius to all corners of the rectangle (topLeft, topRight, bottomLeft, bottomRight).

Class Summary

Class	Description
ActiveDatasetElement	Calling some methods on your chart instance passing an argument of an event, will return the elements at the event position. The elements are mapped by this object. This is the CHART.JS item with all needed info about a selected data set. This object has been created and passed to event handler or callbacks to apply own logic.
AnimationItem	The onProgress and onComplete events are useful for synchronizing an external draw to the chart animation. This is a wrapper of the CHART.JS item with all needed info.
ArcElement	Maps the out-of-the-box CHART.JS element used to represents arcs on the charts.
ArcElementOptions	Maps the out-of-the-box CHART.JS element options used to represents arcs on the charts.
AxisItem	There are a number of configuration callbacks that can be used to change parameters in the scale at different points in the update process. This is a wrapper of the CHART.JS item with all needed info about an axis. Implements all set methods to change java script object properties.
AxisPositionItem	This item is used to define the position of an axis related to a value of another axis.
BarElement	Maps the out-of-the-box CHART.JS element used to represents bars on the charts.
BarElementOptions	Maps the out-of-the-box CHART.JS element options used to represents bars on the charts.
BaseBoxItem	Base object which maps the CHART.JS chart items which represents a box. This is a wrapper of the CHART.JS item with all needed info. Implements all get methods to change java script object properties.
BaseBoxNodeItem<T extends Key>	Base object which maps the CHART.JS chart items and represents main nodes of chart java script object. This is a wrapper of the CHART.JS item with all needed info. Implements all get methods to change java script object properties.
BorderRadiusItem	Defines the border radius for legend item element, applies the corner radius to all corners of the rectangle (topLeft, topRight, bottomLeft, bottomRight).
ChartAreaNode	Object which maps the chart area item of CHART.JS chart java script object. This is a wrapper of the CHART.JS item with all needed info.
ChartElement	Calling some methods on your chart instance passing an argument of an event, will return the elements at the event position. The elements are mapped by this object. This is the CHART.JS item with all needed info about a data element, used to draw the chart. This is the base element created by CHART.JS which is extended by the controllers to manage own elements.
ChartElementFactories	Utility which is registering all ChartElementFactory for element type.
ChartElementOptions	Maps the base options of the ChartElements.
CommonElementOptions	Maps the common options of the ChartElements.
DataItem	This object is wrapping the value of data set which can be used in the plugins (extensions) callbacks. The value could be a double, string or a FloatingData if the data set is a BAR data set and uses floating bars data.
DatasetItem	Calling some methods on your chart instance passing an argument of an event, will return the elements at the event position. Created and passed by CHART.JS and provide dataset information.
DatasetItemController	This item provides all information about the dataset controller which has been displayed. This object has been created and passed to event handler or callbacks to apply own logic. This is a wrapper of the CHART.JS item with all needed info.
DatasetPoint	It wraps the parsed data values for the given item point.
DatasetReference	Calling some methods on your chart instance passing an argument of an event, will return the elements at the event position. The elements are mapped by this object. This is the CHART.JS item with all needed info about a selected data set, providing the right indexes to get the data set.
ElementProperties	Maps all properties of the element, as result of ChartElement.getFinalPositionProps(Key...) method.
FillBaseline	The object enables the axis value to define the baseline for filling at axis level.
FillColors	The object enables to support multiple colors when filling from one dataset.
FontItem	Font options item to use mainly for callbacks.
InteractionItem	Object used by CHART.JS to manages the user interaction on chart instances, for events, hovering and tooltips.
InteractionOptions	Definitions about how the interaction with events will be applied on chart elements.
ItemsEnvelop<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.
LegendHitBoxItem	This is a wrapper of the CHART.JS item which contains the legends hit box.
LegendItem	This is a wrapper of the CHART.JS item which contains the legend item.
LegendItem.LegendItemFactory	Inner class to create legend item by a native object.
LegendLabelItem	This object is created by callbacks and returned to CHART.JS as native object to configure the legend.
LegendLabelItem.LegendLabelItemFactory	Inner class to create legend label item by a native object.
LegendNode	Wrapper of legend node of CHART.JS. This is a wrapper of legend node of Chart (of CHART.JS).
LegendTextHandler	Manages the TEXT property of options in order to use the same logic between legend items and title.
NumberFormatItem	Number format options item to use for numeric tick callbacks.
OptionsNode	Wrapper of options node of CHART.JS.
PaddingItem	Padding options item to use mainly for callbacks.
Parsed	This object is wrapping the native java script object provided by PointElement to know the parsed value.
PluginDatasetArgument	This is a wrapper of java script object which represents a dataset. This object is used in the plugins methods of CHART.JS.
PluginEventArgument	This is a wrapper of java script object which represents a event. This object is used in the plugins methods of CHART.JS.
PluginResizeArgument	This is a wrapper of java script object which represents a resize argument. This object is used in the plugins methods of CHART.JS.
PluginScaleArgument	This is a wrapper of java script object which represents a scale argument. This object is used in the plugins methods of CHART.JS.
PluginTooltipArgument	Contains all info for every item of tooltip. Created and passed by CHART.JS. It uses in the PLUGINS.
PluginUpdateArgument	This is a wrapper of java script object which the argument passed to plugin function. This object is used in the plugins methods of CHART.JS.
PointElement	Maps the out-of-the-box CHART.JS element used to represents points on the charts.
PointElementOptions	Maps the out-of-the-box CHART.JS element options used to represents points on the charts.
ScaleItem	Wraps the scale item of CHART JS chart. This is a wrapper of scale of Chart (of CHART.JS).
ScaleLabelBackdropOptions	The label options maps the labels backdrop options computed by ScaleItem. This is a wrapper of the CHART.JS item with all needed info.
ScaleLabelItem	The label item maps the labels computed by ScaleItem. This is a wrapper of the CHART.JS item with all needed info.
ScaleLabelOptions	The label options maps the labels options computed by ScaleItem. This is a wrapper of the CHART.JS item with all needed info.
ScalesNode	Wrapper of scales node of CHART.JS. This is a wrapper of scale node of Chart (of CHART.JS).
ScaleTickItem	The tick item maps the objects passed a ScaleItem. This is a wrapper of the CHART.JS item with all needed info.
ScaleTickItem.ScaleTickItemFactory	Inner class to create tick item by a native object.
ScaleValueItem	This object is wrapping the value retrieved by the scale. The value could be a double, string or a date.
SizeItem	This item contains the new size of the chart after it has been resized. This object has been created ONLY when a resize event occurs.
SubtitleNode	Wrapper of subtitle node of CHART.JS. This is a wrapper of subtitle node of Chart (of CHART.JS).
TitleNode	Wrapper of title node of CHART.JS. This is a wrapper of title node of Chart (of CHART.JS).
TooltipBodyItem	This object is passed by CHART.JS to the callback to manage tooltip body.
TooltipItem	Contains all info for every item of tooltip. Created and passed by CHART.JS. It uses in the tooltips callbacks.
TooltipItem.TooltipItemFactory	Inner class to create tooltip item by a native object.
TooltipLabelColor	This object contains the color info when a label in the tooltip. It must be used in the label tooltip callback.
TooltipLabelColor.TooltipLabelColorFactory	Inner class to create tooltip label color by a native object.
TooltipLabelPointStyle	This object contains the point style info when a label in the tooltip. It must be used in the label tooltip callback.
TooltipLabelPointStyle.TooltipLabelPointStyleFactory	Inner class to create tooltip label point style by a native object.
TooltipModel	This object is passed by CHART.JS to the callback to manage tooltip custom callback. The tooltip label configuration is nested below the tooltip configuration using the callbacks key.
TooltipNode	Wrapper of tooltip node of CHART.JS. This is a wrapper of title node of Chart (of CHART.JS).
Undefined	Class with default values when the java script object returns an UNDEFINED value.

Enum Summary

Enum	Description
LegendTextHandler.Property	Name of properties of native object.