Dimension

Namespace: PP.Mb;

Inheritance hierarchy

PP.Mb.Descriptor

PP.Mb.Dimension

Description

The Dimension class implements a dictionary model.

Syntax

PP.initClass(PP.Mb.Dimension, PP.Mb.Object, "Dimension");

Properties

	Property name	Brief description
	AllowHasData	The AllowHasData property determines whether to load characteristic that indicates availability of dimension element data.
	AllowSelection	The AllowSelection property determines whether selection by elements can be set.
	ChildEls	The ChildEls property sets an array of children for selected dictionary element.
	FilterEls	The FilterEls property contains an object with element filter parameters.
	IsAllElsLoaded	The IsAllElsLoaded property determines whether all dictionary elements are loaded together with their children.
	IsEmpty	The IsEmpty property determines whether dimension contains elements.
	MultiSelect	The MultiSelect property determines whether multiple elements selection is available in the dictionary.
	SelectedCount	The SelectedCount property determines how many elements are selected in the dictionary.
	TotalCount	The TotalCount property determines total number of elements in dictionary.

Methods

	Method name	Brief description
	addChildElem	The addChildElem method adds a dictionary child.
	clearDimItems	The clearDimItems method clears the list of uploaded dictionary elements.
	clearFilterCache	The clearFilterCache clears filter parameters for all elements.
	deSelectAll	The deSelectAll method removes selection from all uploaded dictionary elements.
	deselectEl	The deselectEl method clears element selection.
	deSelectChild	The deSelectChild method removes selection from children of a specified dictionary element.
	deSelectLevel	The deSelectLevel method deselects all elements on the specified level.
	getActiveGroup	The getActiveGroup method returns active dimension group.
	getActiveHierarchy	The getActiveHierarchy method returns active alternative dimension hierarchy.
	getActiveSchema	The getActiveSchema method returns active dimension selection schema.
	getAttribute	The getAttribute method returns dimension attribute by its identifier.
	getAttributeIndex	The getAttributeIndex method returns attribute index by its identifier.
	getAttributes	The getAttributes method returns array of dictionary attributes.
	getElem	The getElem method returns JSON object of the dictionary element.
	getElemHasDataState	The getElemHasDataState method returns whether dimension element contains any data.
	getElemSelectionState	The getElemSelectionState method returns whether dimension element is selected.
	getFirstItemByLevel	The getFirstItemByLevel method returns the first element of the set level.
	getFirstSelectedText	The getFirstSelectedText method returns text of the first selected element.
	getGroups	The getGroups method returns information about all groups of dictionary elements.
	getHasDataElems	The getHasDataElems method returns an array of elements that contain data.
	getHierarchies	The getHierarchies method returns description of alternative hierarchies for dictionary.
	getIsStartUpdate	The getIsStartUpdate method returns whether the optimal work mode is enabled for dimension update start and end methods.
	getLastSelectedText	The getLastSelectedText method returns text of the last selected element.
	getMaxLoadedLevel	The getMaxLoadedLevel method returns index of the lowest dictionary level from which at least one element was loaded.
	getSchemas	The getSchemas method returns information about all available selection schemas for the dictionary.
	removeElem	The removeElem method removes an element by key.
	selectAll	The selectAll method selects all elements in dictionary.
	selectChild	The selectChild method selects children of a specified dictionary element.
	selectEl	The selectEl method sets element selection.
	selectLevel	The selectLevel method selects all elements on the specified level.
	setDataEls	The setDataEls method sets array of dimension elements that contain data.
	setSelectedEls	The setSelectedEls method sets array of selected dimension elements.

Events

	Property name	Brief description
	ElsChanged	The ElsChanged event occurs after changing dimension elements.

Properties inherited from the class Object

	Property name	Brief description
	Metabase	The Metabase method determines a repository that stores the object.
	OdId	The OdId property determines a string of repository object moniker.
	PPService	The PPService property determines a service for working with a repository object.

Methods inherited from the class Object

	Method name	Brief description
	getReadOnly	The getReadOnly method determines whether an object is available for editing.

Properties inherited from the class Descriptor

	Property name	Brief description
	Key	The Key property determines a repository object key.
	Metadata	The Metadata property determines object metadata.
	Name	The Name property determines object name.

Methods inherited from the class Descriptor

	Method name	Brief description
	getClass	The getClass method returns class of repository object.
	getHasChildren	The getHasChildren method determines whether an object has child objects.
	getIsShortcut	The getIsShortcut method indicates whether an object is a shortcut.
	getParentKey	The getParentKey method returns key of the parent object.
	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
	Data	The Data property associates a random object with this component.
	Id	The Id property sets component identifier.
	Settings	The Settings property sets component parameters.

Methods inherited from the class Object

	Method name	Brief description
	clone	The clone method creates a copy of object. It is not implemented in PP.Ui.Control.
	dispose	The dispose method deletes the component.
	getTypeName	The getTypeName method returns the name of the object type without the namespace, to which it belongs.

See also: