Class actuate.report.HTML5Chart.ClientPoint
Description
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 at the following URL:
http://www.actuate.com/documentation/R11SP4/actuatebirt/highcharts/Highcharts-Options-Reference.htm
Constructor
Syntax
void actuate.report.HTML5Chart.ClientPoint( )
Generates a new ClientPoint object to manage a data point for a ClientChart.
Function summary
Table 44‑32 lists actuate.report.HTML5Chart.ClientPoint functions.
Table 44‑32 actuate.report.HTML5Chart.ClientPoint functions
Function
Description
applyOptions( )
Changes the point values or options
destroy( )
Destroys a point to clear memory
remove( )
Removes a point
select( )
Toggles the selection of a point
update( )
Updates the point with new options
applyOptions
Syntax
void ClientPoint.applyOptions({float | object} options)
Applies the options containing the x and y data and possibly some extra properties. This is called on point initialization or from point.update.
Parameter
options
Float, array of float, or object. 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.
Example
This example changes the Y value of myClientPoint to 12:
myClientPoint.applyOptions(12);
destroy
Syntax
void ClientPoint.destroy( )
Destroys a point to clear memory. Its reference still stays in series.data.
Example
This example destroys the options and values for myClientPoint:
myClientPoint.destroy( );
remove
Syntax
void ClientPoint.remove(boolean redraw, {boolean | object} animation)
Removes this point and optionally redraws the series and axes.
Parameters
redraw
Boolean. Optional. Specifies whether to redraw the chart. Default is true.
animation
Boolean or object. Optional. Whether to apply animation, and optionally animation configuration. Default is true.
Example
This example removes myClientPoint from a series, and redraws the chart with animation to display the changed series:
myClientPoint.remove( );
select
Syntax
void ClientPoint.select(boolean selected, boolean accumulate)
Selects this point.
Parameters
selected
Boolean. Specifies whether to select or deselect the point.
accumulate
Boolean. Whether to add this point to the previous selection. By default, this is true when the Ctrl (PC) or Cmd (Macintosh) key is held during selection.
Example
This example selects MyClientPoint and deselects all other points:
myClientPoint.select(true, false);
update
Syntax
void ClientPoint.update({float|float[ ]|object} options, boolean redraw, {boolean | object} animation)
Updates this point and optionally redraws the series and axes.
Parameters
options
Float, array of float, or object. 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.
redraw
Boolean. Optional. Specifies whether to redraw the chart. Default is true.
animation
Boolean or object. Optional. Whether to apply animation, and optionally animation configuration. Default is true.
Example
This example updates myClientPoint with an X value of 1 and a Y value of 12, then redraws the point:
myClientPoint.update([1,12]);