| Package | Description |
|---|---|
| org.pepstock.charba.client |
Main package with all charts implementation, global classes and common interfaces.
|
| 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.commons |
Core classes to manage the inter-operations with java script code.
|
| 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.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.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.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.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 |
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). |
| 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 |
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 |
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 | Method and Description |
|---|---|
protected AbstractNode |
PropertyHandler.getParent()
Returns the parent.
|
protected AbstractNode |
AbstractNode.getParentNode()
Returns the parent node.
|
protected AbstractNode |
AbstractNode.getRootNode()
Returns the root node.
|
protected AbstractNode |
AbstractNode.retrieveRoot()
Called recursively till the root of nodes.
|
| Modifier and Type | Method and Description |
|---|---|
static String |
HasCallbackScope.extractScope(AbstractNode node)
Extracts the scope tag from the root of the node in the options.
|
void |
CallbackPropertyHandler.setCallback(AbstractNode container,
String scope,
T callback,
CallbackProxy.Proxy proxy)
Stores the callback in the the cache, storing the proxy function and the hash code property key (unique id of callback) in the native object.
|
protected void |
AbstractNode.setInternalCallbackToModel(AbstractNode model,
Key key,
CallbackProxy.Proxy proxy)
Adds a proxy function to a model at the specific key.
|
protected void |
AbstractNode.setInternalCallbackToModel(AbstractNode model,
Key key,
NativeCallback callback)
Adds a native callback function to a model at the specific key.
|
| Constructor and Description |
|---|
AbstractNode(AbstractNode parent,
Key childKey,
NativeObject nativeObject)
Creates the object with the parent, the key of this element, default values and native object to map java script properties.
|
PropertyHandler(AbstractNode parent,
D defaultValues,
NativeObject nativeObject)
Creates a native object where one or more properties must be managed, cross classes and package.
|
| Modifier and Type | Class and Description |
|---|---|
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 |
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 |
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 |
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 | Class and Description |
|---|---|
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 |
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 | Class and Description |
|---|---|
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 |
ChoroplethDataset
The choropleth data set allows a region definition (by
Feature) and specific value to be specified. |
| Modifier and Type | Class and Description |
|---|---|
class |
GaugeDataset
The Gauge chart allows a number of properties to be specified for each dataset.
|
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. |
| Modifier and Type | Class and Description |
|---|---|
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 |
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 |
NumberFormatItem
Number format options item to use for numeric tick callbacks.
|
class |
OptionsNode
Wrapper of options node of CHART.JS.
|
| Constructor and Description |
|---|
LegendTextHandler(AbstractNode parent,
OptionsEnvelop<NativeObject> envelop)
Creates a legend text handler with the envelop of the native object where TEXT property must be managed.
|
| 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 |
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 |
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 |
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 |
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 |
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 |
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 |
Font
Base object to map font options for configuration.
|
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 |
Legend
The chart legend displays data about the datasets that area appearing on the chart.
|
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 |
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 |
|---|---|
protected void |
AbstractModel.setCallbackToModel(AbstractNode model,
Key key,
CallbackProxy.Proxy proxy)
Adds a proxy function (for callbacks) to a model at the specific key.
|
protected void |
AbstractModel.setCallbackToModel(AbstractNode model,
Key key,
NativeCallback callback)
Adds a native callback function to a model at the specific key.
|
void |
ExtendedOptions.setEvent(AbstractNode node,
Key property,
ConfigurationEnvelop<CallbackProxy.Proxy> envelop)
Adds a event proxy function to animation element instance.
|
protected void |
AbstractModel.setEventToModel(AbstractNode model,
Key key,
CallbackProxy.Proxy proxy)
Adds a proxy function (for events) to a model at the specific key.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ExtendedOptions.setCallback(ConfigurationEnvelop<AbstractNode> envelop,
Key property,
CallbackProxy.Proxy proxy)
Adds a callback proxy function to a element node instance.
|
void |
ExtendedScale.setCallback(ConfigurationEnvelop<AbstractNode> envelop,
Key property,
CallbackProxy.Proxy proxy)
Adds a callback proxy function to a element node instance.
|
void |
ExtendedOptions.setCallback(ConfigurationEnvelop<AbstractNode> envelop,
Key property,
NativeCallback callback)
Adds a native callback function to a element node instance.
|
void |
ExtendedScale.setCallback(ConfigurationEnvelop<AbstractNode> envelop,
Key property,
NativeCallback callback)
Adds a native callback function to a element node instance.
|
| Constructor and Description |
|---|
BarDatasetOptionsHandler(AbstractNode parent,
IsDefaultTypedDataset defaultValues,
DataEnvelop<NativeObject> envelop)
Creates an bar options handler with an envelop of the native object where properties must be managed and the default value to use when the property does not exist.
|
FillHandler(AbstractNode parent,
IsFill defaultValues,
DataEnvelop<NativeObject> envelop)
Creates a fill handler with the native object where FILL property must be managed and the default value to use when the property does not exist.
This is called from data package. |
FontContainer(AbstractNode parent,
IsDefaultFontContainer defaultValues,
NativeObject nativeObject)
Creates a font container with the native object where font properties must be managed and the default value to use when the property does not exist.
|
SpanGapHandler(AbstractNode parent,
IsDefaultOptions defaultValues,
DataEnvelop<NativeObject> envelop)
Creates a span gap handler with the envelop of the native object where SPANGAPS property must be managed and the default value to use when the property does not exist.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractPluginOptions
Abstract plugin options where to set all the configuration needed to the plugin.
|
| Constructor and Description |
|---|
AbstractPluginOptions(String pluginId,
AbstractNode parent,
Key childKey,
NativeObject nativeObject)
Creates the object with the parent, the key of this element, default values and native object to map java script properties.
|
| Modifier and Type | Class and Description |
|---|---|
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 |
TreeMapDataset
The treemap data set allows to specify the values for displaying hierarchical data using nested rectangles.
|
| 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 |
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 |
Drag
Configuration item to define the style to apply to drag area, during zooming.
|
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 |
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 |
ZoomOptions
This is the
ZoomPlugin.ID plugin options where to set all the configuration needed to the plugin. |