Package org.pepstock.charba.client.callbacks
All callbacks interfaces to be implemented, also to use the scriptable options of CHART.JS.
- Author:
- Andrea "Stock" Stocchero
-
Interface Summary Interface Description AlignToPixelsCallback Callback interface to set whateveralignToPixels
property at runtime, forAxis
.AngleCallback Callback interface to setangle
property ofArc
at runtime.AxisBuildTicksCallback Interface to be implemented which can be used to change parameters in the scale during ticks building.AxisCalculateLabelRotationCallback Interface to be implemented which can be used to change parameters in the scale during tick rotation.AxisDataLimitsCallback Interface to be implemented which can be used to change parameters in the scale during data limits determination.AxisDimensionsCallback Interface to be implemented which can be used to change parameters in the scale during setting dimensions.AxisFitCallback Interface to be implemented which can be used to change parameters in the scale during fitting phase.AxisTickToLabelConversionCallback Interface to be implemented which can be used to change parameters in the scale during ticks label conversion.AxisUpdateCallback Interface to be implemented which can be used to change parameters in the scale during updating.BarBorderWidthCallback Callback interface to set whateverborderWidth
orhoverBorderWidth
properties at runtime, forBarDataset
andMatrixDataset
.BaseCallback Callback interface to setbase
property at runtime forBarDataset
.BeginAtZeroCallback Callback interface to set whateverbeginAtZero
property at runtime, forCartesianLinearAxis
.BorderAlignCallback Callback interface to setborderAlign
property at runtime.BorderDashCallback<C extends ChartContext> Callback interface to setborderDash
property at runtime.BorderDashOffsetCallback<C extends ChartContext> Callback interface to setborderDashOffset
property at runtime.BorderRadiusCallback<C extends ChartContext> Callback interface to set whateverborderRadius
property at runtime.BorderSkippedCallback Callback interface to setborderSkipped
property at runtime.BoundsCallback Callback interface to set whateverbounds
property at runtime, forCartesianAxis
.CapStyleCallback<C extends ChartContext> Callback interface to setborderCapStyle
property at runtime.CategoryTickCallback Interface to implement if wants to change the tick marks to include information about the data type, for cartesian category axes.
It can return aList
of strings (for multiple lines).CircularCallback Callback interface to setcircular
property ofArc
at runtime.ColorCallback<C extends ChartContext> Callback interface to set whatevercolor
property at runtime.ColorsCallback<C extends ChartContext> Callback interface to setcolor
property at runtime forLabels
.CountCallback Callback interface to setcount
property at runtime, forIsLinearTick
instances.CrosshairFormatterCallback This callback is the interface to defined customized representation of the labels inCrosshair.ID
plugin.CubicInterpolationModeCallback Callback interface to setcubicInterpolationMode
property at runtime.DelayCallback Callback interface to setdelay
property ofAnimation
at runtime.DisplayCallback<C extends ChartContext> Callback interface to setdisplay
property where it can be set byDisplay
or a boolean.DrawActiveElementsOnTopCallback Callback interface to setdrawActiveElementsOnTop
property of at runtime.DurationCallback Callback interface to setduration
property ofAnimation
at runtime.EasingCallback Callback interface to seteasing
property ofAnimation
at runtime.ElementAlignCallback<C extends ChartContext> Callback interface to setalign
property at runtimeEnableBorderRadiusCallback Callback interface to setenableBorderRadius
property ofBar
at runtime.FillCallback Callback interface to setfill
property at runtime.
The result object can have one of following type:
Fill
Boolean Integer forAbsoluteDatasetIndexFill
String forRelativeDatasetIndexFill
FontCallback<C extends ChartContext> Callback interface to setfont
property at runtime.FontsCallback<C extends ChartContext> Callback interface to setfont
property at runtime, for multiple fonts.FromCallback Callback interface to setfrom
property ofAnimationCollection
at runtime.FullSizeCallback<C extends ChartContext> Callback interface to setfullSize
property at runtime.GraceCallback Callback interface to set whatevergrace
property at runtime, forCartesianLinearAxis
.HtmlLegendCallback<T extends HasLegendText> This callback is the base interface for HTML legend callbacks to change the text of legend for a specific item or legend's title, as HTML.
This callback is used ONLY byHtmlLegend
plugin.HtmlLegendItemCallback This callback can be implemented to change the text of legend for a specific item, as HTML.
This callback is used ONLY byHtmlLegend
plugin.HtmlLegendTitleCallback This callback can be implemented to change the text of legend's title, as HTML.
This callback is used ONLY byHtmlLegend
plugin.InflateAmountCallback Callback interface to setinflateAmount
property at runtime, forBarDataset
orBar
element instances.
ReturningUndefined.INTEGER
, the chart will automatically calculate the amount of pixels to inflate the bar rectangles, when drawing.JoinStyleCallback<C extends ChartContext> Callback interface to setborderJoinStyle
property at runtime.LegendFilterCallback Filters legend items out of the legend.LegendItemSortCallback Allows sorting of legend items.LegendLabelsCallback Generates legend items for each thing in the legend.LoopCallback Callback interface to setloop
property ofAnimation
at runtime.MaxTicksLimitCallback Callback interface to setmaxTicksLimit
property at runtime, forIsLinearTick
instances.MeterContentCallback Interface to implement if wants to change the description label content to show inside ofMeterChart
orGaugeChart
.MeterFormatCallback Interface to implement if wants to format the value to show inside ofMeterChart
orGaugeChart
.MinMaxCallback<T> Callback interface to setmin
,max
,suggestedMin
andsuggestedMax
properties for the axes.NumberFormatCallback Callback interface to set a number format element at runtime.OffsetCallback<C extends ChartContext> Callback interface to set whateveroffset
property at runtime.PaddingCallback<C extends ChartContext> Callback interface to set a padding element at runtime.PointLabelCallback Callback function to transform data labels to point labels.
It can return aList
of strings (for multiple lines).PointStyleCallback<C extends ChartContext> Callback interface to setpointStyle
property at runtime.PositionCallback<C extends ChartContext> Callback interface to setposition
property at runtime.PrecisionCallback Callback interface to setmaxTicksLimit
property at runtime, forIsLinearTick
instances.RadiusCallback<C extends ChartContext> Callback interface to set whateverradius
property at runtime.ReverseCallback Callback interface to setreverse
property ofAxis
at runtime.RotationCallback<C extends ChartContext> Callback interface to set whateverrotation
property at runtime.ScaleOffsetCallback Callback interface to set whateveroffset
property at runtime, forCartesianAxis
.ScalePositionCallback Callback interface to setposition
property at runtime, forCartesianAxis
.ScaleWeightCallback Callback interface to set whateverweight
property at runtime, forAxis
.Scriptable<T,C extends ChartContext> Interface to map all callback of scriptable options available for CHART.JS.ScriptableFunctions.ProxyArrayCallback Java script FUNCTION callback called to provide an array property.ScriptableFunctions.ProxyBooleanCallback Java script FUNCTION callback called to provide a boolean property.ScriptableFunctions.ProxyDoubleCallback Java script FUNCTION callback called to provide a double property.ScriptableFunctions.ProxyHandlerCallback Java script FUNCTION callback called to provide a scriptable options implementation with a context.ScriptableFunctions.ProxyHandlerEvent Java script FUNCTION callback called to provide events generated by the chart canvas, by CHART.JS.ScriptableFunctions.ProxyHandlerEventAndRedraw Java script FUNCTION callback called to provide events generated by the chart canvas, by CHART.JS.ScriptableFunctions.ProxyIntegerCallback Java script FUNCTION callback called to provide a integer property.ScriptableFunctions.ProxyNativeObjectCallback Java script FUNCTION callback called to provide a native object property.ScriptableFunctions.ProxyObjectCallback Java script FUNCTION callback called to provide a object property.ScriptableFunctions.ProxyStringCallback Java script FUNCTION callback called to provide a string property.ScriptableResultChecker<T extends Number> To implement to check the consistency of the result, as a number, of aScriptable
.ShowLabelBackdropCallback Callback interface to setshowLabelBackdrop
property at runtime to scale's ticks instance,RadialLinearTick
.SimpleDisplayCallback<C extends ChartContext> Callback interface to setdisplay
property at runtime.SimplePaddingCallback Callback interface to setpadding
property (not as object but only as number) at runtime to scale instance.StackCallback Callback interface to set whateverstack
property at runtime, forCartesianAxis
.StackedCallback Callback interface to set whateverstacked
property at runtime, forCartesianAxis
.StartAngleCallback Callback interface to set whateverstartAngle
property at runtime, forRadialAxis
.SteppedCallback Callback interface to setstepped
property at runtime.StepSizeCallback Callback interface to setstepSize
property at runtime, forIsLinearTick
instances.TextAlignCallback<C extends ChartContext> Callback interface to settextAlign
property at runtimeTextCallback<C extends ChartContext> Callback interface to settext
property at runtime.TickCallback Interface to implement if wants to change the tick marks to include information about the data type, for axes which are showing data as numbers.
It can return aList
of strings (for multiple lines).TimeTickCallback Interface to implement if wants to change the tick marks to include information about the data type, for cartesian time axes.
It can return aList
of strings (for multiple lines).ToCallback Callback interface to setto
property ofAnimationCollection
at runtime.TooltipBodyCallback The tooltip label configuration is nested below the tooltip configuration using the callbacks key.
The tooltip has the following callbacks for providing text.
All functions must return either a string or an array of strings.TooltipExternalCallback External tooltips callback allow you to hook in the tooltip rendering process so that you can render the tooltip in your own custom way.
Generally this is used to create an HTML tooltip instead of an on canvas one.TooltipFilterCallback Allows filtering of tooltip items.TooltipFooterCallback The tooltip label configuration is nested below the tooltip configuration using the callbacks key.
The tooltip has the following callbacks for providing text.
All functions must return either a string or an array of strings.TooltipItemSortCallback Allows sorting of tooltip items.TooltipLabelCallback The tooltip label configuration is nested below the tooltip configuration using the callbacks key.
The tooltip has the following callbacks for providing text.
All functions must return either a string or an array of strings.TooltipTitleCallback The tooltip label configuration is nested below the tooltip configuration using the callbacks key.
The tooltip has the following callbacks for providing text.
All functions must return either a string or an array of strings.WidthCallback<C extends ChartContext> Callback interface to set whateverwidth
property at runtime. -
Class Summary Class Description 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.AbstractTooltipBodyCallback Abstract implementation of tooltip body callback in order to help who will implement it to override ONLY needed methods and use the default for the others.AbstractTooltipFooterCallback Abstract implementation of tooltip footer callback in order to help who will implement it to override ONLY needed methods and use the default for the others.AbstractTooltipLabelCallback Abstract implementation of tooltip label callback in order to help who will implement it to override ONLY needed methods and use the default for the others.AbstractTooltipTitleCallback Abstract implementation of tooltip title callback in order to help who will implement it to override ONLY needed methods and use the default for the others.CallbacksEnvelop<T> This object is a container of hidden object to pass to other packages.
It can not be instantiated in order that public methods can be invoked in safe mode.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.DatasetContext The option context is used to give contextual information when resolving options.NativeCallback Enables the capability to create callback directly in java script language.
This could be helpful when for performance reason, you don't want to wraps all objects.ParsedData Represents the parsed data values for the given data index and dataset index.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)ScriptableFunctions Set of common JSINTEROP functions (mapped as interfaces) to be able to implement scriptable options of CHART.JS.
Must be a public interface with only 1 method.ScriptableUtil Sets of common methods as utilities to manage scriptable options by callback and java interfaces.SegmentContext The callback or handler context wrapper, created and passed bySegment
which contains the line charts references.TooltipContext The option context is used to give contextual information when resolving options. -
Enum Summary Enum Description ScriptableDoubleChecker Checker out of the box forScriptable
s which return aDouble
.ScriptableIntegerChecker Checker out of the box forScriptable
s which return aInteger
.