%DeepSee.UserLibrary.Worksheet
Class %DeepSee.UserLibrary.Worksheet Extends %DeepSee.UserLibrary.FolderItem [ System = 4 ]
This class represents a DeepSee Worksheet within a DeepSee folder.
This class also provides the APIs for working with DeepSee "worksheets". A worksheet can be used in several ways:
- You can use a worksheet to define a specialized KPI containing user-entered data that drives other dashboard widgets.
- You can use a worksheet to feed values into other DeepSee components, such as pivot tables.
- You can use a worksheet to enter and display a grid of values.
Parameters
XMLNAME
Parameter XMLNAME = "worksheet";
ITEMTYPE
Parameter ITEMTYPE = "worksheet";
This is the extension returned by this type from the Finder.
ICON
Parameter ICON = "deepsee/ds2_list_44.png";
LARGEICON
Parameter LARGEICON = "deepsee/ds2_list_44.png";
Properties
format
Property format As %ZEN.Datatype.string(XMLPROJECTION = "attribute");
Default format to apply to cells in this worksheet.
style
Property style As %ZEN.Datatype.style(XMLPROJECTION = "attribute");
Additional style to apply to cells in this worksheet.
columnHeaderStyle
Property columnHeaderStyle As %ZEN.Datatype.style(XMLPROJECTION = "attribute");
Additional style to apply to column headers in this grid.
rowHeaderStyle
Property rowHeaderStyle As %ZEN.Datatype.style(XMLPROJECTION = "attribute");
Additional style to apply to row headers in this grid.
borders
Property borders As %ZEN.Datatype.string(XMLPROJECTION = "attribute");
Specify whether cell borders should be "all" (the default) or "none".
showZebra
Property showZebra As %ZEN.Datatype.boolean(XMLPROJECTION = "attribute");
Specify whether zebra striping should be applied to the grid.
showRowLabels
Property showRowLabels As %ZEN.Datatype.boolean(XMLPROJECTION = "attribute") [ InitialExpression = 1 ];
Specifies whether row labels should be displayed.
showColumnLabels
Property showColumnLabels As %ZEN.Datatype.boolean(XMLPROJECTION = "attribute") [ InitialExpression = 1 ];
Specifies whether column labels should be displayed.
rowHeaders
Property rowHeaders As list Of WorksheetAxis(XMLNAME = "rowHeader", XMLPROJECTION = "ELEMENT");
This contains the definition of the row headers for this worksheet.
columnHeaders
Property columnHeaders As list Of WorksheetAxis(XMLNAME = "columnHeader", XMLPROJECTION = "ELEMENT");
This contains the definition of the column headers for this worksheet.
cells
Property cells As list Of WorksheetCell(XMLNAME = "cellDef", XMLPROJECTION = "ELEMENT");
This contains the definition of (overridden) cells for this worksheet.
gridMode
Property gridMode As %ZEN.Datatype.string(XMLPROJECTION = "attribute");
Data mode for the worksheet: "dataSet" or "dataSource".
dataConnector
Property dataConnector As %ZEN.Datatype.string(XMLPROJECTION = "attribute");
Name of data connector class used by the grid (in "dataSource" mode).
pageSize
Property pageSize As %ZEN.Datatype.integer(XMLPROJECTION = "attribute");
Page size used by the grid (in "dataSource" mode).
columnWidth
Property columnWidth As %ZEN.Datatype.integer;
Default column width.
%cells
Property %cells As %String(XMLPROJECTION = "none") [ Internal, MultiDimensional, Transient ];
This holds the definition of the cells within this worksheet.
%cells(r,c) = value
%values
Property %values As %String(XMLPROJECTION = "none") [ Internal, MultiDimensional, Transient ];
This holds the values of the cells within this worksheet after any calculations have been resolved.
%values(r,c) = value
xmlCells
Property xmlCells As list Of %String(XMLNAME = "cell", XMLPROJECTION = "ELEMENT") [ Transient ];
This is used to hold cell values when they are exported to XML.
xmlValues
Property xmlValues As list Of %String(XMLNAME = "value", XMLPROJECTION = "ELEMENT") [ Transient ];
This is used to hold cell (resolved) values when they are exported to XML.
%rowIndex
Property %rowIndex As %Integer(XMLPROJECTION = "none") [ Internal, MultiDimensional, Transient ];
Index of row names used during calculation.
%columnIndex
Property %columnIndex As %Integer(XMLPROJECTION = "none") [ Internal, MultiDimensional, Transient ];
Index of column names used during calculation.
%currRow
Property %currRow As %Integer(XMLPROJECTION = "none") [ Internal, Transient ];
Current row during calculation.
%currColumn
Property %currColumn As %Integer(XMLPROJECTION = "none") [ Internal, Transient ];
Current column during calculation.
%externalValues
Property %externalValues As %String(XMLPROJECTION = "none") [ Internal, MultiDimensional, Transient ];
Array of values from external sources (used during calculation).
%externalRefs
Property %externalRefs As %String(XMLPROJECTION = "none") [ Internal, MultiDimensional, Transient ];
Array of external sources (used during calculation).
Methods
%GetURL
Method %GetURL() As %String
Return the URL for this item.
%GetTypeName
Method %GetTypeName() As %String
Return the localized type name for this item.
%OnAfterSave
Method %OnAfterSave(insert As %Boolean) As %Status [ Private, ServerOnly = 1 ]
%OnDelete
ClassMethod %OnDelete(oid As %ObjectIdentity) As %Status [ Private, ServerOnly = 1 ]
%OnOpen
Method %OnOpen() As %Status [ Private, ServerOnly = 1 ]
%OnAfterImport
Method %OnAfterImport() As %Status
Notification that this item has just been imported.
XMLBeforeExport
Method XMLBeforeExport()
Notification before xml export.
%CopyToComponent
Method %CopyToComponent(pPivot As %DeepSee.Component.pivotTable) As %Status [ Internal ]
Copy the contents of this definition to pivot table pPivot.
%CopyFromComponent
Method %CopyFromComponent(pPivot As %DeepSee.Component.pivotTable) As %Status [ Internal ]
Set the contents of this definition from pivot table pPivot.
%Calculate
Method %Calculate() As %Status [ Internal ]
Resolve values of any formulas within this worksheet. This takes the raw values in %cells, executes formulas, and puts the results into %values.
%EvaluateCell
Method %EvaluateCell(pValue As %String, pRow As %Integer, pCol As %Integer, Output pResult As %String, Output pSC As %Status) As %Boolean [ Internal ]
Evaluate formula for one cell.
Return false if it has unresolved dependencies.
%Lookup
Method %Lookup(pIdent As %String) As %String
Formula function: Lookup the value of the given identifier.
%LookupReference
ClassMethod %LookupReference(ByRef pContext, pIdent As %String) As %String [ Internal ]
Lookup the value of a complete cell reference: [source].[col].[row] pContext tracks all the data sources that have been referenced.