Package | Description |
---|---|
org.pepstock.charba.client |
Main package with all charts implementation, global classes and common interfaces.
|
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.configuration |
Contains all elements to configure a chart instance (know as chart options at instance level).
|
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.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.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.
|
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 ). |
class |
UpdateConfiguration
Object can be provided with additional configuration for the update/render 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 |
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 into a dataset 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 | 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.
|
<T extends NativeObjectContainer> |
NativeExtendedObject.getOptions(NativeObjectContainerFactory<T> factory)
Returns the options, if exist.
|
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.
|
<T extends NativeObjectContainer> |
NativeExtendedObject.setOptions(T options)
Sets the additional options.
|
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 |
---|---|
void |
ArrayObjectContainerList.addAll(E[] values)
Loads an array of elements into the list
|
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.
|
static void |
ConfigurationLoader.loadData(Configuration configuration,
NativeObjectContainer data)
Loads the DATA into configuration CHART.JS object.
|
static void |
ConfigurationLoader.loadOptions(Configuration configuration,
NativeObjectContainer options)
Loads the OPTIONS into 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) into 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) into 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) into 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) into embedded JavaScript object at specific property by object container.
|
Modifier and Type | Method and Description |
---|---|
<T extends NativeObjectContainer> |
Plugins.getOptions(String pluginId,
NativeObjectContainerFactory<T> factory)
Returns the plugin options, if exist.
|
<T extends NativeObjectContainer> |
Plugins.getOptionsAsList(String pluginId,
NativeObjectContainerFactory<T> factory)
Returns the plugin options as list of object containers, if exist.
|
<T extends NativeObjectContainer> |
Plugins.setOptions(String pluginId,
List<T> objects)
Sets the plugin options as array.
|
<T extends NativeObjectContainer> |
Plugins.setOptions(String pluginId,
T object)
Sets the plugin options.
|
Modifier and Type | Class and Description |
---|---|
class |
StyleElement
Element used by controller by
removeHoverStyle and setHoverStyle methods. |
Modifier and Type | Class and Description |
---|---|
class |
BarBorderWidth
Defines the border width for BAR dataset (left, top, right, bottom).
|
class |
BarDataset
The bar chart allows a number of properties to be specified for each dataset.
|
class |
BorderAligner
Utility to manage the border alignment on chart datasets.
|
class |
BubbleDataset
The chart allows a number of properties to be specified for each dataset.
|
class |
Data
CHART.JS entity object to configure the data options of a chart.
It contains labels and datasets. |
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 dataset.
|
class |
DoughnutDataset
The doughnut chart allows a number of properties to be specified for each dataset.
|
class |
HovingDataset
The chart allows a number of properties to be specified for each dataset.
|
class |
HovingFlexDataset
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 dataset.
|
class |
LiningDataset
The chart allows a number of properties to be specified for each dataset.
These are used to set display properties for a specific dataset. This class collects a set of common field for Line and Radar charts. |
class |
Orderer
Utility to manage the order option on chart datasets.
|
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 |
TimeSeriesBarDataset
The time series 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.
|
Modifier and Type | Method and Description |
---|---|
<T extends NativeObjectContainer> |
Dataset.getOptions(String pluginId,
NativeObjectContainerFactory<T> factory)
Returns the plugin dataset configuration, if exist.
|
<T extends NativeObjectContainer> |
Dataset.setOptions(String pluginId,
T options)
Sets the plugin dataset configuration.
|
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 |
Font
Base object to map font options for
DataLabelsPlugin.ID plugin configuration.It can be used also into callback for font generation at runtime. |
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. These options are merged on top of the options defined at the chart and dataset levels. |
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. |
class |
Padding
Base object to map font options for
DataLabelsPlugin.ID plugin configuration.It is applied to all sides of the chart (left, top, right, bottom). It can be used also into callback for font generation at runtime. |
Modifier and Type | Class and Description |
---|---|
class |
Filler
Manages the FILL property of options in order to use the same logic between line datasets and options/configuration.
|
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 |
ClearSelection
DatasetsItemsSelector.ID plugin configuration element in order to have into the chart a clickable element to clear
the selection. |
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 if firing event on clear selection |
Modifier and Type | Class and Description |
---|---|
class |
AnimationItem
The onProgress and onComplete event 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 |
AxisMarginsItem
JavaScript object which contains the margins sizes of an axis.
This object reflects the object created by CHART.JS and is provided to Axis callbacks. Implements all set methods to change java script object properties. |
class |
AxisMinSizeItem
JavaScript object which contains the minimum size of an axis.
This object reflects the object created by CHART.JS and is provided to Axis callbacks. 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 |
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 |
DatasetItem
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 dataset. |
class |
DatasetMetaItem
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 metadata information. Contains all data set items. |
class |
DatasetPluginItem
This is a wrapper of java script object which represents a dataset.
This object is used in the plugins methods of CHART.JS. |
class |
DatasetViewItem
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 |
EventPluginItem
This is a wrapper of java script object which represents a event.
This object is used in the plugins methods of CHART.JS. |
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 HCART.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 |
MarginsItem
It is applied to all sides of the chart (left, top, right, bottom).
This is a wrapper of the CHART.JS item |
class |
OptionsNode
Wrapper of options node 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 |
ScaleLongestTextCacheItem
Legend internal object to get data about ticks and their length in pixels.
This is a wrapper of scale text item 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 |
TimeTickItem
The time tick item passed when a tick callback has been set for cartesian time axis,
CartesianTimeTick .This is a wrapper of the CHART.JS item with all needed info. |
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 into the tooltips callbacks. |
class |
TooltipLabelColor
This object contains the color info when a label into tooltip.
It must be used into 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. |
class |
TooltipNode
Wrapper of tooltip node of CHART.JS.
This is a wrapper of title node of Chart (of CHART.JS). |
class |
TooltipPluginItem
Contains all info for every item of tooltip.
Created and passed by CHART.JS. It uses into the PLUGINS. |
Modifier and Type | Class and Description |
---|---|
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 |
AbstractElement<D extends IsDefaultOptionsElement>
Options can be configured for four different types of elements: arc, lines, points, and rectangles.
When set, these options apply to all objects of that type unless specifically overridden by the configuration attached to a dataset. |
class |
AbstractTick<P extends org.pepstock.charba.client.options.AbstractModel<?,?>,D extends IsDefaultBaseTick>
Configures the ticks of an axis.
Common base class for ticks. |
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.
|
class |
Arc
Arcs are used in the polar area, doughnut and pie charts.
|
class |
DisplayFormats
The following display formats are used to configure how different time units are formed into strings for the axis tick marks.
|
class |
Elements
Options can be configured for four different types of elements: arc, lines, points, and rectangles.
|
class |
ExtendedOptions
Options used internally inside the chart configuration.
|
class |
ExtendedScale
Scale options used internally inside the chart configuration.
Extends the normal scale options with all methods to add callbacks and events. |
class |
Fonter
Base object to map font options for configuration.
|
class |
GridLines
The grid line configuration defines options for the grid lines that run perpendicular to the axis.
|
class |
Hover
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 |
Line
Line elements are used to represent the line in a line chart.
|
class |
Options
Base object which maps chart options.
|
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 |
Rectangle
Rectangle elements are used to represent the bars in a bar chart.
|
class |
Scale
Axes are an integral part of a chart.
|
class |
ScaledOptions
Base object which maps chart options, with scales elements to set axes configurations.
|
class |
ScaleLabel
When creating a chart, you want to tell the viewer what data they are viewing.
|
class |
ScaleLabelPadding
It is applied to all sides of the scale label object of axes (left, top, right, bottom).
|
class |
Scales
The configuration element which contains all axes definitions.
|
class |
TickMajor
It defines options for the major tick marks that are generated by the axis.
|
class |
TickMinor
It defines options for the minor tick marks that are generated by the axis.
|
class |
Ticks
All configuration for ticks of a chart.
It defines options for the tick marks that are generated by the axis. |
class |
Time
The following display formats are used to configure how different time units are formed into strings for the axis tick marks.
|
class |
Title
Configures the default chart title which defines text to draw at the top of the chart.
|
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 into chart configuration. |
Modifier and Type | Method and Description |
---|---|
<T extends NativeObjectContainer> |
Plugins.getOptions(String pluginId,
NativeObjectContainerFactory<T> factory)
Returns the plugin options, if exist.
|
<T extends NativeObjectContainer> |
Plugins.getOptionsAsList(String pluginId,
NativeObjectContainerFactory<T> factory)
Returns the plugin options as list of object containers, if exist.
|
<T extends NativeObjectContainer> |
Plugins.setOptions(String pluginId,
List<T> options)
Sets the plugin options as array.
|
<T extends NativeObjectContainer> |
Plugins.setOptions(String pluginId,
T options)
Sets the plugin options.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractPluginCachedOptions
Abstract plugin options where to set all the configuration needed to the plugin.
|
class |
AbstractPluginOptions
Abstract plugin options where to set all the configuration needed to the plugin.
|
Modifier and Type | Method and Description |
---|---|
protected <G extends NativeObjectContainer> |
AbstractPluginOptionsFactory.loadGlobalsPluginOptions(NativeObjectContainerFactory<G> factory)
Loads the default plugin options from defaults.
|
protected <T extends NativeObjectContainer> |
AbstractPluginOptions.loadGlobalsPluginOptions(NativeObjectContainerFactory<T> factory)
Loads the default plugin options from defaults.
|