com.flexmonster.pivot.FlexPivotComponent

	Property	Defined by
		autoCollapse : Boolean [write-only] If `true` headers are auto collapsed at start The default value is `false`.	FlexPivotComponent
		autoLoad : Boolean If `true` Pivot autoloads the data.	FlexPivotComponent
		catalog : String [write-only] Catalog name from the dataSource Note: only for OLAP dataSourceType	FlexPivotComponent
		chartsActive : Boolean [write-only] If `true` Pivot charts are shown at start The default value is `false`.	FlexPivotComponent
		chartsEnabled : Boolean [write-only] If `true` Pivot charts are enabled to view via Charts button The default value is `false`.	FlexPivotComponent
		columns : String [write-only] You can create a predefined report via configuration; define columns, rows, pages and values to get exact data you need immediately after the Pivot Table is opened.	FlexPivotComponent
		configuratorActive : Boolean [write-only] If `true` Configurator is opened at start.	FlexPivotComponent
		configuratorEnabled : Boolean [write-only] If `true` Configurator is enabeled and disabeled if `false`.	FlexPivotComponent
		configUrl : String [write-only] Url of configuration XML file.	FlexPivotComponent
		cube : String [write-only] Cube name from the given catalog Note: only for OLAP dataSourceType	FlexPivotComponent
		dataSource : String [write-only] Microsoft Analysis Services info Note: only for OLAP dataSourceType	FlexPivotComponent
		dataSourceType : String [write-only] Data source configuration Possible values: CSV OLAP	FlexPivotComponent
		excelLikeHeader : Boolean [write-only]	FlexPivotComponent
		expandAllEnabled : Boolean [write-only]	FlexPivotComponent
		fieldSeparator : String [write-only] Seperator for dataset in CSV data source type The default value is `,`(Comma).	FlexPivotComponent
		filename : String [write-only] Path to CSV file Note: only for CSV dataSourceType	FlexPivotComponent
		fullScreenEnabled : Boolean [write-only] If `true` application can be viewed in fullscreen mode.	FlexPivotComponent
		measures : String [write-only] You can create a predefined report via configuration; define columns, rows, and values to get exact data you need immediately after the Pivot Table is opened.	FlexPivotComponent
		pages : String [write-only] You can create a predefined report via configuration; define columns, rows, pages and values to get exact data you need immediately after the Pivot Table is opened.	FlexPivotComponent
		pivotCreationCompleted : Boolean [read-only] If `true` Pivot Component is ready to receive data (methods addDimension, addHierarchy, addMeasure, report)	FlexPivotComponent
		printEnabled : Boolean [write-only] If `true` print feature is enabled and Pivot grid can be printed The default value is `true`.	FlexPivotComponent
		proxyUrl : String [write-only] ProxyURL — the URL to msmdpump.dll Note: only for OLAP dataSourceType	FlexPivotComponent
		rows : String [write-only] You can create a predefined report via configuration; define columns, rows, pages and values to get exact data you need immediately after the Pivot Table is opened.	FlexPivotComponent
		styleSheetName : String [write-only] Url of CSS file Skins and visual appearance can be controlled with easy-to-edit CSS and images.	FlexPivotComponent
		zoomEnabled : Boolean [write-only] If `true` Pivot grid can be zoomed.	FlexPivotComponent

	Method	Defined by
		addDataRecord(object:Object):void Dynamically add data record to data source	FlexPivotComponent
		addDimension(uniqueName:String, caption:String):void Dynamically add Dimension to data source	FlexPivotComponent
		addHierarchy(dimensionUniqueName:String, uniqueName:String, caption:String):void Dynamically add Hierarchy to Dimension in data source	FlexPivotComponent
		addMeasure(uniqueName:String, caption:String):void Dynamically add Measure to data source	FlexPivotComponent
		currentReport():ReportValueObject	FlexPivotComponent
		getCell(rowIdx:int, colIdx:int):IGridCellRenderer Get cell object by row and column indexes	FlexPivotComponent
		getValue(rowIdx:int, colIdx:int):Number Get cell value by row and column indexes	FlexPivotComponent
		load():void Loading data	FlexPivotComponent
		report(reportVO:ReportValueObject):void You can create a predefined report after dynamically added data define columns, rows, and measures to get exact data you need after data update.	FlexPivotComponent
		updatePreloader(show:Boolean = true, message:String = "", detales:String = ""):void Set preloader properties	FlexPivotComponent

	Event	Summary	Defined by
		pivotCreationComplete	Dispatched when pivot is created and is ready to recieve data	FlexPivotComponent
		skinComplete	Dispatched when skin files (.css and images) are loaded	FlexPivotComponent

Property detail

autoCollapse

property

autoCollapse:Boolean [write-only]

If true headers are auto collapsed at start

The default value is false.

Implementation
public function set autoCollapse(value:Boolean):void

autoLoad

property

autoLoad:Boolean [read-write]

If true Pivot autoloads the data.

Implementation
public function get autoLoad():Boolean
public function set autoLoad(value:Boolean):void

catalog

property

catalog:String [write-only]

Catalog name from the dataSource
Note: only for OLAP dataSourceType

