The ChartBase class is an abstract class used to create charts.
ChartBase_addTooltipAdds a tooltip to the dom.
_buildSeriesKeysdataProvider
Constructs seriesKeys if not explicitly specified.
dataProvider
Array
The dataProvider for the chart.
Array
_dataProviderChangeHandlere
Event handler for dataProviderChange.
e
Object
Event object.
_getAllKeysdp
Returns all the keys contained in a dataProvider.
dp
Array
Collection of objects to be parsed.
Object
_getAxisClasst
Helper method that returns the axis class that a key references.
t
String
The type of axis.
Axis
_getGraphDefault value function for the Graph attribute.
Graph
_getTooltipDefault getter for tooltip attribute.
Object
_groupMarkersChangeHandlere
Handles groupMarkers change event.
e
Object
Event object.
_markerEventDispatchere
Event handler for marker events.
e
Object
Event object.
_planarLabelFunctioncategoryAxis
valueItems
index
seriesArray
seriesIndex
Formats tooltip text when interactionType is planar.
categoryAxis
Axis
Reference to the categoryAxis of the chart.
valueItems
Array
Array of objects for each series that has a data point in the coordinate plane of the event. Each object contains the following data:
index
Number
The index of the item within its series.
seriesArray
Array
Array of series instances for each value item.
seriesIndex
Number
The index of the series in the seriesCollection.
_setAriaElementscb
Creates an aria live-region, aria-label and aria-describedby for the Chart.
cb
Node
Reference to the Chart's contentBox attribute.
_setDataValuesval
Setter method for dataProvider attribute.
val
Array
Array to be set as dataProvider.
Array
_setOffscreenSets a node offscreen for use as aria-description or aria-live-regin.
Node
_setTextlabel
val
Updates the content of text field. This method writes a value into a text field using
appendChild. If the value is a String, it is converted to a TextNode first.
label
HTMLElement
label to be updated
val
String
value with which to update the label
_showTooltipmsg
x
y
Shows a tooltip
_tooltipChangeHandlere
Event handler for the tooltipChange.
e
Object
Event object.
_tooltipLabelFunctioncategoryItem
valueItem
Formats tooltip text when interactionType is marker.
categoryItem
Object
An object containing the following:
valueItem
Object
An object containing the following:
_updateTooltipval
Updates the tooltip attribute.
val
Object
Object containing properties for the tooltip.
Object
_wereSeriesKeysExplicitlySetUtility method to determine if seriesKeys was explicitly provided
(for example during construction, or set by the user), as opposed to
being derived from the dataProvider for example.
boolean true if the seriesKeys attribute was explicitly set.
bindUIgetAxisByKeyval
Returns an Axis instance by key reference. If the axis was explicitly set through the axes attribute,
the key will be the same as the key used in the axes object. For default axes, the key for
the category axis is the value of the categoryKey (category). For the value axis, the default
key is values.
val
String
Key reference used to look up the axis.
Axis
getCategoryAxisReturns the category axis for the chart.
Axis
getSeriesval
Returns a series instance by index or key value.
val
Object
CartesianSeries
hideTooltipHides the default tooltip
initializerrenderUIsyncUItoggleTooltipe
Event listener for toggling the tooltip. If a tooltip is visible, hide it. If not, it will create and show a tooltip based on the event object.
e
Object
Event object.
_setSeriesCollectionSetter method for seriesCollection attribute.
val
Array
Array of either CartesianSeries instances or objects containing series attribute key value pairs.
ariaDescriptionSets the aria description for the chart.
ariaDescriptionChange
Fires when the value for the configuration attribute ariaDescription is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
ariaLabelSets the aria-label for the chart.
ariaLabelChange
Fires when the value for the configuration attribute ariaLabel is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
axesCollectionReference to all the axes in the chart.
axesCollectionChange
Fires when the value for the configuration attribute axesCollection is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
categoryKeyThe key value used for the chart's category axis.
Default: category
categoryKeyChange
Fires when the value for the configuration attribute categoryKey is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
categoryTypeIndicates the type of axis to use for the category axis.
CategoryAxis.Default: category
categoryTypeChange
Fires when the value for the configuration attribute categoryType is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
dataProviderData used to generate the chart.
dataProviderChange
Fires when the value for the configuration attribute dataProvider is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
graphReference to graph instance.
graphChange
Fires when the value for the configuration attribute graph is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
groupMarkersIndicates whether or not markers for a series will be grouped and rendered in a single complex shape instance.
groupMarkersChange
Fires when the value for the configuration attribute groupMarkers is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
interactionTypeIndicates the the type of interactions that will fire events.
Default: marker
interactionTypeChange
Fires when the value for the configuration attribute interactionType is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
seriesKeysA collection of keys that map to the series axes. If no keys are set, they will be generated automatically depending on the data structure passed into the chart.
seriesKeysChange
Fires when the value for the configuration attribute seriesKeys is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
tooltipReference to the default tooltip available for the chart.
Contains the following properties:
CartesianSeries instance of the item.seriesCollection.HTMLElement which is written into the DOM using appendChild. If you override this method and choose
to return an html string, you will also need to override the tooltip's setTextFunction method to accept an html string.
CategoryAxis Reference to the categoryAxis of the chart.
seriesCollection.HTMLElement which is written into the DOM using appendChild. If you override this method and choose
to return an html string, you will also need to override the tooltip's setTextFunction method to accept an html string.
planarLabelFunction or markerLabelFunction into the
the tooltip node. Has the following signature:
HTMLElement that the content is to be added.String or HTMLElement. If an HTML string is used,
it will be rendered as a string.tooltipChange
Fires when the value for the configuration attribute tooltip is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
markerEvent:clickBroadcasts when interactionType is set to marker and a series marker has received a click event.
e
EventFacade
Event facade with the following additional properties:
Axis.Axis.order of the marker's series.markerEvent:mousedownBroadcasts when interactionType is set to marker and a series marker has received a mousedown event.
e
EventFacade
Event facade with the following additional properties:
Axis.Axis.order of the marker's series.markerEvent:mouseoutBroadcasts when interactionType is set to marker and a series marker has received a mouseout event.
e
EventFacade
Event facade with the following additional properties:
Axis.Axis.order of the marker's series.markerEvent:mouseoverBroadcasts when interactionType is set to marker and a series marker has received a mouseover event.
e
EventFacade
Event facade with the following additional properties:
Axis.Axis.order of the marker's series.markerEvent:mouseupBroadcasts when interactionType is set to marker and a series marker has received a mouseup event.
e
EventFacade
Event facade with the following additional properties:
Axis.Axis.order of the marker's series.