Class Reference
%ZEN.Report.Display.tableOutput
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [%ZEN] >  [Report] >  [Display] >  [tableOutput]
Private  Storage

deprecatedabstract class %ZEN.Report.Display.tableOutput extends controller

This class provides an interface for ZEN report tags to be displayed in a table. Any tag that will be embedded in a table must extend tableOutput. When a class that does not implement the "children" property extends tableOutput, it must introduce a children property with XMLPROJECTION="none." See the <p> tag for an example. When a class that does not implement the "field" or "group" or "removeEmpty" property extends tableOutput it must introduce a "field" or "group" or "removeEmpty" property with XMLPROJECTION="none"

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
28 22


Summary

Properties
applyLevel blockContainerProperty caption colcount
colspan composite crosstabDataGroup crosstabFooterDataField
crosstabFooterFormatNumber crosstabFooterGroup crosstabHeaderDataField crosstabHeaderGroup
crosstabHeaderGroupLabels crosstabHeaderGroupTooLongText crosstabHeaderLabelDataField crosstabHeaderMatchField
crosstabRowGroup crosstabTruncationHeight crosstabTruncationWidth foblock
grouppath hasFooter hasHeader id
ifexpression ifxpath includeBlockContainer includeColIfExpression
includeColIfXPath includeColUnlessExpression includeColUnlessXPath linefeedTreatment
rowspan tooLongText truncate truncationHeight
truncationWidth unlessexpression

Methods
%AddToSaveSet %ApplyLevelParameters %BeginGroup %BeginGroupNoInc
%ClassIsLatestVersion %ClassName %ConstructClone %DeclareLevelParameters
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %DrawCellFO
%DrawCellFO1 %DrawCellToHTML %DrawCellToHTML1 %DrawFooterFO
%DrawFooterToAnnotatedXML %DrawFooterToHTML %DrawHeaderFO %DrawHeaderToHTML
%DrawSort %EndGroup %EndLevel %Extends
%FooterWidth %GetParameter %HeaderWidth %IncLevel
%IsA %IsModified %New %NormalizeObject
%ObjectModified %OldWidth %OriginalNamespace %PackageName
%QuoteValue %QuoteValueEmbedded %QuoteValueL10N %RemoveFromSaveSet
%SerializeObject %SetModified %ValidateObject %Width
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
hasFooterGet hasHeaderGet

Subclasses
%ZEN.Report.Display.COSChart.cchart %ZEN.Report.Display.COSChart.cchartDualY %ZEN.Report.Display.COSChart.test
%ZEN.Report.Display.Chart.chart %ZEN.Report.Display.barcode %ZEN.Report.Display.bidioverride
%ZEN.Report.Display.block %ZEN.Report.Display.br %ZEN.Report.Display.call
%ZEN.Report.Display.callsvg %ZEN.Report.Display.composite %ZEN.Report.Display.container
%ZEN.Report.Display.div %ZEN.Report.Display.fo %ZEN.Report.Display.foblock
%ZEN.Report.Display.group %ZEN.Report.Display.html %ZEN.Report.Display.img
%ZEN.Report.Display.imgSVG %ZEN.Report.Display.inline %ZEN.Report.Display.inlinecontainer
%ZEN.Report.Display.item %ZEN.Report.Display.line %ZEN.Report.Display.link
%ZEN.Report.Display.p %ZEN.Report.Display.table %ZEN.Report.Display.tbody
%ZEN.Report.Display.td %ZEN.Report.Display.tfoot %ZEN.Report.Display.th
%ZEN.Report.Display.thead %ZEN.Report.Display.tr %ZEN.Report.Display.valueof
%ZEN.Report.Display.variable %ZEN.Report.Display.xslt

Properties

