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

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

This dialog lets the user change the print properties for a DeepSee pivot table.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 62 30


Summary

This is a Zen Page class. 

Properties
%condition %import %includeFiles %page
%resource FirstFailed InvalidParam IsEMSReadOnly
ValidationErrorMsg align aux backgroundTimerInterval
borderBottomCell borderBottomCol borderBottomRow borderLeftCell
borderLeftCol borderLeftRow borderRightCell borderRightCol
borderRightRow borderTopCell borderTopCol borderTopRow
cellAlign cellHeight cellSize cellStyle
cellVAlign cellWidth chartMarginBottom chartMarginLeft
chartMarginRight chartMarginTop children columnCount
columnHeaderStyle columnTotals composite containerStyle
cssLevel cubeName dataCellStyle dialogTitle
disabled disabledStyle dragAndDrop dragEnabled
dropEnabled enclosingClass enclosingStyle error
filterRowCount filterTableCaptionStyle filterTableItemStyle filterTableStyle
fontFamilyCell fontFamilyCol fontFamilyRow fontSizeCell
fontSizeCol fontSizeRow groupClass groupStyle
height hidden hideApplyButton hideCancelButton
hint hintClass hintStyle id
index label labelClass labelDisabledClass
labelPosition labelStyle layout listingFilterRowCount
listingFontSize maxRows mode name
nowDisplayFormat onafterdrag onbeforedrag onclick
ondrag ondrop onhide onrefresh
onshow onupdate pageSizeNames pageSizeValues
parent printCellWidth printLabelWidth printMarginBottom
printMarginLeft printMarginRight printMarginTop printOrientation
printPageSize printSubtitle printSubtitleOn printTitle
rowHeaderStyle rowTotals selectedItem showDate
showFilters showLabel showListingFilters showRowCaption
showUser showZebra showZebraStripes slice
title tuple units 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
%OnPreHTTP %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 Encrypt
EscapeHTML EscapeURL EvalResult GetPrintDefinition
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 addItem
adjustSize btnApply btnOK cancelPopup
changePageSize childrenMutated clearStyles cloneTree
closeButtonClick correctIELayering createComponent createComponentNS
ctrlKeyDown dataArrange dataChange dataIndent
deleteComponent dialogApply dialogCancel dialogFinish
dialogTitleGet disableButtons dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
endModal exposeComponent findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getComponent getComponentById getContentForLevel getDialogValue
getEnclosingDiv getHTMLForItems getHidden getHintElement
getLabelElement getLayoutItem getLayoutTree getOpener
getPreviewImage getPrintDef getProperty getSettings
getType gotoPage headerButtonClick invokeSuper
isOfType keyPress launchPopupWindow makeId
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
render renderContents renderSVG resetMsg
roundOff selectElement selectItem setComponentId
setHidden setOverlayMode setProperty setPropertyAll
setTraceOption showMsg startModal startProgressBar
stopProgressBar stripWhitespaces updatePreview validateRequired


Parameters

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

Properties

