Class actuate.report.HTML5Chart.ClientOption
A container for a ClientOption element in a report. ClientOption provides functions to change actuate.report.HTML5Chart.ClientChart features, such as orientation, type, and title.
Member of: actuate.report.HTML5Chart.
Constructor Attributes | Constructor Name and Description |
---|---|
Generates a new ClientOption object to manage the chart options for a actuate.report.HTML5Chart.ClientChart.
|
Method Attributes | Method Name and Description |
---|---|
<static> |
addSeries(seriesName, values)
Adds a data series to this ClientChart.
|
<static> |
explodePieSlice(categoryName, sliced)
Explodes the specified pie chart's slice by category.
|
<static> |
Returns whether this chart has axes.
|
<static> |
Switches the axes of the chart, if the chart has axes.
|
<static> |
setChartType(chartType, isCurve)
Sets the chart type in this ClientOption.
|
<static> |
setSeriesVisible(seriesName, visible)
Makes a series visible.
|
<static> |
setTitle(title)
Sets the title of this ClientChart.
|
<static> |
setXAxisTitle(title)
Sets the X-axis title of this ClientOption.
|
<static> |
setYAxisTitle(title, axisIndex)
Sets the Y-axis title of this ClientOption.
|
Class Detail
actuate.report.HTML5Chart.ClientOption()
Generates a new ClientOption object to manage the chart options for a actuate.report.HTML5Chart.ClientChart.
Method Detail
<static>
{void} addSeries(seriesName, values)
Adds a data series to this ClientChart. This example adds the monthly revenue series as an array of numbers:
myClientOption.addSeries('monthly revenue', [1,5.5, 2,4.5, 3,7.8, 4,7.7, 5,1.2, 6,8.5 7,1.9, 8,4.5, 9,12, 10,9.1, 11,4, 12,6.6]);
- Parameters:
- {String} seriesName
- A name for the series.
- {Array} values
- The values for the series, defining X and Y value pairs.
- Returns:
- {void}
<static>
{void} explodePieSlice(categoryName, sliced)
Explodes the specified pie chart's slice by category. This example explodes the Q1 category from a chart with myClientOption:
myClientOption.explodePieSlice('Q1');
- Parameters:
- {String} categoryName
- The name of a category.
- {Boolean} sliced
- Optional. True means the chart is sliced. Default is true.
- Returns:
- {void}
<static>
{Boolean} isChartWithAxes()
Returns whether this chart has axes. This example displays whether myClientOption has axes:
alert("Chart has axes: " + myClientOption.isChartWithAxes( ));
- Returns:
- {Boolean} True indicates axes, false otherwise.
<static>
{void} pivotChart()
Switches the axes of the chart, if the chart has axes. This example switches the axes in myClientOption and then redraws myClientChart with the switched axes:
var myClientOption = myClientChart.getClientOption( ) myClientOption.pivotChart( ); myClientChart.redraw(myClientOption);
- Returns:
- {void}
<static>
{void} setChartType(chartType, isCurve)
Sets the chart type in this ClientOption. This example changes the chart type to pie in myClientOption:
myClientOption.setChartType('pie');
- Parameters:
- {string} chartType
- The chart type. Valid values are line, area, bar, scatter, and pie.
- {boolean} isCurve
- Optional. Indicates if line or area chart is curve. Default value is false.
- Returns:
- {void}
<static>
{void} setSeriesVisible(seriesName, visible)
Makes a series visible. This example sets the series monthly revenue as visible for myClientOption:
myClientOption.setSeriesVisible('monthly revenue', true);
- Parameters:
- {String} seriesName
- The name of the series to change.
- {Boolean} visible
- Optional. Default is true.
- Returns:
- {void}
<static>
{void} setTitle(title)
Sets the title of this ClientChart. This example sets the title of myClientOption to 'Annual Report':
myClientOption.setTitle('Annual Report');
- Parameters:
- {String} title
- Chart title text.
- Returns:
- {void}
<static>
{void} setXAxisTitle(title)
Sets the X-axis title of this ClientOption. This example sets the title of the X-axis in myClientOption to 'Month':
myClientOption.setXAxisTitle('Month');
- Parameters:
- {String} title
- X-axis title text.
- Returns:
- {void}
<static>
{void} setYAxisTitle(title, axisIndex)
Sets the Y-axis title of this ClientOption. This example sets the title of the Y-axis in myClientOption to 'Dollars, in millions':
myClientOption.setYAxisTitle('Dollars, in millions');
- Parameters:
- {String} title
- Y-axis title text.
- {integer} axisIndex
- Optional. Axis index. The minimum value is 0, which is the default value, indicating the first Axis.
- Returns:
- {void}