Skip to main content

%DeepSee.UI.WorksheetBuilder

Class %DeepSee.UI.WorksheetBuilder Extends %DeepSee.UI.standardPage [ System = 4 ]

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

Parameters​

PAGENAME​

Parameter PAGENAME = "Worksheet Manager";

Displayed name of this page.

DEFAULTVIEWMODE;​

Parameter DEFAULTVIEWMODE;

If this page has multiple views, this is its initial display mode.

DOCBOOKID​

Parameter DOCBOOKID = "D2MODADV_ch_worksheet";

JSINCLUDES​

Parameter JSINCLUDES = "dsparser.js";

Pick up formula code.

Properties​

worksheetName​

Property worksheetName As %String(ZENURL = "WORKSHEET");

Name of worksheet being viewed.

whichCell​

Property whichCell As %String;

Indicates what the cell value editor is showing: "cell","row", or "column".

%model​

Property %model As %DeepSee.UserLibrary.Worksheet;

Local copy of worksheet object.

readOnly​

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

If true, user cannot modify the current worksheet.

canWrite​

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

If true, user can modify (non-read-only) worksheet.

XDatas​

Style​

XData Style

If true, user cannot modify the current worksheet. Property readOnly As %ZEN.Datatype.boolean [ InitialExpression = 0 ]; If true, user can modify (non-read-only) worksheet. Property canWrite As %ZEN.Datatype.boolean [ InitialExpression = 1 ]; This Style block contains page-specific CSS style definitions.

contentPane​

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

Methods​

DrawHelp​

Method DrawHelp(pSeed As %String) As %Status

Draw the help panel.

%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.

%OnGetProductName​

Method %OnGetProductName() As %String

Get the product name for the page.

OnGetRibbonInfo​

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.

onlayoutHandler​

ClientMethod onlayoutHandler(load) [ Language = javascript ]

Adjust sizes of components on the page.

getNavigator​

ClientMethod getNavigator() [ Language = javascript ]

Get the navigator component.

applyModelToGrid​

ClientMethod applyModelToGrid() [ Language = javascript ]

Apply saved attributes to the grid component. There is a copy of this method in the worksheet widget.

adjustSizes​

ClientMethod adjustSizes() [ Language = javascript ]

Adjust sizes of components on the page.

%OnAfterCreatePage​

Method %OnAfterCreatePage() As %Status

This class method callback is called just before the server-side page object is created.

changeWorksheet​

ClientMethod changeWorksheet() [ Language = javascript ]

Launch the worksheet finder dialog.

browseSubjectAreas​

ClientMethod browseSubjectAreas() [ Language = javascript ]

Launch the subject area finder.

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.

canUserModify​

ClientMethod canUserModify() [ Language = javascript ]

Test if the user has write privilege.

searchBoxHandler​

ClientMethod searchBoxHandler(searchKey) [ Language = javascript ]

Change in search box value. Can be overridden by subclasses.

getModel​

ClientMethod getModel() [ Language = javascript ]

Get the json-supplied data model.

headerClick​

ClientMethod headerClick(which, index) [ Language = javascript ]

Click on header in grid.

addRow​

ClientMethod addRow() [ Language = javascript ]

Add a row to the grid

addColumn​

ClientMethod addColumn() [ Language = javascript ]

Add a column to the grid

removeRow​

ClientMethod removeRow() [ Language = javascript ]

Remove a row from the grid.

removeColumn​

ClientMethod removeColumn() [ Language = javascript ]

Remove a column from the grid.

newWorksheet​

ClientMethod newWorksheet() [ Language = javascript ]

Create a new worksheet.

exportWorksheet​

ClientMethod exportWorksheet() [ Language = javascript ]

Export the worksheet.

deleteWorksheet​

ClientMethod deleteWorksheet() [ Language = javascript ]

Delete the worksheet.

saveWorksheet​

ClientMethod saveWorksheet(showDialog) [ Language = javascript ]

Launch the save worksheet dialog.

GetWorksheetContent​

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

Get content object for JSON provider.

SubmitWorksheet​

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.

Delete​

Method Delete(pName As %String) As %String [ ZenMethod ]

Delete a worksheet.

%OnSubmit​

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.

cellControlChange​

ClientMethod cellControlChange() [ Language = javascript ]

Change to value in cell value control.

getCellOverride​

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

Get cell override.

selectCell​

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

Select cell handler.

getGrid​

ClientMethod getGrid() [ Language = javascript ]

Get the grid component.

gridKeyDown​

ClientMethod gridKeyDown(evt) [ Language = javascript ]

Key down handler for grid.

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.

getContentForLevel​

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

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

dataChange​

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

Data change in navigator

selectItem​

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

Item selected in navigator.

launchColorChooser​

ClientMethod launchColorChooser() [ Language = javascript ]

Launch the color chooser.

%OnPreHTTP​

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

Test for additional resources.