Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%DeepSee] >  [Report] >  [UI] >  [reportPreviewer]
Private  Storage   

class %DeepSee.Report.UI.reportPreviewer extends %ZEN.Component.component

Temporary Report Preview Utilities

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 15 20


Summary

Properties
%condition %import %includeFiles %page
%resource align aux collectorLbl
composite containerStyle dataSource debugModeFlag
dirName dragEnabled dropEnabled enclosingClass
enclosingStyle error errorLbl errorOnCollect
height hidden hint hintClass
hintStyle homeDir hostName id
index label labelClass labelDisabledClass
labelStyle modeFlag name onafterdrag
onbeforedrag ondrag ondrop onhide
onrefresh onshow onupdate packageName
parent portNumber reportName showLabel
slice tempDir title tuple
valign visible width winFeatures
winTitle window

Methods
%AddToSaveSet %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawComponentHTML %DrawHTML %DrawJSStrings
%EnclosingDivId %Eval %EvalC %Extends
%ForceClientRender %GetEventHandlers %GetParameter %GetXMLName
%IsA %IsModified %MakeId %New
%NormalizeObject %ObjectModified %OnAddToPageAfter %OnAddToPageBefore
%OnDrawEnclosingDiv %OnDrawObjectProperties %OnObjectSynch %OnZENDeserialize
%OriginalNamespace %PackageName %QuoteValue %QuoteValueL10N
%RemoveFromSaveSet %Self %SerializeObject %SetModified
%ValidateObject DeleteTempFile GenerateDataSet GeneratePresentationReport
GetClassProperties GetDSS GetSystemHomeDir GetSystemTempDir
GetTempDir GetTempFileName MakeRandomFileName ReallyRefreshDataSource
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler execute exposeComponent
findElement fireOnUpdateEvent getEnclosingDiv getHidden
getHintElement getLabelElement getProperty getServerFileDelimiter
getServerHomeDir getServerTempDir getSettings getType
invokeSuper isOfType makeId makeXMLFileName
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onStartModalHandler
onloadHandler onunloadHandler onupdateHandler preview
refreshContents refreshDataSource render renderContents
renderSVG setHidden setOverlayMode setProperty
startProgressBar stopProgressBar


Parameters

• parameter INCLUDEFILES = "zenCSLM.js";
CSV list of additional include files (either .js or .css) that should be included when this component is used on a page.
By default, the file extension (.js or .css) is used to determine whether an item in the list is a script include or a style include. You can override this behavior by adding the terms "script:" or "style:" to the beginning of the file name or names. This prefix is not used as part of the include filename.

Properties

• property collectorLbl as %ZEN.Datatype.caption [ InitialExpression = "Data collection class: " ];
• property dataSource as %String [ InitialExpression = "dataSource.xml" ];
• property debugModeFlag as %String [ InitialExpression = "$MODE=pdf&$REPORTNAME=" ];
• property dirName as %String [ InitialExpression = "/csp/samples/" ];
• property errorLbl as %ZEN.Datatype.caption [ InitialExpression = "Error: " ];
• property errorOnCollect as %ZEN.Datatype.caption [ InitialExpression = "Error collecting live data for report preview" ];
• property homeDir as %String;
• property hostName as %String;
• property modeFlag as %String [ InitialExpression = "$MODE=pdf" ];
• property packageName as %String [ InitialExpression = "MyApp." ];
• property portNumber as %String;
• property reportName as %String [ InitialExpression = "ReportWriterTest" ];
• property tempDir as %String;
• property winFeatures as %String [ InitialExpression = "height=480,left=16,resizeable,scrollbars,top=16,width=640" ];
• property winTitle as %String [ InitialExpression = "Report_Preview" ];

Methods

• method %DrawHTML()
The %DrawHTML method draws the initial HTML for this component.
• classmethod DeleteTempFile(fileName As %String) [ ZenMethod ]
• classmethod GenerateDataSet(clsName As %String, fileName As %String, pStr As %String = "") as %Status [ ZenMethod ]
GenerateData
• classmethod GeneratePresentationReport(pClassName As %String, pStr As %String = "", pOutFileName As %String, pRptObj As %DeepSee.Report.dataPresenter = "", log As %Boolean = 0, renderServer As %String = "", Output RenderDirect As %Integer) as %Status [ ZenMethod ]
• classmethod GetClassProperties(className As %String) as %ZEN.Datatype.string [ ZenMethod ]
Return a string representing an array of the class properties that have ZENURL parameters set for them
• classmethod GetDSS(fileName As %String) as %String [ ZenMethod ]
• classmethod GetSystemHomeDir() as %String [ ZenMethod ]
• classmethod GetSystemTempDir() as %String [ ZenMethod ]
Return the temp directory for this system.
• classmethod GetTempDir() as %String [ ZenMethod ]
Return the temp directory for this system.
• classmethod GetTempFileName() as %String [ ZenMethod ]
• classmethod MakeRandomFileName(ext As %String = "", directory As %String = "") as %String [ ZenMethod ]
• method ReallyRefreshDataSource(pClassName As %String, pURI As %String, pServerName As %String, pServerPort As %String, pOutFileName As %String) as %Status [ ZenMethod ]
• method execute(className, dataSrc, pStr, debug) [ Language = javascript ]
Collect data and return the URL for viewing the report.
• method getServerFileDelimiter() [ Language = javascript ]
• method getServerHomeDir() [ Language = javascript ]
• method getServerTempDir() [ Language = javascript ]
• method makeXMLFileName(name) [ Language = javascript ]
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method preview(className, dataSrc) [ Language = javascript ]
Show a preview.
• method refreshDataSource() [ Language = javascript ]


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