CartesianSeries Class
The CartesianSeries class creates a chart with horizontal and vertical axes.
Item Index
Methods
Properties
Methods
_getDefaultColor
-
index -
type
Parses a color based on a series order and type.
Parameters:
Returns:
_getDefaultStyles
()
protected
Gets the default value for the styles attribute. Overrides
base implementation.
Returns:
_handleVisibleChange
-
e
Shows/hides contents of the series.
Parameters:
-
eObjectEvent 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:
_xAxisChangeHandler
-
e
Event handler for the xAxisChange event.
Parameters:
-
eObjectEvent object.
_xDataChangeHandler
-
event
Event handler for xDataChange event.
Parameters:
-
eventObjectEvent object.
_yAxisChangeHandler
-
e
Event handler the yAxisChange event.
Parameters:
-
eObjectEvent object.
_yDataChangeHandler
-
event
Event handler for yDataChange event.
Parameters:
-
eventObjectEvent 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:
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
_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.
Attributes
categoryDisplayName
String
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
chart
ChartBase
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
direction
String
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
graph
Graph
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
graphOrder
Number
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
groupMarkers
Boolean
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
height
Number
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
order
Number
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
rendered
Boolean
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
type
String
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
valueDisplayName
String
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
visible
Boolean
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
xAxis
Axis
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
xcoords
Array
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
xData
Array
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
xDisplayName
String
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
xKey
String
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
xMarkerPlane
Array
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
xMarkerPlaneOffset
Number
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
yAxis
Axis
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
ycoords
Array
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
yData
Array
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
yDisplayName
String
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
yKey
String
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
yMarkerPlane
Array
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
yMarkerPlaneOffset
Number
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added: