%DeepSee.UserPortal.DashboardViewer

Class %DeepSee.UserPortal.DashboardViewer Extends (%DeepSee.UserPortal.standardPage, %CSP.Portal.SourceControl.Base) [ System = 4 ]

The DeepSee DashBoard viewer page.
This page displays a saved DeepSee dashboard. Invoke this page using the URL:
_DeepSee.UserPortal.DashboardViewer.zen?DASHBOARD=dashboardname
Where dashboardname is the full name of the dashboard: e.g., "folder/name.dashboard"
This class should be considered as *internal*; subclassing is not supported.

Parameters

PAGENAME

Parameter PAGENAME = "Dashboard Viewer";

Name of this page.

WORKLIST1MODE

Parameter WORKLIST1MODE = "group";

Starting mode for worklist 1: html or group.

JSINCLUDES

Parameter JSINCLUDES = "zenCSLM.js,zenESVG.js,DeepSee.js,dsparser.js";

Pick up formula code.

Properties

dashboardName

Property dashboardName As %ZEN.Datatype.string(ZENURL = "DASHBOARD");

Name of the currently displayed dashboard. Use XDASHBOARD to use a session encrypted value for this.

autosave

Property autosave As %ZEN.Datatype.string(ZENURL = "AUTOSAVE");

Token to load unsaved pivot state

autosaveOverride

Property autosaveOverride As %ZEN.Datatype.string;

Token to ignore autosave behavior (used with "Clear My Settings")

tempStorageRoot

Property tempStorageRoot As %ZEN.Datatype.string [ InitialExpression = "$Temp/Dashboard/" ];

Folder for autosave items

dashboardTitle

Property dashboardTitle As %ZEN.Datatype.string;

Title of the currently displayed dashboard.

widgetBorders

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

border of widgets in dashboard

widgetBordersToggle

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

Whether borders of widgets are on or off

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

dashboardTitleLocal

Property dashboardTitleLocal As %ZEN.Datatype.string;

Localized title of the currently displayed dashboard.

dashboardDescription

Property dashboardDescription As %ZEN.Datatype.string;

Description of the currently displayed dashboard.

dashboardLocked

Property dashboardLocked As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

Locked state of the currently displayed dashboard.

dashboardPublic

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

Public state of the currently displayed dashboard.

dashboardSnapGrid

Property dashboardSnapGrid As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

If true, the dashboard uses the new snapGrid desktop and ignores the the dashboardSnapTo property.

dashboardSnapTo

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

Is dashboard in "snap to" mode.

dashboardGridRows

Property dashboardGridRows As %ZEN.Datatype.integer [ InitialExpression = 2 ];

Is dashboard uses snap grid, then this is then number of grid rows.

dashboardGridCols

Property dashboardGridCols As %ZEN.Datatype.integer [ InitialExpression = 2 ];

Is dashboard uses snap grid, then this is then number of grid columns.

dashboardResize

Property dashboardResize As %ZEN.Datatype.boolean(ZENURL = "RESIZE") [ InitialExpression = 1 ];

Does this dashboard allow the user to move and resize widgets.

dashboardModify

Property dashboardModify As %ZEN.Datatype.boolean(ZENURL = "MODIFY") [ InitialExpression = 1 ];

Does this dashboard allow the user to modify widgets.

dashboardKeywords

Property dashboardKeywords As %ZEN.Datatype.string;

Keywords for the currently displayed dashboard.

dashboardOwner

Property dashboardOwner As %ZEN.Datatype.string;

Owner of the currently displayed dashboard.

dashboardResource

Property dashboardResource As %ZEN.Datatype.string;

Resource for the currently displayed dashboard.

dashboardBookCover

Property dashboardBookCover As %ZEN.Datatype.string;

Book cover spec of the currently displayed dashboard.

dashboardCategory

Property dashboardCategory As %ZEN.Datatype.string;

Category for the currently displayed dashboard.

userName

Property userName As %ZEN.Datatype.string(MAXLEN = 160) [ InitialExpression = {$UserName} ];

Current user name.

readOnly

Property readOnly As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

If true, user cannot modify the current dashboard.

%dashboard

Property %dashboard As %DeepSee.Dashboard.Definition(XMLPROJECTION = "none");

Instance of dashboard definition.

trace

Property trace As %ZEN.Datatype.boolean(ZENURL = "TRACE") [ InitialExpression = 0 ];

If true, show alert message to trace filter events.

