%DeepSee.Dashboard.Widget

serial class %DeepSee.Dashboard.Widget extends %Library.SerialObject, %XML.Adaptor [ Final ]

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.

Property Inventory

Parameters

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

Inherited description: NAMESPACE specifies the XML namespace to be used when projecting the class to XML. If NAMESPACE = "", the default namespace is used for the XML schema is used as the namespace for his class.

parameter XMLIGNORENULL = 1;

Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.

parameter XMLNAME = widget;

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

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

JSL4483 color of widget background

Property methods: backgroundColorDisplayToLogical(), backgroundColorGet(), backgroundColorIsValid(), backgroundColorLogicalToDisplay(), backgroundColorLogicalToOdbc(), backgroundColorNormalize(), backgroundColorSet()

property colSpanL as %Integer (MINVAL = 1, XMLPROJECTION = "attribute");

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

Property methods: colSpanLDisplayToLogical(), colSpanLGet(), colSpanLIsValid(), colSpanLLogicalToDisplay(), colSpanLNormalize(), colSpanLSet(), colSpanLXSDToLogical()

property colSpanP as %Integer (MINVAL = 1, XMLPROJECTION = "attribute");

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

Property methods: colSpanPDisplayToLogical(), colSpanPGet(), colSpanPIsValid(), colSpanPLogicalToDisplay(), colSpanPNormalize(), colSpanPSet(), colSpanPXSDToLogical()

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

Specify color of toolbar

Property methods: colorToolbarDisplayToLogical(), colorToolbarGet(), colorToolbarIsValid(), colorToolbarLogicalToDisplay(), colorToolbarLogicalToOdbc(), colorToolbarNormalize(), colorToolbarSet()

property controls as list of Control (XMLNAME = "control", XMLPROJECTION = "element");

Set of controls displayed within this widget.

Property methods: controlsBuildValueArray(), controlsCollectionToDisplay(), controlsCollectionToOdbc(), controlsDisplayToCollection(), controlsGet(), controlsGetObject(), controlsGetObjectId(), controlsGetSwizzled(), controlsIsValid(), controlsOdbcToCollection(), controlsSet(), controlsSetObject(), controlsSetObjectId()

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.

Property methods: dataColorListDisplayToLogical(), dataColorListGet(), dataColorListIsValid(), dataColorListLogicalToDisplay(), dataColorListLogicalToOdbc(), dataColorListNormalize(), dataColorListSet()

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.

Property methods: dataLinkDisplayToLogical(), dataLinkGet(), dataLinkIsValid(), dataLinkLogicalToDisplay(), dataLinkLogicalToOdbc(), dataLinkNormalize(), dataLinkSet()

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).

Property methods: dataPropertiesBuildValueArray(), dataPropertiesCollectionToDisplay(), dataPropertiesCollectionToOdbc(), dataPropertiesDisplayToCollection(), dataPropertiesGet(), dataPropertiesGetObject(), dataPropertiesGetObjectId(), dataPropertiesGetSwizzled(), dataPropertiesIsValid(), dataPropertiesOdbcToCollection(), dataPropertiesSet(), dataPropertiesSetObject(), dataPropertiesSetObjectId()

property dataSeries as list of ChartDataSeries (XMLNAME = "dataSeries", XMLPROJECTION = "element");

Set of data series used displayed within this widget.

Property methods: dataSeriesBuildValueArray(), dataSeriesCollectionToDisplay(), dataSeriesCollectionToOdbc(), dataSeriesDisplayToCollection(), dataSeriesGet(), dataSeriesGetObject(), dataSeriesGetObjectId(), dataSeriesGetSwizzled(), dataSeriesIsValid(), dataSeriesOdbcToCollection(), dataSeriesSet(), dataSeriesSetObject(), dataSeriesSetObjectId()

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).

Property methods: dataSourceDisplayToLogical(), dataSourceGet(), dataSourceIsValid(), dataSourceLogicalToDisplay(), dataSourceLogicalToOdbc(), dataSourceNormalize(), dataSourceSet()

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).

Property methods: drillDownDataSourceDisplayToLogical(), drillDownDataSourceGet(), drillDownDataSourceIsValid(), drillDownDataSourceLogicalToDisplay(), drillDownDataSourceLogicalToOdbc(), drillDownDataSourceNormalize(), drillDownDataSourceSet()

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.

Property methods: filterStateBuildValueArray(), filterStateCollectionToDisplay(), filterStateCollectionToOdbc(), filterStateDisplayToCollection(), filterStateDisplayToLogical(), filterStateGet(), filterStateGetObject(), filterStateGetObjectId(), filterStateGetSwizzled(), filterStateIsValid(), filterStateLogicalToDisplay(), filterStateLogicalToOdbc(), filterStateNormalize(), filterStateOdbcToCollection(), filterStateSet(), filterStateSetObject(), filterStateSetObjectId()

property height as %Integer (MINVAL = 0, XMLPROJECTION = "attribute");

Height of the widget.

