Class actuate.report.HTML5Chart.ClientPoint

Represents a data point in a chart. ClientPoint provides functions to manage a point in a series on an individual basis, including selections, options, and events. The options for ClientPoint are defined in the Highcharts point class, which is documented in the Highcharts documentation.
Member of: actuate.report.HTML5Chart.

Class Summary
Constructor Attributes	Constructor Name and Description
	actuate.report.HTML5Chart.ClientPoint() Generates a new ClientPoint object to manage a data point for a actuate.report.HTML5Chart.ClientChart.

Method Summary
Method Attributes	Method Name and Description
<static>	applyOptions(options, x) Apply the options containing the x and y data and possible some extra properties.
<static>	destroy() Destroy a point to clear memory.
<static>	destroyElements() Destroy SVG elements associated with the point
<static>	firePointEvent(eventType, eventArgs, defaultFunction) Fire an event on the Point object.
<static>	formatItemValue(valueAndFormat, ctx)
<static>	getLabelConfig() Return the configuration hash needed for the data label and tooltip formatters
<static>	importEvents() Import events from the series' and point's options.
<static>	init(series, options, x) Initialize the point
<static>	onMouseOut() Runs on mouse out from the point
<static>	onMouseOver(e) Runs on mouse over the point
<static>	optionsToObject(options) Transform number or array configs into objects
<static>	remove(redraw, animation) Remove a point and optionally redraw the series and if necessary the axes
<static>	select(selected, accumulate) Toggle the selection status of a point
<static>	setState(state) Set the point's state
<static>	tooltipFormatter(pointFormat) Extendable method for formatting each point's tooltip line
<static>	update(options, redraw, animation) Update the point with new options (typically x/y data) and optionally redraw the series.

Class Detail

actuate.report.HTML5Chart.ClientPoint()

Generates a new ClientPoint object to manage a data point for a actuate.report.HTML5Chart.ClientChart.

Method Detail

<static> applyOptions(options, x)

Apply the options containing the x and y data and possible some extra properties. This is called on point init or from point.update.

Parameters:
{Object} options
x

<static> destroy()

Destroy a point to clear memory. Its reference still stays in series.data.

<static> destroyElements()

Destroy SVG elements associated with the point

<static> firePointEvent(eventType, eventArgs, defaultFunction)

Fire an event on the Point object. Must not be renamed to fireEvent, as this causes a name clash in MooTools

Parameters:
{String} eventType
{Object} eventArgs: Additional event arguments
{Function} defaultFunction: Default event handler

<static> formatItemValue(valueAndFormat, ctx)

Parameters:
valueAndFormat
ctx

<static> getLabelConfig()

Return the configuration hash needed for the data label and tooltip formatters

<static> importEvents()

Import events from the series' and point's options. Only do it on demand, to save processing time on hovering.

<static> init(series, options, x)

Initialize the point

Parameters:
{Object} series: The series object containing this point
{Object} options: The data in either number, array or object format
x

<static> onMouseOut()

Runs on mouse out from the point

<static> onMouseOver(e)

Runs on mouse over the point

Parameters:
e

<static> optionsToObject(options)

Transform number or array configs into objects

Parameters:
options

<static> remove(redraw, animation)

Remove a point and optionally redraw the series and if necessary the axes

Parameters:
{Boolean} redraw: Whether to redraw the chart or wait for an explicit call
{Boolean|Object} animation: Whether to apply animation, and optionally animation configuration

<static> select(selected, accumulate)

Toggle the selection status of a point

Parameters:
{Boolean} selected: Whether to select or unselect the point.
{Boolean} accumulate: Whether to add to the previous selection. By default, this happens if the control key (Cmd on Mac) was pressed during clicking.

<static> setState(state)

Set the point's state

Parameters:
{String} state

<static> {String} tooltipFormatter(pointFormat)

Extendable method for formatting each point's tooltip line

Parameters:
pointFormat

Returns:: {String} A string to be concatenated in to the common tooltip text

<static> update(options, redraw, animation)

Update the point with new options (typically x/y data) and optionally redraw the series.

Parameters:
{Object} options: Point options as defined in the series.data array
{Boolean} redraw: Whether to redraw the chart or wait for an explicit call
{Boolean|Object} animation: Whether to apply animation, and optionally animation configuration

Classes

Class actuate.report.HTML5Chart.ClientPoint