Implementation
public function set catalog(value:String):void

See also

dataSourceType
dataSource
cube
proxyUrl

Example

   <fm:PivotComponent
       dataSourceType = "OLAP"
       dataSource = "Provider=MSOLAP; Data Source=extranet;"
       catalog = "Adventure Works DW Standard Edition"
       cube = "Adventure Works"
       proxyUrl = "http://10.14.2.102/olap/msmdpump.dll"/>

chartsActive

property

chartsActive:Boolean [write-only]

If true Pivot charts are shown at start

The default value is false.

Implementation
public function set chartsActive(value:Boolean):void

chartsEnabled

property

chartsEnabled:Boolean [write-only]

If true Pivot charts are enabled to view via Charts button

The default value is false.

Implementation
public function set chartsEnabled(value:Boolean):void

columns

property

columns:String [write-only]

You can create a predefined report via configuration; define columns, rows, pages and values to get exact data you need immediately after the Pivot Table is opened.

You can add to columns as much fields as you like, seperate it commas

Implementation
public function set columns(value:String):void

See also

rows
measures

Example

   <fm:PivotComponent
       ...
       columns = "[Category].[Category], [Geography].[Country]"/>

configuratorActive

property

configuratorActive:Boolean [write-only]

If true Configurator is opened at start.

The default value is true.

Implementation
public function set configuratorActive(value:Boolean):void

configuratorEnabled

property

configuratorEnabled:Boolean [write-only]

If true Configurator is enabeled and disabeled if false.

The default value is true.

Implementation
public function set configuratorEnabled(value:Boolean):void

configUrl

property

configUrl:String [write-only]

Url of configuration XML file.

Note: If after setting this parameter, Flex Pivot Component ignores other data sources

Implementation
public function set configUrl(value:String):void

Example

<fm:PivotComponent configUrl = "config.xml" />

cube

property

cube:String [write-only]

Cube name from the given catalog
Note: only for OLAP dataSourceType

Implementation
public function set cube(value:String):void

Example

   <fm:PivotComponent
       dataSourceType = "OLAP"
       dataSource = "Provider=MSOLAP; Data Source=extranet;"
       catalog = "Adventure Works DW Standard Edition"
       cube = "Adventure Works"
       proxyUrl = "http://10.14.2.102/olap/msmdpump.dll"/>

dataSource

property

dataSource:String [write-only]

Microsoft Analysis Services info
Note: only for OLAP dataSourceType

Implementation
public function set dataSource(value:String):void

See also

dataSourceType
catalog
cube
proxyUrl

Example

   <fm:PivotComponent
       dataSourceType = "OLAP"
       dataSource = "Provider=MSOLAP; Data Source=extranet;"
       catalog = "Adventure Works DW Standard Edition"
       cube = "Adventure Works"
       proxyUrl = "http://10.14.2.102/olap/msmdpump.dll"/>

dataSourceType

property

dataSourceType:String [write-only]

Data source configuration

Possible values:

CSV
OLAP

Implementation
public function set dataSourceType(value:String):void

Example

   <fm:PivotComponent
       dataSourceType = "CSV"
       filename = "csvdata.csv/data.csv" />

   <fm:PivotComponent
       dataSourceType = "OLAP"
       dataSource = "Provider=MSOLAP; Data Source=extranet;"
       catalog = "Adventure Works DW Standard Edition"
       cube = "Adventure Works"
       proxyUrl = "http://10.14.2.102/olap/msmdpump.dll"/>

excelLikeHeader

property

excelLikeHeader:Boolean [write-only]

Implementation
public function set excelLikeHeader(value:Boolean):void

expandAllEnabled

property

expandAllEnabled:Boolean [write-only]

Implementation
public function set expandAllEnabled(value:Boolean):void

fieldSeparator

property

fieldSeparator:String [write-only]

Seperator for dataset in CSV data source type

The default value is ,(Comma).

Implementation
public function set fieldSeparator(value:String):void

See also

dataSourceType

filename

property

filename:String [write-only]

Path to CSV file

Note: only for CSV dataSourceType

Implementation
public function set filename(value:String):void

See also

dataSourceType

Example

   <fm:PivotComponent
       dataSourceType = "CSV"
       filename = "csvdata.csv/data.csv"/>

fullScreenEnabled

property

fullScreenEnabled:Boolean [write-only]

If true application can be viewed in fullscreen mode.

The default value is true.

Implementation
public function set fullScreenEnabled(value:Boolean):void

measures

property

measures:String [write-only]

You can create a predefined report via configuration; define columns, rows, and values to get exact data you need immediately after the Pivot Table is opened.

Define which values you would like to be shown on the predefined report. You can add several values, seperated commas.

Implementation
public function set measures(value:String):void

See also

rows
columns

Example

   <fm:PivotComponent
       ...
       measures = "[Measures].[Price], [Measures].[Quantity]"/>

pages

property

pages:String [write-only]

You can create a predefined report via configuration; define columns, rows, pages and values to get exact data you need immediately after the Pivot Table is opened.

You can add to pages as much fields as you like, seperate it commas

Implementation
public function set pages(value:String):void

