API Docs for: 3.10.3
Show:

CartesianChart Class

Extends ChartBase
Defined in: charts/js/CartesianChart.js:1
Module: charts-base
Parent Module: charts

The CartesianChart class creates a chart with horizontal and vertical axes.

Constructor

CartesianChart

()

Defined in charts/js/CartesianChart.js:1

Item Index

Methods

Properties

Attributes

Events

Methods

_addAxes

() private

Defined in charts/js/CartesianChart.js:687

Adds axes to the chart.

_addGridlines

() private

Defined in charts/js/CartesianChart.js:757

Adds gridlines to the chart.

_addSeries

() private

Defined in charts/js/CartesianChart.js:744

Renders the Graph.

_addToAxesCollection

(
  • position
  • axis
)

Defined in charts/js/CartesianChart.js:234

Adds axis instance to the appropriate array based on position

Parameters:

  • position String

    The position of the axis

  • axis Axis

    The Axis instance

_addToAxesRenderQueue

(
  • axis
)
private

Defined in charts/js/CartesianChart.js:215

Adds an Axis instance to the _itemRenderQueue.

Parameters:

  • axis Axis

    An Axis instance.

_addTooltip

() private

Inherited from ChartBase: charts/js/ChartBase.js:955

Adds a tooltip to the dom.

_buildSeriesKeys

(
  • dataProvider
)
private

Inherited from ChartBase: charts/js/ChartBase.js:1275

Constructs seriesKeys if not explicitly specified.

Parameters:

  • dataProvider Array

    The dataProvider for the chart.

Returns:

Array

_dataProviderChangeHandler

(
  • e
)
private

Inherited from ChartBase: charts/js/ChartBase.js:834

Event handler for dataProviderChange.

Parameters:

_getAllKeys

(
  • dp
)

Inherited from ChartBase: charts/js/ChartBase.js:1247

Returns all the keys contained in a dataProvider.

Parameters:

  • dp Array

    Collection of objects to be parsed.

Returns:

Object

_getAriaMessage

(
  • key
)

Defined in charts/js/CartesianChart.js:1646

Returns the appropriate message based on the key press.

Parameters:

  • key Number

    The keycode that was pressed.

Returns:

String

_getAxisClass

(
  • t
)
private

Inherited from ChartBase: charts/js/ChartBase.js:448

Helper method that returns the axis class that a key references.

Parameters:

Returns:

Axis

_getBaseAttribute

(
  • item
  • key
)
private

Defined in charts/js/CartesianChart.js:518

Gets an attribute from an object, using a getter for Base objects and a property for object literals. Used for determining attributes from series/axis references which can be an actual class instance or a hash of properties that will be used to create a class instance.

Parameters:

  • item Object

    Object or instance in which the attribute resides.

  • key String

    Attribute whose value will be returned.

Returns:

Object

_getBottomOverflow

(
  • set1
  • set2
  • height
)
private

Defined in charts/js/CartesianChart.js:1281

Returns the maximum distance in pixels that the extends outside the bottom bounds of all vertical axes.

Parameters:

  • set1 Array

    Collection of axes to check.

  • set2 Array

    Seconf collection of axes to check.

  • height Number

    Height of the axes

Returns:

Number

_getCategoryAxis

() private

Defined in charts/js/CartesianChart.js:463

Returns the category axis instance for the chart.

Returns:

Axis

_getDefaultAxes

() private

Defined in charts/js/CartesianChart.js:830

Default Function for the axes attribute.

Returns:

Object

_getDefaultAxisPosition

(
  • axis
  • valueAxes
  • position
)
private

Defined in charts/js/CartesianChart.js:1017

Determines the position of an axis when one is not specified.

Parameters:

  • axis Axis

    Axis instance.

  • valueAxes Array

    Array of Axis instances.

  • position String

    Default position depending on the direction of the chart and type of axis.

Returns:

String

_getDefaultSeriesCollection

(
  • val
)
private

Defined in charts/js/CartesianChart.js:252

Returns the default value for the seriesCollection attribute.

Parameters:

  • val Array

    Array containing either CartesianSeries instances or objects containing data to construct series instances.

Returns:

Array

_getGraph

() private

Inherited from ChartBase: charts/js/ChartBase.js:293

Default value function for the Graph attribute.

Returns:

Graph

_getLeftOverflow

(
  • set1
  • set2
  • width
)
private

Defined in charts/js/CartesianChart.js:1237

Returns the maximum distance in pixels that the extends outside the left bounds of all horizontal axes.

