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.Component.Widget.worksheet

class %DeepSee.Component.Widget.worksheet extends %DeepSee.Component.Widget.widget

A specialized DeepSee Dashboard widget that displays a worksheet.

Method Inventory

Methods

classmethod %GetCatalogInfo(Output pInfo As %List, Output pSubtypeList As %List) as %Status
Return information used to list this widget within the "widget catalog".
classmethod %GetWidgetPropertyInfo(pSubtype As %String, Output pInfo As %List) as %Status
Return information on additional "properties" supported by this widget for the given subtype.
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.
method %OnCreateWidget(pGroup As %ZEN.Component.group) as %Status
This callback is responsible for creating the contents of the widget.
classmethod GetWorksheetContent(ByRef pParameters, Output pObject As %RegisteredObject) as %Status
Get content object for JSON provider.
clientmethod adjustContentSize(load, width, height) [ Language = javascript ]
Called when page is loaded or widget is resized.
clientmethod applyFilter(name, value) [ Language = javascript ]
Apply the given filter to this widget.
clientmethod applyModelToGrid() [ Language = javascript ]
Apply saved attributes to the grid component.
clientmethod exportPDF() [ Language = javascript ]
Export to pdf.
clientmethod getCellOverride(row, col) [ Language = javascript ]
Get cell override.
clientmethod getColumnDescriptors() [ Language = javascript ]
Return an array of column descriptors (or null).
clientmethod getData(d1, d2, d3) [ Language = javascript ]
dataSet API Return the data contained in the specified location. Location is 0-based;
clientmethod getDataByName(prop, series) [ Language = javascript ]
dataBag API Get a data value, by property name, from this dataController.
clientmethod getDimSize(dim) [ Language = javascript ]
Controller API
clientmethod getGrid() [ Language = javascript ]
Get the grid control.
clientmethod getLabel(n, dim) [ Language = javascript ]
dataSet API Get the label at position n (0-based) in the given dimension (1,2, or 3).
clientmethod getModel() [ Language = javascript ]
Get the json-supplied data model.
clientmethod getPropertyName(n) [ Language = javascript ]
Given a 0-based index, return the corresponding property name.
clientmethod getRowDescriptors() [ Language = javascript ]
Return an array of row descriptors (or null).
clientmethod notifyController(source, reason, prop, value, row) [ Language = javascript ]
Notification from the dataGrid.

Inherited Members

Inherited Properties

Inherited Methods

Feedback