WbkDocument

Namespace: PP.TS;

Inheritance Hierarchy

Object

PP.Mb.Descriptor

PP.Mb.Object

PP.Exp.EaxAnalyzer

PP.TS.Workbook

WbkDocument

Description

The WbkDocument class implements an instance of workbook based on a time series database.

Comments

The WbkDocument class is a data model, that shows data state in the server.  On adding a new sheet a request is sent to the server, and the server response is written to the model.

Syntax

PP.initClass(PP.TS.WbkDocument, PP.TS.Workbook, "WbkDocument");

Properties

	Property name	Brief description
	ActiveSheetKey	The ActiveSheetKey property determines key of active sheet.
	DocumentMetadata	The DocumentMetadata property determines document metadata.
	DocumentOdld	The DocumentOdld property determines the object that contains workbook document moniker.
	OpenRub	The OpenRub property determines time series database.

Methods

	Method name	Brief description
	checkSheetName	The checkSheetName method checks if a new sheet name is acceptable.
	getActiveSheet	The getActiveSheet method returns active sheet.
	getSheet	The getSheet method returns sheet object by its key or ID.
	getSheetName	The getSheetName method returns sheet name by key or identifier.
	getSheetOdld	The getSheetOdld method returns object that contains sheet moniker, by its key.
	getSheets	The getSheets method returns the list of all document sheets.
	removeSheet	The removeSheet method removes sheet by its key or ID.

Properties inherited from the Workbook class

	Property name	Brief description
	ActiveRub	The ActiveRub property sets a key of the active time series database for a workbook data model.
	CommentAttribute	The CommentAttribute property determines an attribute used as a tooltip for table cells.
	DimLvlsEls	The DimLvlsEls property determines calendar dimension elements.
	DimsObs	The DimsObs property sets dimensions for workbook observation attributes that refer to dictionaries.
	DimUnitsEls	The DimUnitsEls property sets elements of the Measurement Units dimension.
	Hier	The Hier property sets a series tree hierarchy.
	NeedShowSaveDataDialog	The NeedShowSaveDataDialog property is used to store information that a series with enabled history is changed (series data or attributes).
	NeedUpdateSelection	The NeedUpdateSelection property determines whether it is necessary to update selection.
	Permanent	The Permanent property determines whether workbook is saved to the repository.
	Pinned	The Pinned property sets a workbook pinned series.
	RdsDim	The rdsDim property determines a dimension based on an MDM dictionary by its key.
	Rub	The Rub property sets a time series database used as a workbook data source.
	RubProps	The RubProps property sets properties of a time series database.
	SelectedIndexCols	The SelectedIndexCols property determines indexes of selected columns.
	SelectedIndexSeries	The SelectedIndexSeries property determines an array that contains indexes of rows selected in the table.
	SelectedObsTable	The SelectedObsTable property determines an object that contains information on values of selected table cells and on values of observation attributes for these cells.
	SelectedPoint	The SelectedPoint property sets information about selected point coordinates.
	SelectedSeries	The SelectedSeries property sets selected series.
	SelectedTableCells	The SelectedTableCells property sets an object that contains information about values selected in the table.
	Series	The Series property determines an array of loaded workbook series.
	SeriesCount	The SeriesCount property sets the number of series in the workbook.
	StatCoeffTabSheetSource	The StatCoeffTabSheetSource property sets a data source for a sheet on the Equation tab of statistics panel.
	StatCorrTabSheetSource	The StatCorrTabSheetSource property sets a data source for a sheet on the Correlation Bubble Chart tab on the statistics panel.
	StatWeightsTabSheetSource	The StatWeightsTabSheetSource property sets a data source for a sheet on the Weights Bubble Chart tab on the statistics panel.
	WbkMetadata	The WbkMetadata property sets workbook metadata.

Methods inherited from the Workbook class

	Method name	Brief description
	addSelectedSeries	The addSelectedSeries method adds series to the array of selected series.
	getDependentsSeries	The getDependentsSeries method determines the list of series dependent on the specified series.
	getFixedColumnsCount	The getFixedColumnsCount method returns the number of columns fixed on scrolling.
	getFixedRowsCount	The getFixedRowsCount method returns the number of rows fixed on scrolling.
	getGaugePeriodDim	The getGaugePeriodDim method returns speedometer calendar dictionary.
	getKeepHistorySerieRub	The getKeepHistorySerieRub method returns whether saving changes history (revisions list) is enabled in the source (time series database) of the specified series.
	getKeySerie	The getKeySerie method returns series key by index.
	getLoadedChildrenCount	The getLoadedChildrenCount method determines the number of loaded child series for the specified series.
	getObsAttr	The getObsAttr method returns observation attributes list.
	getRootSeriesCount	The getRootSeriesCount method returns the number of root series.
	getRealIndex	The getRealIndex method returns series index.
	getRubOdId	The getRubOdId method determines a moniker of time series database.
	getRubsOdId	The getRubsOdId method returns moniker of factors catalog with the rubKey key.
	getSelectedOrPinnedSeries	The getSelectedOrPinnedSeries method returns the selected series or the pinned series if there is any.
	getSelectionTimeRanges	The getSelectionTimeRanges method returns the list of periods for the selected series.
	getSerie	The getSerie method returns a series from the cache of loaded series by its key.
	getSerieByIndexAndParent	The getSerieByIndexAndParent method returns a series by index of certain parent.
	getSerieDepth	The getSerieDepth method returns series nesting depth.
	getSerieVisibleSize	The getSerieVisibleSize method returns the number of rows occupied by a series and its children.
	hasRubrs	The hasRubrs method determines whether the workbook source is a time series database.
	isMapAvailable	The isMapAvailable method determines whether the Map data view is available in a workbook.
	isSerieSelected	The isSerieSelected method determines whether a series is selected.
	removeAllSelectedSeries	The removeAllSelectedSeries method removes information about selected table rows.
	removeSelectedSeries	The removeSelectedSeries method removes a table row from the array of selected rows.
	removeSeries	The removeSeries method removes table rows.
	updateSeriesList	The updateSeriesList method refreshes series list.

Properties inherited from the class PP.Exp.EaxAnalyzer

	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 GridSelectionType property contains a type of object selected in the express report table.
	IsDefaultHighlight	The IsDefaultHighlight property returns whether selection of express report elements is set by default.
	IsHasDataAvailable	The IsHasDataAvailable property determines whether on data change in dimensions the requests are sent to refresh the state of the @hasData field in dimension element metadata.
	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 TitleChangedData 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.

Methods inherited from the class PP.Exp.EaxAnalyzer

	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.

Properties inherited from the class PP.MbObject

	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.
	Params	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.

Methods inherited from the class PP.Mb.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.

Properties inherited from the class Descriptor

	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.
	ParentKey	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.

Methods inherited from the class Descriptor

	Method name	Brief description
	getState	The getState method returns object descriptor metadata: values of all properties of the Descriptor class.

Properties inherited from the class Object

	Property name	Brief description
	Id	The Id property determines a repository object identifier.

Methods inherited from the class Object

	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.
	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.
	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:

PP.TS