Skip to main content


class %DeepSee.UI.WorksheetBuilder extends %DeepSee.UI.standardPage

This lets a user create and edit worksheets. A worksheet can be used as a source of KPI values or to drive dashboards.

Property Inventory

Method Inventory


If this page has multiple views, this is its initial display mode.
parameter DOCBOOKID = D2MODADV_ch_worksheet;
Inherited description: Docbook ID for this page.
parameter JSINCLUDES = dsparser.js;
Pick up formula code.
parameter PAGENAME = Worksheet Manager;
Displayed name of this page.


property %model as %DeepSee.UserLibrary.Worksheet;
Local copy of worksheet object.
Property methods: %modelGet(), %modelGetObject(), %modelGetObjectId(), %modelGetSwizzled(), %modelIsValid(), %modelNewObject(), %modelSet(), %modelSetObject(), %modelSetObjectId(), %modelUnSwizzle()
property canWrite as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, user can modify (non-read-only) worksheet.
Property methods: canWriteDisplayToLogical(), canWriteGet(), canWriteIsValid(), canWriteLogicalToDisplay(), canWriteLogicalToOdbc(), canWriteLogicalToXSD(), canWriteNormalize(), canWriteSet(), canWriteXSDToLogical()
property readOnly as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, user cannot modify the current worksheet.
Property methods: readOnlyDisplayToLogical(), readOnlyGet(), readOnlyIsValid(), readOnlyLogicalToDisplay(), readOnlyLogicalToOdbc(), readOnlyLogicalToXSD(), readOnlyNormalize(), readOnlySet(), readOnlyXSDToLogical()
property whichCell as %String;
Indicates what the cell value editor is showing: "cell","row", or "column".
Property methods: whichCellDisplayToLogical(), whichCellGet(), whichCellIsValid(), whichCellLogicalToDisplay(), whichCellLogicalToOdbc(), whichCellNormalize(), whichCellSet()
property worksheetName as %String (ZENURL = "WORKSHEET");
Name of worksheet being viewed.
Property methods: worksheetNameDisplayToLogical(), worksheetNameGet(), worksheetNameIsValid(), worksheetNameLogicalToDisplay(), worksheetNameLogicalToOdbc(), worksheetNameNormalize(), worksheetNameSet()


method %OnAfterCreatePage() as %Status
This class method callback is called just before the server-side page object is created.
method %OnGetPageName() as %String
Get the (localized) name of the page.
method %OnGetProductName() as %String
Get the product name for the page.
method %OnGetTitle() as %String
Get the (localized) title string for the page. This should be implemented in a subclass.
classmethod %OnPreHTTP() as %Boolean
Test for additional resources.
classmethod %OnSubmit(pSubmit As %ZEN.Submit) as %Status
This callback is called when the upload form on this page is submitted. pSubmit is a %ZEN.Submit object containing details of the form submit.
method Delete(pName As %String) as %String [ ZenMethod ]
Delete a worksheet.
method DrawHelp(pSeed As %String) as %Status
Draw the help panel.
method GetWorksheetContent(ByRef pParameters, Output pObject As %RegisteredObject) as %Status
Get content object for JSON provider.
method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
method SubmitWorksheet(pCommand As %String, pProvider As %ZEN.Auxiliary.jsonProvider, pSubmitObject As %RegisteredObject, ByRef pResponseObject As %RegisteredObject) as %Status
Object submit handler JSON provider. This is called when the client saves the worksheet.
clientmethod addColumn() [ Language = javascript ]
Add a column to the grid
clientmethod addRow() [ Language = javascript ]
Add a row to the grid
clientmethod adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod applyModelToGrid() [ Language = javascript ]
Apply saved attributes to the grid component. There is a copy of this method in the worksheet widget.
clientmethod browseSubjectAreas() [ Language = javascript ]
Launch the subject area finder.
clientmethod canUserModify() [ Language = javascript ]
Test if the user has write privilege.
clientmethod cellControlChange() [ Language = javascript ]
Change to value in cell value control.
clientmethod changeWorksheet() [ Language = javascript ]
Launch the worksheet finder dialog.
clientmethod dataChange(key, value, final) [ Language = javascript ]
Data change in navigator
clientmethod deleteWorksheet() [ Language = javascript ]
Delete the worksheet.
clientmethod exportWorksheet() [ Language = javascript ]
Export the worksheet.
clientmethod getCellOverride(row, col) [ Language = javascript ]
Get cell override.
clientmethod getColumnDescriptors() [ Language = javascript ]
Return an array of column descriptors (or null).
clientmethod getContentForLevel(level, key, value) [ Language = javascript ]
Return an object describing what to display for this level within the navigator.
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 component.
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 getNavigator() [ Language = javascript ]
Get the navigator component.
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 gridKeyDown(evt) [ Language = javascript ]
Key down handler for grid.
clientmethod headerClick(which, index) [ Language = javascript ]
Click on header in grid.
clientmethod launchColorChooser() [ Language = javascript ]
Launch the color chooser.
clientmethod newWorksheet() [ Language = javascript ]
Create a new worksheet.
clientmethod notifyController(source, reason, prop, value, row) [ Language = javascript ]
Notification from the dataGrid.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod removeColumn() [ Language = javascript ]
Remove a column from the grid.
clientmethod removeRow() [ Language = javascript ]
Remove a row from the grid.
clientmethod saveWorksheet(showDialog) [ Language = javascript ]
Launch the save worksheet dialog.
clientmethod searchBoxHandler(searchKey) [ Language = javascript ]
Change in search box value. Can be overridden by subclasses.
clientmethod selectCell(row, col) [ Language = javascript ]
Select cell handler.
clientmethod selectItem(key, value) [ Language = javascript ]
Item selected in navigator.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab