API Docs for: 3.8.0
Show:

CartesianSeries Class

Defined in: charts/js/CartesianSeries.js:1
Module: charts-base
Parent Module: charts

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

Methods

_getDefaultColor

(
  • index
  • type
)
protected

Defined in charts/js/CartesianSeries.js:473

Parses a color based on a series order and type.

Parameters:

  • index Number

    Index indicating the series order.

  • type String

    Indicates which type of object needs the color.

Returns:

String

_getDefaultStyles

() protected

Defined in charts/js/CartesianSeries.js:419

Gets the default value for the styles attribute. Overrides base implementation.

Returns:

Object

_getFirstValidIndex

(
  • coords
)
private

Defined in charts/js/CartesianSeries.js:327

Finds the first valid index of an array coordinates.

Parameters:

  • coords Array

    An array of x or y coordinates.

Returns:

Number

_getLastValidIndex

(
  • coords
)
private

Defined in charts/js/CartesianSeries.js:348

Finds the last valid index of an array coordinates.

Parameters:

  • coords Array

    An array of x or y coordinates.

Returns:

Number

_handleVisibleChange

(
  • e
)
protected

Defined in charts/js/CartesianSeries.js:501

Shows/hides contents of the series.

Parameters:

_setCanvas

() protected

Defined in charts/js/CartesianSeries.js:224

Creates a Graphic instance.

_updateAxisData

() private

Defined in charts/js/CartesianSeries.js:175

Checks to ensure that both xAxis and yAxis data are available. If so, set the xData and yData attributes and return true. Otherwise, return false.

Returns:

Boolean

_xAxisChangeHandler

(
  • e
)
private

Defined in charts/js/CartesianSeries.js:106

Event handler for the xAxisChange event.

Parameters:

_xDataChangeHandler

(
  • event
)
private

Defined in charts/js/CartesianSeries.js:143

Event handler for xDataChange event.

Parameters:

_yAxisChangeHandler

(
  • e
)
private

Defined in charts/js/CartesianSeries.js:120

Event handler the yAxisChange event.

Parameters:

_yDataChangeHandler

(
  • event
)
private

Defined in charts/js/CartesianSeries.js:159

Event handler for yDataChange event.

Parameters:

addListeners

() private

Defined in charts/js/CartesianSeries.js:60

Adds event listeners.

destructor

() protected

Defined in charts/js/CartesianSeries.js:525

Destructor implementation for the CartesianSeries class. Calls destroy on all Graphic instances.

draw

() protected

Defined in charts/js/CartesianSeries.js:369

Draws the series.

getTotalValues

()

Defined in charts/js/CartesianSeries.js:513

Returns the sum of all values for the series.

Returns:

Number

render

() private

Defined in charts/js/CartesianSeries.js:48

setAreaData

() protected

Defined in charts/js/CartesianSeries.js:237

Calculates the coordinates for the series.

validate

() private

Defined in charts/js/CartesianSeries.js:206

Draws the series is the xAxis and yAxis data are both available.

Properties

_bottomOrigin

String private

Defined in charts/js/CartesianSeries.js:39

The y-coordinate for the bottom edge of the series.

_defaultBorderColors

Array protected

Defined in charts/js/CartesianSeries.js:455

Collection of default colors used for marker borders in a series when not specified by user.

_defaultFillColors

Array protected

Defined in charts/js/CartesianSeries.js:446

Collection of default colors used for marker fills in a series when not specified by user.

_defaultLineColors

Array protected

Defined in charts/js/CartesianSeries.js:437

Collection of default colors used for lines in a series when not specified by user.

_defaultPlaneOffset

Number private

Defined in charts/js/CartesianSeries.js:410

Default value for plane offsets when the parent chart's interactiveType is planar.

_defaultSliceColors

Array protected

Defined in charts/js/CartesianSeries.js:464

Collection of default colors used for area fills, histogram fills and pie fills in a series when not specified by user.

_heightChangeHandle

EventHandle private

Defined in charts/js/CartesianSeries.js:643

Event handle for the heightChange event.

_leftOrigin

String private

Defined in charts/js/CartesianSeries.js:30

Th x-coordinate for the left edge of the series.

_stylesChangeHandle

EventHandle private

Defined in charts/js/CartesianSeries.js:629

Event handle for the stylesChange event.

_visibleChangeHandle

EventHandle private

Defined in charts/js/CartesianSeries.js:650

Event handle for the visibleChange event.

_widthChangeHandle

EventHandle private

Defined in charts/js/CartesianSeries.js:636

Event handle for the widthChange event.

_xAxisChangeHandle

EventHandle private

Defined in charts/js/CartesianSeries.js:615

Event handle for the xAxisChange event.

_xDataReadyHandle

EventHandle private

Defined in charts/js/CartesianSeries.js:584

Event handle for the x-axis' dataReady event.