See also

rows
measures

Example

   <fm:PivotComponent
       ...
       pages = "[Destination].[Country], [Geography].[City]"/>

pivotCreationCompleted

property

pivotCreationCompleted:Boolean [read-only]

If true Pivot Component is ready to receive data (methods addDimension, addHierarchy, addMeasure, report)

Implementation
public function get pivotCreationCompleted():Boolean

printEnabled

property

printEnabled:Boolean [write-only]

If true print feature is enabled and Pivot grid can be printed

The default value is true.

Implementation
public function set printEnabled(value:Boolean):void

proxyUrl

property

proxyUrl:String [write-only]

ProxyURL — the URL to msmdpump.dll
Note: only for OLAP dataSourceType

Implementation
public function set proxyUrl(value:String):void

See also

dataSourceType
dataSource
catalog
cube

Example

   <fm:PivotComponent
       dataSourceType = "OLAP"
       dataSource = "Provider=MSOLAP; Data Source=extranet;"
       catalog = "Adventure Works DW Standard Edition"
       cube = "Adventure Works"
       proxyUrl = "http://10.14.2.102/olap/msmdpump.dll"/>

rows

property

rows:String [write-only]

You can create a predefined report via configuration; define columns, rows, pages and values to get exact data you need immediately after the Pivot Table is opened.

You can add to rows as much fields as you like, seperate it commas

Implementation
public function set rows(value:String):void

See also

columns
measures

Example

   <fm:PivotComponent
       ...
       rows = "[Geography].[Country], [Color].[Color]"/>

styleSheetName

property

styleSheetName:String [write-only]

Url of CSS file

Skins and visual appearance can be controlled with easy-to-edit CSS and images.

Implementation
public function set styleSheetName(value:String):void

zoomEnabled

property

zoomEnabled:Boolean [write-only]

If true Pivot grid can be zoomed.

The default value is true.

Implementation
public function set zoomEnabled(value:Boolean):void

Method detail

addDataRecord

()

method

public function addDataRecord(object:Object):void

Dynamically add data record to data source

Parameters

object:Object — Data record

Example

   var dataRecord:Object = {"[Country].[Country]": "Australia", "[Product].[Color]": "red", "[Product].[Category]": "Car", "[Measures].[Price]": 123};
   pivot.addDataRecord(dataRecord);

addDimension

()

method

public function addDimension(uniqueName:String, caption:String):void

Dynamically add Dimension to data source

Parameters

	`uniqueName:String` — Dimension unique name

	`caption:String` — Dimension caption

addHierarchy

()

method

public function addHierarchy(dimensionUniqueName:String, uniqueName:String, caption:String):void

Dynamically add Hierarchy to Dimension in data source

Parameters

	`dimensionUniqueName:String` — Dimension unique name for adding Hierarchy. If there is no Dimension with such unique name, error is thrown.

	`uniqueName:String` — Hierarchy unique name

	`caption:String` — Hierarchy caption

addMeasure

()

method

public function addMeasure(uniqueName:String, caption:String):void

Dynamically add Measure to data source

Parameters

	`uniqueName:String` — Measure unique name

	`caption:String` — Measure caption

currentReport

()

method

public function currentReport():ReportValueObject

Returns

ReportValueObject

getCell

()

method

public function getCell(rowIdx:int, colIdx:int):IGridCellRenderer

Get cell object by row and column indexes

Parameters

	`rowIdx:int` — Row index

	`colIdx:int` — Column index

Returns

IGridCellRenderer — IGridCellRenderer object

getValue

()

method

public function getValue(rowIdx:int, colIdx:int):Number

Get cell value by row and column indexes

Parameters

	`rowIdx:int` — Row index

	`colIdx:int` — Column index

Returns

Number — Cell value

load

()

method

public function load():void

Loading data

report

()

method

public function report(reportVO:ReportValueObject):void

You can create a predefined report after dynamically added data define columns, rows, and measures to get exact data you need after data update.

Parameters

reportVO:ReportValueObject — Array of rows values

Example

   var reportVO:ReportValueObject = new ReportValueObject();
   reportVO.rows = ["[Country].[Country]", "[Product].[Category]"];
   reportVO.columns = ["[Product].[Color]"];
   reportVO.pages = ["[Product].[Size]"];
   reportVO.measures = ["[Measures].[Price]"];
   pivot.report = reportVO;

updatePreloader

()

method

public function updatePreloader(show:Boolean = true, message:String = "", detales:String = ""):void

Set preloader properties

Parameters

	`show:Boolean` (default = `true`) — If `true`, show preloader

	`message:String` (default = "") — Preloader message

	`detales:String` (default = "") — Preloader detales, goes under message with smaller font

Event detail

pivotCreationComplete

event

Dispatched when pivot is created and is ready to recieve data

skinComplete

event

Dispatched when skin files (.css and images) are loaded

Flex Pivot API	All Packages \| All Classes \| Index \| Frames No Frames
Class FlexPivotComponent	Properties \| Methods \| Events

Package	com.flexmonster.pivot
Class	public class FlexPivotComponent
Inheritance	FlexPivotComponent mx.flash.UIMovieClip