Class actuate.xtabanalyzer.Crosstab

The Crosstab class represents a report crosstab element.
Member of: actuate.xtabanalyzer.

Class Summary
Constructor Attributes	Constructor Name and Description
	actuate.xtabanalyzer.Crosstab() The Crosstab class represents a report crosstab element.

Field Summary
Field Attributes	Field Name and Description
<static> <constant>	TYPE Crosstab element type name.

Method Summary
Method Attributes	Method Name and Description
	addDimension(dimension) Add Dimension
	addMeasure(measure, opts) Add Measure
	applyOptions(measureDirection, rowMirrorStartingLevel, columnMirrorStartingLevel, emptyCellValue, grandTotalsDisplayOption, subtotalsDisplayOption) Sets options: measure direction, row mirror starting level, column mirror starting level and empty cell value.
	changeMeasureDirection() Switch Measure direction.
	clearFilters(level, filterType) Clears the filters
	drill(driller) Drill dimension level.
	drillDown(driller) Drill down dimension level.
	drillUp(driller) Drill up dimension level.
	editMeasure(measure, opts) Edit Measure(Only useful for Computed Measure View)
	getBookmark() Returns the report element bookmark name.
	getColumn(columnIndex) Returns the crosstab data by column index The returned data is only the data from the current visible page and maybe not accurate.
	getData(forceReparse) Returns the crosstab data.
	getHtmlDom() Returns the HTML element DOM object.
	getPageContent() Returns the page content to which this element belongs.
	getRow(rowIndex) Returns the crosstab data by row index.
	getType() Returns the report element type.
	hideDetail(levelName) Hide detail of the specified level.
	hideLevelHeader(axisType) Hide level header.
	pivot() Pivot
	removeDimension(dimension, axisType, levels) Remove Dimension
	removeMeasure(measure) Remove Measure
	reorderDimension(dimension, axisType, newIndex, newAxisType) Reorder Dimension
	reorderMeasure(measure, newIndex) Reorder Measure
	setFilters(filters) Sets the given filters.
	setSorters(sorters) Sets the given sorters.
	setTotals(grandTotals, subTotals) Set totals
	showDetail(levelName) Show detail to the lower level.
	showLevelHeader(axisType) Show level header.
	submit(callback) Applies the changes made to this element.

Class Detail

actuate.xtabanalyzer.Crosstab()

The Crosstab class represents a report crosstab element.

Field Detail

<static> <constant> {String} TYPE

Crosstab element type name.

Method Detail

addDimension(dimension)

Add Dimension

Parameters:
{Object or String} dimension: Dimension object

See:: actuate.xtabanalyzer.Dimension

addMeasure(measure, opts)

Add Measure

Parameters:
{Object} measure: Measure object
{Object} opts: options for add measure operation, used to distinguish the function call from computedDlg or directly call from JSAPI.

See:: actuate.xtabanalyzer.Measure

applyOptions(measureDirection, rowMirrorStartingLevel, columnMirrorStartingLevel, emptyCellValue, grandTotalsDisplayOption, subtotalsDisplayOption)

Sets options: measure direction, row mirror starting level, column mirror starting level and empty cell value.

Parameters:
{String or Options object} measureDirection
{string} rowMirrorStartingLevel
{string} columnMirrorStartingLevel
{string} emptyCellValue
{string} grandTotalsDisplayOption
{string} subtotalsDisplayOption

See:: actuate.xtabanalyzer.Options

changeMeasureDirection()

Switch Measure direction.

clearFilters(level, filterType)

Clears the filters

Parameters:
{Object or String} level: Level name or level object.
{String} filterType: The filter type

See:: actuate.xtabanalyzer.Level

drill(driller)

Drill dimension level. This operation will remove all drill/filter conditions defined on specified dimension first, then add new drill/filter conditions.

Parameters:
{Object} driller: Drill condition object

See:: actuate.xtabanalyzer.Driller

drillDown(driller)

Drill down dimension level. This operation doesn't overwrite old drill conditions and will update related drill conditions.

Parameters:
{Object} driller: Drill condition object

See:: actuate.xtabanalyzer.Driller

drillUp(driller)