_xDataUpdateHandle

EventHandle private

Defined in charts/js/CartesianSeries.js:592

Event handle for the x-axis dataUpdate event.

_xDisplayName

String private

Defined in charts/js/CartesianSeries.js:12

Storage for xDisplayName attribute.

_yAxisChangeHandle

EventHandle private

Defined in charts/js/CartesianSeries.js:622

Event handle for the yAxisChange event.

_yDataReadyHandle

EventHandle private

Defined in charts/js/CartesianSeries.js:600

Event handle for the y-axis dataReady event.

_yDataUpdateHandle

EventHandle private

Defined in charts/js/CartesianSeries.js:608

Event handle for the y-axis dataUpdate event.

_yDisplayName

String private

Defined in charts/js/CartesianSeries.js:21

Storage for yDisplayName attribute.

GUID

String private

Defined in charts/js/CartesianSeries.js:134

Constant used to generate unique id.

Attributes

categoryDisplayName

String readonly

Defined in charts/js/CartesianSeries.js:696

Name used for for displaying category data

Fires event categoryDisplayNameChange

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

chart

ChartBase readonly

Defined in charts/js/CartesianSeries.js:797

Reference to the Chart application.

Fires event chartChange

Fires when the value for the configuration attribute chart 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/CartesianSeries.js:986

Direction of the series

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

Defined in charts/js/CartesianSeries.js:813

Reference to the Graph in which the series is drawn into.

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.

graphOrder

Number

Defined in charts/js/CartesianSeries.js:773

Order of the instance

Fires event graphOrderChange

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

Defined in charts/js/CartesianSeries.js:996

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.

height

Number

Defined in charts/js/CartesianSeries.js:908

Returns the height of the parent graph

Fires event heightChange

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

order

Number

Defined in charts/js/CartesianSeries.js:765

Order of this instance of this type.

Fires event orderChange

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

rendered

Boolean

Defined in charts/js/CartesianSeries.js:883

Indicates whether the Series has been through its initial set up.

Fires event renderedChange

Fires when the value for the configuration attribute rendered 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/CartesianSeries.js:754

Read-only attribute indicating the type of series.

Default: cartesian

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.

valueDisplayName

String readonly

Defined in charts/js/CartesianSeries.js:725

Name used for for displaying value data

Fires event valueDisplayNameChange

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

visible

Boolean

Defined in charts/js/CartesianSeries.js:923

Indicates whether to show the series

Default: true

Fires event visibleChange

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

xAxis

Axis

Defined in charts/js/CartesianSeries.js:821

Reference to the Axis instance used for assigning x-values to the graph.

Fires event xAxisChange

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

xcoords

Array

Defined in charts/js/CartesianSeries.js:781

x coordinates for the series.

Fires event xcoordsChange

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

xData

Array

Defined in charts/js/CartesianSeries.js:867

Array of x values for the series.

Fires event xDataChange

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

xDisplayName

String

Defined in charts/js/CartesianSeries.js:658

Name used for for displaying data related to the x-coordinate.

Fires event xDisplayNameChange

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

xKey

String

Defined in charts/js/CartesianSeries.js:839

Indicates which array to from the hash of value arrays in the x-axis Axis instance.

Fires event xKeyChange

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

xMarkerPlane

Array

Defined in charts/js/CartesianSeries.js:934

Collection of area maps along the xAxis. Used to determine mouseover for multiple series.

Fires event xMarkerPlaneChange

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

xMarkerPlaneOffset

Number

Defined in charts/js/CartesianSeries.js:952

Distance from a data coordinate to the left/right for setting a hotspot.

Fires event xMarkerPlaneOffsetChange

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

yAxis

Axis

Defined in charts/js/CartesianSeries.js:830

Reference to the Axis instance used for assigning y-values to the graph.

Fires event yAxisChange

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

ycoords

Array

Defined in charts/js/CartesianSeries.js:789

y coordinates for the series

Fires event ycoordsChange

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

yData

Array

Defined in charts/js/CartesianSeries.js:875

Array of y values for the series.

Fires event yDataChange

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

yDisplayName

String

Defined in charts/js/CartesianSeries.js:677

Name used for for displaying data related to the y-coordinate.

Fires event yDisplayNameChange

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

yKey

String

Defined in charts/js/CartesianSeries.js:853

Indicates which array to from the hash of value arrays in the y-axis Axis instance.

Fires event yKeyChange

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

yMarkerPlane

Array

Defined in charts/js/CartesianSeries.js:943

Collection of area maps along the yAxis. Used to determine mouseover for multiple series.

Fires event yMarkerPlaneChange

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

yMarkerPlaneOffset

Number

Defined in charts/js/CartesianSeries.js:969

Distance from a data coordinate to the top/bottom for setting a hotspot.

Fires event yMarkerPlaneOffsetChange

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