• property borderBottomCell as %ZEN.Datatype.string(ZENURL="BORDERBOTTOMCELL");
• property borderBottomCol as %ZEN.Datatype.string(ZENURL="BORDERBOTTOMCOL");
• property borderBottomRow as %ZEN.Datatype.string(ZENURL="BORDERBOTTOMROW");
• property borderLeftCell as %ZEN.Datatype.string(ZENURL="BORDERLEFTCELL");
Table borders
• property borderLeftCol as %ZEN.Datatype.string(ZENURL="BORDERLEFTCOL");
• property borderLeftRow as %ZEN.Datatype.string(ZENURL="BORDERLEFTROW");
• property borderRightCell as %ZEN.Datatype.string(ZENURL="BORDERRIGHTCELL");
• property borderRightCol as %ZEN.Datatype.string(ZENURL="BORDERRIGHTCOL");
• property borderRightRow as %ZEN.Datatype.string(ZENURL="BORDERRIGHTROW");
• property borderTopCell as %ZEN.Datatype.string(ZENURL="BORDERTOPCELL");
• property borderTopCol as %ZEN.Datatype.string(ZENURL="BORDERTOPCOL");
• property borderTopRow as %ZEN.Datatype.string(ZENURL="BORDERTOPROW");
• property cellHeight as %ZEN.Datatype.string(ZENURL="CELLHEIGHT");
• property cellWidth as %ZEN.Datatype.string(ZENURL="CELLWIDTH");
• property chartMarginBottom as %ZEN.Datatype.float(ZENURL="CMARGINBOTTOM");
Page bottom margin when pivot is printed. This is in the same units as the page size.
• property chartMarginLeft as %ZEN.Datatype.float(ZENURL="CMARGINLEFT");
Page left margin when pivot is printed. This is in the same units as the page size.
• property chartMarginRight as %ZEN.Datatype.float(ZENURL="CMARGINRIGHT");
Page right margin when pivot is printed. This is in the same units as the page size.
• property chartMarginTop as %ZEN.Datatype.float(ZENURL="CMARGINTOP");
Page top margin when pivot is printed. This is in the same units as the page size.
• property columnCount as %ZEN.Datatype.integer(ZENURL="COLUMNCOUNT");
• property columnHeaderStyle as %ZEN.Datatype.string(ZENURL="COLUMNSTYLE");
• property columnTotals as %ZEN.Datatype.boolean(ZENURL="COLUMNTOTALS");
• property cubeName as %ZEN.Datatype.string(ZENURL="CUBE");
• property dataCellStyle as %ZEN.Datatype.string(ZENURL="CELLSTYLE");
• property filterRowCount as %ZEN.Datatype.integer(ZENURL="FILTERROWCOUNT");
filterRowCount - used in preview
• property filterTableCaptionStyle as %ZEN.Datatype.style(ZENURL="FILTERTABLECAPTIONSTYLE") [ InitialExpression = "border:none;color:white;background-color:#6f6fff;text-align:left;font-weight:bold;font-size:6pt;" ];
filterTableCaptionStyle;
• property filterTableItemStyle as %ZEN.Datatype.style(ZENURL="FILTERTABLEITEMSTYLE") [ InitialExpression = "border:none;text-align:left;font-weight:normal;font-size:6pt;" ];
filterTableItemStyle;
• property filterTableStyle as %ZEN.Datatype.style(ZENURL="FILTERTABLESTYLE") [ InitialExpression = "border:1pt solid gray;" ];
filterTableStyle
• property fontFamilyCell as %ZEN.Datatype.string(ZENURL="FONTFAMILYCELL");
• property fontFamilyCol as %ZEN.Datatype.string(ZENURL="FONTFAMILYCOL");
• property fontFamilyRow as %ZEN.Datatype.string(ZENURL="FONTFAMILYROW");
• property fontSizeCell as %ZEN.Datatype.string(ZENURL="FONTSIZECELL");
• property fontSizeCol as %ZEN.Datatype.string(ZENURL="FONTSIZECOL");
• property fontSizeRow as %ZEN.Datatype.string(ZENURL="FONTSIZEROW");
• property listingFilterRowCount as %ZEN.Datatype.integer(ZENURL="LISTINGFILTERROWCOUNT");
listingFilterRowCount - used in preview
• property listingFontSize as %ZEN.Datatype.string(ZENURL="LISTINGFONTSIZE") [ InitialExpression = "6pt" ];
Font size for listings
• property maxRows as %ZEN.Datatype.integer(ZENURL="MAXROWS");
max rows to export to PDF
• property mode as %ZEN.Datatype.string(ZENURL="MODE") [ InitialExpression = "table" ];
"table", "chart", or "dashboard".
• property nowDisplayFormat as %ZEN.Datatype.string(ZENURL="NOWDISPLAYFORMAT");
nowDisplay
• property pageSizeNames as %ZEN.Datatype.csv;
List of page size names.
• property pageSizeValues as %ZEN.Datatype.csv;
List of page size values.
• property printCellWidth as %ZEN.Datatype.float(ZENURL="PRINTCELLWIDTH");
Width of data cells when the pivot is printed. This is in the same units as the page size.
• property printLabelWidth as %ZEN.Datatype.float(ZENURL="PRINTLABELWIDTH");
Width of row labels when the pivot is printed. This is in the same units as the page size.
• property printMarginBottom as %ZEN.Datatype.float(ZENURL="MARGINBOTTOM");
Page bottom margin when pivot is printed. This is in the same units as the page size.
• property printMarginLeft as %ZEN.Datatype.float(ZENURL="MARGINLEFT");
Page left margin when pivot is printed. This is in the same units as the page size.
• property printMarginRight as %ZEN.Datatype.float(ZENURL="MARGINRIGHT");
Page right margin when pivot is printed. This is in the same units as the page size.
• property printMarginTop as %ZEN.Datatype.float(ZENURL="MARGINTOP");
Page top margin when pivot is printed. This is in the same units as the page size.
• property printOrientation as %ZEN.Datatype.string(ZENURL="ORIENTATION") [ InitialExpression = "portrait" ];
Orientation when pivot is printed.
• property printPageSize as %ZEN.Datatype.string(ZENURL="PAGESIZE");
Page size when pivot is printed. This takes the form "8.5x11 in" (w x h).
• property printSubtitle as %ZEN.Datatype.string(MAXLEN=2000,ZENURL="SUBTITLE");
Subtitle to display when pivot is printed.
• property printSubtitleOn as %ZEN.Datatype.string(ZENURL="SUBTITLEON") [ InitialExpression = "on" ];
Display Subtitle when pivot is printed.
• property printTitle as %ZEN.Datatype.string(MAXLEN=2000,ZENURL="TITLE");
Title to display when pivot is printed.
• property rowHeaderStyle as %ZEN.Datatype.string(ZENURL="ROWSTYLE");
• property rowTotals as %ZEN.Datatype.boolean(ZENURL="ROWTOTALS");
• property selectedItem as %ZEN.Datatype.string;
id of current selected item.
• property showDate as %ZEN.Datatype.string(ZENURL="SHOWDATE") [ InitialExpression = "off" ];
showDate
• property showFilters as %ZEN.Datatype.string(ZENURL="SHOWFILTERS") [ InitialExpression = "byTable" ];
showFilters
• property showListingFilters as %ZEN.Datatype.string(ZENURL="SHOWLISTINGFILTERS") [ InitialExpression = "off" ];
showListingFilters
• property showRowCaption as %ZEN.Datatype.boolean(ZENURL="ROWCAPTION");
• property showUser as %ZEN.Datatype.string(ZENURL="SHOWUSER") [ InitialExpression = "off" ];
Display User when pivot is printed.
• property showZebra as %ZEN.Datatype.boolean(ZENURL="ZEBRA");
• property showZebraStripes as %ZEN.Datatype.string(ZENURL="SHOWZEBRASTRIPES") [ InitialExpression = "on" ];
showZebraStripes
• property units as %ZEN.Datatype.string;