• property blockContainerProperty as %ZEN.Datatype.string(XMLNAME="block-container-property");
properties of block container such as overflow='hidden' to truncate data too large
• property caption as %ZEN.Datatype.caption;
Short-hand property to specify the elements caption within the table's header row.
• property colcount as %ZEN.Datatype.string;
when grouppath is set, the number of columns in the group
• property colspan as %ZEN.Datatype.integer;
• property crosstabDataGroup as %ZEN.Datatype.string;
xpath representing data of cross-tab at row determined by crosstabRowGroup[$row]/
• property crosstabFooterDataField as %ZEN.Datatype.string;
xpath expression, which can use $pos, to get data to display in crosstab footer group
• property crosstabFooterFormatNumber as %ZEN.Datatype.string;
if non-null has footer data is formatted
• property crosstabFooterGroup as %ZEN.Datatype.string;
xpath representing data that will appear in footer
• property crosstabHeaderDataField as %ZEN.Datatype.string;
Defaults to "". Field (attribute or element) of crosstabHeaderGroup used in constructing match.
• property crosstabHeaderGroup as %ZEN.Datatype.string;
cross-tab properties
get headers for cross-tab item from this xpath
used for matching
• property crosstabHeaderGroupLabels as %ZEN.Datatype.string;
cross-tab properties
get headers for cross-tab item from this xpath
used for writing header labels
• property crosstabHeaderGroupTooLongText as %ZEN.Datatype.string(VALUELIST=",none,truncate,wrap,unset") [ InitialExpression = "unset" ];
cross-tab properties
get headers for cross-tab item from this xpath
used for matching
• property crosstabHeaderLabelDataField as %ZEN.Datatype.string;
cross-tab properties
get headers for cross-tab item from this xpath
used for writing header labels
relative to crosstabHeaderGroupLabels
• property crosstabHeaderMatchField as %ZEN.Datatype.string;
xpath representing data that will match against header name crosstabHeaderGroup[$col]
• property crosstabRowGroup as %ZEN.Datatype.string;
xpath representing "row" of table where cross-tab data lives
• property crosstabTruncationHeight as %ZEN.Datatype.string;
the height to use in truncation of cross tab header labels, if not specified inherited from table cell
• property crosstabTruncationWidth as %ZEN.Datatype.string;
the width to use in truncation of cross tab header lablels, if not specified inherited from table cell
• property foblock as %ZEN.Datatype.string;
fo attributes of block for things like orphan control One would specify foblock="orphans='1'"
• property grouppath as %ZEN.Datatype.string;
items and captions can now have groups that allow them to repeat on a line when table draw in orient="col"
• property hasFooter as %Boolean(XMLPROJECTION="none") [ Calculated ];
Calculated property that indicates whether or not this element specifies a footer cell.
• property hasHeader as %Boolean(XMLPROJECTION="none") [ Calculated ];
Calculated property that indicates whether or not this element specifies a header cell.
• property includeBlockContainer as %ZEN.Datatype.boolean(XMLNAME="include-block-container");
Is block wrapped inside a block container
• property linefeedTreatment as %ZEN.Datatype.string(VALUELIST=",ignore,preserve,treat-as-space,treat-as-zero-width-space",XMLNAME="linefeed-treatment");
• property rowspan as %ZEN.Datatype.integer;
• property tooLongText as %ZEN.Datatype.string(VALUELIST=",none,truncate,wrap,unset",XMLNAME="too-long-text") [ InitialExpression = "unset" ];
• property truncate as %ZEN.Datatype.boolean;
truncate text if it is too long if truncate is true
• property truncationHeight as %ZEN.Datatype.string(XMLNAME="truncation-height");
the height to use in truncation.
• property truncationWidth as %ZEN.Datatype.string(XMLNAME="truncation-width");
the width to use in truncation, if not specified inherited from table cell

Methods

• method %BeginGroup(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, mode As %String, name As %String)
• method %BeginGroupNoInc(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, mode As %String, name As %String)
• method %DrawCellFO(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, orient As %String) as %Status
• method %DrawCellFO1(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream) as %Status
Part of the tableOutput API that displays the element contained in a table cell for the PDF report.
• method %DrawCellToHTML(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, orient As %String) as %Status
Part of the tableOutput API that displays the element contained in a table cell for the HTML report.
• method %DrawCellToHTML1(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream) as %Status
• method %DrawFooterFO(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, oldSummary As %Boolean, orient As %String) as %Status

Part of the tableOutput API that searches for a <summary> child and if it finds one renders it (just as an <item> tag) as the row/column's footer.

• method %DrawFooterToAnnotatedXML(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream) as %Status

Part of the tableOutput API that searches for a <summary> child and if it finds one renders it (just as an <item> tag) as the row/column's footer.

• method %DrawFooterToHTML(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, oldSummary As %Boolean, orient As %String) as %Status

Part of the tableOutput API that searches for a <summary> child and if it finds one renders it (just as an <item> tag) as the row/column's footer.

• method %DrawHeaderFO(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, orient As %String) as %Status

Part of the tableOutput API that searches for a <caption> child and if it finds one renders it (just as an <item> tag) as the row/column's header.

As a short-hand, one can simply specify the caption attribute for the tag, but that is less flexible.

• method %DrawHeaderToHTML(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, orient As %String) as %Status

Part of the tableOutput API that searches for a <caption> child and if it finds one renders it (just as an <item> tag) as the row/column's header.

As a short-hand, one can simply specify the caption attribute for the tag, but that is less flexible.

• classmethod %DrawSort(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, orderby As %String, datatype As %String) as %Status
• method %EndGroup(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, mode As %String, name As %String)
• method %FooterWidth()
Returns the width of the footer cell for this object.
• method %HeaderWidth()
Returns the width of the header cell for this object.
• method %OldWidth()
Returns the width of the cell containing this object.
• method %Width()
Returns the width of the cell containing this object.
• method hasFooterGet() as %Boolean
This is a Get accessor method for the hasFooter property.
• method hasHeaderGet() as %Boolean
This is a Get accessor method for the hasHeader property.


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