Drill up dimension level. This operation doesn't overwrite old drill conditions and will update related drill conditions.

Parameters:
{Object} driller: Drill condition object

See:: actuate.xtabanalyzer.Driller

editMeasure(measure, opts)

Edit Measure(Only useful for Computed Measure View)

Parameters:
{Object} measure: Measure object
{Object} opts: options for edit measure operation, used to distinguish the function call from computedDlg or directly call from JSAPI.

See:: actuate.xtabanalyzer.Measure

{String} getBookmark()

Returns the report element bookmark name.

Returns:: {String} report element bookmark name

{Array} getColumn(columnIndex)

Returns the crosstab data by column index The returned data is only the data from the current visible page and maybe not accurate.

Parameters:
{int} columnIndex: column index, starting with 1

Returns:: {Array} array of string values or null if columnIndex is out of range

{Array} getData(forceReparse)

Returns the crosstab data.

Parameters:
{boolean} forceReparse: boolean, if true, forces refreshing the cache

Returns:: {Array} array of string values

{HTMLElement} getHtmlDom()

Returns the HTML element DOM object.

Returns:: {HTMLElement} HTML DOM element

{actuate.xtabanalyzer.PageContent} getPageContent()

Returns the page content to which this element belongs.

Returns:: {actuate.xtabanalyzer.PageContent} report content

{Array} getRow(rowIndex)

Returns the crosstab data by row index. The returned data is only the data from the current visible page and maybe not accurate.

Parameters:
{int} rowIndex: row index starting with 1

Returns:: {Array} array of string values or null if rowIndex out of range

{String} getType()

Returns the report element type.

Returns:: {String} Crosstab type

hideDetail(levelName)

Hide detail of the specified level.

Parameters:
{String} levelName: The dimension level full name

hideLevelHeader(axisType)

Hide level header. If no axis type specified, it means hide all level headers both row level and column level.

Parameters:
{Integer} axisType: The axis type of dimension

pivot()

Pivot

removeDimension(dimension, axisType, levels)

Remove Dimension

Parameters:
{Object or Integer or String} dimension: Dimension object/Dimension Index/Dimension Name
{Integer} axisType: The axis type of dimension
{Array} levels: Level object array/Level Index array/Level Name array

See:: actuate.xtabanalyzer.Dimension

removeMeasure(measure)

Remove Measure

Parameters:
{Object or Integer or String} measure: Measure object/Measure Index/Measure Name

See:: actuate.xtabanalyzer.Measure

reorderDimension(dimension, axisType, newIndex, newAxisType)

Reorder Dimension

Parameters:
{Object or Integer or String} dimension: Dimension object or dimension index or dimension name
{Integer} axisType: Axis type
{Integer} newIndex: New dimension index
{Integer} newAxisType: New Axis type

See:: actuate.xtabanalyzer.Dimension

reorderMeasure(measure, newIndex)

Reorder Measure

Parameters:
{Object or Integer or String} measure: Measure object/Measure Index/Measure Name
{Integer} newIndex: new measure index

See:: actuate.xtabanalyzer.Measure

setFilters(filters)

Sets the given filters.

Parameters:
{Array} filters: array of actuate.xtabanalyzer.Filter instances.

See:: actuate.xtabanalyzer.Filter

setSorters(sorters)

Sets the given sorters.

Parameters:
{Array} sorters: array of actuate.xtabanalyzer.Sorter instances

See:: actuate.xtabanalyzer.Sorter

setTotals(grandTotals, subTotals)

Set totals

Parameters:
{Array} grandTotals: array of actuate.xtabanalyzer.GrandTotal instances.
{Array} subTotals: array of actuate.xtabanalyzer.SubTotal instances.

See:: actuate.xtabanalyzer.GrandTotal; actuate.xtabanalyzer.SubTotal

showDetail(levelName)

Show detail to the lower level.

Parameters:
{String} levelName: The dimension level full name

showLevelHeader(axisType)

Show level header. If no axis type specified, it means show all level headers both row level and column level.

Parameters:
{Integer} axisType: The axis type of dimension

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.

Classes

Class actuate.xtabanalyzer.Crosstab