Skip to main content

%DeepSee.Dashboard.Element

Class %DeepSee.Dashboard.Element Extends %RegisteredObject [ System = 3 ]

This class represents the saved state of a dashboard element. Instances are stored using a generic name-value pair mechanism to provide maximum flexibility.

Properties​

%changed​

Property %changed As %ZEN.Datatype.boolean [ InitialExpression = 0, Internal, Transient ];

Internal property used to track if this object is modified.

%parentGLVN​

Property %parentGLVN As %String [ Internal, Transient ];

Parent storage location (if any).

%container​

Property %container As %String [ Internal, Transient ];

For child element, this the type of its container (or containing array key).

%id​

Property %id As %String(MAXLEN = 255) [ Internal ];

Id used to save the element (based on the name).

%name​

Property %name As %String(MAXLEN = 255);

User-specified name of the element.

%type​

Property %type As %String(MAXLEN = 255);

Type of this element.

%createTime​

Property %createTime As %TimeStamp;

Time this element was created.

%modifiedTime​

Property %modifiedTime As %TimeStamp;

Time this item was most recently modified.

%data​

Property %data [ Internal, MultiDimensional ];

Holder of name/value pairs.

Methods​

%DispatchGetProperty​

Method %DispatchGetProperty(pProperty As %String) [ Final, Internal ]

Property dispatch method to catch references to virtual properties.
This should not be called directly.

%DispatchSetProperty​

Method %DispatchSetProperty(pProperty As %String, pValue As %String) [ Final, Internal ]

Property dispatch method to catch references to virtual properties.
This should not be called directly.

%Clear​

Method %Clear() [ Final ]

Delete all name/value pairs currently in this object.

%CopyToArray​

Method %CopyToArray(Output pArray) [ Final ]

Copy the name/value pairs in this element into a local array subscripted by property name.

%CopyFromArray​

Method %CopyFromArray(ByRef pArray) [ Final ]

Copy the values from a local array (subscripted by property name) into this element.

%Save​

Method %Save() As %Status [ Final ]

Save this element.

%ExistsId​

ClassMethod %ExistsId(pID As %String) As Element [ CodeMode = expression, Final ]

Open this element given its unique name.

%KillExtent​

ClassMethod %KillExtent() As %Status [ Final ]

Delete all elements.

%OpenId​

ClassMethod %OpenId(pID As %String, Output pSC As %Status) As Element [ Final ]

Open this element given its unique name.

%DeleteId​

Method %DeleteId(pID As %String) As %Status [ Final ]

Delete this element given it unique name.

%CopyFromObject​

Method %CopyFromObject(pObject As %RegisteredObject) As %Status

Copy data from an object into this element.

%CopyToObject​

Method %CopyToObject(pObject As %RegisteredObject) As %Status

Copy data from this element to an object.

%GetSettings​

ClassMethod %GetSettings(pType As %String, Output pSettings) As %Status

Get settings meta-data for the given element type.