Parameters:

  • set1 Array

    Collection of axes to check.

  • set2 Array

    Seconf collection of axes to check.

  • width Number

    Width of the axes

Returns:

Number

_getRightOverflow

(
  • set1
  • set2
  • width
)
private

Defined in charts/js/CartesianChart.js:1193

Returns the maximum distance in pixels that the extends outside the right bounds of all horizontal axes.

Parameters:

  • set1 Array

    Collection of axes to check.

  • set2 Array

    Seconf collection of axes to check.

  • width Number

    Width of the axes

Returns:

Number

_getSeriesAxis

(
  • key
)
private

Defined in charts/js/CartesianChart.js:479

Returns the value axis for a series.

Parameters:

  • key String

    The key value used to determine the axis instance.

Returns:

Axis

_getTooltip

() private

Inherited from ChartBase: charts/js/ChartBase.js:1026

Default getter for tooltip attribute.

Returns:

Object

_getTopOverflow

(
  • set1
  • set2
  • width
)
private

Defined in charts/js/CartesianChart.js:1149

Returns the maximum distance in pixels that the extends outside the top bounds of all vertical axes.

Parameters:

  • set1 Array

    Collection of axes to check.

  • set2 Array

    Seconf collection of axes to check.

  • width Number

    Width of the axes

Returns:

Number

_groupMarkersChangeHandler

(
  • e
)
private

Inherited from ChartBase: charts/js/ChartBase.js:260

Handles groupMarkers change event.

Parameters:

_itemRendered

(
  • e
)
private

Inherited from ChartBase: charts/js/ChartBase.js:277

Handler for itemRendered event.

Parameters:

_markerEventDispatcher

(
  • e
)
private

Inherited from ChartBase: charts/js/ChartBase.js:693

Event handler for marker events.

Parameters:

_parseAxes

(
  • axes
)
private

Defined in charts/js/CartesianChart.js:847

Generates and returns a key-indexed object containing Axis instances or objects used to create Axis instances.

Parameters:

  • axes Object

    Object containing Axis instances or Axis attributes.

Returns:

Object

_parseSeriesAxes

(
  • series
)
private

Defined in charts/js/CartesianChart.js:430

Parse and sets the axes for a series instance.

Parameters:

_parseSeriesCollection

(
  • val
)
private

Defined in charts/js/CartesianChart.js:271

Parses and returns a series collection from an object and default properties.

Parameters:

  • val Object

    Object contain properties for series being set.

Returns:

Object

_planarEventDispatcher

(
  • e
)
private

Defined in charts/js/CartesianChart.js:47

When interactionType is set to planar, listens for mouse move events and fires planarEvent:mouseover or planarEvent:mouseout depending on the position of the mouse in relation to data points on the Chart.

Parameters:

_planarLabelFunction

(
  • categoryAxis
  • valueItems
  • index
  • seriesArray
  • seriesIndex
)
String | HTML private

Inherited from ChartBase: charts/js/ChartBase.js:1079

Formats tooltip text when interactionType is planar.

Parameters:

  • 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:

    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 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.

Returns:

String | HTML:

_positionTooltip

(
  • e
)
private

Inherited from ChartBase: charts/js/ChartBase.js:918

Positions the tooltip

Parameters:

_redraw

() private

Defined in charts/js/CartesianChart.js:1325

Redraws and position all the components of the chart instance.

_setAriaElements

(
  • cb
)
private

Inherited from ChartBase: charts/js/ChartBase.js:517

Creates an aria live-region, aria-label and aria-describedby for the Chart.

Parameters:

  • cb Node

    Reference to the Chart's contentBox attribute.

_setAxes

(
  • val
)
private

Defined in charts/js/CartesianChart.js:565

Creates Axis instances.

Parameters:

  • val Object

    Object containing Axis instances or objects in which to construct Axis instances.

Returns:

Object

_setBaseAttribute

(
  • item
  • key
  • value
)
private

Defined in charts/js/CartesianChart.js:542

Sets an attribute on an object, using a setter of Base objects and a property for object literals. Used for setting attributes on a Base class, either directly or to be stored in an object literal for use at instantiation.

Parameters:

  • item Object

    Object or instance in which the attribute resides.

  • key String

    Attribute whose value will be assigned.

  • value Object

    Value to be assigned to the attribute.

_setDataValues

(
  • val
)
private

Inherited from ChartBase: charts/js/ChartBase.js:395

Setter method for dataProvider attribute.

Parameters:

  • val Array

    Array to be set as dataProvider.

Returns:

Array

