Package | Description |
---|---|
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.configuration |
Contains all elements to configure a chart instance (know as chart options 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.impl.charts |
Contains METER and GAUGE charts implementations (based on controllers), available out-of-the box.
|
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.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 |
AnnotationContext
The callback or handler context wrapper, created and passed by
AnnotationPlugin.ID which contains the link to the native chart. |
Modifier and Type | Interface and Description |
---|---|
interface |
BorderDashCallback<C extends ChartContext>
Callback interface to set
borderDash property at runtime. |
interface |
BorderDashOffsetCallback<C extends ChartContext>
Callback interface to set
borderDashOffset property at runtime. |
interface |
CapStyleCallback<C extends ChartContext>
Callback interface to set
borderCapStyle property at runtime. |
interface |
ColorCallback<C extends ChartContext>
Callback interface to set
borderColor
hoverBorderColor
pointBorderColor
pointHoverBorderColor
textStrokeColor
backgroundColor
hoverBackgroundColor
pointBackgroundColor
pointHoverBackgroundColor
property at runtime. |
interface |
CornerRadiusCallback<C extends ChartContext>
Callback interface to set
cornerRadius property at runtime. |
interface |
DisplayCallback<C extends ChartContext>
Callback interface to set
display property at runtime. |
interface |
ElementAlignCallback<C extends ChartContext>
Callback interface to set
align property at runtime |
interface |
FontCallback<C extends ChartContext>
Callback interface to set
font property at runtime to scale instance. |
interface |
FullSizeCallback<C extends ChartContext>
Callback interface to set
fullSize property at runtime. |
interface |
JoinStyleCallback<C extends ChartContext>
Callback interface to set
borderJoinStyle property at runtime. |
interface |
OffsetCallback<C extends ChartContext>
Callback interface to set
offset and hoverOffset properties at runtime. |
interface |
PaddingCallback<C extends ChartContext>
Callback interface to set a padding element at runtime.
|
interface |
PositionCallback<C extends ChartContext>
Callback interface to set
position property at runtime. |
interface |
RadiusCallback<C extends ChartContext>
Callback interface to set
radius or pointRadius (hit and hover) property at runtime. |
interface |
RotationCallback<C extends ChartContext>
Callback interface to set
rotation or pointRotation property at runtime. |
interface |
Scriptable<T,C extends ChartContext>
Interface to map all callback of scriptable options available for CHART.JS.
|
interface |
TextAlignCallback<C extends ChartContext>
Callback interface to set
textAlign property at runtime |
interface |
TextCallback<C extends ChartContext>
Callback interface to set
text property at runtime. |
interface |
WidthCallback<C extends ChartContext>
Callback interface to set
textStrokeWidth , linerWidth , borderWidth , hoverBorderWidth , pointBorderWidth or
pointHoverBorderWidth property at runtime, using the chart instance and the context. |
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 |
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 |
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 |
---|---|
static <T,C extends ChartContext> |
ScriptableUtils.getOptionValue(C context,
Scriptable<T,C> callback)
Returns the value of the property as result of callback (the same type).
|
static <T,C extends ChartContext> |
ScriptableUtils.getOptionValue(C context,
Scriptable<T,C> callback,
T defaultValue)
Returns the value of the property as result of callback (the same type), passing a default value.
|
static <C extends ChartContext> |
ScriptableUtils.getOptionValueAsColor(C context,
Scriptable<?,C> callback,
String defaultValue)
Returns a color value of property by a callback, checking all different types of object which can be used as value of the property in color ones.
By defaults, is able to manage also Pattern or CanvasPatternItem . |
static <C extends ChartContext> |
ScriptableUtils.getOptionValueAsColor(C context,
Scriptable<?,C> callback,
String defaultValue,
boolean hasPattern)
Returns a color value of property by a callback, checking all different types of object which can be used as value of the property in color ones.
|
static <C extends ChartContext> |
ScriptableUtils.getOptionValueAsFont(C context,
Scriptable<FontItem,C> callback,
IsDefaultFont defaultValue)
Returns the font item value as value of the property by invoking a callback which is typed to a font item.
|
static <C extends ChartContext> |
ScriptableUtils.getOptionValueAsPadding(C context,
Scriptable<PaddingItem,C> callback,
IsDefaultPadding defaultValue)
Returns the padding item value as value of the property by invoking a callback which is typed to a paddng item.
|
static <T extends Key,C extends ChartContext> |
ScriptableUtils.getOptionValueAsString(C context,
Scriptable<T,C> callback)
Returns the enumeration value as value of the property by invoking a callback which is typed to a key.
|
static <T extends Key,C extends ChartContext> |
ScriptableUtils.getOptionValueAsString(C context,
Scriptable<T,C> callback,
T defaultValue)
Returns the enumeration value of the property by invoking a callback which is typed to a key, passing a default value.
|
static <C extends ChartContext> |
ScriptableUtils.handleCallbackResultAsColor(C context,
Object result,
String defaultValue,
boolean hasPattern)
Returns a color value of property by a callback, checking all different types of object which can be used as value of the property in color ones.
|
Modifier and Type | Method and Description |
---|---|
static boolean |
ScriptableUtils.isContextConsistent(ChartContext context)
Returns
true if context is consistent, otherwise false . |
static IsChart |
ScriptableUtils.retrieveChart(ChartContext context)
Returns the chart instance, contained in the context if context is consistent.
|
Modifier and Type | Method and Description |
---|---|
ElementAlignCallback<ChartContext> |
Title.getAlignCallback()
Returns the align callback, if set, otherwise
null . |
ColorCallback<ChartContext> |
Title.getColorCallback()
Returns the color callback, if set, otherwise
null . |
DisplayCallback<ChartContext> |
Title.getDisplayCallback()
Returns the callback to set if the title is shown.
|
FontCallback<ChartContext> |
Title.getFontCallback()
Returns the font callback, if set, otherwise
null . |
FullSizeCallback<ChartContext> |
Title.getFullSizeCallback()
Returns the callback to set if marks that this box should take the full width/height of the canvas (moving other boxes).
|
PaddingCallback<ChartContext> |
Title.getPaddingCallback()
Returns the padding callback, if set, otherwise
null . |
PaddingCallback<ChartContext> |
Layout.getPaddingCallback()
Returns the padding callback, if set, otherwise
null . |
PositionCallback<ChartContext> |
Title.getPositionCallback()
Returns the position callback, if set, otherwise
null . |
TextCallback<ChartContext> |
Title.getTextCallback()
Returns the text callback, if set, otherwise
null . |
Modifier and Type | Method and Description |
---|---|
void |
Title.setAlign(ElementAlignCallback<ChartContext> alignCallback)
Sets the align callback.
|
void |
Title.setColor(ColorCallback<ChartContext> colorCallback)
Sets the color callback.
|
void |
Title.setDisplay(DisplayCallback<ChartContext> displayCallback)
Sets if the title is shown by a callback.
|
void |
Title.setFont(FontCallback<ChartContext> fontCallback)
Sets the font callback.
|
void |
Title.setFullSize(FullSizeCallback<ChartContext> fullSizeCallback)
Sets if marks that this box should take the full width/height of the canvas (moving other boxes) is shown by a callback.
|
void |
Title.setPadding(PaddingCallback<ChartContext> paddingCallback)
Sets the padding callback.
|
void |
Layout.setPadding(PaddingCallback<ChartContext> paddingCallback)
Sets the padding callback.
|
void |
Title.setPosition(PositionCallback<ChartContext> positionCallback)
Sets the position callback.
|
void |
Title.setText(TextCallback<ChartContext> textCallback)
Sets the text callback.
|
Modifier and Type | Class and Description |
---|---|
class |
DataLabelsContext
The option context is used to give contextual information when resolving options for
DataLabelsPlugin . |
Modifier and Type | Class and Description |
---|---|
class |
MeterContext
The callback context wrapper, created and passed by
MeterOptions which contains the link to the native chart. |
Modifier and Type | Class and Description |
---|---|
class |
LabelsContext
This object is wrapping the native java script object provided by
LabelsPlugin.ID plugin when the callback function is called. |
Modifier and Type | Class and Description |
---|---|
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 . |
interface |
IsScriptableFontProvider<T extends ChartContext>
Map an object which contains a font instance which can be set by callback,
FontCallback . |
interface |
IsScriptablePaddingProvider<T extends ChartContext>
Map an object which contains a padding instance which can be set by callback,
PaddingCallback . |
Modifier and Type | Class and Description |
---|---|
class |
ZoomContext
The callback or handler context, created and passed by
ZoomPlugin.ID which contains the link to the native chart and the event. |