This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions pageOpens in a new window (login required).

Caché & Ensemble 2018.1.5Opens in a new window > Class Reference > %SYS namespace > %DeepSee.Dashboard.Definition

%DeepSee.Dashboard.Definition

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

SQL Table Name: %DeepSee_Dashboard.Definition

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.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter ICON = deepsee/ds2_dashboard_22.png;
Inherited description: URL of icon for this item
parameter ITEMTYPE = dashboard;
Inherited description: This is the extension returned by this type from the Finder.
parameter LARGEICON = deepsee/ds2_dashboard_44.png;
Inherited description: URL of large icon for this item
parameter XMLNAME = dashboard;
Inherited description: 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 (Including Private)

property backgroundColor as %ZEN.Datatype.color [ InitialExpression = "white" ];
background color of dashboard
Property methods: backgroundColorDisplayToLogical(), backgroundColorGet(), backgroundColorGetStored(), backgroundColorIsValid(), backgroundColorLogicalToDisplay(), backgroundColorLogicalToOdbc(), backgroundColorNormalize(), backgroundColorSet()
property backgroundImage as %ZEN.Datatype.string [ InitialExpression = "none" ];
background image of dashboard
Property methods: backgroundImageDisplayToLogical(), backgroundImageGet(), backgroundImageGetStored(), backgroundImageIsValid(), backgroundImageLogicalToDisplay(), backgroundImageLogicalToOdbc(), backgroundImageNormalize(), backgroundImageSet()
property backgroundOpacity as %ZEN.Datatype.float [ InitialExpression = 1.0 ];
background opacity of dashboard
Property methods: backgroundOpacityDisplayToLogical(), backgroundOpacityGet(), backgroundOpacityGetStored(), backgroundOpacityIsValid(), backgroundOpacityLogicalToDisplay(), backgroundOpacityLogicalToOdbc(), backgroundOpacityNormalize(), backgroundOpacitySet()
property backgroundRepeat as %ZEN.Datatype.string [ InitialExpression = "no-repeat" ];
background image of dashboard
Property methods: backgroundRepeatDisplayToLogical(), backgroundRepeatGet(), backgroundRepeatGetStored(), backgroundRepeatIsValid(), backgroundRepeatLogicalToDisplay(), backgroundRepeatLogicalToOdbc(), backgroundRepeatNormalize(), backgroundRepeatSet()
property backgroundSize as %ZEN.Datatype.string [ InitialExpression = "100% 100%" ];
background image of dashboard
Property methods: backgroundSizeDisplayToLogical(), backgroundSizeGet(), backgroundSizeGetStored(), backgroundSizeIsValid(), backgroundSizeLogicalToDisplay(), backgroundSizeLogicalToOdbc(), backgroundSizeNormalize(), backgroundSizeSet()
property canModify as %Boolean (XMLPROJECTION = "attribute") [ InitialExpression = 1 ];
User can change widget definitions.
Property methods: canModifyDisplayToLogical(), canModifyGet(), canModifyGetStored(), canModifyIsValid(), canModifyLogicalToDisplay(), canModifyLogicalToXSD(), canModifyNormalize(), canModifySet(), canModifyXSDToLogical()
property canResize as %Boolean (XMLPROJECTION = "attribute") [ InitialExpression = 1 ];
User can move and resize widgets.
Property methods: canResizeDisplayToLogical(), canResizeGet(), canResizeGetStored(), canResizeIsValid(), canResizeLogicalToDisplay(), canResizeLogicalToXSD(), canResizeNormalize(), canResizeSet(), canResizeXSDToLogical()
Local override of company logo.
Property methods: companyLogoDisplayToLogical(), companyLogoGet(), companyLogoGetStored(), companyLogoIsValid(), companyLogoLogicalToDisplay(), companyLogoLogicalToOdbc(), companyLogoNormalize(), companyLogoSet()
property companyName as %String (MAXLEN = 512, XMLPROJECTION = "attribute");
Local override of company name.
Property methods: companyNameDisplayToLogical(), companyNameGet(), companyNameGetStored(), companyNameIsValid(), companyNameLogicalToDisplay(), companyNameLogicalToOdbc(), companyNameNormalize(), companyNameSet()
property companyStyle as %String (MAXLEN = 1000, XMLPROJECTION = "attribute");
Local override of company style.
Property methods: companyStyleDisplayToLogical(), companyStyleGet(), companyStyleGetStored(), companyStyleIsValid(), companyStyleLogicalToDisplay(), companyStyleLogicalToOdbc(), companyStyleNormalize(), companyStyleSet()
property gridCols as %Integer (XMLPROJECTION = "attribute") [ InitialExpression = 10 ];
Number of columns when using the new snapGrid layout mode.
Property methods: gridColsDisplayToLogical(), gridColsGet(), gridColsGetStored(), gridColsIsValid(), gridColsLogicalToDisplay(), gridColsNormalize(), gridColsSet(), gridColsXSDToLogical()
property gridRows as %Integer (XMLPROJECTION = "attribute") [ InitialExpression = 10 ];
Number of rows when using the new snapGrid layout mode.
Property methods: gridRowsDisplayToLogical(), gridRowsGet(), gridRowsGetStored(), gridRowsIsValid(), gridRowsLogicalToDisplay(), gridRowsNormalize(), gridRowsSet(), gridRowsXSDToLogical()
property scheme as %String (MAXLEN = 100, XMLPROJECTION = "attribute");
Name of color scheme to use for this dashboard.
Property methods: schemeDisplayToLogical(), schemeGet(), schemeGetStored(), schemeIsValid(), schemeLogicalToDisplay(), schemeLogicalToOdbc(), schemeNormalize(), schemeSet()
property selectedTitleBarColor as %ZEN.Datatype.color (XMLPROJECTION = "attribute");
Specify color of title bars.
Property methods: selectedTitleBarColorDisplayToLogical(), selectedTitleBarColorGet(), selectedTitleBarColorGetStored(), selectedTitleBarColorIsValid(), selectedTitleBarColorLogicalToDisplay(), selectedTitleBarColorLogicalToOdbc(), selectedTitleBarColorNormalize(), selectedTitleBarColorSet()
property selectedTitleBarOpacity as %ZEN.Datatype.float (XMLPROJECTION = "attribute");
Specify opacity of title bars.
Property methods: selectedTitleBarOpacityDisplayToLogical(), selectedTitleBarOpacityGet(), selectedTitleBarOpacityGetStored(), selectedTitleBarOpacityIsValid(), selectedTitleBarOpacityLogicalToDisplay(), selectedTitleBarOpacityLogicalToOdbc(), selectedTitleBarOpacityNormalize(), selectedTitleBarOpacitySet()
property selectedTitleBarTextColor as %ZEN.Datatype.color (XMLPROJECTION = "attribute");
Specify color of title bar text for selected widgets.
Property methods: selectedTitleBarTextColorDisplayToLogical(), selectedTitleBarTextColorGet(), selectedTitleBarTextColorGetStored(), selectedTitleBarTextColorIsValid(), selectedTitleBarTextColorLogicalToDisplay(), selectedTitleBarTextColorLogicalToOdbc(), selectedTitleBarTextColorNormalize(), selectedTitleBarTextColorSet()
property showTitleBar as %Boolean (XMLPROJECTION = "attribute") [ InitialExpression = 1 ];
Display widget title bars.
Property methods: showTitleBarDisplayToLogical(), showTitleBarGet(), showTitleBarGetStored(), showTitleBarIsValid(), showTitleBarLogicalToDisplay(), showTitleBarLogicalToXSD(), showTitleBarNormalize(), showTitleBarSet(), showTitleBarXSDToLogical()
property snapGrid as %Boolean (XMLPROJECTION = "attribute") [ InitialExpression = 0 ];
Dashboard uses the new snapGrid layout mode.
Property methods: snapGridDisplayToLogical(), snapGridGet(), snapGridGetStored(), snapGridIsValid(), snapGridLogicalToDisplay(), snapGridLogicalToXSD(), snapGridNormalize(), snapGridSet(), snapGridXSDToLogical()
property snapTo as %Boolean (XMLPROJECTION = "attribute") [ InitialExpression = 0 ];
Dashboard is in "snap to grid" mode.
Property methods: snapToDisplayToLogical(), snapToGet(), snapToGetStored(), snapToIsValid(), snapToLogicalToDisplay(), snapToLogicalToXSD(), snapToNormalize(), snapToSet(), snapToXSDToLogical()
property titleBarColor as %ZEN.Datatype.color (XMLPROJECTION = "attribute");
Specify color of title bars.
Property methods: titleBarColorDisplayToLogical(), titleBarColorGet(), titleBarColorGetStored(), titleBarColorIsValid(), titleBarColorLogicalToDisplay(), titleBarColorLogicalToOdbc(), titleBarColorNormalize(), titleBarColorSet()
property titleBarFont as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Specify font of title bar text
Property methods: titleBarFontDisplayToLogical(), titleBarFontGet(), titleBarFontGetStored(), titleBarFontIsValid(), titleBarFontLogicalToDisplay(), titleBarFontLogicalToOdbc(), titleBarFontNormalize(), titleBarFontSet()
property titleBarOpacity as %ZEN.Datatype.float (XMLPROJECTION = "attribute");
Specify opacity of title bars.
Property methods: titleBarOpacityDisplayToLogical(), titleBarOpacityGet(), titleBarOpacityGetStored(), titleBarOpacityIsValid(), titleBarOpacityLogicalToDisplay(), titleBarOpacityLogicalToOdbc(), titleBarOpacityNormalize(), titleBarOpacitySet()
property titleBarTextColor as %ZEN.Datatype.color (XMLPROJECTION = "attribute");
Specify color of title bars.
Property methods: titleBarTextColorDisplayToLogical(), titleBarTextColorGet(), titleBarTextColorGetStored(), titleBarTextColorIsValid(), titleBarTextColorLogicalToDisplay(), titleBarTextColorLogicalToOdbc(), titleBarTextColorNormalize(), titleBarTextColorSet()
property widgetBorders as %ZEN.Datatype.string [ InitialExpression = "1px solid #F0F0F0" ];
border of widgets in dashboard
Property methods: widgetBordersColorDisplayToLogical(), widgetBordersColorGet(), widgetBordersColorGetStored(), widgetBordersColorIsValid(), widgetBordersColorLogicalToDisplay(), widgetBordersColorLogicalToOdbc(), widgetBordersColorNormalize(), widgetBordersColorSet(), widgetBordersDisplayToLogical(), widgetBordersGet(), widgetBordersGetStored(), widgetBordersIsValid(), widgetBordersLogicalToDisplay(), widgetBordersLogicalToOdbc(), widgetBordersNormalize(), widgetBordersSet(), widgetBordersStyleDisplayToLogical(), widgetBordersStyleGet(), widgetBordersStyleGetStored(), widgetBordersStyleIsValid(), widgetBordersStyleLogicalToDisplay(), widgetBordersStyleLogicalToOdbc(), widgetBordersStyleNormalize(), widgetBordersStyleSet(), widgetBordersSwitchDisplayToLogical(), widgetBordersSwitchGet(), widgetBordersSwitchGetStored(), widgetBordersSwitchIsValid(), widgetBordersSwitchLogicalToDisplay(), widgetBordersSwitchLogicalToOdbc(), widgetBordersSwitchNormalize(), widgetBordersSwitchSet(), widgetBordersToggleDisplayToLogical(), widgetBordersToggleGet(), widgetBordersToggleGetStored(), widgetBordersToggleIsValid(), widgetBordersToggleLogicalToDisplay(), widgetBordersToggleLogicalToOdbc(), widgetBordersToggleLogicalToXSD(), widgetBordersToggleNormalize(), widgetBordersToggleSet(), widgetBordersToggleXSDToLogical(), widgetBordersWidthDisplayToLogical(), widgetBordersWidthGet(), widgetBordersWidthGetStored(), widgetBordersWidthIsValid(), widgetBordersWidthLogicalToDisplay(), widgetBordersWidthLogicalToOdbc(), widgetBordersWidthNormalize(), widgetBordersWidthSet()
property widgetBordersColor as %ZEN.Datatype.string [ InitialExpression = "#F0F0F0" ];
color of widgets border
Property methods: widgetBordersColorDisplayToLogical(), widgetBordersColorGet(), widgetBordersColorGetStored(), widgetBordersColorIsValid(), widgetBordersColorLogicalToDisplay(), widgetBordersColorLogicalToOdbc(), widgetBordersColorNormalize(), widgetBordersColorSet()
property widgetBordersStyle as %ZEN.Datatype.string [ InitialExpression = "solid" ];
style of widgets border, e.g. solid, dashed, dotted
Property methods: widgetBordersStyleDisplayToLogical(), widgetBordersStyleGet(), widgetBordersStyleGetStored(), widgetBordersStyleIsValid(), widgetBordersStyleLogicalToDisplay(), widgetBordersStyleLogicalToOdbc(), widgetBordersStyleNormalize(), widgetBordersStyleSet()
property widgetBordersSwitch as %ZEN.Datatype.string [ InitialExpression = "edit" ];
Whether border is none, inherit or "width style color"
Property methods: widgetBordersSwitchDisplayToLogical(), widgetBordersSwitchGet(), widgetBordersSwitchGetStored(), widgetBordersSwitchIsValid(), widgetBordersSwitchLogicalToDisplay(), widgetBordersSwitchLogicalToOdbc(), widgetBordersSwitchNormalize(), widgetBordersSwitchSet()
property widgetBordersToggle as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Whether borders of widgets are on or off
Property methods: widgetBordersToggleDisplayToLogical(), widgetBordersToggleGet(), widgetBordersToggleGetStored(), widgetBordersToggleIsValid(), widgetBordersToggleLogicalToDisplay(), widgetBordersToggleLogicalToOdbc(), widgetBordersToggleLogicalToXSD(), widgetBordersToggleNormalize(), widgetBordersToggleSet(), widgetBordersToggleXSDToLogical()
property widgetBordersWidth as %ZEN.Datatype.string [ InitialExpression = "1" ];
width of widgets border
Property methods: widgetBordersWidthDisplayToLogical(), widgetBordersWidthGet(), widgetBordersWidthGetStored(), widgetBordersWidthIsValid(), widgetBordersWidthLogicalToDisplay(), widgetBordersWidthLogicalToOdbc(), widgetBordersWidthNormalize(), widgetBordersWidthSet()
property widgets as list of Widget (XMLNAME = "widget", XMLPROJECTION = "element");
Set of visual widgets displayed on this dashboard.
Property methods: widgetsBuildValueArray(), widgetsCollectionToDisplay(), widgetsCollectionToOdbc(), widgetsDisplayToCollection(), widgetsGet(), widgetsGetObject(), widgetsGetObjectId(), widgetsGetStored(), widgetsGetSwizzled(), widgetsIsValid(), widgetsOdbcToCollection(), widgetsSet(), widgetsSetObject(), widgetsSetObjectId()
property worklistCount as %Integer (MAXVAL = 2, MINVAL = 0, XMLPROJECTION = "attribute") [ InitialExpression = 2 ];
Number of worklist boxes to display on the page.
Property methods: worklistCountDisplayToLogical(), worklistCountGet(), worklistCountGetStored(), worklistCountIsValid(), worklistCountLogicalToDisplay(), worklistCountNormalize(), worklistCountSet(), worklistCountXSDToLogical()

Methods (Including Private)

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.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Storage

Gray indicates storage defined by superclasses.

Storage Model: CacheStorage (%DeepSee.UserLibrary.FolderItem)

^DeepSee.FolderItemD(ID)
=
%%CLASSNAME
folder
name
keywords
owner
shared
resource
timeCreated
timeModified
dummy
description
title
locked
public
createdBy
bookCover
category

Storage Model: CacheStorage (%DeepSee.Dashboard.Definition)

^DeepSee.FolderItemD(ID,"Definition")
=
scheme
title
widgets
controls
worklistCount
snapTo
snapGrid
gridRows
gridCols
canResize
canModify
showTitleBar
companyName
companyLogo
companyStyle
backgroundColor
backgroundImage
backgroundRepeat
backgroundSize
backgroundOpacity
widgetBorders
widgetBordersSwitch
widgetBordersColor
widgetBordersStyle
widgetBordersWidth
widgetBordersToggle
titleBarOpacity
titleBarColor
userModifiedTitleBars
selectedTitleBarOpacity
selectedTitleBarColor
titleBarTextColor
selectedTitleBarTextColor
titleBarFont
FeedbackOpens in a new window