Methods

• method %OnAfterCreatePage() as %Status
Be sure to do ##super() when overriding.
• 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 GetPrintDefinition(ByRef pParms, Output pObject As %RegisteredObject) as %Status
Get Print Definition data for JSON provider.
• method addItem(type) [ Language = javascript ]
Add a new item to the print definition.
• method adjustSize() [ Language = javascript ]
Adjust sizes components on the page.
• method changePageSize() [ Language = javascript ]
Change in page size.
• method clearStyles() [ Language = javascript ]
Reset styles.
• method cloneTree(tree) [ Language = javascript ]
Create a copy of a tree (printDef).
• method closeButtonClick(key) [ Language = javascript ]
Button clicked in navigator close button.
• method dataArrange(key, swap, final) [ Language = javascript ]
Rearrange of list of values.
• method dataChange(key, value, final) [ Language = javascript ]
This is called when a data value within the navigator is changed. key is the key for the item and value is the new value. final is true if this is the final value (controls such as a slider may provide intermediate values as well while the user is actively dragging it).
• method dataIndent(key, swap, final) [ Language = javascript ]
Re-indent list of values.
• method getContentForLevel(level, key, value) [ Language = javascript ]
Return an object describing what to display for this level.
• method getDialogValue() [ Language = javascript ]
Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
• method getHTMLForItems(dir, parentKey, items, availSize, scale, pos) [ Language = javascript ]
Get the HTML for a list of print items.
• method getLayoutItem(key) [ Language = javascript ]
Find the item within the print definition graph with the given key. The key takes the form: "n1,n2,n3..."
• method getLayoutTree(list, level, parentKey) [ Language = javascript ]
Construct a single list of content items from a graph of items.
• method getPreviewImage() [ Language = javascript ]
• method getPrintDef() [ Language = javascript ]
Get the client-side print definition.
• method headerButtonClick(key) [ Language = javascript ]
Button clicked in navigator header.
• method keyPress() [ Language = javascript ]
Key press handler.
• 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 roundOff(value, places) [ Language = javascript ]
Round off a numer to the given number of places.
• method selectElement(evt, which) [ Language = javascript ]
Select an element within the preview.
• method selectItem(key, value, which) [ Language = javascript ]
Item selected in navigator.
• method updatePreview() [ Language = javascript ]
Draw contents of preview component.


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