ElsFilter

Namespace: PP.Mb;

Inheritance hierarchy

Object

ElsTree

Description

The ElsFilter class implements dimension element filter.

Syntax

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

Properties

	Property name	Brief description
	IncludeParents	The IncludeParents property determines including of the parent elements to filtering result.
	IncludeParentsWithSiblings	The IncludeParentsWithSiblings property determines including of parent elements and their neighbor elements to filtering result.
	MbJSONDelegate	The MbJSONDelegate property determines JSON generation handler by the ElsFilter.getFilterJSON method.
	TextAttributes	The TextAttributes property returns array of attributes' identifiers, by which filtering is executed.
	TextCaseSensitive	The TextCaseSensitive method determines whether filtering by attributes is case-sensitive.
	TextValue	The TextValue method determines search bar on filtering by attributes.
	TextWholeWordsOnly	The TextWholeWordsOnly property determines search only by whole words on element filtering.

Methods

	Method name	Brief description
	getFilterJSON	The getFilterJSON method returns filtering settings in the format: tns_PP7_SOM:ElsFilter.
	getHash	The getHash method returns an hash string that contains filtering parameters.
	IsCustomHash	The isCustomHash method determines whether hash is set by the user.
	setCustomHash	The setCustomHash method sets hash string of filter.

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

PP.Mb