Class %ZEN.Report.Display.Chart.chartUtil

deprecatedclass %ZEN.Report.Display.Chart.chartUtil extends %RegisteredObject

Utility class that renders the various utility templates needed by a chart. Note: utility templates of the form 'zenReport...' have a number added to the template name to identify which chart they are a part of.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
		21

Summary

Methods
%AddToSaveSet	%ClassIsLatestVersion	%ClassName	%ConstructClone
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Extends
%GetParameter	%IsA	%IsModified	%New
%NormalizeObject	%ObjectModified	%OriginalNamespace	%PackageName
%RemoveFromSaveSet	%SerializeObject	%SetModified	%ValidateObject
SvgPrefix	outputAttributesFromStyle	qualify	renderDrawLowMarker
renderDrawMarker	renderDrawXLabels	renderDrawYLabels	renderFindScaleUnits
renderGetMaxMinValue	renderGetPlotX	renderGetPlotY	renderGetSeriesColor
renderGetSeriesCount	renderGetSeriesSize	renderGetXLabelText	renderGetYLabelText
renderGridLinesTemplates	renderLog	renderMaxMin	renderPower
renderUtils

Methods

• classmethod SvgPrefix()

• classmethod outputAttributesFromStyle(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, style As %String)

following need for IE support

• classmethod qualify(xpath As %String, ByRef context As %String)

• classmethod renderDrawLowMarker(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, chart As chart, pivot)

• classmethod renderDrawMarker(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, chart As chart)

Renders the 'zenReportDrawMarker' template, which creates a plot marker. This template takes 'shape', 'color', 'x', and 'y' parameters. Shape can be 'up','down','circle','square'.

• classmethod renderDrawXLabels(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, chart As chart, plot As plot)

Renders the 'zenReportXValueLabels' and 'zenReportXCategoryLabels' templates. These loop over the data and display the appropriate labels.

• classmethod renderDrawYLabels(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, chart As chart, plot As plot)

Renders the 'zenReportYValueLabels' and 'zenReportYCategoryLabels' templates. These loop over the data and display the appropriate labels.

• classmethod renderFindScaleUnits(XSL As %GlobalCharacterStream, chart As chart)

Renders the zenReportFindScaleUnits template which finds the best scale units to use for given range.

• classmethod renderGetMaxMinValue(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, chart As chart, plot As plot)

Renders the 'zenReportGetMinValue' and 'zenReportGetMaxValue' templates which return the minimum and maximum data values across all series.

• classmethod renderGetPlotX(context As %String, XSL As %GlobalCharacterStream, chart As chart, plot As plot)

Renders the 'zenReportGetPlotX' template. This template takes 'val' as a parameter, and returns the x coordinate within the chart.

• classmethod renderGetPlotY(context As %String, XSL As %GlobalCharacterStream, chart As chart, plot As plot)

Renders the 'zenReportGetPlotY' template. This template takes 'val' as a parameter, and returns the y coordinate within the chart.

• classmethod renderGetSeriesColor(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, chart As chart, cc As %String = "")

Renders the 'zenReportGetSeriesColor' template which takes a 'series' parameter. Color is determined by choosing the corresponding item in the list seriesColors. Color selection wraps around when the seriesColors list is exhausted.

• classmethod renderGetSeriesCount(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, chart As chart)

Renders the 'zenReportGetSeriesCount' template which returns the number of series. Within a template, it is more efficient to use the $seriescount global variable than re-invoke this template.

• classmethod renderGetSeriesSize(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, chart As chart)

Renders the 'zenReportGetSeriesSize' template which returns the number of series. Within a template, it is more efficient to use the $seriessize global variable than re-invoke this template.

• classmethod renderGetXLabelText(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, chart As chart)

Renders the 'zenReportGetXLabelText' template, which takes an 'item' parameter and returns the appropriate label text.

• classmethod renderGetYLabelText(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, chart As chart)

Renders the 'zenReportGetYLabelText' template, which takes an 'item' parameter and returns the appropriate label text.

• classmethod renderGridLinesTemplates(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, chart As chart, plot As plot)

Renders the 'zenReportYValueLines', 'zenReportYCategoryLines', 'zenReportXValueLines', and 'zenReportXCategoryLines' templates which are invoked as necessary to draw the gridlines.

• classmethod renderLog(ByRef XSL As %GlobalCharacterStream, chart As chart)

Renders the 'util-log10' (log base 10) and 'util-log' (natural log) templates, both of which take a 'number' parameter.

• classmethod renderMaxMin(XSL As %GlobalCharacterStream, chart As chart)

Renders the 'util-min' and 'util-max' templates, which both take a 'nodes' parameter and return the maximum value across the nodes.

• classmethod renderPower(XSL As %GlobalCharacterStream, chart As chart)

Renders the 'util-power' template which raises 'base' to the power 'power.' Warning: very slow implementation.

• classmethod renderUtils(context As %String, XSL As %GlobalCharacterStream, chart As chart, plot As plot)

Entry method that renders all of the utility tempaltes provided by the other methods in this clas.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search