Classes


Class actuate.viewer.Chart

The chart class represents a report chart.
Member of: actuate.viewer.

Class Summary
Constructor Attributes Constructor Name and Description
 
The Chart class represents a report chart.
Field Summary
Field Attributes Field Name and Description
<static> <constant>  
Chart element type name
<static> <constant>  
Chart dimension 2D.
<static> <constant>  
Chart dimension 2D with depth.
<static> <constant>  
Chart dimension 3D.
<static> <constant>  
Chart subtype percent stacked.
<static> <constant>  
Chart subtype side-by-side.
<static> <constant>  
Chart subtype stacked.
<static> <constant>  
Aera chart subtype.
<static> <constant>  
Bar chart subtype.
<static> <constant>  
Bubble chart subtype.
<static> <constant>  
Cone chart subtype.
<static> <constant>  
Difference chart subtype.
<static> <constant>  
Gantt chart subtype.
<static> <constant>  
Line chart subtype.
<static> <constant>  
Meter chart subtype.
<static> <constant>  
Pie chart subtype.
<static> <constant>  
Pyramid chart subtype.
<static> <constant>  
Scatter chart subtype.
<static> <constant>  
Stock chart subtype.
<static> <constant>  
Tube chart subtype.
<static> <constant>  
Flash chart element type name
<static> <constant>  
Chart element type name.
Method Summary
Method Attributes Method Name and Description
 
clearFilters(columnName)
Clears the filters of a given column
 
Returns the report element bookmark name.
 
Returns the HTML element DOM object.
 
Returns the page content to which this element belongs.
 
Returns the report element type.
 
Specify the title for the Chart element
 
setDimension(dimension)
Specify the dimension for the Chart element
 
setFilters(filters)
Sets the given filters.
 
setSubType(chartType)
Specify the chart subtype for the Chart element
 
submit(callback)
Applies the changes made to this element.
Class Detail
actuate.viewer.Chart()
The Chart class represents a report chart.
Field Detail
<static> <constant> {String} CHART
Chart element type name
See:
actuate.viewer.Chart.getType()

<static> <constant> {String} CHART_DIMENSION_2D
Chart dimension 2D.

<static> <constant> {String} CHART_DIMENSION_2D_WITH_DEPTH
Chart dimension 2D with depth.

<static> <constant> {String} CHART_DIMENSION_3D
Chart dimension 3D.

<static> <constant> {String} CHART_SUBTYPE_PERCENTSTACKED
Chart subtype percent stacked.

<static> <constant> {String} CHART_SUBTYPE_SIDEBYSIDE
Chart subtype side-by-side.

<static> <constant> {String} CHART_SUBTYPE_STACKED
Chart subtype stacked.

<static> <constant> {String} CHART_TYPE_AREA
Aera chart subtype.

<static> <constant> {String} CHART_TYPE_BAR
Bar chart subtype.

<static> <constant> {String} CHART_TYPE_BUBBLE
Bubble chart subtype.

<static> <constant> {String} CHART_TYPE_CONE
Cone chart subtype.

<static> <constant> {String} CHART_TYPE_DIFFERENCE
Difference chart subtype.

<static> <constant> {String} CHART_TYPE_GANTT
Gantt chart subtype.

<static> <constant> {String} CHART_TYPE_LINE
Line chart subtype.

<static> <constant> {String} CHART_TYPE_METER
Meter chart subtype.

<static> <constant> {String} CHART_TYPE_PIE
Pie chart subtype.

<static> <constant> {String} CHART_TYPE_PYRAMID
Pyramid chart subtype.

<static> <constant> {String} CHART_TYPE_SCATTER
Scatter chart subtype.

<static> <constant> {String} CHART_TYPE_STOCK
Stock chart subtype.

<static> <constant> {String} CHART_TYPE_TUBE
Tube chart subtype.

<static> <constant> {String} FLASH_CHART
Flash chart element type name
See:
actuate.viewer.Chart.getType()

<static> <constant> {String} TYPE
Chart element type name.
Method Detail
clearFilters(columnName)
Clears the filters of a given column
Parameters:
{String} columnName
column name

{String} getBookmark()
Returns the report element bookmark name.
Returns:
{String} report element bookmark name

{HTMLElement} getHtmlDom()
Returns the HTML element DOM object.
Returns:
{HTMLElement} HTML DOM element

{actuate.viewer.PageContent} getPageContent()
Returns the page content to which this element belongs.
Returns:
{actuate.viewer.PageContent} report content

{String} getType()
Returns the report element type.
Returns:
{String} either actuate.viewer.Chart.CHART or actuate.viewer.Chart.FLASH_CHART according to the chart type.
See:
actuate.viewer.Chart.CHART
actuate.viewer.Chart.FLASH_CHART

setChartTitle(title)
Specify the title for the Chart element
Parameters:
{String} title
the title for this chart element

setDimension(dimension)
Specify the dimension for the Chart element
Parameters:
{String} dimension
supported dimension: 2D, 2D with Depth, 3D. See constants.

setFilters(filters)
Sets the given filters.
Parameters:
{Array} filters
array of actuate.data.Filter instances

setSubType(chartType)
Specify the chart subtype for the Chart element
Parameters:
{String} chartType
the chart type. See constants.

submit(callback)
Applies the changes made to this element.
This is an asynchronous operation.
Parameters:
{Function} callback
an optional user-defined call back function that will be executed after the operation finished. The callback takes the current viewer instance as parameter.

Documentation generated by JsDoc Toolkit 2.0.1 on Tue Jan 19 2010 15:56:28 GMT-0800 (PST)