ChartBase Class
The ChartBase class is an abstract class used to create charts.
Item Index
Methods
- _addTooltip
- _dataProviderChangeHandler
- _getAxisClass
- _getGraph
- _getTooltip
- _itemRendered
- _markerEventDispatcher
- _planarLabelFunction
- _positionTooltip
- _setAriaElements
- _setDataValues
- _setOffscreen
- _setText
- _showTooltip
- _tooltipChangeHandler
- _tooltipLabelFunction
- _updateTooltip
- bindUI
- getAxisByKey
- getCategoryAxis
- getSeries
- hideTooltip
- initializer
- renderUI
- syncUI
- toggleTooltip
Attributes
Methods
_addTooltip
()
private
Adds a tooltip to the dom.
_dataProviderChangeHandler
-
e
Event handler for dataProviderChange.
Parameters:
-
e
ObjectEvent object.
_getAxisClass
-
t
Helper method that returns the axis class that a key references.
Parameters:
-
t
StringThe type of axis.
Returns:
_getGraph
()
private
Default value function for the Graph
attribute.
Returns:
_getTooltip
()
private
Default getter for tooltip
attribute.
Returns:
_itemRendered
-
e
Handler for itemRendered event.
Parameters:
-
e
ObjectEvent object.
_markerEventDispatcher
-
e
Event handler for marker events.
Parameters:
-
e
ObjectEvent object.
_planarLabelFunction
-
categoryAxis
-
valueItems
-
index
-
seriesArray
-
seriesIndex
Formats tooltip text when interactionType
is planar
.
Parameters:
-
categoryAxis
AxisReference to the categoryAxis of the chart.
-
valueItems
ArrayArray of objects for each series that has a data point in the coordinate plane of the event. Each object contains the following data:
- axis
- The value axis of the series.
- key
- The key for the series.
- value
- The value for the series item.
- displayName
- The display name of the series. (defaults to key if not provided)
-
index
NumberThe index of the item within its series.
-
seriesArray
ArrayArray of series instances for each value item.
-
seriesIndex
NumberThe index of the series in the
seriesCollection
.
Returns:
_positionTooltip
-
e
Positions the tooltip
Parameters:
-
e
ObjectEvent object.
_setAriaElements
-
cb
Creates an aria live-region
, aria-label
and aria-describedby
for the Chart.
Parameters:
-
cb
NodeReference to the Chart's
contentBox
attribute.
_setDataValues
-
val
Setter method for dataProvider
attribute.
Parameters:
-
val
ArrayArray to be set as
dataProvider
.
Returns:
_setOffscreen
()
private
Sets a node offscreen for use as aria-description or aria-live-regin.
Returns:
_setText
-
label
-
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.
Parameters:
-
label
HTMLElementlabel to be updated
-
val
Stringvalue with which to update the label
_showTooltip
-
msg
-
x
-
y
Shows a tooltip
Parameters:
-
msg
StringMessage to dispaly in the tooltip.
-
x
Numberx-coordinate
-
y
Numbery-coordinate
_tooltipChangeHandler
-
e
Event handler for the tooltipChange.
Parameters:
-
e
ObjectEvent object.
_tooltipLabelFunction
-
categoryItem
-
valueItem
-
itemIndex
-
series
-
seriesIndex
Formats tooltip text when interactionType
is marker
.
Parameters:
-
categoryItem
ObjectAn object containing the following:
- axis
- The axis to which the category is bound.
- displayName
- The display name set to the category (defaults to key if not provided)
- key
- The key of the category.
- value
- The value of the category
-
valueItem
ObjectAn object containing the following:
- axis
- The axis to which the item's series is bound.
- displayName
- The display name of the series. (defaults to key if not provided)
- key
- The key for the series.
- value
- The value for the series item.
-
itemIndex
NumberThe index of the item within the series.
-
series
CartesianSeriesThe
CartesianSeries
instance of the item. -
seriesIndex
NumberThe index of the series in the
seriesCollection
.
Returns:
_updateTooltip
-
val
Updates the tooltip attribute.
Parameters:
-
val
ObjectObject containing properties for the tooltip.
Returns:
bindUI
()
private
getAxisByKey
-
val
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
.
Parameters:
-
val
StringKey reference used to look up the axis.
Returns:
getCategoryAxis
()
Returns the category axis for the chart.
Returns:
getSeries
-
val
Returns a series instance by index or key value.
Parameters:
-
val
Object
Returns:
hideTooltip
()
Hides the default tooltip
initializer
()
private
renderUI
()
private
syncUI
()
private
toggleTooltip
-
e
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.
Parameters:
-
e
ObjectEvent object.
Properties
_axes
Array
private
Collection of axes.
_axisClass
Object
private
Key value pairs of axis types.
_dataProvider
Array
private
Storage for the dataProvider
attribute.
_direction
String
private
Default direction of the chart.
Default: horizontal
_seriesCollection
Array
private
Storage for seriesCollection
attribute.
_setSeriesCollection
Unknown
private
Setter method for seriesCollection
attribute.
Sub-properties:
-
val
ArrayArray of either
CartesianSeries
instances or objects containing series attribute key value pairs.
Attributes
categoryType
String
Indicates the type of axis to use for the category axis.
- category
- Specifies a
CategoryAxis
. - time
- Specifies a `TimeAxis
Default: category
groupMarkers
Boolean
Indicates whether or not markers for a series will be grouped and rendered in a single complex shape instance.
interactionType
String
Indicates the the type of interactions that will fire events.
- marker
- Events will be broadcasted when the mouse interacts with individual markers.
- planar
- Events will be broadcasted when the mouse intersects the plane of any markers on the chart.
- none
- No events will be broadcasted.
Default: marker
seriesKeys
Array
A 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.
tooltip
Object
Reference to the default tooltip available for the chart.
Contains the following properties:
- node
- Reference to the actual dom node
- showEvent
- Event that should trigger the tooltip
- hideEvent
- Event that should trigger the removal of a tooltip (can be an event or an array of events)
- styles
- A hash of style properties that will be applied to the tooltip node
- show
- Indicates whether or not to show the tooltip
- markerEventHandler
- Displays and hides tooltip based on marker events
- planarEventHandler
- Displays and hides tooltip based on planar events
- markerLabelFunction
- Reference to the function used to format a marker event triggered tooltip's text. The method contains
the following arguments:
- categoryItem
- An object containing the following:
- axis
- The axis to which the category is bound.
- displayName
- The display name set to the category (defaults to key if not provided).
- key
- The key of the category.
- value
- The value of the category.
- valueItem
- An object containing the following:
- axis
- The axis to which the item's series is bound.
- displayName
- The display name of the series. (defaults to key if not provided)
- key
- The key for the series.
- value
- The value for the series item.
- itemIndex
- The index of the item within the series.
- series
- The
CartesianSeries
instance of the item. - seriesIndex
- The index of the series in the
seriesCollection
.
HTMLElement
which is written into the DOM usingappendChild
. If you override this method and choose to return an html string, you will also need to override the tooltip'ssetTextFunction
method to accept an html string. - planarLabelFunction
- Reference to the function used to format a planar event triggered tooltip's text
- categoryAxis
-
CategoryAxis
Reference to the categoryAxis of the chart. - valueItems
- Array of objects for each series that has a data point in the coordinate plane of the event. Each object contains the following data:
- axis
- The value axis of the series.
- key
- The key for the series.
- value
- The value for the series item.
- displayName
- The display name of the series. (defaults to key if not provided)
- index
- The index of the item within its series.
- seriesArray
- Array of series instances for each value item.
- seriesIndex
- The index of the series in the
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:
- label
- The
HTMLElement
that the content is to be added. - val
- The content to be rendered into tooltip. This can be a
String
orHTMLElement
. If an HTML string is used, it will be rendered as a string.
Events
markerEvent:click
Broadcasts when interactionType
is set to marker
and a series marker has received a click event.
Event Payload:
-
e
EventFacadeEvent facade with the following additional properties:
- categoryItem
- Hash containing information about the category
Axis
. - valueItem
- Hash containing information about the value
Axis
. - node
- The dom node of the marker.
- x
- The x-coordinate of the mouse in relation to the Chart.
- y
- The y-coordinate of the mouse in relation to the Chart.
- pageX
- The x location of the event on the page (including scroll)
- pageY
- The y location of the event on the page (including scroll)
- series
- Reference to the series of the marker.
- index
- Index of the marker in the series.
- seriesIndex
- The
order
of the marker's series. - originEvent
- Underlying dom event.
markerEvent:mousedown
Broadcasts when interactionType
is set to marker
and a series marker has received a mousedown event.
Event Payload:
-
e
EventFacadeEvent facade with the following additional properties:
- categoryItem
- Hash containing information about the category
Axis
. - valueItem
- Hash containing information about the value
Axis
. - node
- The dom node of the marker.
- x
- The x-coordinate of the mouse in relation to the Chart.
- y
- The y-coordinate of the mouse in relation to the Chart.
- series
- Reference to the series of the marker.
- index
- Index of the marker in the series.
- seriesIndex
- The
order
of the marker's series.
markerEvent:mouseout
Broadcasts when interactionType
is set to marker
and a series marker has received a mouseout event.
Event Payload:
-
e
EventFacadeEvent facade with the following additional properties:
- categoryItem
- Hash containing information about the category
Axis
. - valueItem
- Hash containing information about the value
Axis
. - node
- The dom node of the marker.
- x
- The x-coordinate of the mouse in relation to the Chart.
- y
- The y-coordinate of the mouse in relation to the Chart.
- series
- Reference to the series of the marker.
- index
- Index of the marker in the series.
- seriesIndex
- The
order
of the marker's series.
markerEvent:mouseover
Broadcasts when interactionType
is set to marker
and a series marker has received a mouseover event.
Event Payload:
-
e
EventFacadeEvent facade with the following additional properties:
- categoryItem
- Hash containing information about the category
Axis
. - valueItem
- Hash containing information about the value
Axis
. - node
- The dom node of the marker.
- x
- The x-coordinate of the mouse in relation to the Chart.
- y
- The y-coordinate of the mouse in relation to the Chart.
- series
- Reference to the series of the marker.
- index
- Index of the marker in the series.
- seriesIndex
- The
order
of the marker's series.
markerEvent:mouseup
Broadcasts when interactionType
is set to marker
and a series marker has received a mouseup event.
Event Payload:
-
e
EventFacadeEvent facade with the following additional properties:
- categoryItem
- Hash containing information about the category
Axis
. - valueItem
- Hash containing information about the value
Axis
. - node
- The dom node of the marker.
- x
- The x-coordinate of the mouse in relation to the Chart.
- y
- The y-coordinate of the mouse in relation to the Chart.
- series
- Reference to the series of the marker.
- index
- Index of the marker in the series.
- seriesIndex
- The
order
of the marker's series.