Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%DeepSee.Report.UI.reportPreviewer

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

Temporary Report Preview Utilities

Property Inventory

Method Inventory

Parameters

parameter INCLUDEFILES = zenCSLM.js;
Inherited description: 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 methods: collectorLblDisplayToLogical(), collectorLblGet(), collectorLblIsValid(), collectorLblLogicalToDisplay(), collectorLblLogicalToOdbc(), collectorLblNormalize(), collectorLblSet()
property dataSource as %String [ InitialExpression = "dataSource.xml" ];
Property methods: dataSourceDisplayToLogical(), dataSourceGet(), dataSourceIsValid(), dataSourceLogicalToDisplay(), dataSourceLogicalToOdbc(), dataSourceNormalize(), dataSourceSet()
property debugModeFlag as %String [ InitialExpression = "$MODE=pdf&$REPORTNAME=" ];
Property methods: debugModeFlagDisplayToLogical(), debugModeFlagGet(), debugModeFlagIsValid(), debugModeFlagLogicalToDisplay(), debugModeFlagLogicalToOdbc(), debugModeFlagNormalize(), debugModeFlagSet()
property dirName as %String [ InitialExpression = "/csp/samples/" ];
Property methods: dirNameDisplayToLogical(), dirNameGet(), dirNameIsValid(), dirNameLogicalToDisplay(), dirNameLogicalToOdbc(), dirNameNormalize(), dirNameSet()
property errorLbl as %ZEN.Datatype.caption [ InitialExpression = "Error: " ];
Property methods: errorLblDisplayToLogical(), errorLblGet(), errorLblIsValid(), errorLblLogicalToDisplay(), errorLblLogicalToOdbc(), errorLblNormalize(), errorLblSet()
property errorOnCollect as %ZEN.Datatype.caption [ InitialExpression = "Error collecting live data for report preview" ];
Property methods: errorOnCollectDisplayToLogical(), errorOnCollectGet(), errorOnCollectIsValid(), errorOnCollectLogicalToDisplay(), errorOnCollectLogicalToOdbc(), errorOnCollectNormalize(), errorOnCollectSet()
property homeDir as %String;
Property methods: homeDirDisplayToLogical(), homeDirGet(), homeDirIsValid(), homeDirLogicalToDisplay(), homeDirLogicalToOdbc(), homeDirNormalize(), homeDirSet()
property hostName as %String;
Property methods: hostNameDisplayToLogical(), hostNameGet(), hostNameIsValid(), hostNameLogicalToDisplay(), hostNameLogicalToOdbc(), hostNameNormalize(), hostNameSet()
property modeFlag as %String [ InitialExpression = "$MODE=pdf" ];
Property methods: modeFlagDisplayToLogical(), modeFlagGet(), modeFlagIsValid(), modeFlagLogicalToDisplay(), modeFlagLogicalToOdbc(), modeFlagNormalize(), modeFlagSet()
property packageName as %String [ InitialExpression = "MyApp." ];
Property methods: packageNameDisplayToLogical(), packageNameGet(), packageNameIsValid(), packageNameLogicalToDisplay(), packageNameLogicalToOdbc(), packageNameNormalize(), packageNameSet()
property portNumber as %String;
Property methods: portNumberDisplayToLogical(), portNumberGet(), portNumberIsValid(), portNumberLogicalToDisplay(), portNumberLogicalToOdbc(), portNumberNormalize(), portNumberSet()
property reportName as %String [ InitialExpression = "ReportWriterTest" ];
Property methods: reportNameDisplayToLogical(), reportNameGet(), reportNameIsValid(), reportNameLogicalToDisplay(), reportNameLogicalToOdbc(), reportNameNormalize(), reportNameSet()
property tempDir as %String;
Property methods: tempDirDisplayToLogical(), tempDirGet(), tempDirIsValid(), tempDirLogicalToDisplay(), tempDirLogicalToOdbc(), tempDirNormalize(), tempDirSet()
property winFeatures as %String [ InitialExpression = "height=480,left=16,resizeable,scrollbars,top=16,width=640" ];
Property methods: winFeaturesDisplayToLogical(), winFeaturesGet(), winFeaturesIsValid(), winFeaturesLogicalToDisplay(), winFeaturesLogicalToOdbc(), winFeaturesNormalize(), winFeaturesSet()
property winTitle as %String [ InitialExpression = "Report_Preview" ];
Property methods: winTitleDisplayToLogical(), winTitleGet(), winTitleIsValid(), winTitleLogicalToDisplay(), winTitleLogicalToOdbc(), winTitleNormalize(), winTitleSet()

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 ]
classmethod GeneratePresentationReport(pClassName As %String, pStr As %String = "", pOutFileName As %String, pRptObj As %DeepSee.Report.dataPresenter = "", log As %Boolean = 0, renderServer As %String = "") 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 ]
clientmethod execute(className, dataSrc, pStr, debug) [ Language = javascript ]
Collect data and return the URL for viewing the report.
clientmethod getServerFileDelimiter() [ Language = javascript ]
clientmethod getServerHomeDir() [ Language = javascript ]
clientmethod getServerTempDir() [ Language = javascript ]
clientmethod makeXMLFileName(name) [ Language = javascript ]
clientmethod onloadHandler() [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is loaded.
clientmethod preview(className, dataSrc) [ Language = javascript ]
Show a preview.
clientmethod refreshDataSource() [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab