HieService

Namespace: PP.TS;

Inheritance Hierarchy

Object

PP.Mb.PPService

HieService

Description

The HieService class is used to work with hierarchy of time series database in Foresight Analytics Platform.

Syntax

PP.initClass(PP.TS.HieService, PP.Mb.PPService, "HieService");

Constructor

	Constructor name	Brief description
	HieService	The HieService constructor creates an instance of the HieService class.

Properties

	Property name	Brief description
	Metadata	The Metadata property sends a request to get series hierarchy metadata.

Methods

	Method name	Brief description
	close	The close method closes a hierarchy object.
	getChildEls	The getChildEls method is used to upload child elements.
	getGetMetadataSettings	The getGetMetadataSettings method returns body of the request to get series hierarchy metadata.
	getMetabase	The getMetabase method returns a metabase instance
	getSetMetadataSettings	The getSetMetadataSettings method returns body of the request to save series hierarchy metadata.
	open	The open method sends a request to open workbook hierarchy by one of the parameters.
	openFromRubKey	The openFromRubKey method sends a request to open workbook hierarchy by time series database key.
	openFromRubOdId	The openFromRubOdId method opens workbook hierarchy by time series database moniker.
	openFromSource	The openFromSource method sends a request to open hierarchy of main time series database in the workbook.
	setLevelsByAttributesIds	The setLevelsByAttributesIds  method sets tree levels in accordance with metaatributes' order.

Events

	Event name	Brief description
	ElementsLoaded	The ElementsLoaded event is fired when loading series hierarchy children is completed.
	HieOpened	The HieOpened event is fired when series hierarchy opening is completed.
	MetadataChanged	The MetadataChanged event occurs when changing series hierarchy metadata is finished.
	MetadataChangeStart	The MetadataChangeStart event occurs when series hierarchy metadata starts changing.

Methods inherited from the class PP.Mb.PPService

	Method name	Brief description
	addCallbackToLastRqt	The addCallbackToLastRqt adds a handler to the last request in the queue.
	beginSyncXHR	The beginSyncXHR method enables the mode of synchronous requests for an instance of the PPService class.
	clearRequests	The clearRequests method clears the list of queued requests and removes the current request.
	endSyncXHR	The endSyncXHR method disables the mode of synchronous requests for an instance of the PPService class.
	getCurrentRequest	The getCurrentRequest method returns the current service request.
	sendRequest	The sendRequest method sends a request to web service.

Events inherited from the class PP.Mb.PPService

	Event name	Brief description
	EndRequest	The EndRequest event occurs on finishing the repository connection.
	Error	The Error event occurs if an error occurs during repository connection.
	Executed	The Executed event occurs after executing a request to server.
	StartRequest	The StartRequest event occurs when the system starts executing a request to repository.

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