Property methods: heightDisplayToLogical(), heightGet(), heightIsValid(), heightLogicalToDisplay(), heightNormalize(), heightSet(), heightXSDToLogical()

property homeColL as %Integer (MINVAL = 0, XMLPROJECTION = "attribute");

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

Property methods: homeColLDisplayToLogical(), homeColLGet(), homeColLIsValid(), homeColLLogicalToDisplay(), homeColLNormalize(), homeColLSet(), homeColLXSDToLogical()

property homeColP as %Integer (MINVAL = 0, XMLPROJECTION = "attribute");

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

Property methods: homeColPDisplayToLogical(), homeColPGet(), homeColPIsValid(), homeColPLogicalToDisplay(), homeColPNormalize(), homeColPSet(), homeColPXSDToLogical()

property homeRowL as %Integer (MINVAL = 0, XMLPROJECTION = "attribute");

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

Property methods: homeRowLDisplayToLogical(), homeRowLGet(), homeRowLIsValid(), homeRowLLogicalToDisplay(), homeRowLNormalize(), homeRowLSet(), homeRowLXSDToLogical()

property homeRowP as %Integer (MINVAL = 0, XMLPROJECTION = "attribute");

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

Property methods: homeRowPDisplayToLogical(), homeRowPGet(), homeRowPIsValid(), homeRowPLogicalToDisplay(), homeRowPNormalize(), homeRowPSet(), homeRowPXSDToLogical()

property left as %Integer (MINVAL = 0, XMLPROJECTION = "attribute");

Left position of the widget.

Property methods: leftDisplayToLogical(), leftGet(), leftIsValid(), leftLogicalToDisplay(), leftNormalize(), leftSet(), leftXSDToLogical()

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.

Property methods: localDataSourceDisplayToLogical(), localDataSourceGet(), localDataSourceIsValid(), localDataSourceLogicalToDisplay(), localDataSourceLogicalToOdbc(), localDataSourceNormalize(), localDataSourceSet()

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

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

Property methods: maximizedDisplayToLogical(), maximizedGet(), maximizedIsValid(), maximizedLogicalToDisplay(), maximizedLogicalToXSD(), maximizedNormalize(), maximizedSet(), maximizedXSDToLogical()

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).

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()

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

JSL4483 opacity of widget background

Property methods: opacityDisplayToLogical(), opacityGet(), opacityIsValid(), opacityLogicalToDisplay(), opacityLogicalToOdbc(), opacityNormalize(), opacitySet()

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

Specify opacity of toolbar

Property methods: opacityToolbarDisplayToLogical(), opacityToolbarGet(), opacityToolbarIsValid(), opacityToolbarLogicalToDisplay(), opacityToolbarLogicalToOdbc(), opacityToolbarNormalize(), opacityToolbarSet()

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.

Property methods: overridesBuildValueArray(), overridesCollectionToDisplay(), overridesCollectionToOdbc(), overridesDisplayToCollection(), overridesDisplayToLogical(), overridesGet(), overridesGetObject(), overridesGetObjectId(), overridesGetSwizzled(), overridesIsValid(), overridesLogicalToDisplay(), overridesLogicalToOdbc(), overridesNormalize(), overridesOdbcToCollection(), overridesSet(), overridesSetObject(), overridesSetObjectId()

property properties as array of %String (MAXLEN = 5000, XMLKEYNAME = "name", XMLNAME = "property", XMLPROJECTION = "ELEMENT");

Array of additional property values to apply to the widget.

Property methods: propertiesBuildValueArray(), propertiesCollectionToDisplay(), propertiesCollectionToOdbc(), propertiesDisplayToCollection(), propertiesDisplayToLogical(), propertiesGet(), propertiesGetObject(), propertiesGetObjectId(), propertiesGetSwizzled(), propertiesIsValid(), propertiesLogicalToDisplay(), propertiesLogicalToOdbc(), propertiesNormalize(), propertiesOdbcToCollection(), propertiesSet(), propertiesSetObject(), propertiesSetObjectId()

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 methods: resetDataSourceDisplayToLogical(), resetDataSourceGet(), resetDataSourceIsValid(), resetDataSourceLogicalToDisplay(), resetDataSourceLogicalToXSD(), resetDataSourceNormalize(), resetDataSourceSet(), resetDataSourceXSDToLogical()

property rowSpanL as %Integer (MINVAL = 1, XMLPROJECTION = "attribute");

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

Property methods: rowSpanLDisplayToLogical(), rowSpanLGet(), rowSpanLIsValid(), rowSpanLLogicalToDisplay(), rowSpanLNormalize(), rowSpanLSet(), rowSpanLXSDToLogical()

property rowSpanP as %Integer (MINVAL = 1, XMLPROJECTION = "attribute");

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

Property methods: rowSpanPDisplayToLogical(), rowSpanPGet(), rowSpanPIsValid(), rowSpanPLogicalToDisplay(), rowSpanPNormalize(), rowSpanPSet(), rowSpanPXSDToLogical()

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

