Package org.pepstock.charba.client

Main package with all charts implementation, global classes and common interfaces.

Author:

Andrea "Stock" Stocchero

Interface Summary

Interface	Description
ChartsLifecycleListener	Interface to catch the initialization, destroy and configuration of all charts. This is acting differently from a chart plugin because it will get all triggers for all charts. Used to clean up resources, created by a special implementation and not ot-of-the-box of Charba, like CHART.JS plugins.
ChartTimerTask	Interface which defines a timer task executable by a chart instance.
ConfigurationElement	Interface which allows an object to be called to set a native object in the chart configuration. The chart configuration are items options, data and plugins.
Controller	This interface enables the capability to create a custom chart.
HasAxes	Defines the acceptable axes for a chart.
HasCartesianAxes	Defines the acceptable axes, the CartesianAxiss, for a chart.
HasRadialAxis	Defines the acceptable axis, the RadialAxis, for a chart.
IsChart	Interface which defines a chart.
IsDatasetCreator<D extends Dataset>	Defines the methods for creating datasets pof a specific type. This is used by chart instances to create datasets relatedo to the chart type.
Plugin	This interface is defining the extension hook for Chart.JS plugin implementation (both for inline and global plugins). Plugins are the most efficient way to customize or change the default behavior of a chart.
Type	Interface to map the type and scale type of a chart.

Class Summary

Class	Description
AbstractChart	Base class of all charts. It contains Chart.js initialization.
AreaChart	AREA chart implementation. A area chart is a way of plotting data points on a line. Often, it is used to show trend data, or the comparison of two data sets.
BarChart	BAR chart implementation. A bar chart provides a way of showing data values represented as vertical bars. It is sometimes used to show trend data, and the comparison of multiple data sets side by side.
BubbleChart	BUBBLE chart implementation. A bubble chart is used to display three dimensions of data at the same time. The location of the bubble is determined by the first two dimensions and the corresponding horizontal and vertical axes. The third dimension is represented by the size of the individual bubbles.
Charba	Entry point to initialize and inject all Charba modules. This utility MUST be called as first statement before using Charba.
Chart	Native object which import the CHART java script object of CHART.JS. The Chart the entry point of CHART.JS.
ChartEnvelop<T>	This object is a container of hidden object. It can not be instantiated in order that public methods can be invoked in safe mode.
ChartNode	This is a wrapper of CHART.JS CHART instance in order to provide all properties of chart java script instance, set at runtime.
ChartOptions	This object is mapping the default options related to the chart type.
Charts	Is a static reference which collects all chart instances to be able to enable global plugins.
Configuration	This is the configuration object of a chart. It contains always the type, options, plugins and data.
Defaults	This singleton is a wrapper to defaults object that CHART.JS (by CHART object) provides to get defaults values.
DeferredCharba	Entry point to initialize and inject all Charba modules, leveraging on deferred resources mode. This helps when the GWT application is leveraging on code splitting.
DoughnutChart	DOUGHNUT chart implementation. A doughnut charts are divided in the segments, the arc of each segment shows the proportional value of each piece of data.
EventPoint	This object is wrapping the native java script object provided by Helpers to know the position of the event on the canvas.
GlobalOptions	Default global options (maps the java script object chart.defaults.global).
GlobalScale	Default global scale (maps the java script object Chart.defaults.scale and the result of Chart.scaleService).
Helpers	Singleton object to use the helpers utility of CHART.JS. It maps the java script object chart.helpers.
HorizontalBarChart	HORIZONTAL BAR chart implementation. A horizontal bar chart is a variation on a bar chart. It is sometimes used to show trend data, and the comparison of multiple data sets side by side.
Injector	This utility injects ChartJS java script and CHARBA custom java script implementation (for some utilities) in the web page of application, in the HEAD. It enables also to inject other script in the web page, necessary when you want to use some Chart.JS extensions. It tracks the resources which have been injected using as key their name and class name to avoid that however will inject own resources will use the same name of already injected resources.
LineChart	LINE chart implementation. A line chart is a way of plotting data points on a line. Often, it is used to show trend data, or the comparison of two data sets.
MutationItem	Object used to invoke a mutation handler when is attached or detached an element. This object can not be instantiated out of this package to avoid that anyone (apart the observer) will invoke the methods of a mutation handler.
PieChart	PIE chart implementation. A pie charts are divided in the segments, the arc of each segment shows the proportional value of each piece of data. They are excellent at showing the relational proportions between data.
PolarAreaChart	POLAR AREA chart implementation. Polar area charts are similar to pie charts, but each segment has the same angle - the radius of the segment differs depending on the value. This type of chart is often useful when we want to show a comparison data similar to a pie chart, but also show a scale of values for context.
RadarChart	RADAR chart implementation. A radar chart is a way of showing multiple data points and the variation between them. They are often useful for comparing the points of two or more different data sets.
ScatterChart	SCATTER chart implementation. Scatter charts are based on basic line charts with the x axis changed to a linear axis. To use a scatter chart, data must be passed as objects containing X and Y properties.
StackedAreaChart	STACKED AREA chart implementation. A stacked area chart is a way of plotting data points on a line. Often, it is used to show trend data, or the comparison of two data sets.
StackedBarChart	STACKED BAR chart implementation. Stacked bar charts can be configured like bar charts and changes the settings on the X and Y axes to enable stacking. Stacked bar charts can be used to show how one data series is made up of a number of smaller pieces.
StackedHorizontalBarChart	STACKED HORIZONTAL BAR chart implementation. Stacked bar charts can be configured like bar charts and changes the settings on the X and Y axes to enable stacking. Stacked bar charts can be used to show how one data series is made up of a number of smaller pieces.
StackedLineChart	STACKED LINE chart implementation. A stacked area chart is a way of plotting data points on a line. Often, it is used to show trend data, or the comparison of two data sets.
StackedVerticalLineChart	STACKED VERTICAL LINE chart implementation. A stacked area chart is a way of plotting data points on a line. Often, it is used to show trend data, or the comparison of two data sets.
TimeSeriesBarChart	BAR chart implementation for time series. A bar chart provides a way of showing data values represented as vertical bars.
TimeSeriesLineChart	LINE chart implementation for time series. A line chart is a way of plotting data points on a line.
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.
UpdateConfigurationBuilder	Comfortable object to create UpdateConfiguration item.
VerticalLineChart	Vertical LINE chart implementation. A line chart is a way of plotting data points on a line. Often, it is used to show trend data, or the comparison of two data sets.

Enum Summary

Enum	Description
ChartType	Enumerates all out-of-the-box types of a chart.
ScaleType	Interface to set the scale type of a chart. Every chart could have scale(s) or not and it depends on chart type.