API Docs for:
Show:

CartesianSeries Class

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

Methods

_getDefaultColor

(
  • index
  • type
)
protected

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

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

Returns:

Object

_handleVisibleChange

(
  • e
)
protected

Shows/hides contents of the series.

Parameters:

  • e Object

    Event object.

_setCanvas

() protected

Creates a Graphic instance.

_updateAxisData

() private

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

Event handler for the xAxisChange event.

Parameters:

  • e Object

    Event object.

_xDataChangeHandler

(
  • event
)
private

Event handler for xDataChange event.

Parameters:

  • event Object

    Event object.

_yAxisChangeHandler

(
  • e
)
private

Event handler the yAxisChange event.

Parameters:

  • e Object

    Event object.

_yDataChangeHandler

(
  • event
)
private

Event handler for yDataChange event.

Parameters:

  • event Object

    Event object.

addListeners

() private

Adds event listeners.

destructor

() protected

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

draw

() protected

Draws the series.

getTotalValues

()

Returns the sum of all values for the series.

Returns:

Number

render

() private

setAreaData

() protected

Calculates the coordinates for the series.

validate

() private

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

Properties

_bottomOrigin

String private

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

_defaultBorderColors

Array protected

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

_defaultFillColors

Array protected

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

_defaultLineColors

Array protected

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

_defaultPlaneOffset

Number private

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

_defaultSliceColors

Array protected

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

_leftOrigin

String private

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

_xDisplayName

String private

Storage for xDisplayName attribute.

_yDisplayName

String private

Storage for yDisplayName attribute.

GUID

String private

Constant used to generate unique id.

Attributes

categoryDisplayName

String

Name used for for displaying category data

chart

ChartBase

Reference to the Chart application.

direction

String

Direction of the series

graph

Graph

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

graphOrder

Number

Order of the instance

groupMarkers

Boolean

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

height

Number

Returns the height of the parent graph

order

Number

Order of this instance of this type.

rendered

Boolean

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

type

String

Read-only attribute indicating the type of series.

Default: cartesian

valueDisplayName

String

Name used for for displaying value data

visible

Boolean

Indicates whether to show the series

Default: true

xAxis

Axis

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

xcoords

Array

x coordinates for the series.

xData

Array

Array of x values for the series.

xDisplayName

String

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

xKey

String

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

xMarkerPlane

Array

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

xMarkerPlaneOffset

Number

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

yAxis

Axis

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

ycoords

Array

y coordinates for the series

yData

Array

Array of y values for the series.

yDisplayName

String

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

yKey

String

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

yMarkerPlane

Array

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

yMarkerPlaneOffset

Number

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