Package | Description |
---|---|
org.pepstock.charba.client |
Main package with all charts implementation, global classes and common interfaces.
|
org.pepstock.charba.client.adapters |
Contains all classes to interact with date adapters implemented by CHART.JS to be abstract from date time java script library to use.
|
org.pepstock.charba.client.annotation |
Contains all classes to activate the
AnnotationPlugin#ID plugin (AKA chartjs-plugin-annotation.js ) for CHART.js. |
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.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.enums |
Contains all enumerations of some chart options where only a specific set of values can be set.
|
org.pepstock.charba.client.events |
Contains all events to interact with chart instance.
|
org.pepstock.charba.client.geo |
Contains all classes to activate the GEO controllers (AKA
chartjs-chart-geo.js ) for CHART.js. |
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.intl |
Contains classes in order to use the ECMAScript Internationalization API, which provides language sensitive number formatting, and date and time formatting.
|
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.
|
org.pepstock.charba.client.labels |
Contains all classes to use
LabelsPlugin.ID plugin (AKA chartjs-plugin-labels.js ) available for CHART.JS. |
org.pepstock.charba.client.matrix |
Contains all classes to activate the Matrix controller (AKA
chartjs-chart-matrix.js ) for CHART.js. |
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.
|
org.pepstock.charba.client.sankey |
Contains all classes to activate the Sankey controller (AKA
chartjs-chart-sankey.js ) for CHART.js. |
org.pepstock.charba.client.treemap |
Contains all classes to activate the TreeMap controller (AKA
chartjs-chart-treemap.js ) for CHART.js. |
org.pepstock.charba.client.utils |
Contains some utilities to use in Charba, like HTML annotation builder, and other java script utilities useful for debugging.
|
org.pepstock.charba.client.utils.toast |
Contains all classes to use
Toaster utility. |
org.pepstock.charba.client.zoom |
Contains all classes to activate the
ZoomPlugin.ID plugin (AKA chartjs-plugin-zoom.js ) for CHART.js. |
Modifier and Type | Class and Description |
---|---|
class |
ChartOptions
This object is mapping the default options related to the chart type.
|
class |
Configuration
This is the configuration object of a chart.
It contains always the type, options, plugins and data. |
class |
EventPoint
This object is wrapping the native java script object provided by
Helpers to know the position of the event on the canvas. |
class |
GlobalOptions
Default global options (maps the java script object chart.defaults.global).
|
class |
GlobalScale
Default global scale (maps the java script object
Chart.defaults.scale and the result of Chart.scaleService ). |
class |
UpdateConfiguration
Object can be provided with additional configuration for the update process.
This is useful when update is manually called inside an event handler and some different animation is desired. |
Modifier and Type | Class and Description |
---|---|
class |
DateAdapterFormats
Contains all date time formats that a date adapter can manage.
|
class |
DateAdapterOptions
Simple class to map LUXON options to provide to date time adapter.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractAnnotation
Base class to define an annotation in the
AnnotationPlugin.ID plugin.It contains all commons properties to define an annotation. |
class |
AnnotationContext
The callback or handler context wrapper, created and passed by
AnnotationPlugin.ID which contains the link to the native chart. |
class |
AnnotationOptions
This is the
AnnotationPlugin.ID plugin options where to set all configuration items needed to the plugin. |
class |
BoxAnnotation
Implements a BOX annotation which draws a box in the a chart.
If one of the axes is not specified, the box will take the entire chart dimension. The 4 coordinates, xMin, xMax, yMin, yMax are optional. |
class |
EllipseAnnotation
Implements a ELLIPSE annotation which draws a ellipse in the a chart.
If one of the axes is not specified, the ellipse will take the entire chart dimension. The 4 coordinates, xMin, xMax, yMin, yMax are optional. |
class |
Font
Base object to map font options for
AnnotationPlugin.ID plugin LINE LABEL configuration. |
class |
LineAnnotation
Implements a LINE annotation which draws a line in the a chart.
Vertical or horizontal lines are supported. |
class |
LineLabel
Implements a LABEL to apply on a LINE annotation.
|
class |
PointAnnotation
Implements a POINT annotation which draws a point in the a chart.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractDatasetContext
The option context is used to give contextual information when resolving options where the data set locator (data and data set index) must be used.
|
class |
ChartContext
Abstract implementation to map the context used as argument on options, data sets, scales and plugins callbacks.
All context implementations have got a property which is a reference to the chart instance. |
class |
DatasetContext
The option context is used to give contextual information when resolving options.
|
class |
ScaleContext
The SCALE option context is used to give contextual information when resolving options.
The context object contains the following properties: index: index of the associated data scale: scale instance which contains the element to configure tick: tick item instance which contains data to be consumed configuring the element (only for ticks) label: label item to manage by callback (only for point label context) |
class |
SegmentContext
The callback or handler context wrapper, created and passed by
Segment which contains the line charts references. |
class |
TooltipContext
The option context is used to give contextual information when resolving options.
|
Modifier and Type | Method and Description |
---|---|
<T extends NativeObjectContainer> |
ChartContext.getAttributes(NativeObjectContainerFactory<T> factory)
Returns the attributes, if exist.
|
<T extends NativeObjectContainer> |
ChartContext.setAttributes(T attributes)
Sets the additional attributes.
|
Modifier and Type | Class and Description |
---|---|
class |
CanvasObject
Base object for pattern and gradient instances, based on canvas element.
|
class |
Gradient
A gradient is an image consisting of a progressive transition between two or more colors.
Could be Linear or Radial .Can be created using the size of CANVAS or CHART area.The orientation to have a progressive transition, is defined by an enumeration in order to creates the gradient using the right coordinates and dimension, based on existing items (canvas and chart). |
class |
GradientColor
Contains the color and its offset to set a gradient.
|
class |
Pattern
Entity to apply a canvas pattern in the a data set as background.
See here some interesting pattern images. |
Modifier and Type | Class and Description |
---|---|
class |
ArrayObjectContainerList<E extends NativeObjectContainer>
An ordered collection (also known as a sequence).
|
interface |
NativeObjectContainerFactory<T extends NativeObjectContainer>
Interface to be implemented to load elements from an array of native object.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractNode
Base class for all options nodes, which will wraps a native object and manages the relations about parent and children elements.
|
class |
AbstractPoint
This object is wrapping the native java script object to map a point.
|
class |
AbstractReadOnlyPoint
This object is wrapping the native java script object to map a point, in READ-ONLY mode.
|
class |
PropertyHandler<D>
Base object to to manage common properties in the the options or configuration.
To reduce the duplication of code, this calls helps to manage the same property or properties on different objects, without extending them. |
Modifier and Type | Method and Description |
---|---|
static <E extends NativeObjectContainer> |
ArrayObject.fromOrEmpty(E item)
Creates a java script array of objects starting from a native object containers and the array will have ONE 1 element.
|
static <E extends NativeObjectContainer> |
ArrayObject.fromOrEmpty(E[] items)
Creates a java script array of objects starting from an array of native object containers.
|
static <E extends NativeObjectContainer> |
ArrayObject.fromOrEmpty(List<E> items)
Creates a java script array of objects starting from a list of native object containers.
|
static <E extends NativeObjectContainer> |
ArrayObject.fromOrNull(E item)
Creates a java script array of objects starting from a native object containers and the array will have ONE 1 element.
|
static <E extends NativeObjectContainer> |
ArrayObject.fromOrNull(E[] items)
Creates a java script array of objects starting from an array of native object containers.
|
static <E extends NativeObjectContainer> |
ArrayObject.fromOrNull(List<E> items)
Creates a java script array of objects starting from a list of native object containers.
|
static <E extends NativeObjectContainer> |
ArrayListHelper.list(ArrayObject array,
NativeObjectContainerFactory<E> factory)
Creates a array list of java script native object container by a java script array and a factory.
|
static <E extends NativeObjectContainer> |
ArrayListHelper.unmodifiableList(ArrayObject array,
NativeObjectContainerFactory<E> factory)
Creates an unmodifiable array list of java script native object container by a java script array and a factory.
|
Modifier and Type | Method and Description |
---|---|
static <E extends NativeObjectContainer> |
ArrayObject.fromOrEmpty(E[] items)
Creates a java script array of objects starting from an array of native object containers.
|
static <E extends NativeObjectContainer> |
ArrayObject.fromOrNull(E[] items)
Creates a java script array of objects starting from an array of native object containers.
|
static String |
Id.get(NativeObjectContainer nativeObjectContainer)
Returns the property value from java script object.
|
T |
CallbackPropertyHandler.getCallback(NativeObjectContainer container)
Returns the callback stored in the native object or
null if not exists. |
T |
CallbackPropertyHandler.getCallback(NativeObjectContainer container,
T defaultValue)
Returns the callback stored in the native object or the default value passed as argument, if not exists.
|
boolean |
JsHelper.isCanvas(NativeObjectContainer object,
Key key)
Returns
true if the object is a Canvas . |
boolean |
JsHelper.isImage(NativeObjectContainer object,
Key key)
Returns
true if the object is a Img . |
void |
Merger.load(IsChart chart,
NativeObjectContainer options,
ChartEnvelop<NativeObject> envelop)
Merges chart default options (by chart.defaults[type]), default scale options (by chart.defaults.scale) and global options (by chart.defaults.global) and chart options.
The chain of priority is: chart options chart default options (by chart.defaults[type]) default scale options (by chart.defaults.scale) global options (by chart.defaults.global) |
void |
Merger.load(NativeObjectContainer options,
ChartEnvelop<NativeObject> envelop)
Merges the chart options, built after the chart initialization on the chart configuration in order that the configuration can contain all values, also the defaults.
|
static void |
ConfigurationLoader.loadData(Configuration configuration,
NativeObjectContainer data)
Loads the DATA in the configuration CHART.JS object.
|
static void |
ConfigurationLoader.loadOptions(Configuration configuration,
NativeObjectContainer options)
Loads the OPTIONS in the configuration CHART.JS object.
|
NativeObject |
Merger.merge(NativeObjectContainer target,
NativeObjectContainer source,
String property)
Copies
source properties (creating a new java script object and setting the source one with the property argument) in the target only
if not defined in target.target is not cloned and will be updated with source properties.The property is |
NativeObject |
Merger.merge(NativeObjectContainer target,
NativeObject source,
String property)
Copies
source properties (creating a new java script object and setting the source one with the property argument) in the target only
if not defined in target.target is not cloned and will be updated with source properties.The property is |
NativeObject |
Merger.merge(NativeObject target,
NativeObjectContainer source,
String property)
Copies
source properties (creating a new java script object and setting the source one with the property argument) in the target only
if not defined in target.target is not cloned and will be updated with source properties.The property is |
protected void |
NativeObjectContainer.setValue(Key key,
NativeObjectContainer value)
Sets a value (JavaScript Object) in the embedded JavaScript object at specific property by object container.
|
protected void |
PropertyHandler.setValueAndAddToParent(Key key,
NativeObjectContainer value)
Sets a value (JavaScript Object) in the embedded JavaScript object at specific property by object container.
|
protected void |
AbstractNode.setValueAndAddToParent(Key key,
NativeObjectContainer value)
Sets a value (JavaScript Object) in the embedded JavaScript object at specific property by object container.
|
protected void |
NativeObjectContainer.setValueOrArray(Key key,
NativeObjectContainer... values)
Sets a value (array or native object container) in the embedded JavaScript object at specific property.
This must be used when a java script property can contain an array or a native object container. |
protected void |
PropertyHandler.setValueOrArrayAndAddToParent(Key key,
NativeObjectContainer... values)
Sets a value (array or native object container) in the embedded JavaScript object at specific property.
This must be used when a java script property can contain an array or a native object container. |
protected void |
AbstractNode.setValueOrArrayAndAddToParent(Key key,
NativeObjectContainer... values)
Sets a value (array or native object container) in the embedded JavaScript object at specific property.
This must be used when a java script property can contain an array or a native object container. |
Modifier and Type | Class and Description |
---|---|
class |
ControllerMapperFactory<T extends NativeObjectContainer>
Class to implement from controllers in order to extend the standard configuration of charts.
It takes the java script object of standard options passing it to a wrapper to manage additional properties. |
Modifier and Type | Class and Description |
---|---|
class |
AbstractDataPoint
Maps the common methods for a data point.
|
class |
ArcBorderRadius
Defines the border radius for ARC data set element, applies the corner radius to all corners of the arc (outerStart, outerEnd, innerStart, and innerEnd).
|
class |
BarBorderRadius
Defines the border radius for BAR data set element, applies the corner radius to all corners of the rectangle (topLeft, topRight, bottomLeft, bottomRight).
|
class |
BarBorderWidth
Defines the border width for BAR data set (left, top, right, bottom).
|
class |
BarDataset
The bar chart allows a number of properties to be specified for each data set.
|
class |
BubbleDataset
The chart allows a number of properties to be specified for each data set.
|
class |
Clip
Defines how to clip relative to the chart area.
Positive value allows overflow, negative value clips that many pixels inside the chart area. If sets false , that means that CHART.JS will use chart area dimension.With false value, the properties will be:
Left is 0
Top is 0
Right is area right
Bottom is area bottom
|
class |
Data
CHART.JS entity object to configure the data options of a chart.
It contains labels and data sets. |
class |
DataPoint
Used for sparse datasets, such as those in scatter charts.
|
class |
Dataset
The chart allows a number of properties to be specified for each data set.
|
class |
DoughnutDataset
The doughnut chart allows a number of properties to be specified for each dataset.
|
class |
HorizontalBarDataset
The horizontal bar chart allows a number of properties to be specified for each data set.
These are used to set display properties for a specific data set. Some properties can be specified as an array. If these are set to an array value, the first value applies to the first bar, the second value to the second bar, and so on. |
class |
HoverDataset
The chart allows a number of properties to be specified for each data set.
These are used to set display properties for a specific data set. |
class |
HoverFlexDataset
This dataset is managing some common properties related to background and border colors where every property can be set as a single value or an array.
|
class |
LabelsHandler
Utility to manage the LABELS on chart datasets and options.
|
class |
LineDataset
The line chart allows a number of properties to be specified for each data set.
These are used to set display properties for a specific data set. All point* properties can be specified as an array. If these are set to an array value, the first value applies to the first point, the second value to the second point, and so on. |
class |
LiningDataset
The chart allows a number of properties to be specified for each data set.
These are used to set display properties for a specific data set. This class collects a set of common field for Line and Radar charts. |
class |
PieDataset
The pie chart allows a number of properties to be specified for each dataset.
|
class |
PolarAreaDataset
The polar area chart allows a number of properties to be specified for each dataset.
|
class |
RadarDataset
The radar chart allows a number of properties to be specified for each dataset.
|
class |
ScatterDataset
The scatter chart allows a number of properties to be specified for each dataset.
|
class |
StackedAreaDataset
The stacked area chart allows a number of properties to be specified for each dataset.
|
class |
StackedBarDataset
The stacked bar area chart allows a number of properties to be specified for each dataset.
|
class |
StackedHorizontalBarDataset
The stacked horizontal bar area chart allows a number of properties to be specified for each dataset.
|
class |
TimeSeriesBarDataset
The time series bar chart allows a number of properties to be specified for each dataset.
|
class |
TimeSeriesHorizontalBarDataset
The time series horizontal bar chart allows a number of properties to be specified for each dataset.
|
class |
TimeSeriesItem
Default implementation for time series item interface in order to manage time series item (time and value).
|
class |
TimeSeriesLineDataset
The time series line chart allows a number of properties to be specified for each dataset.
|
class |
VerticalLineDataset
The vertical line chart allows a number of properties to be specified for each data set.
These are used to set display properties for a specific data set. All point* properties can be specified as an array. If these are set to an array value, the first value applies to the first point, the second value to the second point, and so on. |
Modifier and Type | Method and Description |
---|---|
<T extends NativeObjectContainer> |
AbstractDataPoint.getAttributeAsObject(Key key,
NativeObjectContainerFactory<T> factory)
Returns a custom field value from data point.
|
<T extends NativeObjectContainer> |
AbstractDataPoint.setAttribute(Key key,
T value)
Sets a custom field to data point.
|
Modifier and Type | Class and Description |
---|---|
class |
DataLabelsContext
The option context is used to give contextual information when resolving options for
DataLabelsPlugin . |
class |
DataLabelsOptions
This is the
DataLabelsPlugin.ID plugin options where to set all the configuration needed to the plugin.The options could be set by simply the value or by setting a callback. The DataLabelsPlugin.ID plugin is highly customizable CHART.JS plugin that displays labels on data for any type of charts. |
class |
LabelItem
This is the base for
DataLabelsPlugin.ID plugin options where to set all the configuration needed to the a label.The options could be set by simply the value or by setting a callback. |
class |
Labels
Base object to map multi labels options for
DataLabelsPlugin.ID plugin configuration.It's possible to define multiple labels for each data element using the this object. It is an object where each property represents a new label, the key being the label key and the value being the options specific to each label. |
class |
Listeners
This is the LISTENER options of
DataLabelsPlugin.ID plugin allows to register callback(s) to be notified when an event is detected on a specific label. |
Modifier and Type | Method and Description |
---|---|
static PointStyleType |
PointStyleType.getType(NativeObjectContainer object,
Key key)
Returns the point style type in the native object container.
|
Modifier and Type | Class and Description |
---|---|
class |
ChartEventContext
This is the class which can wrap a CHART.JS event.
|
Modifier and Type | Class and Description |
---|---|
class |
BubbleMapDataPoint
Used for BubbleMap data sets to set the data to render.
A data has to have a latitude and longitude properties and a value property containing the value for the coloring. |
class |
BubbleMapDataset
It is a
BubbleDataset with additional options for bubble map charts. |
class |
BubbleMapPoint
The styling of the new element
BubbleMapPoint is based on Point element with some additional options for the outline and graticule. |
class |
ChoroplethBar
The styling of the new element
ChoroplethBar is based on Bar element with some additional options for the outline and graticule. |
class |
ChoroplethDataPoint
Used for GEO data sets to set the data to render.
A GEO data has to have a feature property containing the feature to render and a value property containing the value for the coloring. |
class |
ChoroplethDataset
The choropleth data set allows a region definition (by
Feature ) and specific value to be specified. |
class |
Feature
Represents the region definition with all properties and geometries needed to draw the region.
|
class |
Graticule
The network of intersecting lines of latitude and longitude is called the graticule.
It is imaginary on the earth, of course, but is drawn on globes and maps for reference. The graticule of latitude and longitude lines is an angular measurement system. |
class |
Legend
Legend configuration for GEO chart scale.
|
class |
Margin
Defines the margin pixels for legend such that it doesn't stick to the edge of the chart .
|
class |
PositionPoint
This object is wrapping the native java script object to provide the position of the legend.
|
class |
TopoJson
TopoJSON is an extension of GeoJSON that encodes topology.
|
Modifier and Type | Class and Description |
---|---|
class |
GaugeDataset
The Gauge chart allows a number of properties to be specified for each dataset.
|
class |
MeterContext
The callback context wrapper, created and passed by
MeterOptions which contains the link to the native chart. |
class |
MeterDataset
The Meter chart allows a number of properties to be specified for each dataset.
|
Modifier and Type | Class and Description |
---|---|
class |
ChartBackgroundColorOptions
Configuration options of
ChartBackgroundColor.ID plugin. |
class |
ChartPointerOptions
Configuration options of
ChartPointer.ID plugin.It manages the cursor to adopt when the cursor is over the dataset item and when not. |
class |
ColorSchemesOptions
This is the object to map the
ColorSchemes.ID plugin options, both at chart and global level. |
class |
DatasetsItemsSelectorOptions
Configuration options of
DatasetsItemsSelector.ID plugin.It is managing: the X axis ID the selection color the border color the border width the border dash the border dash offset flag to fire event on update "clear" options |
class |
HtmlLegendOptions
Configuration options of
HtmlLegend.ID plugin.This is mapping the configuration both default global and per chart instance. |
class |
SelectionCleaner
DatasetsItemsSelector.ID plugin configuration element in order to have in the the chart a clickable element to clear the selection. |
Modifier and Type | Class and Description |
---|---|
class |
DateTimeFormatOptions
The object configures a date time formatter.
See MDN for more details. |
class |
FormatPart
Result of
NumberFormat.formatToParts(double) which is containing the locale-specific tokens from which it possible to build custom strings while preserving the
locale-specific parts.See MDN for more details. |
class |
NumberFormatOptions
The object configures a number formatter.
See MDN for more details. |
Modifier and Type | Class and Description |
---|---|
class |
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. |
class |
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. |
class |
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. |
class |
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. |
class |
BaseBoxNodeItem
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. |
class |
BorderRadiusItem
Defines the border radius for legend item element, applies the corner radius to all corners of the rectangle (topLeft, topRight, bottomLeft, bottomRight).
|
class |
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. |
class |
DatasetElement
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. |
class |
DatasetElementOptions
This item provides all information about the view where a dataset 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. |
class |
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. |
class |
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. |
class |
DatasetPoint
It wraps the parsed data values for the given item point.
|
class |
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. |
class |
FontItem
Font options item to use mainly for callbacks.
|
class |
LegendHitBoxItem
This is a wrapper of the CHART.JS item which contains the legends hit box.
|
class |
LegendItem
This is a wrapper of the CHART.JS item which contains the legend item.
|
class |
LegendLabelItem
This object is created by callbacks and returned to CHART.JS as native object to configure the legend.
|
class |
LegendNode
Wrapper of legend node of CHART.JS.
This is a wrapper of legend node of Chart (of CHART.JS). |
class |
LegendTextHandler
Manages the TEXT property of options in order to use the same logic between legend items and title.
|
class |
NumberFormatItem
Number format options item to use for numeric tick callbacks.
|
class |
OptionsNode
Wrapper of options node of CHART.JS.
|
class |
PaddingItem
Padding options item to use mainly for callbacks.
|
class |
Parsed
This object is wrapping the native java script object provided by
DatasetElement to know the parsed value. |
class |
PluginDatasetArgument
This is a wrapper of java script object which represents a dataset.
This object is used in the plugins methods of CHART.JS. |
class |
PluginEventArgument
This is a wrapper of java script object which represents a event.
This object is used in the plugins methods of CHART.JS. |
class |
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. |
class |
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. |
class |
PluginTooltipArgument
Contains all info for every item of tooltip.
Created and passed by CHART.JS. It uses in the the PLUGINS. |
class |
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. |
class |
ScaleItem
Wraps the scale item of CHART JS chart.
This is a wrapper of scale of Chart (of CHART.JS). |
class |
ScalesNode
Wrapper of scales node of CHART.JS.
This is a wrapper of scale node of Chart (of CHART.JS). |
class |
ScaleTickItem
The tick item maps the objects passed a
ScaleItem .This is a wrapper of the CHART.JS item with all needed info. |
class |
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. |
class |
SubtitleNode
Wrapper of subtitle node of CHART.JS.
This is a wrapper of subtitle node of Chart (of CHART.JS). |
class |
TitleNode
Wrapper of title node of CHART.JS.
This is a wrapper of title node of Chart (of CHART.JS). |
class |
TooltipBodyItem
This object is passed by CHART.JS to the callback to manage tooltip body.
|
class |
TooltipItem
Contains all info for every item of tooltip.
Created and passed by CHART.JS. It uses in the the tooltips callbacks. |
class |
TooltipLabelColor
This object contains the color info when a label in the tooltip.
It must be used in the label tooltip callback. |
class |
TooltipLabelPointStyle
This object contains the point style info when a label in the tooltip.
It must be used in the label tooltip callback. |
class |
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. |
Modifier and Type | Method and Description |
---|---|
<T extends NativeObjectContainer> |
DataItem.createDataPoint(NativeObjectContainerFactory<T> factory)
Returns a data point to be mapped for customization, like for out of the box controllers.
|
Modifier and Type | Class and Description |
---|---|
class |
Label
This is the object to map the
LabelsPlugin.ID plugin options, both at chart and global level. |
class |
LabelsContext
This object is wrapping the native java script object provided by
LabelsPlugin.ID plugin when the callback function is called. |
class |
LabelsOptions
This is the object to map the
LabelsPlugin.ID plugin options, both at chart and global level. |
Modifier and Type | Class and Description |
---|---|
class |
MatrixDataPoint
Maps the data passed to a matrix dataset.
|
class |
MatrixDataset
The matrix data set allows to specify the values for showing magnitude of a phenomenon as color in two dimensions.
The variation in color may be by hue or intensity, giving obvious visual cues to the reader about how the phenomenon is clustered or varies over space. |
Modifier and Type | Class and Description |
---|---|
class |
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. |
class |
AbstractFont
Base class to map the font properties of an element.
|
class |
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. |
class |
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. |
class |
AbstractNumberFormat
This is abstract number format object element of the chart options.
|
class |
AbstractPadding
Base class to map the padding properties of an element.
|
class |
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 |
class |
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 . |
class |
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 . |
class |
AbstractTitle<T extends IsDefaultAbstractTitle>
Configures the default chart title and subtitle which defines texts to draw at the top of the chart.
|
class |
Adapters
The following adapters element is used to configure a date adapter, injecting to support time series in the CHART.JS.
|
class |
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 . |
class |
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. |
class |
AnimationCollection
Is the base animation options with common properties for animation properties (property and collections of properties).
|
class |
AnimationContainer
Manages the ANIMATION, ANIMATIONS and TRANSITIONS properties of options in order to use the same logic among all options/configuration and datasets.
|
class |
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. |
class |
AnimationTransition
Abstract options to define the animation for a specific update mode (transition).
|
class |
Arc
Arcs are used in the polar area, doughnut and pie charts.
|
class |
Bar
Bar elements are used to represent the bars in a bar chart.
|
class |
BarDatasetOptionsHandler
Manages the BAR dataset properties of options in order to use the same logic between datasets and options/configuration.
|
class |
Datasets
Contains the options for the datasets.
|
class |
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
|
class |
DisplayFormats
The display formats are used to configure how different time units are formed in the strings for the axis tick marks.
|
class |
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. |
class |
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. |
class |
ExtendedScale
Scale options used internally inside the chart configuration.
Extends the normal scale options with all methods to add callbacks and events. |
class |
ExtendedScales
Options used internally inside the chart configuration.
This is the SCALES element of configuration. |
class |
Filler
The filler plugin can be used to fill the datasets.
|
class |
FillHandler
Manages the FILL property of options in order to use the same logic between line datasets and options/configuration.
|
class |
FontContainer
This is the labels configuration of the legend.
|
class |
Grid
The grid line configuration defines options for the grid that run perpendicular to the axis.
|
class |
Hover
Definitions about how elements appear in the tooltip, hovering the chart.
|
class |
Interaction
Definitions about how elements appear in the tooltip, hovering the chart.
|
class |
Layout
The layout configuration is needed to set the padding.
|
class |
LegendLabels
This is the labels configuration of the legend.
|
class |
LegendTitle
This is the title configuration of the legend.
|
class |
Line
Line elements are used to represent the line in a line chart.
|
class |
Major
It defines options for the major tick marks that are generated by the axis.
|
class |
Options
Base object which maps chart options.
|
class |
Padding
Maps the additional space to apply to the sides of elements (left, top, right, bottom), in pixels.
|
class |
Plugins
Definitions about plugins options.
|
class |
Point
Point elements are used to represent the points in a line chart or a bubble chart.
|
class |
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 . |
class |
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 |
class |
ScaleDateAdapter
This is abstract date adapter object element of the chart options.
|
class |
ScaledOptions
Base object which maps chart options, with scales elements to set axes configurations.
|
class |
Scales
The configuration element which contains all axes definitions.
|
class |
ScaleTitle
When creating a chart, you want to tell the viewer what data they are viewing.
|
class |
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. |
class |
SpanGapHandler
Manages the SPANGAPS property of options in order to use the same logic between line datasets and options/configuration.
|
class |
Subtitle
Configures the default chart subtitle which defines text to draw at the top of the chart.
|
class |
Ticks
All configuration for ticks of a chart.
It defines options for the tick marks that are generated by the axis. |
class |
TicksNumberFormat
It applies the number formatting to the ticks of all linear scales.
|
class |
Time
The time configuration is used to configure how time and time series axes must configure the tick marks.
|
class |
Tooltips
Configuration element to set all attributes and features of the default tooltip.
|
class |
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. |
class |
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. |
class |
TypedDataset
Contains the options for the data sets.
|
Modifier and Type | Method and Description |
---|---|
<T extends NativeObjectContainer> |
ExtendedOptions.getRemappedOptions(ControllerMapperFactory<T> factory)
Returns the options, mapped with a custom object, used for controllers to map the options.
It uses a factory instance to create a customized options. If factory argument is not consistent, null is returned. |
<T extends NativeObjectContainer> |
ExtendedScale.getRemappedOptions(ControllerMapperFactory<T> factory)
Returns the options, mapped with a custom object, used for controllers to map the options.
It uses a factory instance to create a customized options. If factory argument is not consistent, null is returned. |
Modifier and Type | Class and Description |
---|---|
class |
AbstractPluginOptions
Abstract plugin options where to set all the configuration needed to the plugin.
|
Modifier and Type | Class and Description |
---|---|
class |
PositionerContext
The positioner context is used to give contextual information to the tooltip positioner function.
|
Modifier and Type | Class and Description |
---|---|
class |
Priority
Is a map to user to apply a different priority to sankey node, priority used to layout calculation.
|
class |
SankeyDataPoint
Maps the data passed to a sankey dataset.
|
class |
SankeyDataset
Sankey charts are a type of flow diagram in which the width of the arrows is proportional to the flow rate.
Sankey diagrams emphasize the major transfers or flows within a system. They help locate the most important contributions to a flow. They often show conserved quantities within defined system boundaries. |
Modifier and Type | Class and Description |
---|---|
class |
TreeMapDataPoint
Used for treemap datasets.
|
class |
TreeMapDataset
The treemap data set allows to specify the values for displaying hierarchical data using nested rectangles.
|
Modifier and Type | Method and Description |
---|---|
<T extends NativeObjectContainer> |
TreeMapDataPoint.getData(NativeObjectContainerFactory<T> factory)
Returns the object in the user format of the data point.
|
<T extends NativeObjectContainer> |
TreeMapDataset.getTreeObjects(NativeObjectContainerFactory<T> factory)
Returns the tree data property of a data set for a chart is specified as a list of objects.
|
<T extends NativeObjectContainer> |
TreeMapDataPoint.getTreeObjects(NativeObjectContainerFactory<T> factory)
Returns the unmodifiable list of tree user objects, related to this data point.
|
<T extends NativeObjectContainer> |
TreeMapDataset.getTreeObjects(NativeObjectContainerFactory<T> factory,
boolean binding)
Returns the tree data property of a data set for a chart is specified as an list of objects.
|
<T extends NativeObjectContainer> |
TreeMapDataset.setTreeObjects(T[] values)
Sets the tree data property of a data set for a chart is specified as an array of objects.
|
<T extends NativeObjectContainer> |
TreeMapDataset.setTreeObjetcs(List<T> values)
Sets the tree data property of a data set for a chart is specified as a list of objects.
|
Modifier and Type | Method and Description |
---|---|
<T extends NativeObjectContainer> |
TreeMapDataset.setTreeObjects(T[] values)
Sets the tree data property of a data set for a chart is specified as an array of objects.
|
Modifier and Type | Method and Description |
---|---|
<T extends NativeObjectContainer> |
RegExpResult.groups(NativeObjectContainerFactory<T> factory)
Returns the object to refer to certain token by string that a regular expression matches.
|
Modifier and Type | Class and Description |
---|---|
class |
Action
Configures style of the toast actions.
|
class |
ActionItem
Defines user action to show on a toast in order to enable the user to act with the toast.
|
class |
DefaultToastOptions
Provides the defaults of the toast options.
|
class |
Title
Configures the toast title.
|
class |
ToastItem
Represents an toast instance, once it has been created and consumed.
|
class |
ToastOptions
Entity to configure the toast to show.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractConfigurationItem
Abstract element used by pan and zoom object in order to enable to provide the configuration of
ZoomPlugin.ID . |
class |
Amount
This object is wrapping the native java script object to set the position to pan the chart.
|
class |
Drag
Configuration item to define the style to apply to drag area, during zooming.
|
class |
Limits
Entity of
ZoomPlugin.ID configuration in order to define the limits of X and Y scales for pan and zoom. |
class |
Pan
Base object to map pan options for
ZoomPlugin.ID plugin configuration.It represents the container for PAN options. |
class |
Pinch
Base object to map wheel options for
ZoomPlugin.ID plugin configuration.It represents the container for WHEEL options. |
class |
ScaleLimit
Entity of
ZoomPlugin.ID configuration in order to set minimum and maximum values of the scales for pan or zoom. |
class |
ScaleRange
Entity of
ZoomPlugin.ID configuration in order to set minimum and maximum values of the scales for pan or zoom.The values to set to the properties depends on the type of scales are used. |
class |
Wheel
Base object to map wheel options for
ZoomPlugin.ID plugin configuration.It represents the container for WHEEL options. |
class |
Zoom
Base object to map zoom options for
ZoomPlugin.ID plugin configuration.It represents the container for ZOOM options. |
class |
ZoomContext
The callback or handler context, created and passed by
ZoomPlugin.ID which contains the link to the native chart and the event. |
class |
ZoomOptions
This is the
ZoomPlugin.ID plugin options where to set all the configuration needed to the plugin. |