| Package | Top Level |
| Class | public class FlexPivotComponent |
| Inheritance | FlexPivotComponent  mx.containers.Canvas |
| Property | Defined By | ||
|---|---|---|---|
| autoLoad : Boolean [write-only] | FlexPivotComponent | ||
| binaryAssets : Object [write-only] | FlexPivotComponent | ||
| catalog : String [write-only]
The catalog property lets you define the data source catalog name of the OLAP data source, such as Mondrian or Microsoft Analysis Services. | FlexPivotComponent | ||
| chartTitle : String [write-only]
The chartTitle property lets you set the title for charts. | FlexPivotComponent | ||
| chartType : String [write-only]
The chartType property lets you define the chart type. | FlexPivotComponent | ||
| columnDecimals : Boolean [write-only]
The columnDecimals property is one of the number formatting properties and it lets you define
whether the formatting should add extra zeros in end to complete number length (true) or not (false). | FlexPivotComponent | ||
| columns : * [write-only]
The columns property lets you set the columns data into your predefined report. | FlexPivotComponent | ||
| configuratorButton : Boolean [write-only] | FlexPivotComponent | ||
| configUrl : String [write-only]
The configUrl property lets you define a URL of the configuration XML file. | FlexPivotComponent | ||
| cube : String [write-only]
The cube property lets you define the cube name from the given catalog of the OLAP data source, such as Mondrian or Microsoft Analysis Services. | FlexPivotComponent | ||
| currencySymbol : String [write-only]
The currencySymbol property is one of the number formatting properties and it lets you define
the currency symbol. | FlexPivotComponent | ||
| currencySymbolAlign : String [write-only]
The currencySymbolAlign property is one of the number formatting properties and it lets you define
the currency symbol alignment. | FlexPivotComponent | ||
| dataSourceInfo : String [write-only]
The dataSourceInfo property lets you define the service info of the OLAP data source, such as Mondrian or Microsoft Analysis Services. | FlexPivotComponent | ||
| decimalPlaces : int [write-only]
The decimalPlaces property is one of the number formatting properties and it lets you define
the number of decimal places (the number of digits following the decimal separator). | FlexPivotComponent | ||
| decimalSeparator : String [write-only]
The decimalSeparator property is one of the number formatting properties and it lets you define
the decimal separator for data cell rendering. | FlexPivotComponent | ||
| editableHeaders : Boolean [write-only] | FlexPivotComponent | ||
| expandAll : Boolean [write-only]
The expandAll property defines whether to expand all rows and columns in a report or not. | FlexPivotComponent | ||
| fieldSeparator : String [write-only]
The fieldSeparator property lets you set the field separator for CSV (if your data source is CSV). | FlexPivotComponent | ||
| filename : String [write-only]
The filename property lets you set the path to CSV data source. | FlexPivotComponent | ||
| fitGridlines : Boolean [write-only] | FlexPivotComponent | ||
| gridColumnCount : int [read-only]
Returns the number of grid columns. | FlexPivotComponent | ||
| gridRowCount : int [read-only]
Returns the number of grid rows. | FlexPivotComponent | ||
| gridTitle : String [write-only]
The gridTitle property lets you set the title for grid. | FlexPivotComponent | ||
| infinityValue : String [write-only] | FlexPivotComponent | ||
| licenseFilePath : String [write-only]
The licenseFilePath property lets you define the path the TXT file with the license key. | FlexPivotComponent | ||
| localSettingsURL : String [write-only] | FlexPivotComponent | ||
| logoURL : String [write-only] | FlexPivotComponent | ||
| maxDecimalPlaces : int [write-only]
The maxDecimalPlaces property is one of the number formatting properties and it lets you define
the same as decimalPlaces, but shows no more digits, than specified and
adds no extra zeros in end to complete number length. | FlexPivotComponent | ||
| maxSymbols : int [write-only]
The maxSymbols property is one of the number formatting properties and it lets you define
the maximum number of symbols in cell. | FlexPivotComponent | ||
| measures : * [write-only]
The measures property lets you set the measures data into your predefined report. | FlexPivotComponent | ||
| nullValue : String [write-only] | FlexPivotComponent | ||
| pages : * [write-only]
The pages property lets you set the pages data into your predefined report. | FlexPivotComponent | ||
| percentZoom : Number [write-only]
Zooms Grid in percents. | FlexPivotComponent | ||
| productKey : String [write-only]
The productKey property lets you set the license key. | FlexPivotComponent | ||
| proxyUrl : String [write-only]
The proxyUrl property lets you define the proxy URL to the OLAP data source, such as Mondrian or Microsoft Analysis Services. | FlexPivotComponent | ||
| report : ReportValueObject
You can create a predefined report after dynamically added data
define ReportValueObject to get exact data you need after data update. | FlexPivotComponent | ||
| rows : * [write-only]
The rows property lets you set the rows data into your predefined report. | FlexPivotComponent | ||
| showAggregations : Boolean [write-only] | FlexPivotComponent | ||
| showChartZeroValues : Boolean [write-only] | FlexPivotComponent | ||
| showFieldsList : Boolean [write-only]
The showFieldsList property lets you define whether to show Fields List or hide it. | FlexPivotComponent | ||
| showFilter : Boolean [write-only] | FlexPivotComponent | ||
| showGrandTotals : Boolean [write-only] | FlexPivotComponent | ||
| showHeaders : Boolean [write-only] | FlexPivotComponent | ||
| showReportFilter : Boolean [write-only] | FlexPivotComponent | ||
| showTotals : Boolean [write-only] | FlexPivotComponent | ||
| sorting : Boolean [write-only]
The sorting property lets you enable or disable the data sorting feature. | FlexPivotComponent | ||
| styleSheetName : String [write-only]
The styleSheetName property lets you define the URL to CSS file to apply the skin. | FlexPivotComponent | ||
| swfFilePath : String [write-only]
The swfFilePath property lets you define the path to resource files, such as assets.swf, styles, skins etc. | FlexPivotComponent | ||
| thousandsSeparator : String [write-only]
The thousandsSeparator property is one of the number formatting properties and it lets you define
the thousands separator for data cell rendering. | FlexPivotComponent | ||
| viewType : String [write-only]
The viewType property lets you define the view type: show Pivot Grid or selected chart. | FlexPivotComponent | ||
| zoom : Number [write-only]
Zooms Grid
| FlexPivotComponent | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | FlexPivotComponent | ||
addDataArray(array:Array):void
Adds dynamically multiple data rows to the data source. | FlexPivotComponent | ||
addDataRecord(object:Object):void
Adds dynamically one data record to the data source. | FlexPivotComponent | ||
addDimension(uniqueName:String, caption:String):void
Adds dynamically Dimension to the data source. | FlexPivotComponent | ||
addFormat(format:FormatValueObject, measureName:String):void
deprecated
Use setFormat()
Sets the formatting for cells. | FlexPivotComponent | ||
addHierarchy(dimensionUniqueName:String, uniqueName:String, caption:String):void
Adds dynamically Hierarchy to Dimension in the data source. | FlexPivotComponent | ||
addMeasure(uniqueName:String, caption:String, aggregation:String, format:String):void
Adds dynamically Measure to the data source. | FlexPivotComponent | ||
clear():void
Clears all data and views; Pivot Grid, Charts and Fields List become empty. | FlexPivotComponent | ||
clearFilter(hierarchyName:String):void
Clears the filter for hierarchy by hierarchyName. | FlexPivotComponent | ||
clearReport():void
Clears only view, such as Pivot Grid and Charts. | FlexPivotComponent | ||
closeFieldsList():void
Closes Fields List. | FlexPivotComponent | ||
collapseAllData():void
Collapses all dimensions on the grid and on charts
| FlexPivotComponent | ||
connectTo(params:Object):void
Connects to the data source. | FlexPivotComponent | ||
drawCell(cell:PivotGridCellRenderer):void
Redraws concrete cell on the grid
| FlexPivotComponent | ||
expandAllData():void
Expands all dimensions on the grid and on charts
| FlexPivotComponent | ||
expandData(value:Boolean = true):void
deprecated
| FlexPivotComponent | ||
export(type:String, exportOptions:ExportOptions = null, callbackHandler:Function = null):void
Exports Grid or Chart to preferred format. | FlexPivotComponent | ||
getAllHierarchies():Array
Returns all hierarchies. | FlexPivotComponent | ||
getAllMeasures():Array
Returns all measures. | FlexPivotComponent | ||
getCell(rowIdx:int, colIdx:int):PivotGridCellRenderer
Gets the cell object by row and column indexes. | FlexPivotComponent | ||
getColumns():Array
Returns the hierarchies selected as columns for the report. | FlexPivotComponent | ||
getFilter(hierarchyName:String):Array
Returns the filter for hierarchy by hierarchyName. | FlexPivotComponent | ||
getFormat(measureName:String):FormatValueObject
Returns the formatting for the measure by measure name. | FlexPivotComponent | ||
getLocalizedLabels():Object
Returns an object which represents current localization. | FlexPivotComponent | ||
getMeasures():Array
Returns the measures selected for the report. | FlexPivotComponent | ||
getMembers(hierarchyName:String, callbackHandler:Function = null):Array
Gets all members of hierarchy by hierarchy name. | FlexPivotComponent | ||
getPages():Array
Returns the hierarchies selected as pages for the report. | FlexPivotComponent | ||
getRows():Array
Returns the hierarchies selected as rows for the report. | FlexPivotComponent | ||
Gets selected cell
| FlexPivotComponent | ||
getSort(hierarchyName:String):String
Returns the sort type for hierarchy by hierarchyName. | FlexPivotComponent | ||
getValue(rowIdx:int, colIdx:int):Number
Gets the cell value by row and column indexes. | FlexPivotComponent | ||
load():void
Starts loading data to FlexPivotComponent and applying the report. | FlexPivotComponent | ||
openFieldsList():void
Opens Fields List. | FlexPivotComponent | ||
print():void
Prints Grid via OS print manager. | FlexPivotComponent | ||
removeSelection():void
Removes selection on the grid
| FlexPivotComponent | ||
save(filename:String, destinationType:String = server, callbackHandler:Function = null, url:String):void
Saves a report. | FlexPivotComponent | ||
saveReport(url:String, name:String = report.xml, callbackHandler:Function = null, destinationType:String = server):void
deprecated
Saves the report. | FlexPivotComponent | ||
setActualSize(newWidth:Number, newHeight:Number):void [override] | FlexPivotComponent | ||
setBottomX(hierarchyName:String, num:int, measureName:String):void
Sets the Bottom X filter for hierarchy by hierarchyName, X, and measure. | FlexPivotComponent | ||
setChartTitle(value:String):void
Sets the title for charts in run time. | FlexPivotComponent | ||
setColumnWidth(colIdx:int, width:int):void
The autoLoad property defines whether the report will be loaded automatically after the component initialization
or the report will be loaded only after the method load() call. | FlexPivotComponent | ||
setFilter(hierarchyName:String, items:Array):void
Sets the filter for hierarchy by hierarchyName. | FlexPivotComponent | ||
setFormat(format:FormatValueObject, measureName:String):void
Sets the formatting for cells. | FlexPivotComponent | ||
setGridTitle(value:String):void
Sets the title for grid in run time. | FlexPivotComponent | ||
setLocalizedLabels(labels:Object):void
Sets a localization. | FlexPivotComponent | ||
setRowHeight(rowIdx:int, height:int):void | FlexPivotComponent | ||
setSort(hierarchyName:String, sortType:String):void
Sets the sort type for hierarchy by hierarchyName. | FlexPivotComponent | ||
setStyleSheet(value:String):void
Applies the skin loaded from the URL to CSS file. | FlexPivotComponent | ||
setTopX(hierarchyName:String, num:int, measureName:String):void
Sets the Top X filter for hierarchy by hierarchyName, X, and measure. | FlexPivotComponent | ||
showCharts(type:String):void
Switches to Charts view, default chart type is "bar". | FlexPivotComponent | ||
showGrid():void
Switches to Grid view. | FlexPivotComponent | ||
sortValues(axisName:String, type:String, tuple:Array, measureName:String):void
Sorts values. | FlexPivotComponent | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when fields list is closed | FlexPivotComponent | |||
| Dispatched when a filter icon is pressed | FlexPivotComponent | |||
| Dispatched when a user presses and releases the main button of a pointing device over the defined grid cell. | FlexPivotComponent | |||
| Dispatched when pivot is created and is ready to receive data. | FlexPivotComponent | |||
| Dispatched when the rendering of pivot grid or chart has been finished. | FlexPivotComponent | |||
| Dispatched when data are received and updated. | FlexPivotComponent | |||
| autoLoad | property |
autoLoad:Boolean [write-only] public function set autoLoad(value:Boolean):void| binaryAssets | property |
binaryAssets:Object [write-only] public function set binaryAssets(value:Object):void| catalog | property |
catalog:String [write-only]
The catalog property lets you define the data source catalog name of the OLAP data source, such as Mondrian or Microsoft Analysis Services.
There is no default value for this property.
public function set catalog(value:String):voidSee also
| chartTitle | property |
chartTitle:String [write-only]
The chartTitle property lets you set the title for charts.
The default value is "".
public function set chartTitle(value:String):void| chartType | property |
chartType:String [write-only]
The chartType property lets you define the chart type.
If incorrect chart type is passed, Pivot Grid will be shown.
public function set chartType(value:String):voidSee also
| columnDecimals | property |
columnDecimals:Boolean [write-only]
The columnDecimals property is one of the number formatting properties and it lets you define
whether the formatting should add extra zeros in end to complete number length (true) or not (false).
The default value is false.
public function set columnDecimals(value:Boolean):voidSee also
| columns | property |
columns:* [write-only]
The columns property lets you set the columns data into your predefined report.
public function set columns(value:any):voidSee also
| configuratorButton | property |
configuratorButton:Boolean [write-only] public function set configuratorButton(value:Boolean):void| configUrl | property |
configUrl:String [write-only]
The configUrl property lets you define a URL of the configuration XML file.
The configUrl property is used when you set the component configuration via XML.
Note: After setting this parameter, FlexPivotComponent will ignore the previous configuration.
There is no default value for this property.
public function set configUrl(value:String):void
<pivot:FlexPivotComponent configUrl="config.xml" />
| cube | property |
cube:String [write-only]
The cube property lets you define the cube name from the given catalog of the OLAP data source, such as Mondrian or Microsoft Analysis Services.
There is no default value for this property.
public function set cube(value:String):voidSee also
| currencySymbol | property |
currencySymbol:String [write-only]
The currencySymbol property is one of the number formatting properties and it lets you define
the currency symbol.
Set this parameter, if you want to format numbers as currency.
The default value is null.
public function set currencySymbol(value:String):voidSee also
| currencySymbolAlign | property |
currencySymbolAlign:String [write-only]
The currencySymbolAlign property is one of the number formatting properties and it lets you define
the currency symbol alignment.
The default value is left.
public function set currencySymbolAlign(value:String):voidSee also
| dataSourceInfo | property |
dataSourceInfo:String [write-only]
The dataSourceInfo property lets you define the service info of the OLAP data source, such as Mondrian or Microsoft Analysis Services.
Contains the information, such as the instance name, required to connect to the data source.
There is no default value for this property.
public function set dataSourceInfo(value:String):voidSee also
| decimalPlaces | property |
decimalPlaces:int [write-only]
The decimalPlaces property is one of the number formatting properties and it lets you define
the number of decimal places (the number of digits following the decimal separator).
-1 means "no formatting"
The default value is -1.
public function set decimalPlaces(value:int):voidSee also
| decimalSeparator | property |
decimalSeparator:String [write-only]
The decimalSeparator property is one of the number formatting properties and it lets you define
the decimal separator for data cell rendering.
The default value is ..
public function set decimalSeparator(value:String):voidSee also
| editableHeaders | property |
editableHeaders:Boolean [write-only] public function set editableHeaders(value:Boolean):void| expandAll | property |
expandAll:Boolean [write-only]
The expandAll property defines whether to expand all rows and columns in a report or not.
The default value is false.
public function set expandAll(value:Boolean):void| fieldSeparator | property |
fieldSeparator:String [write-only]
The fieldSeparator property lets you set the field separator for CSV (if your data source is CSV).
By default, field separator is automatically defined.
public function set fieldSeparator(value:String):voidSee also
| filename | property |
filename:String [write-only]
The filename property lets you set the path to CSV data source. It can be CSV file or path to the service which returns CSV.
There is no default value for this property.
public function set filename(value:String):void| fitGridlines | property |
fitGridlines:Boolean [write-only] public function set fitGridlines(value:Boolean):void| gridColumnCount | property |
gridColumnCount:int [read-only] Returns the number of grid columns.
public function get gridColumnCount():intSee also
| gridRowCount | property |
gridRowCount:int [read-only] Returns the number of grid rows.
public function get gridRowCount():intSee also
| gridTitle | property |
gridTitle:String [write-only]
The gridTitle property lets you set the title for grid.
The default value is "".
public function set gridTitle(value:String):void| infinityValue | property |
infinityValue:String [write-only] public function set infinityValue(value:String):void| licenseFilePath | property |
licenseFilePath:String [write-only]
The licenseFilePath property lets you define the path the TXT file with the license key.
The productKey property is the alternative way to set the license key.
The default value is null.
public function set licenseFilePath(value:String):voidSee also
| localSettingsURL | property |
localSettingsURL:String [write-only] public function set localSettingsURL(value:String):void| logoURL | property |
logoURL:String [write-only] public function set logoURL(value:String):void| maxDecimalPlaces | property |
maxDecimalPlaces:int [write-only]
The maxDecimalPlaces property is one of the number formatting properties and it lets you define
the same as decimalPlaces, but shows no more digits, than specified and
adds no extra zeros in end to complete number length.
Usually used for currency formatting. -1 means "no formatting"
The default value is -1.
public function set maxDecimalPlaces(value:int):voidSee also
| maxSymbols | property |
maxSymbols:int [write-only]
The maxSymbols property is one of the number formatting properties and it lets you define
the maximum number of symbols in cell.
The default value is 10.
public function set maxSymbols(value:int):voidSee also
| measures | property |
measures:* [write-only]
The measures property lets you set the measures data into your predefined report.
public function set measures(value:any):voidSee also
| nullValue | property |
nullValue:String [write-only] public function set nullValue(value:String):void| pages | property |
pages:* [write-only]
The pages property lets you set the pages data into your predefined report.
public function set pages(value:any):voidSee also
| percentZoom | property |
percentZoom:Number [write-only] Zooms Grid in percents.
Equal to zoom method, but argument is in percents.
public function set percentZoom(value:Number):voidSee also
| productKey | property |
productKey:String [write-only]
The productKey property lets you set the license key.
The licenseFilePath property is the alternative way to set the license key.
The default value is null.
public function set productKey(value:String):void| proxyUrl | property |
proxyUrl:String [write-only]
The proxyUrl property lets you define the proxy URL to the OLAP data source, such as Mondrian or Microsoft Analysis Services.
There is no default value for this property.
public function set proxyUrl(value:String):voidSee also
| report | property |
report:ReportValueObjectYou can create a predefined report after dynamically added data define ReportValueObject to get exact data you need after data update.
public function get report():ReportValueObject public function set report(value:ReportValueObject):voidSee also
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;
pivot.load();
| rows | property |
rows:* [write-only]
The rows property lets you set the rows data into your predefined report.
public function set rows(value:any):voidSee also
| showAggregations | property |
showAggregations:Boolean [write-only] public function set showAggregations(value:Boolean):void| showChartZeroValues | property |
showChartZeroValues:Boolean [write-only] public function set showChartZeroValues(value:Boolean):void| showFieldsList | property |
showFieldsList:Boolean [write-only]
The showFieldsList property lets you define whether to show Fields List or hide it.
public function set showFieldsList(value:Boolean):void| showFilter | property |
showFilter:Boolean [write-only] public function set showFilter(value:Boolean):void| showGrandTotals | property |
showGrandTotals:Boolean [write-only] public function set showGrandTotals(value:Boolean):void| showHeaders | property |
showHeaders:Boolean [write-only] public function set showHeaders(value:Boolean):void| showReportFilter | property |
showReportFilter:Boolean [write-only] public function set showReportFilter(value:Boolean):void| showTotals | property |
showTotals:Boolean [write-only] public function set showTotals(value:Boolean):void| sorting | property |
sorting:Boolean [write-only]
The sorting property lets you enable or disable the data sorting feature.
The default value is true.
public function set sorting(value:Boolean):void| styleSheetName | property |
styleSheetName:String [write-only]
The styleSheetName property lets you define the URL to CSS file to apply the skin.
Skins and visual appearance can be controlled with easy-to-edit CSS and images.
public function set styleSheetName(value:String):voidSee also
| swfFilePath | property |
swfFilePath:String [write-only]
The swfFilePath property lets you define the path to resource files, such as assets.swf, styles, skins etc.
If Assets.swf is not located in root directory, specify the path to them.
The default value is "".
public function set swfFilePath(value:String):void| thousandsSeparator | property |
thousandsSeparator:String [write-only]
The thousandsSeparator property is one of the number formatting properties and it lets you define
the thousands separator for data cell rendering.
Default value is space
public function set thousandsSeparator(value:String):voidSee also
| viewType | property |
viewType:String [write-only]
The viewType property lets you define the view type: show Pivot Grid or selected chart.
By default or incorrect parameter case, Pivot Grid will be shown.
public function set viewType(value:String):voidSee also
| zoom | property |
zoom:Number [write-only] Zooms Grid
public function set zoom(value:Number):voidSee also
| FlexPivotComponent | () | Constructor |
public function FlexPivotComponent()Constructor.
| addDataArray | () | method |
public function addDataArray(array:Array):voidAdds dynamically multiple data rows to the data source.
Parameters
array:Array — data rows
|
| addDataRecord | () | method |
public function addDataRecord(object:Object):voidAdds dynamically one data record to the data source.
Parameters
object:Object — Data record
|
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):voidAdds dynamically Dimension to the data source.
Parameters
uniqueName:String — Dimension unique name
| |
caption:String — Dimension caption
|
| addFormat | () | method |
public function addFormat(format:FormatValueObject, measureName:String):voiddeprecated Use setFormat() Sets the formatting for cells.
You can format all cell or only concrete meusere cell, if specify measureName parameter
Parameters
format:FormatValueObject — the class style used by this component to format object
| |
measureName:String — optional parameter. Specify concrete measure to format
|
See also
| addHierarchy | () | method |
public function addHierarchy(dimensionUniqueName:String, uniqueName:String, caption:String):voidAdds dynamically Hierarchy to Dimension in the 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, aggregation:String, format:String):voidAdds dynamically Measure to the data source.
Parameters
uniqueName:String — Measure unique name
| |
caption:String — Measure caption
| |
aggregation:String | |
format:String |
| clear | () | method |
public function clear():voidClears all data and views; Pivot Grid, Charts and Fields List become empty.
| clearFilter | () | method |
public function clearFilter(hierarchyName:String):voidClears the filter for hierarchy by hierarchyName.
Parameters
hierarchyName:String — is name of hierarchy.
|
| clearReport | () | method |
public function clearReport():voidClears only view, such as Pivot Grid and Charts.
| closeFieldsList | () | method |
| collapseAllData | () | method |
public function collapseAllData():voidCollapses all dimensions on the grid and on charts
See also
| connectTo | () | method |
public function connectTo(params:Object):voidConnects to the data source. It can be CSV provider, MS OLAP or Mondrian.
Parameters
params:Object — Object.
CSV sample
connectTo({dataSourceType: 'CSV', filename: 'data/csv/arabic.csv'})
MS OLAP sample
connectTo({dataSourceType: 'MSOLAP', dataSourceInfo: 'Provider=MSOLAP; Data Source=extranet;', catalog: 'Adventure Works DW Standard Edition', cube: 'Adventure Works', proxyUrl: 'http://olap.flexmonster.com/olap/msmdpump.dll'})
Mondrian sample
connectTo({dataSourceType: 'Mondrian', dataSourceInfo: 'Provider=Mondrian;DataSource=MondrianFoodMart;', catalog: 'FoodMart', cube: 'Sales', proxyUrl: 'http://olap.flexmonster.com:8080/mondrian/xmla'})
|
| drawCell | () | method |
public function drawCell(cell:PivotGridCellRenderer):voidRedraws concrete cell on the grid
Parameters
cell:PivotGridCellRenderer — PivotGridCellRenderer
|
| expandAllData | () | method |
public function expandAllData():voidExpands all dimensions on the grid and on charts
See also
| expandData | () | method |
public function expandData(value:Boolean = true):voiddeprecated
Parameters
value:Boolean (default = true) |
See also
| export | () | method |
public function export(type:String, exportOptions:ExportOptions = null, callbackHandler:Function = null):voidExports Grid or Chart to preferred format.
Parameters
type:String — ExportType is an export type, see possible values in appropriate class below
| |
exportOptions:ExportOptions (default = null) | |
callbackHandler:Function (default = null) |
See also
| getAllHierarchies | () | method |
public function getAllHierarchies():ArrayReturns all hierarchies.
ReturnsArray — Array of objects with hierarchy caption, and uniqueName
|
| getAllMeasures | () | method |
public function getAllMeasures():ArrayReturns all measures.
ReturnsArray — Array of objects with measure caption, name, uniqueName, availableAggregations, and aggregation selected
|
| getCell | () | method |
public function getCell(rowIdx:int, colIdx:int):PivotGridCellRendererGets the cell object by row and column indexes.
Parameters
rowIdx:int — Row index
| |
colIdx:int — Column index
|
PivotGridCellRenderer — PivotGridCellRenderer
|
See also
| getColumns | () | method |
public function getColumns():ArrayReturns the hierarchies selected as columns for the report.
ReturnsArray — Array of objects with hierarchy caption, and uniqueName
|
| getFilter | () | method |
public function getFilter(hierarchyName:String):ArrayReturns the filter for hierarchy by hierarchyName.
Parameters
hierarchyName:String — hierarchy name string
|
Array — Array of objects with member caption, uniqueName, id, and hierarchyName
|
| getFormat | () | method |
public function getFormat(measureName:String):FormatValueObjectReturns the formatting for the measure by measure name.
Parameters
measureName:String |
FormatValueObject — FormatValueObject
|
See also
| getLocalizedLabels | () | method |
public function getLocalizedLabels():ObjectReturns an object which represents current localization. The object contains pairs of key and value of all localized labels.
ReturnsObject |
See also
| getMeasures | () | method |
public function getMeasures():ArrayReturns the measures selected for the report.
ReturnsArray — Array of objects with measure caption, name, uniqueName, availableAggregations, and aggregation selected
|
| getMembers | () | method |
public function getMembers(hierarchyName:String, callbackHandler:Function = null):ArrayGets all members of hierarchy by hierarchy name.
Parameters
hierarchyName:String — hierarchy name string
| |
callbackHandler:Function (default = null) |
Array — Array of objects with member caption, uniqueName, and hierarchyName
|
| getPages | () | method |
public function getPages():ArrayReturns the hierarchies selected as pages for the report.
ReturnsArray — Array of objects with hierarchy caption, and uniqueName
|
| getRows | () | method |
public function getRows():ArrayReturns the hierarchies selected as rows for the report.
ReturnsArray — Array of objects with hierarchy caption, and uniqueName
|
| getSelectedCell | () | method |
public function getSelectedCell():PivotGridCellRendererGets selected cell
ReturnsPivotGridCellRenderer — PivotGridCellRenderer
|
See also
| getSort | () | method |
public function getSort(hierarchyName:String):StringReturns the sort type for hierarchy by hierarchyName.
Parameters
hierarchyName:String — hierarchy name string
|
String — sort type String
|
| getValue | () | method |
public function getValue(rowIdx:int, colIdx:int):NumberGets the cell value by row and column indexes.
Parameters
rowIdx:int — Row index
| |
colIdx:int — Column index
|
Number — Cell value
|
| load | () | method |
public function load():voidStarts loading data to FlexPivotComponent and applying the report.
Before calling this function, set proxyUrl, dataSourceInfo, catalog, cube (MS Analysis Services or Mondrian OLAP server version)
or filename (CSV version).
If no source or incorrent URL specified, grid takes no changes.
See also
| openFieldsList | () | method |
| () | method |
public function print():voidPrints Grid via OS print manager.
| removeSelection | () | method |
public function removeSelection():voidRemoves selection on the grid
| save | () | method |
public function save(filename:String, destinationType:String = server, callbackHandler:Function = null, url:String):voidSaves a report. The report can be saved to local computer, to server or to clipboard as XML file.
Parameters
filename:String — is a name of report XML file.
| |
destinationType:String (default = server) | |
callbackHandler:Function (default = null) | |
url:String — save report url. Default value is empty String.
|
See also
| saveReport | () | method |
public function saveReport(url:String, name:String = report.xml, callbackHandler:Function = null, destinationType:String = server):voiddeprecated Saves the report.
Parameters
url:String — save report url
| |
name:String (default = report.xml) | |
callbackHandler:Function (default = null) | |
destinationType:String (default = server) |
See also
| setActualSize | () | method |
override public function setActualSize(newWidth:Number, newHeight:Number):voidParameters
newWidth:Number | |
newHeight:Number |
| setBottomX | () | method |
public function setBottomX(hierarchyName:String, num:int, measureName:String):voidSets the Bottom X filter for hierarchy by hierarchyName, X, and measure.
Parameters
hierarchyName:String — hierarchy name string
| |
num:int — amount of filtered items
| |
measureName:String — identifies the measure on which Bottom X filter will be applied
|
See also
| setChartTitle | () | method |
public function setChartTitle(value:String):voidSets the title for charts in run time.
Parameters
value:String — the charts title
|
| setColumnWidth | () | method |
public function setColumnWidth(colIdx:int, width:int):void
The autoLoad property defines whether the report will be loaded automatically after the component initialization
or the report will be loaded only after the method load() call.
If true the data will be loaded after FlexPivotComponent initialization.
If false, the data load will be started only after the method load() call.
Parameters
colIdx:int | |
width:int |
See also
| setFilter | () | method |
public function setFilter(hierarchyName:String, items:Array):voidSets the filter for hierarchy by hierarchyName.
Parameters
hierarchyName:String — hierarchy name string
| |
items:Array — Array of objects with member caption, uniqueName, id, and hierarchyName
|
| setFormat | () | method |
public function setFormat(format:FormatValueObject, measureName:String):voidSets the formatting for cells.
You can format all cell or only concrete meusere cell, if specify measureName parameter
Parameters
format:FormatValueObject — FormatValueObject. It is used by this component to format cells.
| |
measureName:String — optional parameter. Specify concrete measure to format
|
See also
| setGridTitle | () | method |
public function setGridTitle(value:String):voidSets the title for grid in run time.
Parameters
value:String — the grid title
|
| setLocalizedLabels | () | method |
public function setLocalizedLabels(labels:Object):voidSets a localization.
Parameters
labels:Object — is an object which contains pairs of key and value for any amount of localized labels.
|
See also
| setRowHeight | () | method |
public function setRowHeight(rowIdx:int, height:int):voidParameters
rowIdx:int | |
height:int |
| setSort | () | method |
public function setSort(hierarchyName:String, sortType:String):voidSets the sort type for hierarchy by hierarchyName.
Parameters
hierarchyName:String — hierarchy name string
| |
sortType:String — sort type String
|
| setStyleSheet | () | method |
public function setStyleSheet(value:String):voidApplies the skin loaded from the URL to CSS file.
This method can be called after the component initialization.
Parameters
value:String — CSS file URL
|
See also
| setTopX | () | method |
public function setTopX(hierarchyName:String, num:int, measureName:String):voidSets the Top X filter for hierarchy by hierarchyName, X, and measure.
Parameters
hierarchyName:String — hierarchy name string
| |
num:int — amount of filtered items
| |
measureName:String — identifies the measure on which Top X filter will be applied
|
See also
| showCharts | () | method |
public function showCharts(type:String):voidSwitches to Charts view, default chart type is "bar".
This method can be called after the component initialization.
Parameters
type:String — is a chart type
|
See also
| showGrid | () | method |
public function showGrid():voidSwitches to Grid view.
This method can be called after the component initialization.
See also
| sortValues | () | method |
public function sortValues(axisName:String, type:String, tuple:Array, measureName:String):voidSorts values.
Parameters
axisName:String — String. It can be "rows" or "columns"
| |
type:String — sort type String
| |
tuple:Array — Array
| |
measureName:String — identifies the measure on which sorting will be applied
|
| fieldsListClose | Event |
Dispatched when fields list is closed
| filterOpen | Event |
| gridMouseClick | Event |
Dispatched when a user presses and releases the main button of a pointing device over the defined grid cell.
See also
| pivotCreationComplete | Event |
Dispatched when pivot is created and is ready to receive data.
| renderComplete | Event |
Dispatched when the rendering of pivot grid or chart has been finished.
| updateComplete | Event |
Dispatched when data are received and updated.