This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %ZEN.ComponentEx.documentView


class %ZEN.ComponentEx.documentView extends %ZEN.Component.abstractGroup, %ZEN.Component.dataView

Experimental Document view component.
This provides an way to display a "document" -- data supplied as a graph of JavaScript objects and rendered using a model supplied by another object graph.

Property Inventory

Method Inventory


parameter DEFAULTENCLOSINGCLASS = dvEnclosingClass;
Inherited description: Subclasses can set this to change default enclosingClass used for this component.


property blockStyle as;
Style for blocks (sections) within the document. A block encloses a title and paragraph or a table.
Property methods: blockStyleDisplayToLogical(), blockStyleGet(), blockStyleIsValid(), blockStyleLogicalToDisplay(), blockStyleLogicalToOdbc(), blockStyleNormalize(), blockStyleSet()
property documentStyle as;
Style for overall document.
Property methods: documentStyleDisplayToLogical(), documentStyleGet(), documentStyleIsValid(), documentStyleLogicalToDisplay(), documentStyleLogicalToOdbc(), documentStyleNormalize(), documentStyleSet()
property evenRowStyle as [ InitialExpression = "background:#F8F8F8;" ];
Style for even rows within tables.
Property methods: evenRowStyleDisplayToLogical(), evenRowStyleGet(), evenRowStyleIsValid(), evenRowStyleLogicalToDisplay(), evenRowStyleLogicalToOdbc(), evenRowStyleNormalize(), evenRowStyleSet()
property headerRowStyle as [ InitialExpression = "background:#E0E0FF;" ];
Style for header rows within tables.
Property methods: headerRowStyleDisplayToLogical(), headerRowStyleGet(), headerRowStyleIsValid(), headerRowStyleLogicalToDisplay(), headerRowStyleLogicalToOdbc(), headerRowStyleNormalize(), headerRowStyleSet()
property oddRowStyle as;
Style for odd rows within tables.
Property methods: oddRowStyleDisplayToLogical(), oddRowStyleGet(), oddRowStyleIsValid(), oddRowStyleLogicalToDisplay(), oddRowStyleLogicalToOdbc(), oddRowStyleNormalize(), oddRowStyleSet()
property ongetdata as %ZEN.Datatype.eventHandler;
ongetdata event handler: If defined, this event is returns the source data to be displayed within this component.
Property methods: ongetdataDisplayToLogical(), ongetdataGet(), ongetdataIsValid(), ongetdataLogicalToDisplay(), ongetdataLogicalToOdbc(), ongetdataNormalize(), ongetdataSet()
property ongetlayout as %ZEN.Datatype.eventHandler;
ongetlayout event handler: If defined, this event is returns the layout model for the document.
Property methods: ongetlayoutDisplayToLogical(), ongetlayoutGet(), ongetlayoutIsValid(), ongetlayoutLogicalToDisplay(), ongetlayoutLogicalToOdbc(), ongetlayoutNormalize(), ongetlayoutSet()
property paraStyle as;
Style for paragraphs within the document.
Property methods: paraStyleDisplayToLogical(), paraStyleGet(), paraStyleIsValid(), paraStyleLogicalToDisplay(), paraStyleLogicalToOdbc(), paraStyleNormalize(), paraStyleSet()
property tableBorder as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Display borders for tables.
Property methods: tableBorderDisplayToLogical(), tableBorderGet(), tableBorderIsValid(), tableBorderLogicalToDisplay(), tableBorderLogicalToOdbc(), tableBorderLogicalToXSD(), tableBorderNormalize(), tableBorderSet(), tableBorderXSDToLogical()
property tableStyle as;
Style for tables within the document.
Property methods: tableStyleDisplayToLogical(), tableStyleGet(), tableStyleIsValid(), tableStyleLogicalToDisplay(), tableStyleLogicalToOdbc(), tableStyleNormalize(), tableStyleSet()
property titleStyle as;
Style for titles within the document.
Property methods: titleStyleDisplayToLogical(), titleStyleGet(), titleStyleIsValid(), titleStyleLogicalToDisplay(), titleStyleLogicalToOdbc(), titleStyleNormalize(), titleStyleSet()
property useLayout as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If false, show a generic view of the data with no layout applied.
Property methods: useLayoutDisplayToLogical(), useLayoutGet(), useLayoutIsValid(), useLayoutLogicalToDisplay(), useLayoutLogicalToOdbc(), useLayoutLogicalToXSD(), useLayoutNormalize(), useLayoutSet(), useLayoutXSDToLogical()


method %DrawHTML()
Inherited description: Static HTML display method: draw the BODY of this component as HTML.
Subclasses implement this in order to render the static HTML contents of a component.
clientmethod eval(data, expr, context) [ Language = javascript ]
Evaluate a display value expression and return the result.
data is the data source object supplying the data.
expr is the expression. If is starts with "=", it is interpreted as an expression.
An expression can refer to a property within the data source object:
"=[prop]" evaluates to sourceData.prop
"=[propA.propB]" evaluates to sourceData.propA.propB (if propA is not an object, return "")
"=[prop[0]]" evaluates to sourceData.prop[0]
context is current context object (which modifies the reference to the data source object).
clientmethod getLayout() [ Language = javascript ]
Get the layout model the defineds the layout and display of the document.
clientmethod getSourceData() [ Language = javascript ]
Get the source data for the document.
clientmethod renderChart(key, data, sect, context, display) [ Language = javascript ]
Render an embedded chart.
clientmethod renderContents() [ Language = javascript ]
Client-side method to render this control.
clientmethod renderGeneric(data, level, counter) [ Language = javascript ]
Render the HTML for a "generic" view of the given source data.
clientmethod renderImage(key, data, sect, context, display) [ Language = javascript ]
Render an image.
clientmethod renderList(key, data, list, context, display) [ Language = javascript ]
Render a list of items.
key is the key (prefix) used to assign key values to the items.
data is the source data.
list is the list of items.
context is the inherited data context.
displat specifies how to display the items: 'div' or 'td'.
clientmethod renderPara(key, data, sect, context, display) [ Language = javascript ]
Render a paragraph.
clientmethod resolveNamedStyle(namedStyle, data, context) [ Language = javascript ]
Resolve the value of a named style. evaluate and lookup the style in the local list of named styles.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new window