Class %DeepSee.Dashboard.Definition

persistent class %DeepSee.Dashboard.Definition extends %DeepSee.UserLibrary.FolderItem

This persistent class represents the contents of a user-defined DeepSee dashboard.
APIs for dealing with Dashboard definitions are in the %DeepSee.Dashboard.Utils class.
The logic for converting definitions into visible items is in the %DeepSee.UserPortal.DashboardViewer class.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
4	9	4

Summary

Properties
canModify	canResize	createdBy	description	documentName
folder	folderName	fullName	gridCols	gridRows
keywords	locked	name	owner	public
resource	scheme	shared	snapGrid	snapTo
timeCreated	timeModified	title	widgets	worklistCount

Methods
%%OIDGet	%AddToSaveSet	%AddToSyncSet	%BMEBuilt
%BuildIndices	%CheckResource	%CheckUnique	%ClassIsLatestVersion
%ClassName	%ComposeOid	%ConstructClone	%Delete
%DeleteExtent	%DeleteId	%DispatchClassMethod	%DispatchGetModified
%DispatchGetProperty	%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty
%DispatchSetProperty	%Dump	%Exists	%ExistsId
%Extends	%GUID	%GUIDSet	%GetDependencies
%GetIcon	%GetLargeIcon	%GetLock	%GetParameter
%GetResource	%GetSwizzleObject	%GetTypeName	%GetURL
%Id	%InsertBatch	%IsA	%IsModified
%KillExtent	%KillExtentData	%LoadFromMemory	%LockExtent
%LockId	%New	%NormalizeObject	%ObjectModified
%Oid	%OnAfterImport	%OnBeforeAddToSync	%OnDetermineClass
%Open	%OpenId	%OriginalNamespace	%PackageName
%ParseFullName	%PhysicalAddress	%PurgeIndices	%Reload
%RemoveFromSaveSet	%ResolveConcurrencyConflict	%RollBack	%Save
%SaveDirect	%SaveIndices	%SerializeObject	%SetModified
%SortBegin	%SortEnd	%SyncObjectIn	%SyncTransport
%UnlockExtent	%UnlockId	%ValidateObject	XMLDTD
XMLExport	XMLExportToStream	XMLExportToString	XMLNew
XMLSchema	XMLSchemaNamespace	XMLSchemaType	documentNameGet
folderNameGet	folderNameSet	fullNameFromDocumentName	fullNameGet
fullNameSet

Parameters

• parameter ICON = "deepsee/ds2_dashboard_22.png";

URL of icon for this item

• parameter ITEMTYPE = "dashboard";

This is the extension returned by this type from the Finder.

• parameter LARGEICON = "deepsee/ds2_dashboard_44.png";

URL of large icon for this item

• parameter XMLNAME = "dashboard";

This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties

• property canModify as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 1 ];

User can change widget definitions.

• property canResize as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 1 ];

User can move and resize widgets.

• property gridCols as %Integer(XMLPROJECTION="attribute") [ InitialExpression = 2 ];

Number of columns when using the new snapGrid layout mode.

• property gridRows as %Integer(XMLPROJECTION="attribute") [ InitialExpression = 2 ];

Number of rows when using the new snapGrid layout mode.

• property scheme as %String(MAXLEN=100,XMLPROJECTION="attribute");

Name of color scheme to use for this dashboard.

• property snapGrid as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];

Dashboard uses the new snapGrid layout mode.

• property snapTo as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 1 ];

Dashboard is in "snap to grid" mode.

• property widgets as list of Widget(XMLNAME="widget",XMLPROJECTION="element");

Set of visual widgets displayed on this dashboard.

• property worklistCount as %Integer(MAXVAL=2,MINVAL=0,XMLPROJECTION="attribute") [ InitialExpression = 2 ];

Number of worklist boxes to display on the page.

Methods

• method %Dump() as %Status

Diagnostic method: display contents of this folder item to the console.

• method %GetDependencies(pList As %String) as %Status

Return a list of all other folder items (including cubes or kpis) that this item depends upon.

• method %GetTypeName() as %String

Return the localized type name for this item.

• method %GetURL() as %String

Return the URL for this item.


[BASEXML] > [%DeepSee] > [Dashboard] > [Definition]		Private Storage