This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%DeepSee.UI.WidgetPreview

class %DeepSee.UI.WidgetPreview extends %ZEN.Component.page

DeepSee Widget Preview page. Displays a transient version of a widget for the widget builder page. (Restored)

Property Inventory

Method Inventory

Parameters

parameter CSPURL = %DeepSee.UI.WidgetPreview;
Inherited description: This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
parameter PAGENAME = DeepSee Widget Preview;
Inherited description: Optional. This is the display name used for this page. If not provided, the class name is used.
parameter RESOURCE = %DeepSee_Portal;
All DeepSee pages require %DeepSee_Portal USE.

Properties

property catalogName as %ZEN.Datatype.string (ZENURL = "CATALOG");
Name of catalog containing widget.
Property methods: catalogNameDisplayToLogical(), catalogNameGet(), catalogNameIsValid(), catalogNameLogicalToDisplay(), catalogNameLogicalToOdbc(), catalogNameNormalize(), catalogNameSet()
property dashboardName as %ZEN.Datatype.string (ZENURL = "DASHBOARD");
Name of dashboard containing widget.
Property methods: dashboardNameDisplayToLogical(), dashboardNameGet(), dashboardNameIsValid(), dashboardNameLogicalToDisplay(), dashboardNameLogicalToOdbc(), dashboardNameNormalize(), dashboardNameSet()

Methods

method %OnAfterCreatePage() as %Status
Inherited description: This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
method %OnDrawHTMLHead() as %Status
Add include files to support color schemes.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is first loaded or whenever it is resized.
If this is called at load time, then load will be true.

Inherited Members

Inherited Properties

Inherited Methods

Feedback