showTitleBar

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

If true, widgets display a title bar.

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 for selected widgets.

selectedTitleBarColor

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

Specify color of title bar for selected widgets.

titleBarTextColor

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

Specify color of title bar text.

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

dbsettings

Property dbsettings As %ZEN.Datatype.string [ Internal, MultiDimensional ];

Copy of db settings saved for this dashboard.

nonce

Property nonce As %ZEN.Datatype.string(ZENURL = "NONCE");

This is used when launching a dashboard from an email alert.

activeWhenArray

Property activeWhenArray As array Of %ZEN.Datatype.string [ Internal ];

Track any activeWhen values for widget controls.

currWidgetKey

Property currWidgetKey As %ZEN.Datatype.string [ Internal ];

Key of selected widget.

widgetTemplateName

Property widgetTemplateName As %ZEN.Datatype.string;

Name used to save a widget to the catalog!

widgetDescription

Property widgetDescription As %ZEN.Datatype.string;

Description of the widget (if any). Used for save to catalog.

widgetOwner

Property widgetOwner As %ZEN.Datatype.string(MAXLEN = 255);

Widget owner. Used for save to catalog.

widgetResource

Property widgetResource As %ZEN.Datatype.string(MAXLEN = 255);

Widget resource. Used for save to catalog.

widgetKeywords

Property widgetKeywords As %ZEN.Datatype.string;

Keywords of the saved widget (if any). Used for save to catalog.

saveAction

Property saveAction As %ZEN.Datatype.string;

Container for the current save mode for source control.

printMasterWidgetId

Property printMasterWidgetId As %ZEN.Datatype.string;

If the dashboard is in multi-print mode, there is master widget which defines the page margins and other overall settings in the pdf report. This property is the container for the reference to that widget.

printPageSize

Property printPageSize As %ZEN.Datatype.string [ InitialExpression = "8.5x11 in" ];

Container for the page size when printing widgets in multi-print mode.

printPageOrientation

Property printPageOrientation As %ZEN.Datatype.string [ InitialExpression = "portrait" ];

Container for the page orientation when printing widgets in multi-print mode.

printMarginLeft

Property printMarginLeft As %ZEN.Datatype.string [ InitialExpression = "0.5in" ];

Container for the page's left margin when printing widgets in multi-print mode.

printMarginRight

Property printMarginRight As %ZEN.Datatype.string [ InitialExpression = "0.5in" ];

Container for the page's right margin when printing widgets in multi-print mode.

printMarginTop

Property printMarginTop As %ZEN.Datatype.string [ InitialExpression = "0.5in" ];

Container for the page's top margin when printing widgets in multi-print mode.

printMarginBottom

Property printMarginBottom As %ZEN.Datatype.string [ InitialExpression = "0.5in" ];

Container for the page's bottom margin when printing widgets in multi-print mode.

tempFileToken

Property tempFileToken As %ZEN.Datatype.string;

When creating multiple temp files, a token is generated that is unique to the CSP session. Temporary files incoporate this token to avoid concurrency problems.

pdfPreserveTempFiles

Property pdfPreserveTempFiles As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

Debugging property. Setting this to true will prevent the pdf viewer from deleting temporary files used for printing when launched.

widgetNamesAdded

Property widgetNamesAdded As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

Indicates whether or not the page had to generate widget names on load.

XDatas

Style

XData Style

menuPane

XData menuPane [ XMLNamespace = "http://www.intersystems.com/zen" ]

This XML defines the menu for this page.

contentsRightPane

XData contentsRightPane [ XMLNamespace = "http://www.intersystems.com/zen" ]

This XML defines the main display area.

Methods

%OnPreHTTP

ClassMethod %OnPreHTTP() As %Boolean [ ServerOnly = 1 ]

Translate encrypted URL parameters

%OnAfterCreatePage

Method %OnAfterCreatePage() As %Status

Decorate the page.

removeMenuOption

Method removeMenuOption(option As %String)

Helper method to remove a menu option. Used to remove edit/save options in read-only mode.

%OnGetWorklistOptions1

Method %OnGetWorklistOptions1(Output pOptions, Output pDefaultMode) As %Status

Return list of options for work list 1.

%OnGetWorklistOptions2

Method %OnGetWorklistOptions2(Output pOptions, Output pDefaultMode) As %Status

Return list of options for work list 2.

%LoadDashboard

Method %LoadDashboard(Output pDashboard As %DeepSee.Dashboard.Definition, pDashboardName As %String) As %Status

