Class actuate.report.HTML5Chart.ClientSeries

A container for a ClientSeries in a actuate.report.HTML5Chart.ClientChart. ClientSeries provides functions to manage a series and the graph of that series. In the ClientSeries object, all the points are accessible from the ClientSeries.data array.
Member of: actuate.report.HTML5Chart.

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

Method Summary
Method Attributes	Method Name and Description
<static>	addPoint(options, redraw, shift, animation) Add a point dynamically after chart load time
<static>	afterAnimate() This runs after animation to land on the final plot clipping
<static>	alignDataLabel(point, dataLabel, options, alignTo, isNew) Align each individual data label
<static>	animate(init) Animate in the series
<static>	autoIncrement() Return an auto incremented x value based on the pointStart and pointInterval options.
<static>	bindAxes() Set the xAxis and yAxis properties of cartesian series, and register the series in the axis.series array
<static>	clipNeg() Clip the graphs into the positive and negative coloured graphs
<static>	convertAttribs(options, base1, base2, base3) Convert state properties from API naming conventions to SVG attributes
<static>	cropData(xData, yData, min, max) Iterate over xData and crop values between min and max.
<static>	destroy() Clear DOM objects and free up memory
<static>	drawDataLabels(labelOptions) Draw the data labels
<static>	drawGraph() Draw the actual graph
<static>	drawLegendSymbol(legend) Get the series' symbol in the legend.
<static>	drawPoints() Draw the markers
<static>	drawTracker() Draw the tracker object that sits above all data labels and markers to track mouse events on the graph or points.
<static>	generatePoints() Generate the data point after the data has been processed by cropping away unused points and optionally grouped in Highcharts Stock.
<static>	getAttribs() Get the state attributes.
<static>	getColor() Get the series' color
<static>	getExtremes() Calculate x and y extremes for visible data
<static>	getGraphPath() Get the graph path
<static>	getPlotBox() Get the translation and scale for the plot area of this series
<static>	getSegmentPath(segment) Return the graph path of a segment
<static>	getSegments() Divide the series data into segments divided by null values.
<static>	getSymbol() Get the series' symbol
<static>	hide() Hide the graph
<static>	init(chart, options)
<static>	invertGroups() Initialize and perform group inversion on series.group and series.markerGroup
<static>	onMouseOut() Series mouse out handler
<static>	onMouseOver() Series mouse over handler
<static>	plotGroup(prop, name, visibility, zIndex, parent) General abstraction for creating plot groups like series.group, series.dataLabelsGroup and series.markerGroup.
<static>	processData(force) Process the data by cropping away unused data points if the series is longer than the crop threshold.
<static>	redraw() Redraw the series after an update in the axes.
<static>	remove(redraw, animation) Remove a series and optionally redraw the chart
<static>	render() Render the graph and markers
<static>	select(selected) Set the selected state of the graph
<static>	setData(data, redraw) Replace the series data with a new set of data
<static>	setOptions(itemOptions) Set the series options by merging from the options tree
<static>	setPercentStacks() Iterate over all stacks and compute the absolute values to percent
<static>	setStackedPoints() Adds series' points value to corresponding stack
<static>	setState(state) Set the state of the graph
<static>	setTooltipPoints(renew) Memoize tooltip texts and positions
<static>	setVisible(vis, redraw) Set the visibility of the graph
<static>	show() Show the graph
<static>	tooltipHeaderFormatter(point) Format the header of the tooltip
<static>	translate() Translate data points from raw data values to chart specific positioning data needed later in drawPoints, drawGraph and drawTracker.
<static>	update(newOptions, redraw) Update the series with a new set of options

Class Detail

actuate.report.HTML5Chart.ClientSeries()

Generates a new ClientSeries object to manage a series for a actuate.report.HTML5Chart.ClientChart.

Method Detail

<static> addPoint(options, redraw, shift, animation)

Add a point dynamically after chart load time

Parameters:
{Object} options: Point options as given in series.data
{Boolean} redraw: Whether to redraw the chart or wait for an explicit call
{Boolean} shift: If shift is true, a point is shifted off the start of the series as one is appended to the end.
{Boolean|Object} animation: Whether to apply animation, and optionally animation configuration

<static> afterAnimate()

This runs after animation to land on the final plot clipping

<static> alignDataLabel(point, dataLabel, options, alignTo, isNew)

Align each individual data label

Parameters:
point
dataLabel
options
alignTo
isNew

<static> animate(init)

Animate in the series

Parameters:
init

<static> autoIncrement()

