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.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Generates a new ClientPoint object to manage a data point for a actuate.report.HTML5Chart.ClientChart.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
applyOptions(options)
Applies the options containing the x and y data and possibly some extra properties.
|
| <static> |
destroy()
Destroys a point to clear memory.
|
| <static> |
remove(redraw, animation)
Removes this point and optionally redraws the series and axes.
|
| <static> |
select(selected, accumulate)
Selects this point.
|
| <static> |
update(options, redraw, animation)
Updates this point and optionally redraws the series and axes.
|
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>
{void} applyOptions(options)
Applies the options containing the x and y data and possibly some extra properties. This is called on point initialization or from #update. This example changes the Y value of myClientPoint to 12:
myClientPoint.applyOptions(12);
- Parameters:
- {float|float[ ]|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.
- Returns:
- {void}
<static>
{void} destroy()
Destroys a point to clear memory. Its reference still stays in series.data. This example destroys the options and values for myClientPoint:
myClientPoint.destroy( );
- Returns:
- {void}
<static>
{void} remove(redraw, animation)
Removes this point and optionally redraws the series and axes. This example removes myClientPoint and redraws the chart:
myClientPoint.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} select(selected, accumulate)
Selects this point. This example selects MyClientPoint and deselects all other points:
myClientPoint.select(true, false);
- Parameters:
- {Boolean} selected
- Specifies whether to select or deselect the point.
- {Boolean} accumulate
- 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.
- Returns:
- {void}
<static>
{void} update(options, redraw, animation)
Updates this point and optionally redraws the series and axes. This example updates myClientPoint with an X value of 1 and a Y value of 12, then redraws the point:
myClientPoint.update([1,12]);
- Parameters:
- {Object} options
- Point 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|Object} animation
- Optional. Whether to apply animation, and optionally animation configuration. Default is true.
- Returns:
- {void}