This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions pageOpens in a new window (login required).

Caché & Ensemble 2018.1.5Opens in a new window > Class Reference > %SYS namespace > %ZEN.Report.Display.group

%ZEN.Report.Display.group

class %ZEN.Report.Display.group extends %ZEN.Report.Display.childrenNode, %ZEN.Report.Display.tableOutput

The <group> tag indicates that its content should be displayed for each child contained within the XML containing tag given by 's name attribute. When developing a stylesheet for XML data generated by the ReportDefinition XData block, one should nest the <group> tags in the same order within each XData block, with the same names.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property breakCheck as %ZEN.Datatype.string;
Added new property "breakCheck", if defined, contains the condition used to determine when a page break should execute. Condition that will allow pagebreak to be executed
Property methods: breakCheckDisplayToLogical(), breakCheckGet(), breakCheckIsValid(), breakCheckLogicalToDisplay(), breakCheckLogicalToOdbc(), breakCheckNormalize(), breakCheckSet()
property dataType as %ZEN.Datatype.string (VALUELIST = ",text,number,qname", XMLNAME = "data-type") [ InitialExpression = "text" ];
specify type of data used in group sort orderby - text, number or qname
Property methods: dataTypeDisplayToLogical(), dataTypeGet(), dataTypeIsValid(), dataTypeLogicalToDisplay(), dataTypeLogicalToOdbc(), dataTypeNormalize(), dataTypeSet()
property field as %ZEN.Datatype.string (XMLPROJECTION = "NONE");
Property methods: fieldDisplayToLogical(), fieldGet(), fieldIsValid(), fieldLogicalToDisplay(), fieldLogicalToOdbc(), fieldNormalize(), fieldSet()
property group as %ZEN.Datatype.string (XMLPROJECTION = "NONE");
Property methods: groupDisplayToLogical(), groupGet(), groupIsValid(), groupLogicalToDisplay(), groupLogicalToOdbc(), groupNormalize(), groupSet(), grouppathDisplayToLogical(), grouppathGet(), grouppathIsValid(), grouppathLogicalToDisplay(), grouppathLogicalToOdbc(), grouppathNormalize(), grouppathSet()
property line as %ZEN.Datatype.length [ InitialExpression = 0 ];
Specifies the thickness of the line to drawn between records within the group. If line=0, no line is drawn.
Property methods: lineDisplayToLogical(), lineGet(), lineIsValid(), lineLogicalToDisplay(), lineLogicalToOdbc(), lineNormalize(), lineSet(), linefeedTreatmentDisplayToLogical(), linefeedTreatmentGet(), linefeedTreatmentIsValid(), linefeedTreatmentLogicalToDisplay(), linefeedTreatmentLogicalToOdbc(), linefeedTreatmentNormalize(), linefeedTreatmentSet()
property name as %ZEN.Datatype.name [ Required ];
Specifies the tag to match within the XML data. The 's contents are displayed for each element that matches the name.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property orderby as %ZEN.Datatype.string;
comma separated list of xpaths by which the group will be sorted
Property methods: orderbyDisplayToLogical(), orderbyGet(), orderbyIsValid(), orderbyLogicalToDisplay(), orderbyLogicalToOdbc(), orderbyNormalize(), orderbySet()
property pagebreak as %ZEN.Datatype.boolean [ InitialExpression = "0" ];
If pagebreak is true, a pagebreak is added between records within the group.
Property methods: pagebreakBeforeDisplayToLogical(), pagebreakBeforeGet(), pagebreakBeforeIsValid(), pagebreakBeforeLogicalToDisplay(), pagebreakBeforeLogicalToOdbc(), pagebreakBeforeLogicalToXSD(), pagebreakBeforeNormalize(), pagebreakBeforeSet(), pagebreakBeforeXSDToLogical(), pagebreakDisplayToLogical(), pagebreakGet(), pagebreakIsValid(), pagebreakLogicalToDisplay(), pagebreakLogicalToOdbc(), pagebreakLogicalToXSD(), pagebreakNormalize(), pagebreakSet(), pagebreakXSDToLogical()
property pagebreakBefore as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
property "pagebreakBefore", if true, applies page break logic before "xsl:aply-templates". Move pagebreak to before each entry in the group
Property methods: pagebreakBeforeDisplayToLogical(), pagebreakBeforeGet(), pagebreakBeforeIsValid(), pagebreakBeforeLogicalToDisplay(), pagebreakBeforeLogicalToOdbc(), pagebreakBeforeLogicalToXSD(), pagebreakBeforeNormalize(), pagebreakBeforeSet(), pagebreakBeforeXSDToLogical()
property primaryGroup as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
display group used by XSL:for-each loop to provide multiple page sequences
Property methods: primaryGroupDisplayToLogical(), primaryGroupGet(), primaryGroupIsValid(), primaryGroupLogicalToDisplay(), primaryGroupLogicalToOdbc(), primaryGroupLogicalToXSD(), primaryGroupNormalize(), primaryGroupSet(), primaryGroupXSDToLogical()
property removeEmpty as %ZEN.Datatype.boolean (XMLPROJECTION = "NONE") [ InitialExpression = 0 ];
Property methods: removeEmptyDisplayToLogical(), removeEmptyGet(), removeEmptyIsValid(), removeEmptyLogicalToDisplay(), removeEmptyLogicalToOdbc(), removeEmptyLogicalToXSD(), removeEmptyNormalize(), removeEmptySet(), removeEmptyXSDToLogical()
property separator as %ZEN.Datatype.string (VALUELIST = ",none,line") [ InitialExpression = "none" ];
Use to separate rendered items
Property methods: separatorDisplayToLogical(), separatorGet(), separatorIsValid(), separatorLogicalToDisplay(), separatorLogicalToOdbc(), separatorNormalize(), separatorSet()
property smallMultiple as %ZEN.Datatype.boolean (XMLNAME = "small-multiple");
top-level group being used to construct small multiple
Property methods: smallMultipleDisplayToLogical(), smallMultipleGet(), smallMultipleIsValid(), smallMultipleLogicalToDisplay(), smallMultipleLogicalToOdbc(), smallMultipleLogicalToXSD(), smallMultipleNameDisplayToLogical(), smallMultipleNameGet(), smallMultipleNameIsValid(), smallMultipleNameLogicalToDisplay(), smallMultipleNameLogicalToOdbc(), smallMultipleNameNormalize(), smallMultipleNameSet(), smallMultipleNormalize(), smallMultipleSet(), smallMultipleXSDToLogical()
property smallMultipleName as %ZEN.Datatype.string (XMLNAME = "small-multiple-name") [ InitialExpression = "small-multiple" ];
name of small multiple, must be specified to have more than one on a report page
Property methods: smallMultipleNameDisplayToLogical(), smallMultipleNameGet(), smallMultipleNameIsValid(), smallMultipleNameLogicalToDisplay(), smallMultipleNameLogicalToOdbc(), smallMultipleNameNormalize(), smallMultipleNameSet()
property testEachifxpath as %ZEN.Datatype.string;
Test each itteration of the group with the defined ifxpath condition
Property methods: testEachifxpathDisplayToLogical(), testEachifxpathGet(), testEachifxpathIsValid(), testEachifxpathLogicalToDisplay(), testEachifxpathLogicalToOdbc(), testEachifxpathNormalize(), testEachifxpathSet()

Methods (Including Private)

method %DrawToHTML(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream, ByRef incell As %Boolean) as %Status
Inherited description: This method outputs the necessary stylesheet information for the HTML report. Every tag should override this method.
method %DrawToXSLFO(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream, ByRef incell As %Boolean) as %Status
Inherited description: This method outputs the necessary stylesheet information for the PDF report. Every tag should override this method.
method %xDrawToAnnotatedXML(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream) as %Status

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window