CartesianChart Class
+ + + + +The CartesianChart class creates a chart with horizontal and vertical axes.
+Constructor
+CartesianChart
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
- Index + + +
- Methods + + +
- Properties + + +
- Attributes + + +
- Events + +
Item Index
+ + +Methods
+ +-
+
+
- + _addAxes + + + + + +
- + _addGridlines + + + + + +
- + _addSeries + + + + + +
- + _addToAxesCollection + + + + + +
- + _addToAxesRenderQueue + + + + + +
- + _addTooltip + + + + + +
- + _buildSeriesKeys + + + + + +
- + _dataProviderChangeHandler + + + + + +
- + _getAllKeys + + + + + +
- + _getAriaMessage + + + + + +
- + _getAxisClass + + + + + +
- + _getBaseAttribute + + + + + +
- + _getBottomOverflow + + + + + +
- + _getCategoryAxis + + + + + +
- + _getDefaultAxes + + + + + +
- + _getDefaultAxisPosition + + + + + +
- + _getDefaultSeriesCollection + + + + + +
- + _getGraph + + + + + +
- + _getLeftOverflow + + + + + +
- + _getRightOverflow + + + + + +
- + _getSeriesAxis + + + + + +
- + _getTooltip + + + + + +
- + _getTopOverflow + + + + + +
- + _groupMarkersChangeHandler + + + + + +
- + _itemRendered + + + + + +
- + _markerEventDispatcher + + + + + +
- + _parseAxes + + + + + +
- + _parseSeriesAxes + + + + + +
- + _parseSeriesCollection + + + + + +
- + _planarEventDispatcher + + + + + +
- + _planarLabelFunction + + + + + +
- + _positionTooltip + + + + + +
- + _redraw + + + + + +
- + _setAriaElements + + + + + +
- + _setAxes + + + + + +
- + _setBaseAttribute + + + + + +
- + _setDataValues + + + + + +
- + _setOffscreen + + + + + +
- + _setText + + + + + +
- + _showTooltip + + + + + +
- + _sizeChanged + + + + + +
- + _tooltipChangeHandler + + + + + +
- + _tooltipLabelFunction + + + + + +
- + _updateTooltip + + + + + +
- + bindUI + + + + + +
- + destructor + + + + + +
- + getAxisByKey + + + + + +
- + getCategoryAxis + + + + + +
- + getSeries + + + + + +
- + getSeriesItems + + + + + +
- + hideTooltip + + + + + +
- + initializer + + + + + +
- + renderUI + + + + + +
- + syncUI + + + + + +
- + toggleTooltip + + + + + +
Properties
+ +-
+
+
- + _axes + + + + + +
- + _axisClass + + + + + +
- + _dataProvider + + + + + +
- + _direction + + + + + +
- + _itemRenderQueue + + + + + +
- + _seriesCollection + + + + + +
- + _setSeriesCollection + + + + + +
- + _type + + + + + +
Attributes
+ +-
+
+
- + allowContentOverflow + + +
- + ariaDescription + + +
- + ariaLabel + + +
- + axes + + +
- + axesCollection + + +
- + axesStyles + + +
- + bottomAxesCollection + + +
- + categoryAxis + + +
- + categoryAxisName + + +
- + categoryKey + + +
- + categoryType + + +
- + dataProvider + + +
- + direction + + +
- + graph + + +
- + graphStyles + + +
- + groupMarkers + + +
- + horizontalGridlines + + +
- + interactionType + + +
- + leftAxesCollection + + +
- + rightAxesCollection + + +
- + seriesCollection + + +
- + seriesKeys + + +
- + seriesStyles + + +
- + showAreaFill + + +
- + showLines + + +
- + showMarkers + + +
- + stacked + + +
- + styles + + +
- + tooltip + + +
- + topAxesCollection + + +
- + type + + +
- + valueAxisName + + +
- + verticalGridlines + + +
Events
+ +-
+
+
- + markerEvent:click + + + + + +
- + markerEvent:mousedown + + + + + +
- + markerEvent:mouseout + + + + + +
- + markerEvent:mouseover + + + + + +
- + markerEvent:mouseup + + + + + +
- + planarEvent:mouseout + + + + + +
- + planarEvent:mouseover + + + + + +
Methods
+ + +_addAxes
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Adds axes to the chart.
+_addGridlines
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Adds gridlines to the chart.
+_addSeries
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Renders the Graph.
+_addToAxesCollection
+
+
+ -
+
+
-
+
+
position+ +
+
+ -
+
+
axis+ +
+
+
Adds axis instance to the appropriate array based on position
+_addToAxesRenderQueue
+
+
+ -
+
+
-
+
+
axis+ +
+
+
Adds an Axis instance to the _itemRenderQueue.
Parameters:
+ +-
+
+
-
+
+
axis+ Axis + + + + +++ + +An
+Axisinstance.
+
+
_addTooltip
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Adds a tooltip to the dom.
+_buildSeriesKeys
+
+
+ -
+
+
-
+
+
dataProvider+ +
+
+
Constructs seriesKeys if not explicitly specified.
+Parameters:
+ +-
+
+
-
+
+
dataProvider+ Array + + + + +++ + +The dataProvider for the chart.
+
+
+
Returns:
+ +_dataProviderChangeHandler
+
+
+ -
+
+
-
+
+
e+ +
+
+
Event handler for dataProviderChange.
+Parameters:
+ +-
+
+
-
+
+
e+ Object + + + + +++ + +Event object.
+
+
+
_getAllKeys
+
+
+ -
+
+
-
+
+
dp+ +
+
+
Returns all the keys contained in a dataProvider.
Parameters:
+ +-
+
+
-
+
+
dp+ Array + + + + +++ + +Collection of objects to be parsed.
+
+
+
Returns:
+ +_getAriaMessage
+
+
+ -
+
+
-
+
+
key+ +
+
+
Returns the appropriate message based on the key press.
+Parameters:
+ +-
+
+
-
+
+
key+ Number + + + + +++ + +The keycode that was pressed.
+
+
+
Returns:
+ +_getAxisClass
+
+
+ -
+
+
-
+
+
t+ +
+
+
Helper method that returns the axis class that a key references.
+Parameters:
+ +-
+
+
-
+
+
t+ String + + + + +++ + +The type of axis.
+
+
+
Returns:
+ +_getBaseAttribute
+
+
+ -
+
+
-
+
+
item+ +
+
+ -
+
+
key+ +
+
+
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:
+ + +Returns:
+ +_getBottomOverflow
+
+
+ -
+
+
-
+
+
set1+ +
+
+ -
+
+
set2+ +
+
+ -
+
+
height+ +
+
+
Returns the maximum distance in pixels that the extends outside the bottom bounds of all vertical axes.
+Parameters:
+ + +Returns:
+ +_getCategoryAxis
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the category axis instance for the chart.
+Returns:
+ +_getDefaultAxes
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Default Function for the axes attribute.
+Returns:
+ +_getDefaultAxisPosition
+
+
+ -
+
+
-
+
+
axis+ +
+
+ -
+
+
valueAxes+ +
+
+ -
+
+
position+ +
+
+
Determines the position of an axis when one is not specified.
+Parameters:
+ + +Returns:
+ +_getDefaultSeriesCollection
+
+
+ -
+
+
-
+
+
val+ +
+
+
Returns the default value for the seriesCollection attribute.
Parameters:
+ +-
+
+
-
+
+
val+ Array + + + + +++ + +Array containing either
+CartesianSeriesinstances or objects containing data to construct series instances.
+
+
Returns:
+ +_getGraph
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Default value function for the Graph attribute.
Returns:
+ +_getLeftOverflow
+
+
+ -
+
+
-
+
+
set1+ +
+
+ -
+
+
set2+ +
+
+ -
+
+
width+ +
+
+
Returns the maximum distance in pixels that the extends outside the left bounds of all horizontal axes.
+Parameters:
+ + +Returns:
+ +_getRightOverflow
+
+
+ -
+
+
-
+
+
set1+ +
+
+ -
+
+
set2+ +
+
+ -
+
+
width+ +
+
+
Returns the maximum distance in pixels that the extends outside the right bounds of all horizontal axes.
+Parameters:
+ + +Returns:
+ +_getSeriesAxis
+
+
+ -
+
+
-
+
+
key+ +
+
+
Returns the value axis for a series.
+Parameters:
+ +-
+
+
-
+
+
key+ String + + + + +++ + +The key value used to determine the axis instance.
+
+
+
Returns:
+ +_getTooltip
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Default getter for tooltip attribute.
Returns:
+ +_getTopOverflow
+
+
+ -
+
+
-
+
+
set1+ +
+
+ -
+
+
set2+ +
+
+ -
+
+
width+ +
+
+
Returns the maximum distance in pixels that the extends outside the top bounds of all vertical axes.
+Parameters:
+ + +Returns:
+ +_groupMarkersChangeHandler
+
+
+ -
+
+
-
+
+
e+ +
+
+
Handles groupMarkers change event.
+Parameters:
+ +-
+
+
-
+
+
e+ Object + + + + +++ + +Event object.
+
+
+
_itemRendered
+
+
+ -
+
+
-
+
+
e+ +
+
+
Handler for itemRendered event.
+Parameters:
+ +-
+
+
-
+
+
e+ Object + + + + +++ + +Event object.
+
+
+
_markerEventDispatcher
+
+
+ -
+
+
-
+
+
e+ +
+
+
Event handler for marker events.
+Parameters:
+ +-
+
+
-
+
+
e+ Object + + + + +++ + +Event object.
+
+
+
_parseAxes
+
+
+ -
+
+
-
+
+
axes+ +
+
+
Generates and returns a key-indexed object containing Axis instances or objects used to create Axis instances.
Parameters:
+ +-
+
+
-
+
+
axes+ Object + + + + +++ + +Object containing
+Axisinstances orAxisattributes.
+
+
Returns:
+ +_parseSeriesAxes
+
+
+ -
+
+
-
+
+
series+ +
+
+
Parse and sets the axes for a series instance.
+Parameters:
+ +-
+
+
-
+
+
series+ CartesianSeries + + + + +++ + +A
+CartesianSeriesinstance.
+
+
_parseSeriesCollection
+
+
+ -
+
+
-
+
+
val+ +
+
+
Parses and returns a series collection from an object and default properties.
+Parameters:
+ +-
+
+
-
+
+
val+ Object + + + + +++ + +Object contain properties for series being set.
+
+
+
Returns:
+ +_planarEventDispatcher
+
+
+ -
+
+
-
+
+
e+ +
+
+
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:
+ +-
+
+
-
+
+
e+ Object + + + + +++ + +Event object.
+
+
+
_planarLabelFunction
+
+
+ -
+
+
-
+
+
categoryAxis+ +
+
+ -
+
+
valueItems+ +
+
+ -
+
+
index+ +
+
+ -
+
+
seriesArray+ +
+
+ -
+
+
seriesIndex+ +
+
+
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:
+ +_positionTooltip
+
+
+ -
+
+
-
+
+
e+ +
+
+
Positions the tooltip
+Parameters:
+ +-
+
+
-
+
+
e+ Object + + + + +++ + +Event object.
+
+
+
_redraw
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Redraws and position all the components of the chart instance.
+_setAriaElements
+
+
+ -
+
+
-
+
+
cb+ +
+
+
Creates an aria live-region, aria-label and aria-describedby for the Chart.
Parameters:
+ +-
+
+
-
+
+
cb+ Node + + + + +++ + +Reference to the Chart's
+contentBoxattribute.
+
+
_setAxes
+
+
+ -
+
+
-
+
+
val+ +
+
+
Creates Axis instances.
Parameters:
+ +-
+
+
-
+
+
val+ Object + + + + +++ + +Object containing
+Axisinstances or objects in which to constructAxisinstances.
+
+
Returns:
+ +_setBaseAttribute
+
+
+ -
+
+
-
+
+
item+ +
+
+ -
+
+
key+ +
+
+ -
+
+
value+ +
+
+
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.
+_setDataValues
+
+
+ -
+
+
-
+
+
val+ +
+
+
Setter method for dataProvider attribute.
Parameters:
+ +-
+
+
-
+
+
val+ Array + + + + +++ + +Array to be set as
+dataProvider.
+
+
Returns:
+ +_setOffscreen
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets a node offscreen for use as aria-description or aria-live-regin.
+Returns:
+ +_setText
+
+
+ -
+
+
-
+
+
label+ +
+
+ -
+
+
val+ +
+
+
Updates the content of text field. This method writes a value into a text field using
+appendChild. If the value is a String, it is converted to a TextNode first.
Parameters:
+ +-
+
+
-
+
+
label+ HTMLElement + + + + +++ + +label to be updated
+
+
+ -
+
+
val+ String + + + + +++ + +value with which to update the label
+
+
+
_showTooltip
+
+
+ -
+
+
-
+
+
msg+ +
+
+ -
+
+
x+ +
+
+ -
+
+
y+ +
+
+
Shows a tooltip
+_sizeChanged
+
+
+ -
+
+
-
+
+
e+ +
+
+
Handler for sizeChanged event.
+Parameters:
+ +-
+
+
-
+
+
e+ Object + + + + +++ + +Event object.
+
+
+
_tooltipChangeHandler
+
+
+ -
+
+
-
+
+
e+ +
+
+
Event handler for the tooltipChange.
+Parameters:
+ +-
+
+
-
+
+
e+ Object + + + + +++ + +Event object.
+
+
+
_tooltipLabelFunction
+
+
+ -
+
+
-
+
+
categoryItem+ +
+
+ -
+
+
valueItem+ +
+
+
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:
+ +_updateTooltip
+
+
+ -
+
+
-
+
+
val+ +
+
+
Updates the tooltip attribute.
+Parameters:
+ +-
+
+
-
+
+
val+ Object + + + + +++ + +Object containing properties for the tooltip.
+
+
+
Returns:
+ +bindUI
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ destructor
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ 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+ +
+
+
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:
+ +getCategoryAxis
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the category axis for the chart.
+Returns:
+ +getSeries
+
+
+ -
+
+
-
+
+
val+ +
+
+
Returns a series instance by index or key value.
+Parameters:
+ +-
+
+
-
+
+
val+ Object + + + + ++ ++ + +
+
+
Returns:
+ +getSeriesItems
+
+
+ -
+
+
-
+
+
series+ +
+
+ -
+
+
index+ +
+
+
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:
+ +-
+
- 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
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hides the default tooltip
+initializer
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ renderUI
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ syncUI
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ toggleTooltip
+
+
+ -
+
+
-
+
+
e+ +
+
+
Event listener for toggling the tooltip. If a tooltip is visible, hide it. If not, it +will create and show a tooltip based on the event object.
+Parameters:
+ +-
+
+
-
+
+
e+ Object + + + + +++ + +Event object.
+
+
+
Properties
+ + + + + +_axisClass
+ Object
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Key value pairs of axis types.
+_dataProvider
+ Array
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Storage for the dataProvider attribute.
_direction
+ String
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Default direction of the chart.
+Default: horizontal
+ + + + + +_itemRenderQueue
+ Array
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Queue of axes instances that will be updated. This method is used internally to determine when all axes have been updated.
+_seriesCollection
+ Array
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Storage for seriesCollection attribute.
_setSeriesCollection
+ Unknown
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Setter method for seriesCollection attribute.
Sub-properties:
+ +-
+
+
-
+
+
val+ Array + + +++ + +Array of either
+CartesianSeriesinstances or objects containing series attribute key value pairs.
+
+
_type
+ String
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ Indicates the default series type for the chart.
+Attributes
+ + +allowContentOverflow
+ Boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Style properties for the chart. Contains a key indexed hash of the following: +
-
+
- series
- A key indexed hash containing references to the
stylesattribute for each series in the chart. + Specific style attributes vary depending on the series: +-
+
- AreaSeries +
- BarSeries +
- ColumnSeries +
- ComboSeries +
- LineSeries +
- MarkerSeries +
- SplineSeries +
+ - axes
- A key indexed hash containing references to the
stylesattribute for each axes in the chart. Specific + style attributes can be found in the Axis class.
+ - graph
- A reference to the
stylesattribute 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
CartesianSeriesinstance of the item.
+ - seriesIndex
- The index of the series in the
seriesCollection.
+
HTMLElementwhich is written into the DOM usingappendChild. If you override this method and choose + to return an html string, you will also need to override the tooltip'ssetTextFunctionmethod to accept an html string. +
+ - planarLabelFunction
- Reference to the function used to format a planar event triggered tooltip's text
+
-
+
- categoryAxis
-
CategoryAxisReference to the categoryAxis of the chart. + - valueItems
- Array of objects for each series that has a data point in the coordinate plane of the event. Each
+ object contains the following data:
+
-
+
- axis
- The value axis of the series. +
- key
- The key for the series. +
- value
- The value for the series item. +
- displayName
- The display name of the series. (defaults to key if not provided) +
+ - index
- The index of the item within its series. +
- seriesArray
- Array of series instances for each value item. +
- seriesIndex
- The index of the series in the
seriesCollection.
+
+
HTMLElement which is written into the DOM using appendChild. If you override this method and choose
+ to return an html string, you will also need to override the tooltip's setTextFunction method to accept an html string.
+
+ planarLabelFunction or markerLabelFunction into the
+ the tooltip node. Has the following signature:
+ -
+
- label
- The
HTMLElementthat the content is to be added.
+ - val
- The content to be rendered into tooltip. This can be a
StringorHTMLElement. 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
orderof the marker's series.
+ - originEvent
- Underlying dom event. +
+
+
markerEvent:mousedown
+
+
+
+
+
+
+
+
+
+
+
+
+ Broadcasts when interactionType is set to marker and a series marker has received a mousedown event.
Event Payload:
+ +-
+
+
-
+
+
e+ 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
orderof the marker's series.
+
+
+
markerEvent:mouseout
+
+
+
+
+
+
+
+
+
+
+
+
+ Broadcasts when interactionType is set to marker and a series marker has received a mouseout event.
Event Payload:
+ +-
+
+
-
+
+
e+ 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
orderof the marker's series.
+
+
+
markerEvent:mouseover
+
+
+
+
+
+
+
+
+
+
+
+
+ Broadcasts when interactionType is set to marker and a series marker has received a mouseover event.
Event Payload:
+ +-
+
+
-
+
+
e+ 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
orderof the marker's series.
+
+
+
markerEvent:mouseup
+
+
+
+
+
+
+
+
+
+
+
+
+ Broadcasts when interactionType is set to marker and a series marker has received a mouseup event.
Event Payload:
+ +-
+
+
-
+
+
e+ 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
orderof the marker's series.
+
+
+
planarEvent:mouseout
+
+
+
+
+
+
+
+
+
+
+
+
+ Broadcasts when interactionType is set to planar and a series' marker plane has received a mouseout event.
Event Payload:
+ +-
+
+
-
+
+
e+ EventFacade + + + + ++ ++ + +
+
+
planarEvent:mouseover
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
Axisof each marker + whose plane has been intersected.
+ - valueItem
- An array of hashes, each containing information about the value
Axisof 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. +
+
+