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) Adds a point dynamically to the series.
<static>	cleanData() Sorts the series and removes duplicate points or values.
<static>	destroy() Clears DOM series objects and frees memory.
<static>	hide() Hides the graph of this series.
<static>	redraw() Redraws the graph of this series after updating the data and axes.
<static>	remove(redraw, animation) Removes this series and optionally redraws the chart.
<static>	render() Renders the graph of this series and its markers.
<static>	select(selected) Selects this series.
<static>	setData(data, redraw) Replaces the series data with a new set of data.
<static>	setVisible(vis, redraw) Sets the visibility of this series.
<static>	show() Displays the graph of this series.

Class Detail

actuate.report.HTML5Chart.ClientSeries()

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

Method Detail

<static> {void} addPoint(options, redraw, shift, animation)

Adds a point dynamically to the series. This example adds a point of value 12 to the end of myClientSeries:

	myClientSeries.addPoint(12);

Parameters:
{Object} options: The point options. If options is a single number, the point gets that number as the Y value. If options is an array, the point gets the first two numbers as an X and Y value pair. If options is an object, advanced options as outlined in the Highcharts options.point are applied. The fields include color, events, id, marker, legend, Index (pie chart only), name, sliced (pie chart only), X, and Y.
{Boolean} redraw: Optional. Specifies whether to redraw the chart. Default is true.
{Boolean} shift: Optional. When shift is true, the graph of the series shifts one point toward the end of the series and a point added to the beginning of the series. Default is false.
{Boolean|Object} animation: Optional. Whether to apply animation, and optionally animation configuration. Default is true.

Returns:: {void}

<static> {void} cleanData()

Sorts the series and removes duplicate points or values. This example sorts myClientSeries and removes its duplicate points and values:

	myClientSeries.cleanData( );

Returns:: {void}

<static> {void} destroy()

Clears DOM series objects and frees memory. This example clears the memory of myClientSeries and its member objects:

	myClientSeries.destroy( );

Returns:: {void}

<static> {void} hide()

Hides the graph of this series. This example hides myClientSeries graph from the chart:

	myClientSeries.hide( );

Returns:: {void}

<static> {void} redraw()

Redraws the graph of this series after updating the data and axes. This example redraws the graph of myClientSeries:

	myClientSeries.redraw( );

Returns:: {void}

<static> {void} remove(redraw, animation)

Removes this series and optionally redraws the chart. his example removes the graph of myClientSeries from the chart:

	myClientSeries.remove( );

Parameters:
{Boolean} redraw: Optional. Specifies whether to redraw the chart. Default is true.
{Boolean|Object} animation: Optional. Whether to apply animation, and optionally animation configuration. Default is true.

Returns:: {void}

<static> {void} render()

Renders the graph of this series and its markers. This example renders the graph of myClientSeries to the chart:

	myClientSeries.render( );

Returns:: {void}

<static> {void} select(selected)

Selects this series. This example selects myClientSeries:

	myClientSeries.select(true);

Parameters:
{boolean} selected: Optional. Specifies whether to select or deselect the series. If undefined, toggles selection.

Returns:: {void}

<static> {void} setData(data, redraw)

Replaces the series data with a new set of data. This example replaces the points in myClientSeries with three new points:

	myClientSeries.setData([[4, 2], [6, 3], [8, 2]]);

Parameters:

{float[ ]|Object[ ]} data

An array of data points for the series. The points can be given in three ways:

A list of numerical values, which are assigned as Y values, paired with X values starting with 0 and incrementing by 1 for each additional number. For example:
```
[0, 5, 3, 5]
```
A list of arrays with two values, which are assigned as X and Y value pairs. If the first value is a string, it is applied as the name of the point, and the x value is incremented following the above rules. For example:
```
[[4, 2], [6, 3], [8, 2]]
```
A list of objects with named values, which are assigned to points using the Highchart point configuration specification options.point. For example:
```
[{	name: 'Point 1',
	color: '#00FF00',
	y: 0
}, 
{	name: 'Point 2',
	color: '#FF00FF',
	y: 5
}]
```

{boolean} redraw

Optional. Specifies whether to redraw the chart. Default is true.

Returns:: {void}

<static> {void} setVisible(vis, redraw)

Sets the visibility of this series. This example sets myClientSeries to visible and redraws it:

	myClientSeries.setVisible(true);

Parameters:
{boolean} vis: Optional. Specifies whether to display the series. True displays the series, false hides it. If no value is provided, the visibility changes to false if visibility is true, and true if visibility is false.
{boolean} redraw: Optional. Specifies whether to redraw the chart. Default is true.

Returns:: {void}

<static> {void} show()

Displays the graph of this series. This example displays the graph of myClientSeries:

	myClientSeries.show( );

Returns:: {void}

Classes

Class actuate.report.HTML5Chart.ClientSeries