Skip to main content

%ZEN.Report.Display.Chart.chart

class %ZEN.Report.Display.Chart.chart extends %ZEN.Report.Display.childrenNode, %ZEN.Report.Display.tableOutput

Property Inventory

Method Inventory

Parameters

parameter DEFAULTASPECT = none;
Do not worry about preserving the aspect ratio.
parameter DEFAULTMARKERSVISIBLE = 0;
Default value for the markersVisible property.
parameter DEFAULTPLOTTOEDGE = 1;
Default value for the plotToEdge property.
parameter DEFAULTVIEWBOXHEIGHT = 100;
Default viewBoxHeight of this component. This is set to 100 to provide a fixed coordinate system for meters.
parameter DEFAULTVIEWBOXWIDTH = 100;
Default viewBoxWidth of this component. This is set to 100 to provide a fixed coordinate system for meters.

Properties

property axisTitleStyle as %ZEN.Datatype.svgStyle;
Optional: default style applied to axis titles for this chart.
This is applied in addition to the style supplied by labelStyle.
Property methods: axisTitleStyleDisplayToLogical(), axisTitleStyleGet(), axisTitleStyleIsValid(), axisTitleStyleLogicalToDisplay(), axisTitleStyleLogicalToOdbc(), axisTitleStyleNormalize(), axisTitleStyleSet()
property backgroundStyle as %ZEN.Datatype.style;
Optional: style used for chart background panel.
Property methods: backgroundStyleDisplayToLogical(), backgroundStyleGet(), backgroundStyleIsValid(), backgroundStyleLogicalToDisplay(), backgroundStyleLogicalToOdbc(), backgroundStyleNormalize(), backgroundStyleSet()
property bandLower as %ZEN.Datatype.float;
If defined, then a colored band (specified by bandLowerStyle) is displayed on the plot area covering the range lower than this value;
Property methods: bandLowerDisplayToLogical(), bandLowerGet(), bandLowerIsValid(), bandLowerLogicalToDisplay(), bandLowerLogicalToOdbc(), bandLowerNormalize(), bandLowerSet()
property bandLowerStyle as %ZEN.Datatype.style;
Optional: style used for upper band on plot area.
Property methods: bandLowerStyleDisplayToLogical(), bandLowerStyleGet(), bandLowerStyleIsValid(), bandLowerStyleLogicalToDisplay(), bandLowerStyleLogicalToOdbc(), bandLowerStyleNormalize(), bandLowerStyleSet()
property bandUpper as %ZEN.Datatype.float;
If defined, then a colored band (specified by bandUpperStyle) is displayed on the plot area covering the range greater than this value;
Property methods: bandUpperDisplayToLogical(), bandUpperGet(), bandUpperIsValid(), bandUpperLogicalToDisplay(), bandUpperLogicalToOdbc(), bandUpperNormalize(), bandUpperSet()
property bandUpperStyle as %ZEN.Datatype.style;
Optional: style used for upper band on plot area.
Property methods: bandUpperStyleDisplayToLogical(), bandUpperStyleGet(), bandUpperStyleIsValid(), bandUpperStyleLogicalToDisplay(), bandUpperStyleLogicalToOdbc(), bandUpperStyleNormalize(), bandUpperStyleSet()
property children as list of %ZEN.Report.Display.Chart.axis (XMLELEMENTREF = 1, XMLPROJECTION = "ELEMENT", XMLTYPECONSTRAINT = "CHOICE");
Typical children property for a childrenNode, but every child must be an axis.
Property methods: childrenBuildValueArray(), childrenCollectionToDisplay(), childrenCollectionToOdbc(), childrenDisplayToCollection(), childrenGet(), childrenGetObject(), childrenGetObjectId(), childrenGetSwizzled(), childrenIsValid(), childrenOdbcToCollection(), childrenSet(), childrenSetObject(), childrenSetObjectId()
property dataFields as %ZEN.Datatype.csv;
Comma-delimited list of fields to acquire data from. If dataGroup is provided, only the first data field is used.
Property methods: dataFieldsDisplayToLogical(), dataFieldsGet(), dataFieldsIsValid(), dataFieldsLogicalToDisplay(), dataFieldsLogicalToOdbc(), dataFieldsNormalize(), dataFieldsSet()
property dataGroup as %ZEN.Datatype.string;
Specifies the group the group that corresponds to the data elements for the chart.
Property methods: dataGroupDisplayToLogical(), dataGroupGet(), dataGroupIsValid(), dataGroupLogicalToDisplay(), dataGroupLogicalToOdbc(), dataGroupNormalize(), dataGroupSet()
property field as %ZEN.Datatype.string (XMLPROJECTION = "NONE");
Property methods: fieldDisplayToLogical(), fieldGet(), fieldIsValid(), fieldLogicalToDisplay(), fieldLogicalToOdbc(), fieldNormalize(), fieldSet()
property gridStyle as %ZEN.Datatype.style;
Optional: default style applied to all grid line elements for this chart.
If defined, this style overrides any styles define in the CSS style definition for the page, but is in turn overridden by any styles defined by a specific axis element.
Property methods: gridStyleDisplayToLogical(), gridStyleGet(), gridStyleIsValid(), gridStyleLogicalToDisplay(), gridStyleLogicalToOdbc(), gridStyleNormalize(), gridStyleSet()
property group as %ZEN.Datatype.string (XMLPROJECTION = "NONE");
Property methods: groupDisplayToLogical(), groupGet(), groupIsValid(), groupLogicalToDisplay(), groupLogicalToOdbc(), groupNormalize(), groupSet()
property height as %ZEN.Datatype.length;
Height of the chart within the report.
Property methods: heightDisplayToLogical(), heightGet(), heightIsValid(), heightLogicalToDisplay(), heightLogicalToOdbc(), heightNormalize(), heightSet()
property labelStyle as %ZEN.Datatype.style;
Optional: default style applied to all grid label elements for this chart. If defined, this style overrides any styles define in the CSS style definition for the page, but is in turn overridden by any styles defined by a specific axis element.
Property methods: labelStyleDisplayToLogical(), labelStyleGet(), labelStyleIsValid(), labelStyleLogicalToDisplay(), labelStyleLogicalToOdbc(), labelStyleNormalize(), labelStyleSet()
property labelsVisible as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, display axis labels for this chart (or slice labels in the case of a pie chart).
Property methods: labelsVisibleDisplayToLogical(), labelsVisibleGet(), labelsVisibleIsValid(), labelsVisibleLogicalToDisplay(), labelsVisibleLogicalToOdbc(), labelsVisibleLogicalToXSD(), labelsVisibleNormalize(), labelsVisibleSet(), labelsVisibleXSDToLogical()
property legendAutoPosition as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, auto-position the legend
Property methods: legendAutoPositionDisplayToLogical(), legendAutoPositionGet(), legendAutoPositionIsValid(), legendAutoPositionLogicalToDisplay(), legendAutoPositionLogicalToOdbc(), legendAutoPositionLogicalToXSD(), legendAutoPositionNormalize(), legendAutoPositionSet(), legendAutoPositionXSDToLogical()
property legendHeight as %ZEN.Datatype.float;
If this chart has a legend, height (within the chart coordinate space) of legend box. If not specified a default height (based on number of data series) will be used.
Property methods: legendHeightDisplayToLogical(), legendHeightGet(), legendHeightIsValid(), legendHeightLogicalToDisplay(), legendHeightLogicalToOdbc(), legendHeightNormalize(), legendHeightSet()
property legendLabelStyle as %ZEN.Datatype.style;
Optional: style used for text within the legend box.
Property methods: legendLabelStyleDisplayToLogical(), legendLabelStyleGet(), legendLabelStyleIsValid(), legendLabelStyleLogicalToDisplay(), legendLabelStyleLogicalToOdbc(), legendLabelStyleNormalize(), legendLabelStyleSet()
property legendStyle as %ZEN.Datatype.style;
Optional: style used for background of the legend box.
Property methods: legendStyleDisplayToLogical(), legendStyleGet(), legendStyleIsValid(), legendStyleLogicalToDisplay(), legendStyleLogicalToOdbc(), legendStyleNormalize(), legendStyleSet()
property legendVisible as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, display a legend for this chart.
Property methods: legendVisibleDisplayToLogical(), legendVisibleGet(), legendVisibleIsValid(), legendVisibleLogicalToDisplay(), legendVisibleLogicalToOdbc(), legendVisibleLogicalToXSD(), legendVisibleNormalize(), legendVisibleSet(), legendVisibleXSDToLogical()
property legendWidth as %ZEN.Datatype.float;
If this chart has a legend, width (within the chart coordinate space) of legend box. If not specified a default width will be used.
Property methods: legendWidthDisplayToLogical(), legendWidthGet(), legendWidthIsValid(), legendWidthLogicalToDisplay(), legendWidthLogicalToOdbc(), legendWidthNormalize(), legendWidthSet()
property legendX as %ZEN.Datatype.float [ InitialExpression = 0 ];
If this chart has a legend, x-position (within the chart coordinate space) of legend box.
Property methods: legendXDisplayToLogical(), legendXGet(), legendXIsValid(), legendXLogicalToDisplay(), legendXLogicalToOdbc(), legendXNormalize(), legendXSet()
property legendY as %ZEN.Datatype.float [ InitialExpression = 0 ];
If this chart has a legend, y-position (within the chart coordinate space) of legend box.
Property methods: legendYDisplayToLogical(), legendYGet(), legendYIsValid(), legendYLogicalToDisplay(), legendYLogicalToOdbc(), legendYNormalize(), legendYSet()
property marginBottom as %ZEN.Datatype.float [ InitialExpression = 10 ];
Margin (within the chart coordinate space) from bottom edge of chart to bottom edge of grid (plot area).
Property methods: marginBottomDisplayToLogical(), marginBottomGet(), marginBottomIsValid(), marginBottomLogicalToDisplay(), marginBottomLogicalToOdbc(), marginBottomNormalize(), marginBottomSet()
property marginLeft as %ZEN.Datatype.float [ InitialExpression = 10 ];
Margin (within the chart coordinate space) from left edge of chart to left edge of grid (plot area).
Property methods: marginLeftDisplayToLogical(), marginLeftGet(), marginLeftIsValid(), marginLeftLogicalToDisplay(), marginLeftLogicalToOdbc(), marginLeftNormalize(), marginLeftSet()
property marginRight as %ZEN.Datatype.float [ InitialExpression = 2 ];
Margin (within the chart coordinate space) from right edge of chart to right edge of grid (plot area).
Property methods: marginRightDisplayToLogical(), marginRightGet(), marginRightIsValid(), marginRightLogicalToDisplay(), marginRightLogicalToOdbc(), marginRightNormalize(), marginRightSet()
property marginTop as %ZEN.Datatype.float [ InitialExpression = 6 ];
Margin (within the chart coordinate space) from top edge of chart to top edge of grid (plot area).
Property methods: marginTopDisplayToLogical(), marginTopGet(), marginTopIsValid(), marginTopLogicalToDisplay(), marginTopLogicalToOdbc(), marginTopNormalize(), marginTopSet()
property markerScale as %ZEN.Datatype.float [ InitialExpression = 1 ];
Scaling applied to chart markers: A value of 1.0 (or '') will display markers with their default size. This only applies to charts that support markers.
Property methods: markerScaleDisplayToLogical(), markerScaleGet(), markerScaleIsValid(), markerScaleLogicalToDisplay(), markerScaleLogicalToOdbc(), markerScaleNormalize(), markerScaleSet()
property markerShapes as %ZEN.Datatype.csv [ InitialExpression = "circle,up,down,square" ];
Comma-delimited list of marker shapes used for data series markers. Possible values are 'up','down','square','circle'.
This only applies to charts that support markers.
Property methods: markerShapesDisplayToLogical(), markerShapesGet(), markerShapesIsValid(), markerShapesLogicalToDisplay(), markerShapesLogicalToOdbc(), markerShapesNormalize(), markerShapesSet()
property markerStyle as %ZEN.Datatype.style;
Optional: style used for series markers.
Property methods: markerStyleDisplayToLogical(), markerStyleGet(), markerStyleIsValid(), markerStyleLogicalToDisplay(), markerStyleLogicalToOdbc(), markerStyleNormalize(), markerStyleSet()
property markersVisible as %ZEN.Datatype.boolean [ InitialExpression = ..#DEFAULTMARKERSVISIBLE ];
Specifies whether markers should be displayed for the data points within the line chart.
This only appies to charts that display markers.
Property methods: markersVisibleDisplayToLogical(), markersVisibleGet(), markersVisibleIsValid(), markersVisibleLogicalToDisplay(), markersVisibleLogicalToOdbc(), markersVisibleLogicalToXSD(), markersVisibleNormalize(), markersVisibleSet(), markersVisibleXSDToLogical()
property ongetLabelX as %ZEN.Datatype.eventHandler;
ongetLabelX event handler:
This event handler, if defined, is called by the chart to get the text for a given label on the x axis.
Property methods: ongetLabelXDisplayToLogical(), ongetLabelXGet(), ongetLabelXIsValid(), ongetLabelXLogicalToDisplay(), ongetLabelXLogicalToOdbc(), ongetLabelXNormalize(), ongetLabelXSet()
property ongetLabelY as %ZEN.Datatype.eventHandler;
ongetLabelY event handler:
This event handler, if defined, is called by the chart to get the text for a given label on the y axis.
Property methods: ongetLabelYDisplayToLogical(), ongetLabelYGet(), ongetLabelYIsValid(), ongetLabelYLogicalToDisplay(), ongetLabelYLogicalToOdbc(), ongetLabelYNormalize(), ongetLabelYSet()
property plot as %ZEN.Report.Display.Chart.plot (XMLPROJECTION = "none");
Internal property used to keep track of plot information.
Property methods: plotGet(), plotGetSwizzled(), plotIsValid(), plotNewObject(), plotSet()
property plotAreaStyle as %ZEN.Datatype.style;
Optional: style used for chart plot area panel.
Property methods: plotAreaStyleDisplayToLogical(), plotAreaStyleGet(), plotAreaStyleIsValid(), plotAreaStyleLogicalToDisplay(), plotAreaStyleLogicalToOdbc(), plotAreaStyleNormalize(), plotAreaStyleSet()
property plotStyle as %ZEN.Datatype.style;
Optional: default style applied to svg elements used for plotting data by this chart (such as the line in a line chart).
Property methods: plotStyleDisplayToLogical(), plotStyleGet(), plotStyleIsValid(), plotStyleLogicalToDisplay(), plotStyleLogicalToOdbc(), plotStyleNormalize(), plotStyleSet()
property plotToEdge as %ZEN.Datatype.boolean [ InitialExpression = ..#DEFAULTPLOTTOEDGE ];
Specifies how values should be plotted along a category axis. If true, plot the first and last values on the edges of the plotArea (as in a line chart). If false, plot values in the centers of each unit (as in a bar chart).
This is specified by subclasses.
Property methods: plotToEdgeDisplayToLogical(), plotToEdgeGet(), plotToEdgeIsValid(), plotToEdgeLogicalToDisplay(), plotToEdgeLogicalToOdbc(), plotToEdgeLogicalToXSD(), plotToEdgeNormalize(), plotToEdgeSet(), plotToEdgeXSDToLogical()
property removeEmpty as %ZEN.Datatype.boolean (XMLPROJECTION = "NONE") [ InitialExpression = 0 ];
Property methods: removeEmptyDisplayToLogical(), removeEmptyGet(), removeEmptyIsValid(), removeEmptyLogicalToDisplay(), removeEmptyLogicalToOdbc(), removeEmptyLogicalToXSD(), removeEmptyNormalize(), removeEmptySet(), removeEmptyXSDToLogical()
property seriesColors as %ZEN.Datatype.csv [ InitialExpression = "blue,red,green,yellow,orange,plum,purple" ];
Comma-delimited list of CSS color values used for data series. The colors can be acquired dynamically by using the form "!fieldname".
Property methods: seriesColorsDisplayToLogical(), seriesColorsGet(), seriesColorsIsValid(), seriesColorsLogicalToDisplay(), seriesColorsLogicalToOdbc(), seriesColorsNormalize(), seriesColorsSet()
property seriesCount as %ZEN.Datatype.string;
Number of data series to display on this chart.
If "", then this is computed automatically from the chart's data source.
Property methods: seriesCountDisplayToLogical(), seriesCountGet(), seriesCountIsValid(), seriesCountLogicalToDisplay(), seriesCountLogicalToOdbc(), seriesCountNormalize(), seriesCountSet()
property seriesGroup as %ZEN.Datatype.string;
Specifies the group the group that corresponds to the list of series for the chart.
Property methods: seriesGroupDisplayToLogical(), seriesGroupGet(), seriesGroupIsValid(), seriesGroupLogicalToDisplay(), seriesGroupLogicalToOdbc(), seriesGroupNormalize(), seriesGroupSet()
property seriesNames as %ZEN.Datatype.csv;
Comma-delimited list of names used to label each data series in the legend box. The series names can be acquired dynamically by beginning them with a "!". If seriesGroup is provided, only the first series name field is considered.
Property methods: seriesNamesDisplayToLogical(), seriesNamesGet(), seriesNamesIsValid(), seriesNamesLogicalToDisplay(), seriesNamesLogicalToOdbc(), seriesNamesNormalize(), seriesNamesSet()
property seriesSize as %ZEN.Datatype.string;
Number of items within each data series to display on this chart.
If "", then this is computed automatically from the chart's data source.
Property methods: seriesSizeDisplayToLogical(), seriesSizeGet(), seriesSizeIsValid(), seriesSizeLogicalToDisplay(), seriesSizeLogicalToOdbc(), seriesSizeNormalize(), seriesSizeSet()
property title as %ZEN.Datatype.caption;
Title to display for chart.
Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property titleStyle as %ZEN.Datatype.style;
Optional: style used for title text.
Property methods: titleStyleDisplayToLogical(), titleStyleGet(), titleStyleIsValid(), titleStyleLogicalToDisplay(), titleStyleLogicalToOdbc(), titleStyleNormalize(), titleStyleSet()
property titleX as %ZEN.Datatype.float [ InitialExpression = 50 ];
If this chart has a title, x-position (within the chart coordinate space) of the title.
Property methods: titleXDisplayToLogical(), titleXGet(), titleXIsValid(), titleXLogicalToDisplay(), titleXLogicalToOdbc(), titleXNormalize(), titleXSet()
property titleY as %ZEN.Datatype.float [ InitialExpression = 5 ];
If this chart has a legend, y-position (within the chart coordinate space) of the title.
Property methods: titleYDisplayToLogical(), titleYGet(), titleYIsValid(), titleYLogicalToDisplay(), titleYLogicalToOdbc(), titleYNormalize(), titleYSet()
property xAxis as %ZEN.Report.Display.Chart.axis (XMLPROJECTION = "none");
Internal property that references this charts xaxis object.
Property methods: xAxisGet(), xAxisGetSwizzled(), xAxisIsValid(), xAxisNewObject(), xAxisSet()
property yAxis as %ZEN.Report.Display.Chart.axis (XMLPROJECTION = "none");
Internal property that references this charts yaxis object.
Property methods: yAxisGet(), yAxisGetSwizzled(), yAxisIsValid(), yAxisNewObject(), yAxisSet()

Methods

method %DrawToHTML(ByRef context As %Library.String, XSL As %Library.GlobalCharacterStream, delay As %Library.GlobalCharacterStream, ByRef incell As %Library.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 %Library.String, XSL As %Library.GlobalCharacterStream, delay As %Library.GlobalCharacterStream, ByRef incell As %Library.Boolean) as %Status
Inherited description: This method outputs the necessary stylesheet information for the PDF report. Every tag should override this method.
classmethod OnSVGAttribution(ByRef context As %String)
method SvgPrefix()
method calcLegendArea(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream)
Calc Legend Area
method getColorCount() as %Integer
Return the number of colors provided.
method getSeriesColor(series As %Integer) as %String
Return the CSS color that should be used for the given series.
method getXAxis() as %ZEN.Report.Display.Chart.xaxis
Return the x-axis definition for this chart.
method getXAxisType()
Return the type of x axis (category or value) used by this chart.
method getYAxis() as %ZEN.Report.Display.Chart.yaxis
Return the y-axis definition for this chart.
method getYAxisType()
Return the type of y axis (category or value) used by this chart.
method hasAxes()
Indicates that this chart has axes and associated grids A subclass may override this to turn off axis display.
method render(ByRef context As %String, XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream, labelValues As %String)
method renderAxes(context As %String, XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream)
Draw the x and y axes and grid lines.
method renderBands(context As %String, XSL As %GlobalCharacterStream)
Draw the upper/lower bands for the chart.
method renderLegend(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, labelValues As %String)
Draw the legend for the chart.
method renderPlotArea(context As %String, XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream)
Draw the plot area of the chart.
method renderSeries(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream)
Draw data series for this chart. This is implemented by subclasses. group is the SVG container for the chart components.
method renderSeriesGroup(ByRef context As %String, XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream) as %Status
Draw the data series for this chart. This method renders the container for the data series and then invokes a sub-class specific renderSeries() method.
method renderSeriesGroupLabels(ByRef context As %String, XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream) as %Status
Draw the data labels for this chart. This method renders the container for the data series and then invokes a sub-class specific renderSeries() method.
method renderSeriesLabels(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream)
Draw data label series for this chart. This is implemented by subclasses. group is the SVG container for the chart components.
method renderTitle(ByRef context As %String, ByRef XSL As %GlobalCharacterStream) as %Status
Draw the title for the chart.
method renderXLabels(context As %String, XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream)
Draw the labels for the x axis.
method renderYLabels(context As %String, XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream)
Draw the labels for the y axis.
method useSumForRange()
This method returns true if data series should be summed when calculating data range for the chart. Typically a chart will return true if it is in "stacked" mode.
method writeLoadParams(ByRef XSL As %GlobalCharacterStream)
method writeLoadParamsNoBase(ByRef XSL As %GlobalCharacterStream)
method writeWithParams(ByRef XSL As %GlobalCharacterStream)
method writeWithParamsNoBase(ByRef XSL As %GlobalCharacterStream)

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

FeedbackOpens in a new tab