_setOffscreen

() private

Inherited from ChartBase: charts/js/ChartBase.js:547

Sets a node offscreen for use as aria-description or aria-live-regin.

Returns:

Node

_setText

(
  • label
  • val
)
private

Inherited from ChartBase: charts/js/ChartBase.js:1220

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 HTMLElement

    label to be updated

  • val String

    value with which to update the label

_showTooltip

(
  • msg
  • x
  • y
)
private

Inherited from ChartBase: charts/js/ChartBase.js:895

Shows a tooltip

Parameters:

  • msg String

    Message to dispaly in the tooltip.

  • x Number

    x-coordinate

  • y Number

    y-coordinate

_sizeChanged

(
  • e
)
private

Defined in charts/js/CartesianChart.js:1127

Handler for sizeChanged event.

Parameters:

_tooltipChangeHandler

(
  • e
)
private

Inherited from ChartBase: charts/js/ChartBase.js:1195

Event handler for the tooltipChange.

Parameters:

_tooltipLabelFunction

(
  • categoryItem
  • valueItem
)
String | HTML private

Inherited from ChartBase: charts/js/ChartBase.js:1145

Formats tooltip text when interactionType is marker.

Parameters:

  • categoryItem Object

    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 Object

    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.

Returns:

String | HTML:

_updateTooltip

(
  • val
)
private

Inherited from ChartBase: charts/js/ChartBase.js:976

Updates the tooltip attribute.

Parameters:

  • val Object

    Object containing properties for the tooltip.

Returns:

Object

bindUI

() private

Inherited from ChartBase: charts/js/ChartBase.js:576

destructor

() protected

Defined in charts/js/CartesianChart.js:1589

Destructor implementation for the CartesianChart class. Calls destroy on all axes, series and the Graph instance. Removes the tooltip and overlay HTML elements.

getAxisByKey

(
  • val
)

Inherited from ChartBase: charts/js/ChartBase.js:337

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 String

    Key reference used to look up the axis.

Returns:

Axis

getCategoryAxis

()

Inherited from ChartBase: charts/js/ChartBase.js:358

Returns the category axis for the chart.

Returns:

Axis

getSeries

(
  • val
)

Inherited from ChartBase: charts/js/ChartBase.js:312

Returns a series instance by index or key value.

Parameters:

Returns:

CartesianSeries

getSeriesItems

(
  • series
  • index
)

Defined in charts/js/CartesianChart.js:1061

Returns an object literal containing a categoryItem and a valueItem for a given series index. Below is the structure of each:

Parameters:

  • series CartesianSeries

    Reference to a series.

  • index Number

    Index of the specified item within a series.

Returns:

Object An object literal containing the following:
categoryItem
Object containing the following data related to the category axis of the series.
axis
Reference to the category axis of the series.
key
Category key for the series.
value
Value on the axis corresponding to the series index.
valueItem
Object containing the following data related to the category axis of the series.
axis
Reference to the value axis of the series.
key
Value key for the series.
value
Value on the axis corresponding to the series index.

hideTooltip

()

Inherited from ChartBase: charts/js/ChartBase.js:939

Hides the default tooltip

initializer

() private

Inherited from ChartBase: charts/js/ChartBase.js:484

renderUI

() private

Inherited from ChartBase but overwritten in charts/js/CartesianChart.js:10

syncUI

() private

Inherited from ChartBase: charts/js/ChartBase.js:567

toggleTooltip

(
  • e
)

Inherited from ChartBase: charts/js/ChartBase.js:875

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:

Properties

_axes

Array private

Inherited from ChartBase: charts/js/ChartBase.js:475

Collection of axes.

_axisClass

Object private

Inherited from ChartBase: charts/js/ChartBase.js:461

Key value pairs of axis types.

_dataProvider

Array private

Inherited from ChartBase: charts/js/ChartBase.js:386

Storage for the dataProvider attribute.

_direction

String private

Inherited from ChartBase: charts/js/ChartBase.js:376

Default direction of the chart.

Default: horizontal

_itemRenderQueue

Array private

Defined in charts/js/CartesianChart.js:206

Queue of axes instances that will be updated. This method is used internally to determine when all axes have been updated.

_seriesCollection

Array private

Inherited from ChartBase: charts/js/ChartBase.js:428

Storage for seriesCollection attribute.

_setSeriesCollection

Unknown private

Inherited from ChartBase: charts/js/ChartBase.js:437

Setter method for seriesCollection attribute.

Sub-properties:

  • val Array

    Array of either CartesianSeries instances or objects containing series attribute key value pairs.

