Skip to main content

%DeepSee.Dashboard.Definition

Class %DeepSee.Dashboard.Definition Extends %DeepSee.UserLibrary.FolderItem [ System = 4 ]

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.

Parameters​

XMLNAME​

Parameter XMLNAME = "dashboard";

ITEMTYPE​

Parameter ITEMTYPE = "dashboard";

ICON​

Parameter ICON = "deepsee/ds2_dashboard_22.png";

LARGEICON​

Parameter LARGEICON = "deepsee/ds2_dashboard_44.png";

Properties​

scheme​

Property scheme As %String(MAXLEN = 100, XMLPROJECTION = "attribute");

Name of color scheme to use for this dashboard.

worklistCount​

Property worklistCount As %Integer(MAXVAL = 2, MINVAL = 0, XMLPROJECTION = "attribute") [ InitialExpression = 2 ];

Number of worklist boxes to display on the page.

widgets​

Property widgets As list Of Widget(XMLNAME = "widget", XMLPROJECTION = "element");

Set of visual widgets displayed on this dashboard.

snapTo​

Property snapTo As %Boolean(XMLPROJECTION = "attribute") [ InitialExpression = 0 ];

Dashboard is in "snap to grid" mode.

snapGrid​

Property snapGrid As %Boolean(XMLPROJECTION = "attribute") [ InitialExpression = 0 ];

Dashboard uses the new snapGrid layout mode.

gridRows​

Property gridRows As %Integer(XMLPROJECTION = "attribute") [ InitialExpression = 10 ];

Number of rows when using the new snapGrid layout mode.

gridCols​

Property gridCols As %Integer(XMLPROJECTION = "attribute") [ InitialExpression = 10 ];

Number of columns when using the new snapGrid layout mode.

canResize​

Property canResize As %Boolean(XMLPROJECTION = "attribute") [ InitialExpression = 1 ];

User can move and resize widgets.

canModify​

Property canModify As %Boolean(XMLPROJECTION = "attribute") [ InitialExpression = 1 ];

User can change widget definitions.

showTitleBar​

Property showTitleBar As %Boolean(XMLPROJECTION = "attribute") [ InitialExpression = 1 ];

Display widget title bars.

titleBarOpacity​

Property titleBarOpacity As %ZEN.Datatype.float(XMLPROJECTION = "attribute");

Specify opacity of title bars.

titleBarColor​

Property titleBarColor As %ZEN.Datatype.color(XMLPROJECTION = "attribute");

Specify color of title bars.

selectedTitleBarOpacity​

Property selectedTitleBarOpacity As %ZEN.Datatype.float(XMLPROJECTION = "attribute");

Specify opacity of title bars.

selectedTitleBarColor​

Property selectedTitleBarColor As %ZEN.Datatype.color(XMLPROJECTION = "attribute");

Specify color of title bars.

titleBarTextColor​

Property titleBarTextColor As %ZEN.Datatype.color(XMLPROJECTION = "attribute");

Specify color of title bars.

selectedTitleBarTextColor​

Property selectedTitleBarTextColor As %ZEN.Datatype.color(XMLPROJECTION = "attribute");

Specify color of title bar text for selected widgets.

titleBarFont​

Property titleBarFont As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

Specify font of title bar text

companyName​

Property companyName As %String(MAXLEN = 512, XMLPROJECTION = "attribute");

Local override of company name.

Property companyLogo As %String(MAXLEN = 512, XMLPROJECTION = "attribute");

Local override of company logo.

companyStyle​

Property companyStyle As %String(MAXLEN = 1000, XMLPROJECTION = "attribute");

Local override of company style.

backgroundColor​

Property backgroundColor As %ZEN.Datatype.color [ InitialExpression = "white" ];

background color of dashboard

backgroundImage​

Property backgroundImage As %ZEN.Datatype.string [ InitialExpression = "none" ];

background image of dashboard

backgroundRepeat​

Property backgroundRepeat As %ZEN.Datatype.string [ InitialExpression = "no-repeat" ];

background image of dashboard

backgroundSize​

Property backgroundSize As %ZEN.Datatype.string [ InitialExpression = "100% 100%" ];

background image of dashboard

backgroundOpacity​

Property backgroundOpacity As %ZEN.Datatype.float [ InitialExpression = 1.0 ];

background opacity of dashboard

widgetBorders​

Property widgetBorders As %ZEN.Datatype.string [ InitialExpression = "1px solid #F0F0F0" ];

border of widgets in dashboard

widgetBordersSwitch​

Property widgetBordersSwitch As %ZEN.Datatype.string [ InitialExpression = "edit" ];

Whether border is none, inherit or "width style color"

widgetBordersColor​

Property widgetBordersColor As %ZEN.Datatype.string [ InitialExpression = "#F0F0F0" ];

color of widgets border

widgetBordersStyle​

Property widgetBordersStyle As %ZEN.Datatype.string [ InitialExpression = "solid" ];

style of widgets border, e.g. solid, dashed, dotted

widgetBordersWidth​

Property widgetBordersWidth As %ZEN.Datatype.string [ InitialExpression = "1" ];

width of widgets border

widgetBordersToggle​

Property widgetBordersToggle As %ZEN.Datatype.boolean [ InitialExpression = 1 ];

Whether borders of widgets are on or off

Methods​

%GetURL​

Method %GetURL() As %String

Return the URL for this item.

%GetTypeName​

Method %GetTypeName() As %String

Return the localized type name for this item.

%GetDependencies​

Method %GetDependencies(pList As %String) As %Status

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

%CopyToDao​

Method %CopyToDao(ByRef pDynamicObj As %DynamicObject = {$$$NULLOREF}) As %Status

%Dump​

Method %Dump() As %Status

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