Return an auto incremented x value based on the pointStart and pointInterval options. This is only used if an x value is not given for the point that calls autoIncrement.

<static> bindAxes()

Set the xAxis and yAxis properties of cartesian series, and register the series in the axis.series array

<static> clipNeg()

Clip the graphs into the positive and negative coloured graphs

<static> convertAttribs(options, base1, base2, base3)

Convert state properties from API naming conventions to SVG attributes

Parameters:
{Object} options: API options object
{Object} base1: SVG attribute object to inherit from
{Object} base2: Second level SVG attribute object to inherit from
base3

<static> cropData(xData, yData, min, max)

Iterate over xData and crop values between min and max. Returns object containing crop start/end cropped xData with corresponding part of yData, dataMin and dataMax within the cropped range

Parameters:
xData
yData
min
max

<static> destroy()

Clear DOM objects and free up memory

<static> drawDataLabels(labelOptions)

Draw the data labels

Parameters:
labelOptions

<static> drawGraph()

Draw the actual graph

<static> drawLegendSymbol(legend)

Get the series' symbol in the legend. This method should be overridable to create custom symbols through Highcharts.seriesTypes[type].prototype.drawLegendSymbols.

Parameters:
{Object} legend: The legend object

<static> drawPoints()

Draw the markers

<static> drawTracker()

Draw the tracker object that sits above all data labels and markers to track mouse events on the graph or points. For the line type charts the tracker uses the same graphPath, but with a greater stroke width for better control.

<static> generatePoints()

Generate the data point after the data has been processed by cropping away unused points and optionally grouped in Highcharts Stock.

<static> getAttribs()

Get the state attributes. Each series type has its own set of attributes that are allowed to change on a point's state change. Series wide attributes are stored for all series, and additionally point specific attributes are stored for all points with individual marker options. If such options are not defined for the point, a reference to the series wide attributes is stored in point.pointAttr.

<static> getColor()

Get the series' color

<static> getExtremes()

Calculate x and y extremes for visible data

<static> getGraphPath()

Get the graph path

<static> getPlotBox()

Get the translation and scale for the plot area of this series

<static> getSegmentPath(segment)

Return the graph path of a segment

Parameters:
segment

<static> getSegments()

Divide the series data into segments divided by null values.

<static> getSymbol()

Get the series' symbol

<static> hide()

Hide the graph

<static> init(chart, options)

Parameters:
chart
options

<static> invertGroups()

Initialize and perform group inversion on series.group and series.markerGroup

<static> onMouseOut()

Series mouse out handler

<static> onMouseOver()

Series mouse over handler

<static> plotGroup(prop, name, visibility, zIndex, parent)

General abstraction for creating plot groups like series.group, series.dataLabelsGroup and series.markerGroup. On subsequent calls, the group will only be adjusted to the updated plot size.

Parameters:
prop
name
visibility
zIndex
parent

<static> processData(force)

Process the data by cropping away unused data points if the series is longer than the crop threshold. This saves computing time for lage series.

Parameters:
force

<static> redraw()

Redraw the series after an update in the axes.

<static> remove(redraw, animation)

Remove a series and optionally redraw the chart

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> render()

Render the graph and markers

<static> select(selected)

Set the selected state of the graph

Parameters:
selected: {Boolean} True to select the series, false to unselect. If UNDEFINED, the selection state is toggled.

<static> setData(data, redraw)

Replace the series data with a new set of data

Parameters:
{Object} data
{Object} redraw

<static> setOptions(itemOptions)

Set the series options by merging from the options tree

Parameters:
{Object} itemOptions

<static> setPercentStacks()

Iterate over all stacks and compute the absolute values to percent

<static> setStackedPoints()

Adds series' points value to corresponding stack

<static> setState(state)

Set the state of the graph

Parameters:
state

<static> setTooltipPoints(renew)

Memoize tooltip texts and positions

Parameters:
renew

<static> setVisible(vis, redraw)

Set the visibility of the graph

Parameters:
vis: {Boolean} True to show the series, false to hide. If UNDEFINED, the visibility is toggled.
redraw

<static> show()

Show the graph

<static> tooltipHeaderFormatter(point)

Format the header of the tooltip

Parameters:
point

<static> translate()

Translate data points from raw data values to chart specific positioning data needed later in drawPoints, drawGraph and drawTracker.

<static> update(newOptions, redraw)

Update the series with a new set of options

Parameters:
newOptions
redraw

Classes

Class actuate.report.HTML5Chart.ClientSeries