_type

String private

Defined in charts/js/CartesianChart.js:197

Indicates the default series type for the chart.

Attributes

allowContentOverflow

Boolean

Defined in charts/js/CartesianChart.js:1735

Indicates whether axis labels are allowed to overflow beyond the bounds of the chart's content box.

Fires event allowContentOverflowChange

Fires when the value for the configuration attribute allowContentOverflow 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

ariaDescription

String

Inherited from ChartBase: charts/js/ChartBase.js:87

Sets the aria description for the chart.

Fires event 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

ariaLabel

String

Inherited from ChartBase: charts/js/ChartBase.js:67

Sets the aria-label for the chart.

Fires event 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

axes

Object

Defined in charts/js/CartesianChart.js:1954

Axes to appear in the chart. This can be a key indexed hash of axis instances or object literals used to construct the appropriate axes.

Fires event axesChange

Fires when the value for the configuration attribute axes 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

axesCollection

Array

Inherited from ChartBase: charts/js/ChartBase.js:230

Reference to all the axes in the chart.

Fires event 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

axesStyles

Object private

Defined in charts/js/CartesianChart.js:1745

Style object for the axes.

Fires event axesStylesChange

Fires when the value for the configuration attribute axesStyles 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

bottomAxesCollection

Array private

Defined in charts/js/CartesianChart.js:2007

Reference to the bottom-aligned axes for the chart.

Fires event bottomAxesCollectionChange

Fires when the value for the configuration attribute bottomAxesCollection 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

categoryAxis

Axis

Defined in charts/js/CartesianChart.js:2223

Reference to the category axis used by the chart.

Fires event categoryAxisChange

Fires when the value for the configuration attribute categoryAxis 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

categoryAxisName

String

Defined in charts/js/CartesianChart.js:2098

Indicates the key value used to identify a category axis in the axes hash. If not specified, the categoryKey attribute value will be used.

Fires event categoryAxisNameChange

Fires when the value for the configuration attribute categoryAxisName 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

categoryKey

String

Inherited from ChartBase: charts/js/ChartBase.js:186

The key value used for the chart's category axis.

Default: category

Fires event 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

categoryType

String

Inherited from ChartBase: charts/js/ChartBase.js:197

Indicates the type of axis to use for the category axis.

