Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%DeepSee] >  [Report] >  [dataPresenter]
Private  Storage   

class %DeepSee.Report.dataPresenter extends %DeepSee.Report.reportPage

Base class for all data presentation reports created by the DeepSee Report Builder.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
6


Summary

This is a Zen Report class. 

Properties
%ArrayLogFiles %SplitReturnedPDFs %display %id
%seriesCount %seriesNames %source AggregatesIgnoreNLS
CheckPDFNotZeroLength ConnectTimeOut CountRepeatingElement Datasource
DefaultFontFaceCopyHTML DefaultFontSizeCopyHTML ExcelServer ExcelServerTimeOut
FileLifeTime MainReport Mode NamespaceDeclarations
OldBehaviorLineFeedOnBreak OptionCachePath OptionConserve OptionDPI
OptionEnableAccessibility OptionFlush OptionLang OptionNoAccessContent
OptionNoAnnotations OptionNoAssembleDoc OptionNoComplexScript OptionNoCopy
OptionNoEdit OptionNoFillInForms OptionNoPrint OptionNoPrintHq
OptionOwnerPassword OptionPDFProfile OptionRelaxed OptionUserPassword
PDFMergeMemSize PS PrintServer PrintTimeOut
RenderDirectlyOnTimeout RenderTimeOut RepeatingElement ReportDir
ReportXMLNameSpace ReportXMLNameSpacePrefix SaxMemSize SetProcessWideRunTimeMode
SplitAndMerge SplitDir SplitOnly SplitRootName
StripPI SubReport SuppressExcelHeaders TableAltColor
TimeOut TooLongText UseHTML5 UseRawIOForXML
UseSemaphore XsltVersion getxmlstylesheet isHTML5
isServer reportDSSClass reportDSSHome toexcelstream
tohtmlstream toxslfostream xmlfile xmlstream
xmlstylesheet xmlstylesheetarg

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName
%ConstructClone %CreateModelInstance %DeleteModel
%DispatchClassMethod %DispatchGetModified %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DisplayAnnotatedExcel
%Extends %GetComponentById %GetJSValidationCode
%GetParameter %GetPropertyInfo %GetReportName
%GetXDataTextSection %InitProperties1 %InvokeAction
%IsA %IsModified %IsReadOnly
%MakeTransformedXMLFile %New %NormalizeObject
%ObjectModified %OnAfterCreateDisplay %OnAfterReport
%OnBeforeReport %OnCopyDataFromModel %OnCopyDataToModel
%OnDeleteModel %OnDeleteSource %OnGetPropertyInfo
%OnInvokeAction %OnLoadModel %OnNewSource
%OnOpenSource %OnPreHTTP %OnReportTag
%OnSaveSource %OnStoreModel %OnSubmit
%OpenModel %OriginalNamespace %PackageName
%RemoveFromSaveSet %ResolveText %SaveModel
%SerializeObject %SetModified %SubmitHandler
%ValidateObject %getDisplayUniqueExcelSheetName %getUniqueExcelSheetName
AsynchGenerateReport ConvertParameter Decrypt
Encrypt EscapeHTML EscapeURL
GenerateReport GenerateReportToStream GenerateToFile
GetDSSClass GetDSSHome GetReportDCR
GetReportDSS GetReportModel GetResultValue
GetTempFileName HyperEventCall HyperEventHead
Include InsertHiddenField InsertHiddenFields
IsPrivate Link MakeXPath
OnAfterCreateDisplay OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page
Purge QueryURL QuoteJS
RewriteURL ShowError StartTimer
StopTimer TestPDFGeneration ThrowError
ToExcelDate UnLock UnescapeHTML
UnescapeURL


Methods

• method GenerateReport(outputfile As %String, mode As %Integer = 0, log As %Boolean = 0, renderServer As %String = "", ExcelMode As %String = "", pStr As %String = "", Output RenderDirect As %Integer = 1) as %Status
Generate the report and save it to outputfile.
Choices for mode are:
  • 0 = XML
  • 1 = HTML
  • 2 = PDF
  • 3 = ToHTML Stylesheet
  • 4 = ToXSLFO Stylesheet
  • 5 = XSD Schema
  • 6 = PrintPS
  • 7 = Excel
  • 8 = XSLFO
  • 9 = ToEXCEL
  • 10=xlsx
  • 11=TIFF
  • 12=pdfprint
  • 13=displayxlsx
  • 14=fo2pdf
  • 15=foandpdf

If log is true, the log file is returned instead of the report
• method GetResultValue(Results, N As %Integer = 1) as %String
Extracts a value from XPath Result list.
• method MakeXPath(ByRef values, dataGroup, dataFields, plotBy, context, seriesNameField)
Specify seriesGroup or dataGroup as dataGroup.
Specify comma-separated list for dataFields, (no need for !-prefixes).

When plotBy is "series" : the number of series equals the number of dataGroup elements found in the XML.
When plotBy is "item" : the number of series equals the number dataField entries specified.

If the dataGroup name is not unique, specify the context using XPath syntax. The default is to match elements of that name anywhere (context="//").

Optionally specify a seriesNameField XPath expression. This is evaluated relative to the dataGroup. If not specified, a default name is generated using the dataGroup and a positional predicate.

• classmethod OnPage() as %Status
Render the contents of this ZEN report.
• classmethod QueryURL() as %ZEN.Datatype.string [ ZenMethod ]


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