Open (or create) an instance of dashboard definition that defines the contents of this dashboard.

%CreateWidgets

Method %CreateWidgets(pDashboard As %DeepSee.Dashboard.Definition, pDesktop As %ZEN.Component.desktop, ByRef pURLSettings As %String, ByRef pDBSettings As %String, ByRef pAddedWidget As %String) As %Status

Create the dashboard widgets and add them to the desktop.
pURLSettings is an array of settings values pulled out of the URL.
pDBSettings is an array of saved dashboard settings values.

%OnCreateWidgets

Method %OnCreateWidgets(pDashboard As %DeepSee.Dashboard.Definition, pDesktop As %ZEN.Component.desktop) As %Status

Nofication that %CreateWidgets was called.

%CreateControls

ClassMethod %CreateControls(pWhich As %String, pControls As %ListOfObjects, pGroup As %ZEN.Component.group, pWidget As %DeepSee.Component.Widget.widget = "") As %Status [ Internal ]

Utility method. Create a set of controls from the given list and add them to the given group. pWidget is the name of the widget the controls are in.
If pWhich is "dashboard", then add the controls to the dashboard.

%OnCreateControls

Method %OnCreateControls(pDashboard As %DeepSee.Dashboard.Definition, pGroup As %ZEN.Component.group) As %Status

Nofication that CreateControls was called.

%OnGetTitle

Method %OnGetTitle() As %String

Get the (localized) title string for the page. This should be implemented in a subclass.

%OnGetPageName

Method %OnGetPageName() As %String

Get the (localized) name of the page. This should be implemented in a subclass.

onAdjustSizes

ClientMethod onAdjustSizes(load, contentWidth, contentHeight) [ Language = javascript ]

Adjust sizes of content area.

navExpand

ClientMethod navExpand() [ Language = javascript ]

Expand or contract of navigator.

getSlaveList

ClientMethod getSlaveList(masterWidget) [ Internal, Language = javascript ]

For the given widget, return a list of all widgets linked to it.

dashboardEventHandler

ClientMethod dashboardEventHandler(sourceWidget, which, control, action, target, targetProperty, varType) [ Language = javascript ]

Central handler for control events on this dashboard. This is called whenever a control is modified (or otherwise activated). This is also called when a widget raises an event.
sourceWidget is the widget that raised the event.
which is either 'control' for controls or 'click' for click on widget element. Return true if the event was handled.

dispatchAction

ClientMethod dispatchAction(which, currWidget, target, action, targetProperty, value, text) [ Internal, Language = javascript ]

Dispatch the given action to all widgets in the list target. currWidget is the current widget (used to resolve empty target names).

actionHandler

ClientMethod actionHandler(widget, dataSource, action) [ Language = javascript ]

This handles any actions that were not handled by the widgets on the dashboard. This is done by sending the event to the server-side dataSource.

SendActionToDataSource

ClassMethod SendActionToDataSource(pDataSource As %String, pAction As %String, pContext As %ZEN.proxyObject, pPivotVariables As %ZEN.proxyObject = "", pFilters As %ZEN.proxyObject = "") As %String [ Internal, ZenMethod ]

Dispatch DataSource Action back to server-side class.
pContext is a proxy object that carries the server action back to the client.

%GetDisplayValue

ClassMethod %GetDisplayValue(pDataSource As %String, pFilterName As %String, pValue As %String) As %String [ Internal ]

Utility method. Find the display method for a given filter value.

deleteDashboard

ClientMethod deleteDashboard() [ Language = javascript ]

Delete this dashboard.

openDashboard

ClientMethod openDashboard() [ Language = javascript ]

Launch the dashboard finder.

newDashboard

ClientMethod newDashboard() [ Language = javascript ]

Create a new dashboard.

saveSettings

ClientMethod saveSettings(user) [ Language = javascript ]

Save the dashboard settings for the current user (save my settings).

clearSettings

ClientMethod clearSettings() [ Language = javascript ]

Clear saved dashboard settings.

clearAutosaveState

ClientMethod clearAutosaveState() [ Language = javascript ]

Remove any autosave state associated with this dashboard -- the dashboard should load fresh

ClearDashboardAutosaveState

Method ClearDashboardAutosaveState(pAutosaveItems As %ZEN.proxyObject, pDashboardName As %String, pAutosave As %String) As %Status [ ZenMethod ]

saveDashboard