category
Specifies a CategoryAxis.
time
Specifies a `TimeAxis

Default: category

Fires event 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

dataProvider

Array

Inherited from ChartBase: charts/js/ChartBase.js:11

Data used to generate the chart.

Fires event 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

direction

String

Defined in charts/js/CartesianChart.js:2044

Direction of chart's category axis when there is no series collection specified. Charts can be horizontal or vertical. When the chart type is column, the chart is horizontal. When the chart type is bar, the chart is vertical.

Fires event directionChange

Fires when the value for the configuration attribute direction 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

graph

Graph

Inherited from ChartBase: charts/js/ChartBase.js:238

Reference to graph instance.

Fires event 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

graphStyles

Object private

Defined in charts/js/CartesianChart.js:1858

Styles for the graph.

Fires event graphStylesChange

Fires when the value for the configuration attribute graphStyles 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

groupMarkers

Boolean

Inherited from ChartBase: charts/js/ChartBase.js:248

Indicates whether or not markers for a series will be grouped and rendered in a single complex shape instance.

Fires event 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

horizontalGridlines

Gridlines

Defined in charts/js/CartesianChart.js:2118

Reference to the horizontalGridlines for the chart.

Fires event horizontalGridlinesChange

Fires when the value for the configuration attribute horizontalGridlines 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

interactionType

String

Inherited from ChartBase: charts/js/ChartBase.js:213

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

Fires event 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

leftAxesCollection

Array private

Defined in charts/js/CartesianChart.js:1998

Reference to the left-aligned axes for the chart.

Fires event leftAxesCollectionChange

Fires when the value for the configuration attribute leftAxesCollection 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

rightAxesCollection

Array private

Defined in charts/js/CartesianChart.js:2016

Reference to the right-aligned axes for the chart.

Fires event rightAxesCollectionChange

Fires when the value for the configuration attribute rightAxesCollection 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

seriesCollection

Array

Defined in charts/js/CartesianChart.js:1976

Collection of series to appear on the chart. This can be an array of Series instances or object literals used to construct the appropriate series.

Fires event seriesCollectionChange

Fires when the value for the configuration attribute seriesCollection 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

seriesKeys

Array

Inherited from ChartBase: charts/js/ChartBase.js:41

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.

Fires event 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

seriesStyles

Object private

Defined in charts/js/CartesianChart.js:1792

Style object for the series

Fires event seriesStylesChange

Fires when the value for the configuration attribute seriesStyles 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

showAreaFill

Boolean

Defined in charts/js/CartesianChart.js:2074

Indicates whether or not an area is filled in a combo chart.

Fires event showAreaFillChange

Fires when the value for the configuration attribute showAreaFill 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

showLines

Boolean

Defined in charts/js/CartesianChart.js:2090

Indicates whether to display lines in a combo chart.

Fires event showLinesChange

Fires when the value for the configuration attribute showLines 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

showMarkers

Boolean

Defined in charts/js/CartesianChart.js:2082

Indicates whether to display markers in a combo chart.

Fires event showMarkersChange

Fires when the value for the configuration attribute showMarkers 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

stacked

Boolean

Defined in charts/js/CartesianChart.js:2034

Indicates whether or not the chart is stacked.

Fires event stackedChange

Fires when the value for the configuration attribute stacked 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

styles

Object

Defined in charts/js/CartesianChart.js:1887

Style properties for the chart. Contains a key indexed hash of the following:

series
A key indexed hash containing references to the styles attribute for each series in the chart. Specific style attributes vary depending on the series:
axes
A key indexed hash containing references to the styles attribute for each axes in the chart. Specific style attributes can be found in the Axis class.
graph
A reference to the styles attribute in the chart. Specific style attributes can be found in the Graph class.

Fires event stylesChange

Fires when the value for the configuration attribute styles 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

tooltip

Object

Inherited from ChartBase: charts/js/ChartBase.js:107

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.
The method returns an 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
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.
The method returns an 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.
setTextFunction
Method that writes content returned from 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 or HTMLElement. If an HTML string is used, it will be rendered as a string.

Fires event 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

topAxesCollection

Array private

Defined in charts/js/CartesianChart.js:2025

Reference to the top-aligned axes for the chart.

Fires event topAxesCollectionChange

Fires when the value for the configuration attribute topAxesCollection 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

type

String

Defined in charts/js/CartesianChart.js:2186

Type of chart when there is no series collection specified.

Fires event typeChange

Fires when the value for the configuration attribute type 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

valueAxisName

String

Defined in charts/js/CartesianChart.js:2108

Indicates the key value used to identify a the series axis when an axis not generated.

Fires event valueAxisNameChange

Fires when the value for the configuration attribute valueAxisName 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

verticalGridlines

Gridlines

Defined in charts/js/CartesianChart.js:2152

Reference to the verticalGridlines for the chart.

Fires event verticalGridlinesChange

Fires when the value for the configuration attribute verticalGridlines 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.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

Events

markerEvent:click

Inherited from ChartBase: charts/js/ChartBase.js:798

Broadcasts when interactionType is set to marker and a series marker has received a click event.

Event Payload:

  • e EventFacade

    Event 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

Inherited from ChartBase: charts/js/ChartBase.js:762

Broadcasts when interactionType is set to marker and a series marker has received a mousedown event.

Event Payload:

  • e EventFacade

    Event 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

Inherited from ChartBase: charts/js/ChartBase.js:744

Broadcasts when interactionType is set to marker and a series marker has received a mouseout event.

Event Payload:

  • e EventFacade

    Event 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

Inherited from ChartBase: charts/js/ChartBase.js:725

Broadcasts when interactionType is set to marker and a series marker has received a mouseover event.

Event Payload:

  • e EventFacade

    Event 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

Inherited from ChartBase: charts/js/ChartBase.js:780

Broadcasts when interactionType is set to marker and a series marker has received a mouseup event.

Event Payload:

  • e EventFacade

    Event 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.

planarEvent:mouseout

Defined in charts/js/CartesianChart.js:169

Broadcasts when interactionType is set to planar and a series' marker plane has received a mouseout event.

Event Payload:

planarEvent:mouseover

Defined in charts/js/CartesianChart.js:147

Broadcasts when interactionType is set to planar and a series' marker plane has received a mouseover event.

Event Payload:

  • e EventFacade

    Event facade with the following additional properties:

    categoryItem
    An array of hashes, each containing information about the category Axis of each marker whose plane has been intersected.
    valueItem
    An array of hashes, each containing information about the value Axis of each marker whose plane has been intersected.
    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)
    items
    An array including all the series which contain a marker whose plane has been intersected.
    index
    Index of the markers in their respective series.
    originEvent
    Underlying dom event.