Skip to main content

%DeepSee.Component.Widget.worksheet

Class %DeepSee.Component.Widget.worksheet Extends %DeepSee.Component.Widget.widget [ System = 4 ]

A specialized DeepSee Dashboard widget that displays a worksheet.

Methods​

%GetCatalogInfo​

ClassMethod %GetCatalogInfo(Output pInfo As %List, Output pSubtypeList As %List) As %Status

Return information used to list this widget within the "widget catalog".

%GetWidgetPropertyInfo​

ClassMethod %GetWidgetPropertyInfo(pSubtype As %String, Output pInfo As %List) As %Status

Return information on additional "properties" supported by this widget for the given subtype.

%OnCreateWidget​

Method %OnCreateWidget(pGroup As %ZEN.Component.group) As %Status

This callback is responsible for creating the contents of the widget.

%OnCreateControls​

Method %OnCreateControls(pGroup As %ZEN.Component.group) As %Status

This callback is called just before controls are added to the top of the widget. pGroup is the header in which new Zen control can be added.

adjustContentSize​

ClientMethod adjustContentSize(load, width, height) [ Language = javascript ]

Called when page is loaded or widget is resized.

applyFilter​

ClientMethod applyFilter(name, value) [ Language = javascript ]

Apply the given filter to this widget.

exportPDF​

ClientMethod exportPDF() [ Language = javascript ]

Export to pdf.

GetWorksheetContent​

ClassMethod GetWorksheetContent(ByRef pParameters, Output pObject As %RegisteredObject) As %Status

Get content object for JSON provider.

getRowDescriptors​

ClientMethod getRowDescriptors() [ Language = javascript ]

Return an array of row descriptors (or null).

getColumnDescriptors​

ClientMethod getColumnDescriptors() [ Language = javascript ]

Return an array of column descriptors (or null).

getDimSize​

ClientMethod getDimSize(dim) [ Language = javascript ]

Controller API

getLabel​

ClientMethod getLabel(n, dim) [ Language = javascript ]

dataSet API Get the label at position n (0-based) in the given dimension (1,2, or 3).

getData​

ClientMethod getData(d1, d2, d3) [ Language = javascript ]

dataSet API Return the data contained in the specified location. Location is 0-based;

getDataByName​

ClientMethod getDataByName(prop, series) [ Language = javascript ]

dataBag API Get a data value, by property name, from this dataController.

getPropertyName​

ClientMethod getPropertyName(n) [ Language = javascript ]

Given a 0-based index, return the corresponding property name.

notifyController​

ClientMethod notifyController(source, reason, prop, value, row) [ Language = javascript ]

Notification from the dataGrid.

getModel​

ClientMethod getModel() [ Language = javascript ]

Get the json-supplied data model.

getGrid​

ClientMethod getGrid() [ Language = javascript ]

Get the grid control.

applyModelToGrid​

ClientMethod applyModelToGrid() [ Language = javascript ]

Apply saved attributes to the grid component.

applyFilters​

ClientMethod applyFilters(refresh) [ Internal, Language = javascript ]

Apply the current filters to this widget.

getCellOverride​

ClientMethod getCellOverride(row, col) [ Language = javascript ]

Get cell override.