ClientMethod saveDashboard(show, autosaveDashboard) [ Language = javascript ]

Launch the save dialog. If show is true, show the dialog.

runAutosave

ClientMethod runAutosave() [ Language = javascript ]

Perform an autosave of the current dashboard, filed under the current user

saveCopyOfDashboard

ClientMethod saveCopyOfDashboard() [ Language = javascript ]

Launch the save as dialog.

addWidgetFromCatalog

ClientMethod addWidgetFromCatalog() [ Language = javascript ]

Invoke widget catalog dialog.

newWidget

ClientMethod newWidget() [ Language = javascript ]

Invoke the widget wizard dialog to add a new widget to the dashboard.

showAnalyzerDialog

ClientMethod showAnalyzerDialog(key, datasource, local) [ Internal, Language = javascript ]

Invoke dialog-version of Analyzer.

SubmitDashboardDef

Method SubmitDashboardDef(pCommand As %String, pProvider As %ZEN.Auxiliary.jsonProvider, pSubmitObject As %DeepSee.Dashboard.Definition, ByRef pResponseObject As %RegisteredObject) As %Status

Submit handler for the dashboard definition. This is called when the dashboard is saved.

ClearDashboardSettings

Method ClearDashboardSettings() As %String [ ZenMethod ]

Clear settings for the current dashboard.

SaveDashboardSettings

Method SaveDashboardSettings(pUser As %String = "") As %String [ ZenMethod ]

Save settings for the current dashboard.

%GetDashboardSettings

Method %GetDashboardSettings(ByRef pDBSettings As %String) As %Status

Get array of "dashboard" settings for this dashboard.

SaveWidget

Method SaveWidget(pWidgetKey As %String, pLocalDataSource As %String) As %String [ ZenMethod ]

Change the local datasource for one widget and save it to local settings.

onPopupAction

ClientMethod onPopupAction(popupName, action, value) [ Language = javascript ]

This client event is fired when the a popup page launched from this page fires an action.

findWidgetByKey

ClientMethod findWidgetByKey(key) [ Internal, Language = javascript ]

Find a widget given its key.

updateWorklistTitle

ClientMethod updateWorklistTitle() [ Language = javascript ]

Update the title for the dashboard.

getWidgetLayout

ClientMethod getWidgetLayout() [ Language = javascript ]

Get the current size and position of each widget and place it within the widget. Also make sure that the subtype class is current.

addThisToFavorites

ClientMethod addThisToFavorites() [ Language = javascript ]

Add this dashboard to the favorites list.

gotoAnalyzer

ClientMethod gotoAnalyzer() [ Language = javascript ]

Show the analyzer page.

drillDown

ClientMethod drillDown(widget, dataSource) [ Language = javascript ]

Execute a drill down for the given widget.

isReadOnly

ClientMethod isReadOnly() [ Language = javascript ]

Test if this page is in read only mode.

filterDropDown

ClientMethod filterDropDown(ctrl, widgetKey, dataSource) [ Language = javascript ]

Drop down is about to appear for searchBox control.

%ParseFilterSpec

ClassMethod %ParseFilterSpec(pSpec As %String, Output pFSpec As %String, Output pFKey As %String, Output pFValue As %String, ByRef pIndex As %Integer = 0) As %Status

Utility method.
Pull apart a filter spec, as we may get from a URL, into a spec and key or value:
[Outlet].[Country].[France] ==> "[Outlet].[Country]","[France]"
{[HOMED].[H1].[ZIP].[32006],[HOMED].[H1].[ZIP].[32007]} ==> "[HOMED].[H1].[ZIP]","{&[32006],&[32007]}"
Note that an array of results is returned. If the spec contains a tuple, each piece is put into its own array node (pIndex is used to track how many pieces there are).

mailDashboard

ClientMethod mailDashboard() [ Language = javascript ]

email this dashboard.

reloadDashboard

ClientMethod reloadDashboard() [ Language = javascript ]

Reload the dashboard (show current saved state)

GetDimensionInfo

ClassMethod GetDimensionInfo(pRoot As %String, Output pTree, ByRef pParms) As %Status

Provide contents of the dimension tree. Used by pivot widget.

widgetClosing

ClientMethod widgetClosing() [ Internal, Language = javascript ]

Notification that this widget is being closed.

invokeAdjustSizes

ClientMethod invokeAdjustSizes(skip) [ Internal, Language = javascript ]

Raise the resize method for all widgets except skip.

setTitleBar

ClientMethod setTitleBar(flag) [ Internal, Language = javascript ]

Turn title bars on or off.

navGetContentForLevel

ClientMethod navGetContentForLevel(level, key, value) [ Language = javascript ]

Return an object describing what to display for this level within the navigator.

navDataArrange

ClientMethod navDataArrange(key, swap, final) [ Language = javascript ]

Arrange of data list in navigator.

navDataChange

ClientMethod navDataChange(key, value, final) [ Language = javascript ]

Change of data value in navigator.

setTitleBarColorAndOpacity

ClientMethod setTitleBarColorAndOpacity() [ Language = javascript ]

Apply color and opacity to all available widgets

navSelectItem

ClientMethod navSelectItem(key, value, which) [ Language = javascript ]

Select of item within the navigator.

navHeaderButtonClick

ClientMethod navHeaderButtonClick(key) [ Language = javascript ]

Click on header button in navigator.

navCloseButtonClick

ClientMethod navCloseButtonClick(key) [ Language = javascript ]

Click on close button in navigator.

deleteWidget

Method deleteWidget(pIndex) As %String [ ZenMethod ]

navPopupAction

ClientMethod navPopupAction(key, value) [ Language = javascript ]

Popup action in navigator.

setGridRows

ClientMethod setGridRows(rows) [ Language = javascript ]

Set number of grid rows in the desktop.

setBorder

ClientMethod setBorder(value) [ Language = javascript ]

setFromBorderValues

ClientMethod setFromBorderValues() [ Language = javascript ]

setBackground

ClientMethod setBackground(attr, value) [ Language = javascript ]

setGridColumns

ClientMethod setGridColumns(cols) [ Language = javascript ]

Set number of grid columns in the desktop.

getGridRows

ClientMethod getGridRows() [ Language = javascript ]

Number of grid rows in the desktop.

getGridColumns

ClientMethod getGridColumns() [ Language = javascript ]

Number of grid columns in the desktop.

widgetSelected

ClientMethod widgetSelected(evt, key) [ Language = javascript ]

User has selected a widget on the dashboard.

getCurrWidget

ClientMethod getCurrWidget() [ Language = javascript ]

If there is a selected widget, return it.

setProperty

ClientMethod setProperty(property, value, value2) [ Language = javascript ]

Set the value of a named property.

showCurrentGrid

ClientMethod showCurrentGrid() [ Internal, Language = javascript ]

Make a poor man's grid to show the drop zones and add it to the wallpaper

getToolbarData

ClientMethod getToolbarData() [ Language = javascript ]

Return json data to drive the toolbar. !!!

designBookCover

ClientMethod designBookCover() [ Internal, Language = javascript ]

Launch the book cover editor.

getWidgetTypes

ClientMethod getWidgetTypes() [ Internal, Language = javascript ]

Get the array of available widget types.

GetWidgetTypeList

Method GetWidgetTypeList(ByRef pParameters, Output pMetaData, Output pData) As %Status

Return JSON array of widget types.

getDefinition

ClientMethod getDefinition() [ Internal, Language = javascript ]

Get the dashboard definition object.

getWidgetDefinition

ClientMethod getWidgetDefinition(widgetKey) [ Internal, Language = javascript ]

Get the widget definition within the dashaboard definition object.

GetDbDefinition

Method GetDbDefinition(ByRef pParms, Output pObject As %RegisteredObject) As %Status

Get the definition of this dashboard for the JSON provider.

UpdateWidget

ClassMethod UpdateWidget(pWidget As %DeepSee.Component.Widget.widget, pJSON As %String, pWorkList As %ZEN.Component.group, pAction As %String, pControlLocation As %String, pControlIndex As %String, pWidgetControlIndex As %String) As %String [ Internal, ZenMethod ]

Update the definition of a widget on the server.

setModified

ClientMethod setModified(flag) [ Internal, Language = javascript ]

Set the modified state of this page. Modified flag only appears when user permissions are NOT read-only.

recreateWidget

ClientMethod recreateWidget(widgetKey, action, controlIndex) [ Internal, Language = javascript ]

Recreate the given widget on the server and reload it.

recreateHandler

ClientMethod recreateHandler(widgetKey) [ Language = javascript ]

Called after a widget is recreated.

fetchOptionList

ClientMethod fetchOptionList(which, spec, properties) [ Language = javascript ]

Fetch the given list of options from the server.

