Namespace: PP.Exp;
EaxDocument
The EaxDocument class implements the express report document.
PP.initClass(PP.Exp.EaxDocument, PP.Exp.EaxAnalyzer, «EaxDocument»);
Constructor name | Brief description | |
EaxDocument | The EaxDocument constructor creates an instance of the EaxDocument class. |
Property name | Brief description | |
ActiveSheetKey | The ActiveSheetKey property contains key of the active sheet of the express report document. | |
DocumentMetadata | The DocumentMetadata property contains information on express report document. | |
DocumentOdId | The DocumentOdId method contains identifier of the express report document. |
Method name | Brief description | |
checkSheetName | The checkSheetName method checks if the name of the express report document sheet is correct. | |
getActiveSheet | The getActiveSheet method returns active sheet of the express report document. | |
getSheet | The getSheet method returns sheet of express report document by its key or identifier. | |
getSheetName | The getSheetName method returns name of the express report document sheet by its key or identifier. | |
getSheets | The getSheets method returns an array of express report document sheets. | |
removeSheet | The removeSheet method deletes a sheet of express report document by its key or identifier. |
Property name | Brief description | |
AutoUpdate | The AutoUpdate property controls express report auto update. | |
BubbleChartChangedData | The BubbleChartChangedData property contains changed data and metadata of express report bubble chart view. | |
BubbleChartData | The BubbleChartData property contains data of the Bubble Chart express report. | |
ChartChangedData | The ChartChangedData property contains changed data of express report chart. | |
ChartData | The ChartData property contains data of the express report Chart view. | |
Document | The Document property contains HTML document of an express report. | |
EaxParams | The EaxParams property determines an array of parameters of express report. | |
GaugeData | The GaugeData property determines settings for speedometer container. | |
GaugeChangedData | The GaugeChangedData property determines edited settings for speedometer container. | |
GridSelectionType | The GridSelectionType property contains a type of object selected in the express report table. | |
IsChanged | The IsChanged property returns whether the express report is changed. | |
IsDataChanged | The IsDataChanged property returns whether express report data is changed. | |
IsDefaultHighlight | The IsDefaultHighlight property returns whether selection of express report elements is set by default. | |
IsHasDataAvailable | The IsHasDataAvailable property determines whether requests for updating the status of the @hasData field in the dimension element metadata are to be sent when changing data in dimensions. | |
IsSelectionChanged | The IsSelectionChanged property determines whether selection in the express report table has been changed. | |
MapChangedData | The MapChangedData property contains changed data of the Map express report view. | |
MapData | The MapData property contains data of the Map express report view. | |
PeriodicalUpdateInterval | The PeriodicalUpdateInterval property determines interval of express report periodic update. | |
SelectedPart | The SelectedPart property determines selected table area. | |
Selection | The Selection property contains cells selected in the express report table. | |
SourceParams | The SourceParams property determines an array of data source parameters. | |
StatData | The StatData property contains statistic data of an express report. | |
TabFocusedCell | The TabFocusedCell property contains coordinates of focused cell in the express report table. | |
TabSheetChangedState | The TabSheetChangedState property contains changed settings of an express report sheet. | |
TableChangedData | The TableChangedData property contains changed data of express report title. | |
TableChangedStruct | The TableChangedStruct property contains modified structure of express report table. | |
TitleChangedData | The TitleChangedData property contains changed data of express report title. | |
Topobase | The Topobase property contains a topobase for the Map express report data view. | |
TopobaseOd | The TopobaseOd property contains identifier of express report topobase as a JSON object. | |
ViewSize | The ViewSize property contains express report visualizer size on using vertical or horizontal layout of visualizers. | |
WaitToken | The WaitToken property sets and gets a wait token by the specified name. |
Method name | Brief description | |
canMapDrillUp | The canMapDrillUp method checks if it is possible to drill up the selection hierarchy in the express report Map view. | |
clearAllWaitTokens | The clearAllWaitTokens method resets all wait tokens in an express report. | |
clearDataSources | The clearDataSources method resets all data sources for express report. | |
clearDimItems | The clearDimItems method removes all loaded dimension elements in an express report. | |
clearDims | The clearDims method removes all dimensions from an express report. | |
clearMapDrill | The clearMapDrill method clears map metadata. | |
clearViewData | The clearViewData method clears express report metadata. | |
clearWaitToken | The clearWaitToken method resets wait token in the express report by the specified name. | |
getAllWaitTokens | The getAllWaitTokens method returns all wait tokens. | |
getBubbleChartId | The getBubbleChartId method returns identifier of the Bubble Chart view of express report data. | |
getCustomHierMd | The getCustomHierMd method returns custom hierarchy metadata. | |
getChartId | The getChartId method returns identifier of the Chart view of the express report data. | |
getDataSource | The getDataSource method returns data source by key. | |
getDim | The getDim method returns dimension by own key and its source key. | |
getDimFilterOdId | The getDimFilterOdId method returns identifier of the express report dimension filter. | |
getDimOdId | The getDimOdId method returns moniker for express report dimension. | |
getDimPosition | The getDimPosition method returns dimension position of the cube, based on which express report is created. | |
getDimSources | The getDimSources method returns an array of dimension sources for express report. | |
getDims | The getDims method returns an array of express report dimensions. | |
getDimsByPosition | The getDimsByPosition method returns an array of report dimensions in the specified position. | |
getDimsState | The getDimsState method returns information on express report dimensions. | |
getIndAgg | The getIndAgg method returns the selected metric aggregation type. | |
getIndicatorEls | The getIndicatorEls method returns a list of metrics dimensions of the specified visualizer type. | |
getIndValue | The getIndValue method returns indicator value for express report map or bubble chart. | |
getIsADOMD | The getIsADOMD method returns whether express report is based on ADOMD cube. | |
getIsDmHier | The getIsDmHier method returns key of the dimension, for which express report dimension with the specified key is an alternative hierarchy. | |
getIsNewReport | The getIsNewReport method determines whether this express report has been previously saved. | |
getIsPPSrvCreate | The getIsPPSrvCreate method determines whether the express report is created by means of the EaxMdService service. | |
getMapId | The getMapId method returns identifier of the Map data view of express report. | |
getMetricOdId | The getMetricOdId method returns identifier of the selected visualizer metric. | |
getPvtSortItemDimId | The getPvtSortItemDimId method returns moniker for sorting of express report table. | |
getSelectedParts | The getSelectedParts method returns an array of table areas included into the current selection. | |
getServiceTbFormat | The getServiceTbFormat method transforms the specified topobase format to TopobaseFormat (platform services enumeration). | |
getSourceName | The getSourceName method returns name of an express report data source by its key. | |
getSourcePrivateDims | The getSourcePrivateDims method returns private dimension keys of the specified source. | |
getSpecialValidDimKeys | The getSpecialValidDimKeys method returns keys of the specified type of dimensions. | |
getTabId | The getTabId method returns identifier of the Table data view of express report. | |
getTableParts | The getTableParts method returns an array of all table areas. | |
getTypeGrowth | The getTypeGrowth method returns type of the specified growth indicator. | |
hasDataSources | The hasDataSources method determines whether the express report contains some changes. | |
isMapAvailable | The isMapAvailable method determines whether the Map data view is available in express report. | |
transposeSelection | The transposeSelection method transposes a range of the selected cells in express report table. | |
waitFor | The waitFor method sets the wait token for the specified operation in express report. |
Property name | Brief description | |
Metabase | The Metabase property determines a repository that stores the object. | |
Names | The Names property determines a collection of the object names for different languages. | |
OdId | The OdId property determines a string of repository object moniker. | |
The Params property determines a collection of the parameters for the repository object. | ||
PPService | The PPService property determines a service for working with a repository object. | |
ReadOnly | The ReadOnly property determines whether it is possible to edit repository object. | |
ShareUrl | The ShareUrl property determines URL of repository object. |
Method name | Brief description | |
getIsOpened | The getIsOpened method returns object opening checking result. | |
getRights | The getRights method returns effective access permissions of the object. |
Property name | Brief description | |
Class | The Class property determines a repository object class. | |
HasChildren | The HasChildren property returns whether there are child objects. | |
IsLink | The IsLink property returns whether this object is in another repository. | |
IsShortcut | The IsShortcut property returns whether this object is a shortcut to other repository object. | |
Key | The Key property determines a repository object key. | |
Metadata | The Metadata property determines object metadata. | |
Name | The Name property determines object name. | |
The ParentKey property determines parent object key. | ||
TimeStamp | The TimeStamp property determines date and time of the last changing of the repository object. | |
Visible | The Visible property returns whether a repository object is visible. |
Method name | Brief description | |
getState | The getState method returns object descriptor metadata: values of all properties of the Descriptor class. |
Property name | Brief description | |
The Id property determines a repository object identifier. |
Method name | Brief description | |
clone | The clone method creates an object copy. | |
dispose | The dispose method deletes the component. | |
getHashCode | The getHashCode method returns hash code of repository object. | |
getId | The getId method returns repository object identifier. | |
getSettings | The getSettings method returns repository object settings. | |
getTypeName | The getTypeName method returns the name of the object type without the namespace, to which it belongs. | |
isEqual | The isEqual method determines whether the specified object is equal to the current repository object. | |
isLive | The isLive method determines validity of repository object. | |
removeAllEvents | The removeAllEvents method removes all object event handlers by the specified context. | |
setId | The setId method determines a repository object identifier. | |
setSettings | The setSettings method determines repository object settings. | |
defineProps | The defineProps method creates get and set methods from name array for the specified class. | |
keys | The keys method returns array of methods and properties names for the specified object. |
See also: