Skip to main content

%DeepSee.Dashboard.Widget

Class %DeepSee.Dashboard.Widget Extends (%SerialObject, %XML.Adaptor) [ Final, System = 4 ]

This class represents the definition of a visual widget (such as a chart) within a user-defined DeepSee dashboard. This is what is saved to disk, not the actual visual component.

Parameters​

NAMESPACE​

Parameter NAMESPACE = "http://www.intersystems.com/deepsee/library";

XMLNAME​

Parameter XMLNAME = "widget";

XMLIGNORENULL​

Parameter XMLIGNORENULL = 1;

Properties​

name​

Property name As %String(MAXLEN = 255, XMLPROJECTION = "attribute");

Identifying name for this widget. This is used to logically identify the widget within a dashboard (such as for sending filter events to it).

key​

Property key As %String(MAXLEN = 255, XMLPROJECTION = "none") [ Internal ];

Internal key used to track this widget instance.

type​

Property type As %String(MAXLEN = 255, XMLPROJECTION = "attribute");

Which type of widget to display. This is the class name of a widget. If no class package is provided, then "%DeepSee.Component.Widget" is used.

subtype​

Property subtype As %String(MAXLEN = 255, XMLPROJECTION = "attribute");

Widget subtype. This is used by widgets that support various subtypes (such as a meter).

subtypeClass​

Property subtypeClass As %String(MAXLEN = 255, XMLPROJECTION = "attribute");

Widget subtype class. If the user overrides the subtype class (such as in a chart or meter), this holds the actual type.

title​

Property title As %String(MAXLEN = 255, XMLPROJECTION = "attribute");

Title to display for the widget.
Long titles may not display well.

dataSource​

Property dataSource As %String(MAXLEN = 255, XMLPROJECTION = "attribute");

Name of the data source for the widget. This is the name of the data source originally defined for this widget. It may be the case that the widget is using a local override of the data source (such as when a user uses the "analyze" button on a pivot widget).

localDataSource​

Property localDataSource As %String(MAXLEN = 255, XMLPROJECTION = "none") [ Transient ];

Name of local datasource, if the user has made a local modification to its datasource. This is stored in the dashboard settings global.

resetDataSource​

Property resetDataSource As %Boolean(XMLPROJECTION = "none") [ InitialExpression = 0, Transient ];

Indicates that the user-specific localDataSource for this widget should be cleared when this widget is saved.

Property dataLink As %String(MAXLEN = 255, XMLPROJECTION = "attribute");

If defined, this the name of a widget on the dashboard that provides the data for this widget. This overrides dataSource if present.

drillDownDataSource​

Property drillDownDataSource As %String(MAXLEN = 255, XMLPROJECTION = "attribute");

Name of the drill down data source for the widget. This is the name of a data source used when the user performs a "drill down" operation (if supported) on the widget. (This is a dashboard to display when the user drills down on a cell within a pivot widget).

top​

Property top As %Integer(MINVAL = 0, XMLPROJECTION = "attribute");

Top position of the widget.

left​

Property left As %Integer(MINVAL = 0, XMLPROJECTION = "attribute");

Left position of the widget.

width​

Property width As %Integer(MINVAL = 0, XMLPROJECTION = "attribute");

Width of the widget.

height​

Property height As %Integer(MINVAL = 0, XMLPROJECTION = "attribute");

Height of the widget.

sidebarContent​

Property sidebarContent As %ZEN.Datatype.html(XMLPROJECTION = "attribute");

HTML content of sidebar.

showSidebar​

Property showSidebar As %ZEN.Datatype.boolean(XMLPROJECTION = "attribute") [ InitialExpression = 0 ];

Specify whether to display a sidebar.

sidebarWidth​

Property sidebarWidth As %ZEN.Datatype.length(XMLPROJECTION = "attribute");

Width of sidebar area.

controls​

Property controls As list Of Control(XMLNAME = "control", XMLPROJECTION = "element");

Set of controls displayed within this widget.

dataProperties​

Property dataProperties As list Of DataProperty(XMLNAME = "dataProperty", XMLPROJECTION = "element");

Set of dataProperties displayed within this widget. (Interpretation of this is dependent on the type of widget in use).

properties​

Property properties As array Of %String(MAXLEN = 5000, XMLKEYNAME = "name", XMLNAME = "property", XMLPROJECTION = "ELEMENT");

Array of additional property values to apply to the widget.

dataSeries​

Property dataSeries As list Of ChartDataSeries(XMLNAME = "dataSeries", XMLPROJECTION = "element");

Set of data series used displayed within this widget.

filterState​

Property filterState As array Of %String(MAXLEN = 5000, XMLKEYNAME = "name", XMLNAME = "filterState", XMLPROJECTION = "ELEMENT");

Array of filter states for the widget. Each name is of the form: [DIM].[HIER].[LEVEL]
Each value is an MDX key value.

overrides​

Property overrides As array Of %String(MAXLEN = 30000, XMLKEYNAME = "name", XMLNAME = "override", XMLPROJECTION = "ELEMENT");

Array of additional override values (such as chart state) to apply to the widget.

maximized​

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

If true, this widget should be maximized when first displayed.

homeRowL​

Property homeRowL As %Integer(MINVAL = 0, XMLPROJECTION = "attribute");

homeRow position (landscape) of the widget (if in snap grid mode).

homeColL​

Property homeColL As %Integer(MINVAL = 0, XMLPROJECTION = "attribute");

homeCol position (landscape) of the widge (if in snap grid mode)t.

colSpanL​

Property colSpanL As %Integer(MINVAL = 1, XMLPROJECTION = "attribute");

colSpan (landscape) of the widget (if in snap grid mode).

rowSpanL​

Property rowSpanL As %Integer(MINVAL = 1, XMLPROJECTION = "attribute");

rowSpan (landscape) of the widget (if in snap grid mode).

homeRowP​

Property homeRowP As %Integer(MINVAL = 0, XMLPROJECTION = "attribute");

homeRow position (portrait) of the widget (if in snap grid mode).

homeColP​

Property homeColP As %Integer(MINVAL = 0, XMLPROJECTION = "attribute");

homeCol position (portrait) of the widge (if in snap grid mode)t.

colSpanP​

Property colSpanP As %Integer(MINVAL = 1, XMLPROJECTION = "attribute");

colSpan (portrait) of the widget (if in snap grid mode).

rowSpanP​

Property rowSpanP As %Integer(MINVAL = 1, XMLPROJECTION = "attribute");

rowSpan (portrait) of the widget (if in snap grid mode).

showToolbar​

Property showToolbar As %ZEN.Datatype.boolean(XMLPROJECTION = "attribute") [ InitialExpression = 1 ];

Specify whether to display a toolbar.

showToolbarBottomBorder​

Property showToolbarBottomBorder As %ZEN.Datatype.boolean(XMLPROJECTION = "attribute") [ InitialExpression = 1 ];

Specify whether to display the separator between the toolbar and widget content

showToolbarOnlyWhenMaximized​

Property showToolbarOnlyWhenMaximized As %ZEN.Datatype.boolean(XMLPROJECTION = "attribute") [ InitialExpression = 0 ];

Specify whether to display a toolbar.

colorToolbar​

Property colorToolbar As %ZEN.Datatype.color(XMLPROJECTION = "attribute") [ InitialExpression = "#F0F0F0" ];

Specify color of toolbar

opacityToolbar​

Property opacityToolbar As %ZEN.Datatype.float(XMLPROJECTION = "attribute") [ InitialExpression = 1.0 ];

Specify opacity of toolbar

backgroundColor​

Property backgroundColor As %ZEN.Datatype.color(XMLPROJECTION = "attribute") [ InitialExpression = "#F0F0F0" ];

JSL4483 color of widget background

opacity​

Property opacity As %ZEN.Datatype.float(XMLPROJECTION = "attribute") [ InitialExpression = 1.0 ];

JSL4483 opacity of widget background

theme​

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

If defined, this the name of a theme provides the styles for this widget.

themeOverrides​

Property themeOverrides As array Of %String(MAXLEN = 30000, XMLPROJECTION = "NONE") [ Transient ];

Transient array of additional override values that come from the theme for this widget.

dataColorList​

Property dataColorList As %ZEN.Datatype.string(MAXLEN = 255, XMLPROJECTION = "attribute");

Optional. Name of termlist (with or without extension) that supplies data-driven colors for chart series.

Methods​

%GetDataSource​

Method %GetDataSource() As %String

Return the name of the data source for this widget. If there is a local override, return it.

%CreateVisualWidget​

Method %CreateVisualWidget(Output pWidget As %DeepSee.Component.Widget.widget, ByRef pURLSettings As %String, pPreviewMode As %Boolean = 0) As %Status

Create a visual widget component using this definition.
pURLSettings is an array of settings values pulled out of the URL.

%CopyTo​

Method %CopyTo(ByRef pTarget) As %Status

Copy contents of this widget to pTarget.

%CopyToDef​

Method %CopyToDef(ByRef pTarget As %DeepSee.Dashboard.Widget) As %Status

%CopyToDao​

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

Copy the contents of this definition to an Dao.

%GetDependencies​

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

Return a list of all folder items that this widget depends upon. Returns a list of the form:
pList(ITEMNAME) = itemName

%Dump​

Method %Dump() As %Status

Diagnostic method: display contents of this widget definition to the console.