GetOptionList

Method GetOptionList(ByRef pParameters, Output pMetaData, Output pData) As %Status

Return JSON array of options.

addControlDef

ClientMethod addControlDef() [ Language = javascript ]

Launch the new control wizard.

addDataPropertyDef

ClientMethod addDataPropertyDef() [ Language = javascript ]

Launch the new data property wizard.

saveWidgetToCatalog

ClientMethod saveWidgetToCatalog() [ Language = javascript ]

Save the selected widget to the widget catalog.

getPreviewImage

ClientMethod getPreviewImage() [ Language = javascript ]

showPDFOptions

ClientMethod showPDFOptions() [ Language = javascript ]

Launch the pdf options dialog.

saveWidgetToTheme

ClientMethod saveWidgetToTheme() [ Language = javascript ]

Save the selected widget styles to the theme catalog.

SaveTheme

ClassMethod SaveTheme(pThemeName As %String, pOverrides As %ZEN.proxyObject) As %String [ Internal, ZenMethod ]

Save the given style overrides to the named theme. Create the theme if is does not exist.

DeleteTheme

ClassMethod DeleteTheme(pThemeName As %String) As %String [ Internal, ZenMethod ]

Delete the named theme.

%GetResourceList

ClassMethod %GetResourceList(Output pList) As %Status [ Internal ]

Get a list of system resources.

launchColorChooser

ClientMethod launchColorChooser() [ Language = javascript ]

Launch the color chooser.

SetDataSource

ClassMethod SetDataSource(pWidget As %DeepSee.Component.Widget.widget, pPivotTable As %DeepSee.Component.pivotTable, pDataSource As %String, pOverrides As %String = "") As %String [ Internal, ZenMethod ]

Set the data source for the given widget.

%OnGetSmallMenu

Method %OnGetSmallMenu(Output pMenu)

Get the contents of the small menu in the title area.

CreateQueryNonce

ClassMethod CreateQueryNonce(pQuery As %String, pMode As %String = "MDX") As %String [ Internal, ZenMethod ]

Generate a nonce for an MDX query or XML payload.

CreateParameterNonce

ClassMethod CreateParameterNonce(pParmValue As %String) As %String [ Internal, ZenMethod ]

Generate a nonce for parameter value. This function will perform UTF8 conversion.

onlogoutHandler

ClientMethod onlogoutHandler() [ Language = javascript ]

Ensure that auto-logout is not blocked by onunloadHandler checking for unsaved changes

onunloadHandler

ClientMethod onunloadHandler() [ Language = javascript ]

onloadHandler

ClientMethod onloadHandler() [ Language = javascript ]

GetInternalName

Method GetInternalName() As %String

Return the internal name of the current document, including the three letter extension in upper-case. For example, MyPackage.MyClass.CLS would be the internal name for the class MyPackage.MyClass. Subclasses MUST override this method.

getClientModel

ClientMethod getClientModel() [ Language = javascript ]

Get the jsonProvider object on the client. Subclasses MUST override this method to return the jsonProvider.

getCurrentName

ClientMethod getCurrentName() [ Language = javascript ]

Return the current name of the class/object being modified. Subclasses MUST override this method to return the correct name.

setReadOnly

ClientMethod setReadOnly(readOnly) [ Language = javascript ]

Set readOnly to the value of readOnly. Subclasses MUST implement this method to update the controls on the page so that the page's behaviour actually matches the value of the readOnly flag.

%OnDrawHTMLHead

Method %OnDrawHTMLHead() As %Status

Add include files to support color schemes.

SavePivotTable

ClassMethod SavePivotTable(pPivot As %DeepSee.Component.pivotTable, autoSavePivotName As %String) As %String [ ZenMethod ]

Save the pivot table so we have an autosaved version

getSaveAction

ClientMethod getSaveAction(force) [ Language = javascript ]

Return the string used as the command when sending JSON content to the server. The OnSubmitContent handler for the jsonProvider MUST support two action types.

getCurrentExtension

ClientMethod getCurrentExtension() [ Language = javascript ]

Return the extension used by Studio for the class/object. This is ".CLS" by default, but subclasses should override this method if a different extension is in use.

setConnectivityStatusMsg

ClientMethod setConnectivityStatusMsg(msg) [ Language = javascript ]

chooseSCMenu

ClientMethod chooseSCMenu(menuName, commandName, saveFlags) [ Language = javascript ]

Handle a source control menu selection.