Class Reference
%DeepSee.UI.Dialog.CellFormatOptions
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [%DeepSee] >  [UI] >  [Dialog] >  [CellFormatOptions]
Private  Storage

class %DeepSee.UI.Dialog.CellFormatOptions extends %DeepSee.UI.Dialog.standardDialog

This dialog lets the user specificy conditional formatting for a pivot table.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 3 17


Summary

This is a Zen Page class. 

Properties
%condition %import %includeFiles %page
%resource FirstFailed InvalidParam IsEMSReadOnly
ValidationErrorMsg align aux backgroundTimerInterval
cellAlign cellSize cellStyle cellVAlign
children colorScale composite containerStyle
cssLevel defRange dialogTitle disabled
disabledStyle dragAndDrop dragEnabled dropEnabled
enclosingClass enclosingStyle error formatRules
groupClass groupStyle height hidden
hideApplyButton hideCancelButton hint hintClass
hintStyle id index label
labelClass labelDisabledClass labelPosition labelStyle
layout name onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onrefresh onshow onupdate parent
showLabel slice title tuple
useSVG useSoftModals valign visible
width window zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddToSaveSet %ApplyURLParms %Attr
%BindExport %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout
%DrawClassDefinitions %DrawComponentHTML %DrawHTML %DrawHTMLPage
%DrawJSStrings %DrawObjectDefinitions %DrawTitle %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %EvalC
%Extends %ForceClientRender %GetChildIndex %GetComponent
%GetComponentById %GetComponentByName %GetEventHandlers %GetLinks
%GetPageName %GetParameter %GetValueById %GetValueByName
%GetXMLName %IsA %IsModified %Link
%LinkCSS %LinkScript %MakeId %New
%NormalizeObject %ObjectModified %OnAddToPageAfter %OnAddToPageBefore
%OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication %OnCreatePage
%OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody %OnDrawHTMLHead
%OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask %OnGetSubtitle
%OnGetTitle %OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch
%OnSubmit %OnUseSoftModals %OnZENDeserialize %OriginalNamespace
%PackageName %QuoteValue %QuoteValueL10N %RemoveChild
%RemoveChildren %RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod
%Self %SerializeObject %SetBackgroundMethodStatus %SetErrorById
%SetErrorByName %SetModified %SetValueById %SetValueByName
%SetValuesByName %StartScript %ValidateObject %ZENVersion
ConvertParameter Decrypt DrawColorScale DrawRuleList
Encrypt EscapeHTML EscapeURL EvalResult
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate JavaInstalled Link
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
QuoteJS RewriteURL ShowError StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore addRule
adjustSize btnApply btnOK cancelPopup
ccChange childrenMutated clearRules correctIELayering
createComponent createComponentNS ctrlKeyDown deleteComponent
dialogApply dialogCancel dialogFinish dialogTitleGet
disableButtons dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler editRule
endModal exposeComponent findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getComponent getComponentById getDialogValue getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getProperty getSettings getType gotoPage
invokeSuper isOfType launchPopupWindow makeId
moveRuleDown moveRuleUp onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onServerMethodCall onServerMethodError onServerMethodReturn
onStartModalHandler ondialogCancel ondialogFinish ondialogStart
ondisabledHandler onhandleAutoLogoutWarn onkeydownHandler onkeyupHandler
onlayoutHandler onloadHandler onlogoutHandler onoverlayHandler
onresizeHandler onunloadHandler onupdateHandler popupActionHandler
refreshContents removeChild removeRule render
renderContents renderSVG resetMsg selectColorScale
setComponentId setHidden setOverlayMode setProperty
setPropertyAll setTraceOption showMsg startModal
startProgressBar stopProgressBar stripWhitespaces validateRequired


Parameters

• parameter APPLYBUTTON = 1;
If true, then this dialog displays an Apply button.

Properties

• property colorScale as %ZEN.Datatype.string(ZENURL="COLORSCALE");
Name of color scale in effect.
• property defRange as %ZEN.Datatype.string;
Default Range for new rules.
• property formatRules as list of %DeepSee.Component.pivotCondition(XMLNAME="formatRule",XMLPROJECTION="ELEMENT");
List of formatting rules for the table.

Methods

• method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
• method %OnGetTitle() as %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
• method DrawColorScale(pSeed As %String) as %Status
Draw contents of color scale icon box.
• method DrawRuleList(pSeed As %String) as %Status
Draw contents of rule list box.
• method addRule() [ Language = javascript ]
Add a rule definition.
• method ccChange(apply) [ Language = javascript ]
Change to custom color
• method clearRules() [ Language = javascript ]
Clear the rules
• method editRule(n) [ Language = javascript ]
Edit a rule definition.
• method getDialogValue() [ Language = javascript ]
Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
• method moveRuleDown(n) [ Language = javascript ]
Move a rule definition up.
• method moveRuleUp(n) [ Language = javascript ]
Move a rule definition up.
• method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
• method ondialogFinish(action) as %Boolean [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.
• method ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
• method removeRule(n) [ Language = javascript ]
Remove a rule definition.
• method selectColorScale(type) [ Language = javascript ]
Click on a new color scale.


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.