Specify whether to display a sidebar.

Property methods: showSidebarDisplayToLogical(), showSidebarGet(), showSidebarIsValid(), showSidebarLogicalToDisplay(), showSidebarLogicalToOdbc(), showSidebarLogicalToXSD(), showSidebarNormalize(), showSidebarSet(), showSidebarXSDToLogical()

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

Specify whether to display a toolbar.

Property methods: showToolbarDisplayToLogical(), showToolbarGet(), showToolbarIsValid(), showToolbarLogicalToDisplay(), showToolbarLogicalToOdbc(), showToolbarLogicalToXSD(), showToolbarNormalize(), showToolbarSet(), showToolbarXSDToLogical()

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

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

Property methods: showToolbarBottomBorderDisplayToLogical(), showToolbarBottomBorderGet(), showToolbarBottomBorderIsValid(), showToolbarBottomBorderLogicalToDisplay(), showToolbarBottomBorderLogicalToOdbc(), showToolbarBottomBorderLogicalToXSD(), showToolbarBottomBorderNormalize(), showToolbarBottomBorderSet(), showToolbarBottomBorderXSDToLogical()

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

Specify whether to display a toolbar.

Property methods: showToolbarOnlyWhenMaximizedDisplayToLogical(), showToolbarOnlyWhenMaximizedGet(), showToolbarOnlyWhenMaximizedIsValid(), showToolbarOnlyWhenMaximizedLogicalToDisplay(), showToolbarOnlyWhenMaximizedLogicalToOdbc(), showToolbarOnlyWhenMaximizedLogicalToXSD(), showToolbarOnlyWhenMaximizedNormalize(), showToolbarOnlyWhenMaximizedSet(), showToolbarOnlyWhenMaximizedXSDToLogical()

property sidebarContent as %ZEN.Datatype.html (XMLPROJECTION = "attribute");

HTML content of sidebar.

Property methods: sidebarContentDisplayToLogical(), sidebarContentGet(), sidebarContentIsValid(), sidebarContentLogicalToDisplay(), sidebarContentLogicalToOdbc(), sidebarContentNormalize(), sidebarContentSet()

property sidebarWidth as %ZEN.Datatype.length (XMLPROJECTION = "attribute");

Width of sidebar area.

Property methods: sidebarWidthDisplayToLogical(), sidebarWidthGet(), sidebarWidthIsValid(), sidebarWidthLogicalToDisplay(), sidebarWidthLogicalToOdbc(), sidebarWidthNormalize(), sidebarWidthSet()

property subtype as %String (MAXLEN = 255, XMLPROJECTION = "attribute");

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

Property methods: subtypeDisplayToLogical(), subtypeGet(), subtypeIsValid(), subtypeLogicalToDisplay(), subtypeLogicalToOdbc(), subtypeNormalize(), subtypeSet()

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.

Property methods: subtypeClassDisplayToLogical(), subtypeClassGet(), subtypeClassIsValid(), subtypeClassLogicalToDisplay(), subtypeClassLogicalToOdbc(), subtypeClassNormalize(), subtypeClassSet()

property theme as %String (MAXLEN = 512, XMLPROJECTION = "attribute");

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

Property methods: themeDisplayToLogical(), themeGet(), themeIsValid(), themeLogicalToDisplay(), themeLogicalToOdbc(), themeNormalize(), themeSet()

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.

Property methods: themeOverridesBuildValueArray(), themeOverridesCollectionToDisplay(), themeOverridesCollectionToOdbc(), themeOverridesDisplayToCollection(), themeOverridesDisplayToLogical(), themeOverridesGet(), themeOverridesGetObject(), themeOverridesGetObjectId(), themeOverridesGetSwizzled(), themeOverridesIsValid(), themeOverridesLogicalToDisplay(), themeOverridesLogicalToOdbc(), themeOverridesNormalize(), themeOverridesOdbcToCollection(), themeOverridesSet(), themeOverridesSetObject(), themeOverridesSetObjectId()

property title as %String (MAXLEN = 255, XMLPROJECTION = "attribute");

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

Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()

property top as %Integer (MINVAL = 0, XMLPROJECTION = "attribute");

Top position of the widget.

Property methods: topDisplayToLogical(), topGet(), topIsValid(), topLogicalToDisplay(), topNormalize(), topSet(), topXSDToLogical()

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.

Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()

property width as %Integer (MINVAL = 0, XMLPROJECTION = "attribute");

Width of the widget.

Property methods: widthDisplayToLogical(), widthGet(), widthIsValid(), widthLogicalToDisplay(), widthNormalize(), widthSet(), widthXSDToLogical()

Methods

method %CopyTo(ByRef pTarget) as %Status

Copy contents of this widget to pTarget.

method %CopyToDao(ByRef pTarget As %DynamicObject = $$$NULLOREF) as %Status

Copy the contents of this definition to an Dao.

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

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.

method %Dump() as %Status

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

method %GetDataSource() as %String

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

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