Class Reference
IRIS for UNIX 2024.1.2
 InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%DeepSee] >  [Dashboard] >  [Definition]
Private  Storage   

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 31 5


Summary

Properties
ReadOnly Timestamp backgroundColor backgroundImage
backgroundOpacity backgroundRepeat backgroundSize bookCover
canModify canResize category companyLogo
companyName companyStyle createdBy description
documentName folder folderName fullName
gridCols gridRows keywords lastAccessed
locked name owner public
resource scheme selectedTitleBarColor selectedTitleBarOpacity
selectedTitleBarTextColor shared showTitleBar snapGrid
snapTo timeCreated timeModified title
titleBarColor titleBarFont titleBarOpacity titleBarTextColor
widgetBorders widgetBordersColor widgetBordersStyle widgetBordersSwitch
widgetBordersToggle widgetBordersWidth widgets worklistCount

Methods
%%CLASSNAMELogicalToStorage %%CLASSNAMEStorageToLogical %AddToSaveSet %AddToSyncSet
%BMEBuilt %BuildIndicesAsync %BuildIndicesAsyncResponse %CheckConstraints
%CheckConstraintsForExtent %CheckResource %ClassIsLatestVersion %ClassName
%ComposeOid %ConstructClone %CopyToDao %Delete
%DeleteExtent %DeleteId %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Dump %Exists %ExistsId
%Extends %GUID %GUIDSet %GetCoverSpec
%GetDependencies %GetIcon %GetLargeIcon %GetLock
%GetParameter %GetResource %GetSwizzleObject %GetTypeName
%GetURL %Id %InsertBatch %IsA
%IsModified %IsNull %KillExtent %KillExtentData
%LoadFromMemory %LockExtent %LockId %New
%NormalizeObject %ObjectIsNull %ObjectModified %Oid
%OnAfterImport %OnBeforeAddToSync %OnDeleteFinally %OnDetermineClass
%OnOpenFinally %OnSaveFinally %Open %OpenId
%OriginalNamespace %PackageName %ParseFullName %PhysicalAddress
%PurgeIndices %Reload %RemoveFromSaveSet %ResolveConcurrencyConflict
%RollBack %Save %SaveDirect %SaveIndices
%SerializeObject %SetModified %SortBegin %SortEnd
%SyncObjectIn %SyncTransport %UnlockExtent %UnlockId
%ValidateIndices %ValidateObject %ValidateTable 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 backgroundColor as %ZEN.Datatype.color [ InitialExpression = "white" ];
background color of dashboard
• property backgroundImage as %ZEN.Datatype.string [ InitialExpression = "none" ];
background image of dashboard
• property backgroundOpacity as %ZEN.Datatype.float [ InitialExpression = 1.0 ];
background opacity of dashboard
• property backgroundRepeat as %ZEN.Datatype.string [ InitialExpression = "no-repeat" ];
background image of dashboard
• property backgroundSize as %ZEN.Datatype.string [ InitialExpression = "100% 100%" ];
background image of dashboard
• 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 companyLogo as %String(MAXLEN=512,XMLPROJECTION="attribute");
Local override of company logo.
• property companyName as %String(MAXLEN=512,XMLPROJECTION="attribute");
Local override of company name.
• property companyStyle as %String(MAXLEN=1000,XMLPROJECTION="attribute");
Local override of company style.
• property gridCols as %Integer(XMLPROJECTION="attribute") [ InitialExpression = 10 ];
Number of columns when using the new snapGrid layout mode.
• property gridRows as %Integer(XMLPROJECTION="attribute") [ InitialExpression = 10 ];
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 selectedTitleBarColor as %ZEN.Datatype.color(XMLPROJECTION="attribute");
Specify color of title bars.
• property selectedTitleBarOpacity as %ZEN.Datatype.float(XMLPROJECTION="attribute");
Specify opacity of title bars.
• property selectedTitleBarTextColor as %ZEN.Datatype.color(XMLPROJECTION="attribute");
Specify color of title bar text for selected widgets.
• property showTitleBar as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 1 ];
Display widget title bars.
• property snapGrid as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];
Dashboard uses the new snapGrid layout mode.
• property snapTo as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];
Dashboard is in "snap to grid" mode.
• property titleBarColor as %ZEN.Datatype.color(XMLPROJECTION="attribute");
Specify color of title bars.
• property titleBarFont as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Specify font of title bar text
• property titleBarOpacity as %ZEN.Datatype.float(XMLPROJECTION="attribute");
Specify opacity of title bars.
• property titleBarTextColor as %ZEN.Datatype.color(XMLPROJECTION="attribute");
Specify color of title bars.
• property widgetBorders as %ZEN.Datatype.string [ InitialExpression = "1px solid #F0F0F0" ];
border of widgets in dashboard
• property widgetBordersColor as %ZEN.Datatype.string [ InitialExpression = "#F0F0F0" ];
color of widgets border
• property widgetBordersStyle as %ZEN.Datatype.string [ InitialExpression = "solid" ];
style of widgets border, e.g. solid, dashed, dotted
• property widgetBordersSwitch as %ZEN.Datatype.string [ InitialExpression = "edit" ];
Whether border is none, inherit or "width style color"
• property widgetBordersToggle as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Whether borders of widgets are on or off
• property widgetBordersWidth as %ZEN.Datatype.string [ InitialExpression = "1" ];
width of widgets border
• 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 %CopyToDao(ByRef pDynamicObj As %DynamicObject = $$$NULLOREF) as %Status
• 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.

Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.