Home > Class Reference > %SYS namespace > %ZEN.SVGComponent.chart

%ZEN.SVGComponent.chart

abstract class %ZEN.SVGComponent.chart extends %ZEN.SVGComponent.svgComponent, %ZEN.Component.dataView

This is the abstract base class from which all SVG chart components are derived.
A chart provides a base on which to display a specific type of chart (such as a barChart, lineChart, or pieChart).
This base class defines the data, grid (axes and scales), styles, and legend used by charts.
All charts are plotted onto a virtual coordinate space that measures 100 units by 100 units.
You can adjust the visual aspects of a chart by setting the various properties of this class (plus any additional properties added by the specific chart subclass).
You can adjust the x and y axis settings (such as scaling and range) via the xAxis and yAxis properties (which are objects of the type %ZEN.Auxiliary.axis).

Property Inventory

Method Inventory

Parameters

parameter DEFAULTAPPEARANCE = 2D;
Default appearance of this component.
parameter DEFAULTASPECT = none;
Do not worry about preserving the aspect ratio.
parameter DEFAULTAUTOSCALETEXT = 1;
Default setting for autoscaling text as chart resizes
parameter DEFAULTMARKERSVISIBLE = 0;
Default value for the markersVisible property.
parameter DEFAULTPLOTTOEDGE = 1;
Parameter SYSMODULE = "chart"; Default value for the plotToEdge property.
parameter DEFAULTVALUELABELSVISIBLE = 0;
Default value for the valueLabelsVisible property.
parameter DEFAULTVIEWBOXHEIGHT;
Default viewBoxHeight of this component. This is set to 100 to provide a fixed coordinate system for meters.
parameter DEFAULTVIEWBOXWIDTH;
Default viewBoxWidth of this component. This is set to 100 to provide a fixed coordinate system for meters.

Properties

property appearance as %ZEN.Datatype.string (VALUELIST = ",2D,3D") [ InitialExpression = ..#DEFAULTAPPEARANCE ];
Controls the appearance of this chart.
Set this to "2D" (the default) for a standard chart appearance.
Setting this to "3D" will give the chart a 3-D appearance; the plot area will appear to be recessed. Certain chart types, such as bar charts, will display items with a 3-D look.
For pie charts, setting this to "3D" will display a pie chart with a 3-D appearance, but will not affect the plot area.
Property methods: appearanceDisplayToLogical(), appearanceGet(), appearanceIsValid(), appearanceLogicalToDisplay(), appearanceLogicalToOdbc(), appearanceNormalize(), appearanceSet()
property autoScaleText as %ZEN.Datatype.boolean [ InitialExpression = ..#DEFAULTAUTOSCALETEXT ];
Specifies how the text elements of a chart should be handled when a chart is resized. If True, the text scales in proportion to the chart itself and all requested labels are rendered regardless of legibility. If false, the size of the text elements is fixed with respect to the page and some lables may be omitted to avoid visual overlap if insufficient space is provided to render the values should the chart be scaled down beyond certain thresholds
Property methods: autoScaleTextDisplayToLogical(), autoScaleTextGet(), autoScaleTextIsValid(), autoScaleTextLogicalToDisplay(), autoScaleTextLogicalToOdbc(), autoScaleTextLogicalToXSD(), autoScaleTextNormalize(), autoScaleTextSet(), autoScaleTextXSDToLogical()
property axisLineStyle as %ZEN.Datatype.svgStyle;
Optional: style applied to line drawn for x and y axes.
Property methods: axisLineStyleDisplayToLogical(), axisLineStyleGet(), axisLineStyleIsValid(), axisLineStyleLogicalToDisplay(), axisLineStyleLogicalToOdbc(), axisLineStyleNormalize(), axisLineStyleSet()
property axisTitleStyle as %ZEN.Datatype.svgStyle [ InitialExpression = "opacity:0.5;" ];
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.svgStyle;
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(), bandLowerStyleDisplayToLogical(), bandLowerStyleGet(), bandLowerStyleIsValid(), bandLowerStyleLogicalToDisplay(), bandLowerStyleLogicalToOdbc(), bandLowerStyleNormalize(), bandLowerStyleSet()
property bandLowerStyle as %ZEN.Datatype.svgStyle;
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(), bandUpperStyleDisplayToLogical(), bandUpperStyleGet(), bandUpperStyleIsValid(), bandUpperStyleLogicalToDisplay(), bandUpperStyleLogicalToOdbc(), bandUpperStyleNormalize(), bandUpperStyleSet()
property bandUpperStyle as %ZEN.Datatype.svgStyle;
Optional: style used for upper band on plot area.
Property methods: bandUpperStyleDisplayToLogical(), bandUpperStyleGet(), bandUpperStyleIsValid(), bandUpperStyleLogicalToDisplay(), bandUpperStyleLogicalToOdbc(), bandUpperStyleNormalize(), bandUpperStyleSet()
property baseLineStyle as %ZEN.Datatype.svgStyle;
Optional: style applied to base line.
Property methods: baseLineStyleDisplayToLogical(), baseLineStyleGet(), baseLineStyleIsValid(), baseLineStyleLogicalToDisplay(), baseLineStyleLogicalToOdbc(), baseLineStyleNormalize(), baseLineStyleSet()
property borderOffset as %ZEN.Datatype.integer [ InitialExpression = 8 ];
Optional: distance (in pixels) between the background rectangle and the border.
Property methods: borderOffsetDisplayToLogical(), borderOffsetGet(), borderOffsetIsValid(), borderOffsetLogicalToDisplay(), borderOffsetLogicalToOdbc(), borderOffsetNormalize(), borderOffsetSet()
property borderRadius as %ZEN.Datatype.integer [ InitialExpression = 0 ];
Optional: radius applied to the chart's background rectangle and border.
Property methods: borderRadiusDisplayToLogical(), borderRadiusGet(), borderRadiusIsValid(), borderRadiusLogicalToDisplay(), borderRadiusLogicalToOdbc(), borderRadiusNormalize(), borderRadiusSet()
property borderStyle as %ZEN.Datatype.svgStyle;
Optional: style used for border line inset from outer edge of chart.
Property methods: borderStyleDisplayToLogical(), borderStyleGet(), borderStyleIsValid(), borderStyleLogicalToDisplay(), borderStyleLogicalToOdbc(), borderStyleNormalize(), borderStyleSet()
property currYAxis as %ZEN.Datatype.integer (MINVAL = 0) [ InitialExpression = 0 ];
Specifies which yAxis definition is used to drive the chart yaxis (0 based).
Property methods: currYAxisDisplayToLogical(), currYAxisGet(), currYAxisIsValid(), currYAxisLogicalToDisplay(), currYAxisLogicalToOdbc(), currYAxisNormalize(), currYAxisSet()
property endTime as %ZEN.Datatype.string;
Latest displayed time (as YYYY-MM-DD HH:MM:SS). This is used for the x axis in a timeBased chart.
Property methods: endTimeDisplayToLogical(), endTimeGet(), endTimeIsValid(), endTimeLogicalToDisplay(), endTimeLogicalToOdbc(), endTimeNormalize(), endTimeSet()
property gridStyle as %ZEN.Datatype.svgStyle;
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 hasZoom as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Optional: if true, display zoom in/out buttons (for certain chart types).
Property methods: hasZoomDisplayToLogical(), hasZoomGet(), hasZoomIsValid(), hasZoomLogicalToDisplay(), hasZoomLogicalToOdbc(), hasZoomLogicalToXSD(), hasZoomNormalize(), hasZoomSet(), hasZoomXSDToLogical()
property indicatorStyle as %ZEN.Datatype.svgStyle;
Optional: style used for indicators.
Property methods: indicatorStyleDisplayToLogical(), indicatorStyleGet(), indicatorStyleIsValid(), indicatorStyleLogicalToDisplay(), indicatorStyleLogicalToOdbc(), indicatorStyleNormalize(), indicatorStyleSet()
property indicatorsVisible as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Specifies whether indicator lines should be displayed for the selected item within the chart.
This only applies to charts that display indicator lines.
Property methods: indicatorsVisibleDisplayToLogical(), indicatorsVisibleGet(), indicatorsVisibleIsValid(), indicatorsVisibleLogicalToDisplay(), indicatorsVisibleLogicalToOdbc(), indicatorsVisibleLogicalToXSD(), indicatorsVisibleNormalize(), indicatorsVisibleSet(), indicatorsVisibleXSDToLogical()
property labelStyle as %ZEN.Datatype.svgStyle;
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 legendHeight as %ZEN.Datatype.length;
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.svgStyle;
Optional: style used for text within the legend box.
Property methods: legendLabelStyleDisplayToLogical(), legendLabelStyleGet(), legendLabelStyleIsValid(), legendLabelStyleLogicalToDisplay(), legendLabelStyleLogicalToOdbc(), legendLabelStyleNormalize(), legendLabelStyleSet()
property legendRectStyle as %ZEN.Datatype.svgStyle;
Optional: style used for rectangle indicating the current legend within the legend box.
Property methods: legendRectStyleDisplayToLogical(), legendRectStyleGet(), legendRectStyleIsValid(), legendRectStyleLogicalToDisplay(), legendRectStyleLogicalToOdbc(), legendRectStyleNormalize(), legendRectStyleSet()
property legendStyle as %ZEN.Datatype.svgStyle;
Optional: style used for background of the legend box.
Property methods: legendStyleDisplayToLogical(), legendStyleGet(), legendStyleIsValid(), legendStyleLogicalToDisplay(), legendStyleLogicalToOdbc(), legendStyleNormalize(), legendStyleSet()
property legendTitle as %ZEN.Datatype.caption;
Title to display for legend box.
Property methods: legendTitleDisplayToLogical(), legendTitleGet(), legendTitleIsValid(), legendTitleLogicalToDisplay(), legendTitleLogicalToOdbc(), legendTitleNormalize(), legendTitleSet()
property legendVisible as %ZEN.Datatype.string (VALUELIST = ",auto,false,true") [ InitialExpression = "auto" ];
If true, display a legend for this chart. If "auto" then the legend is displayed if there is more than one data series for the chart.
Property methods: legendVisibleDisplayToLogical(), legendVisibleGet(), legendVisibleIsValid(), legendVisibleLogicalToDisplay(), legendVisibleLogicalToOdbc(), legendVisibleNormalize(), legendVisibleSet()
property legendWidth as %ZEN.Datatype.length;
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.length;
If this chart has a legend, x-position (within the chart coordinate space) of legend box. If not specified a default position will be used.
Property methods: legendXDisplayToLogical(), legendXGet(), legendXIsValid(), legendXLogicalToDisplay(), legendXLogicalToOdbc(), legendXNormalize(), legendXSet()
property legendY as %ZEN.Datatype.length;
If this chart has a legend, y-position (within the chart coordinate space) of legend box. If not specified a default position will be used.
Property methods: legendYDisplayToLogical(), legendYGet(), legendYIsValid(), legendYLogicalToDisplay(), legendYLogicalToOdbc(), legendYNormalize(), legendYSet()
property lineStyle as %ZEN.Datatype.svgStyle;
Optional: default style applied to svg line elements within line-style charts.
Property methods: lineStyleDisplayToLogical(), lineStyleGet(), lineStyleIsValid(), lineStyleLogicalToDisplay(), lineStyleLogicalToOdbc(), lineStyleNormalize(), lineStyleSet()
property marginBottom as %ZEN.Datatype.length;
Margin (within the chart coordinate space) from bottom edge of chart to bottom edge of grid (plot area). If not specified, then this value will be automatically calculated.
Property methods: marginBottomDisplayToLogical(), marginBottomGet(), marginBottomIsValid(), marginBottomLogicalToDisplay(), marginBottomLogicalToOdbc(), marginBottomNormalize(), marginBottomSet()
property marginLeft as %ZEN.Datatype.length;
Margin (within the chart coordinate space) from left edge of chart to left edge of grid (plot area). If not specified, then this width will be automatically calculated.
Property methods: marginLeftDisplayToLogical(), marginLeftGet(), marginLeftIsValid(), marginLeftLogicalToDisplay(), marginLeftLogicalToOdbc(), marginLeftNormalize(), marginLeftSet()
property marginRight as %ZEN.Datatype.length;
Margin (within the chart coordinate space) from right edge of chart to right edge of grid (plot area). If not specified, then this width will be automatically calculated.
Property methods: marginRightDisplayToLogical(), marginRightGet(), marginRightIsValid(), marginRightLogicalToDisplay(), marginRightLogicalToOdbc(), marginRightNormalize(), marginRightSet()
property marginTop as %ZEN.Datatype.length;
Margin (within the chart coordinate space) from top edge of chart to top edge of grid (plot area). If not specified, then this value will be automatically calculated.
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.svgStyle;
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 chart.
This only applies to charts that display markers.
Property methods: markersVisibleDisplayToLogical(), markersVisibleGet(), markersVisibleIsValid(), markersVisibleLogicalToDisplay(), markersVisibleLogicalToOdbc(), markersVisibleLogicalToXSD(), markersVisibleNormalize(), markersVisibleSet(), markersVisibleXSDToLogical()
property maxLabelLen as %ZEN.Datatype.integer [ InitialExpression = 20 ];
Maximum number of characters to display for an axis label.
Property methods: maxLabelLenDisplayToLogical(), maxLabelLenGet(), maxLabelLenIsValid(), maxLabelLenLogicalToDisplay(), maxLabelLenLogicalToOdbc(), maxLabelLenNormalize(), maxLabelLenSet()
property msgIfNoData as %ZEN.Datatype.caption [ InitialExpression = "No Data" ];
localized warning message if chart has no data
Property methods: msgIfNoDataDisplayToLogical(), msgIfNoDataGet(), msgIfNoDataIsValid(), msgIfNoDataLogicalToDisplay(), msgIfNoDataLogicalToOdbc(), msgIfNoDataNormalize(), msgIfNoDataSet()
property multipleTitleStyle as %ZEN.Datatype.svgStyle;
Optional: style used for title text within each "multiple" charts. Used when showMultiples is enabled.
Property methods: multipleTitleStyleDisplayToLogical(), multipleTitleStyleGet(), multipleTitleStyleIsValid(), multipleTitleStyleLogicalToDisplay(), multipleTitleStyleLogicalToOdbc(), multipleTitleStyleNormalize(), multipleTitleStyleSet()
property noDataFill as %ZEN.Datatype.color [ InitialExpression = "red" ];
color of background rectangle for no data message
Property methods: noDataFillDisplayToLogical(), noDataFillGet(), noDataFillIsValid(), noDataFillLogicalToDisplay(), noDataFillLogicalToOdbc(), noDataFillNormalize(), noDataFillSet()
property noDataOpacity as %ZEN.Datatype.float [ InitialExpression = "1.0" ];
opacity of background rectangle for no data message
Property methods: noDataOpacityDisplayToLogical(), noDataOpacityGet(), noDataOpacityIsValid(), noDataOpacityLogicalToDisplay(), noDataOpacityLogicalToOdbc(), noDataOpacityNormalize(), noDataOpacitySet()
property noDataStroke as %ZEN.Datatype.color [ InitialExpression = "white" ];
color of no data message
Property methods: noDataStrokeDisplayToLogical(), noDataStrokeGet(), noDataStrokeIsValid(), noDataStrokeLogicalToDisplay(), noDataStrokeLogicalToOdbc(), noDataStrokeNormalize(), noDataStrokeSet()
property onelementClick as %ZEN.Datatype.eventHandler;
onelementClick event handler: This event handler is called by the chart when the user clicks the mouse on a chart element (such as a line chart marker, or bar in a bar chart).
The event handler is passed an argument, chart, that is this chart object. You can then use the getSelectedItem() method to determine the current selected element.
Property methods: onelementClickDisplayToLogical(), onelementClickGet(), onelementClickIsValid(), onelementClickLogicalToDisplay(), onelementClickLogicalToOdbc(), onelementClickNormalize(), onelementClickSet()
property ongetData as %ZEN.Datatype.eventHandler;
ongetData event handler: This event handler, if defined, is called by the chart to get an array of values to plot for a data series. This provides an alternate way to provide display data for a chart.
The event handler is passed an argument, series, that contains the ordinal number (0-based) of the data series. This event handler should return an array of numeric values for the specified data series.
Property methods: ongetDataDisplayToLogical(), ongetDataGet(), ongetDataIsValid(), ongetDataLogicalToDisplay(), ongetDataLogicalToOdbc(), ongetDataNormalize(), ongetDataSet()
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.
The event handler is passed an argument, value, that contains the ordinal number (0-based) of the label.
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.
The event handler is passed an argument, value, that contains the ordinal number (0-based) of the label.
Property methods: ongetLabelYDisplayToLogical(), ongetLabelYGet(), ongetLabelYIsValid(), ongetLabelYLogicalToDisplay(), ongetLabelYLogicalToOdbc(), ongetLabelYNormalize(), ongetLabelYSet()
property ongetSeriesColor as %ZEN.Datatype.eventHandler;
ongetSeriesColor event handler: This event handler, if defined, is called by the chart to get the color for a given data series.
The event handler is passed an argument, series, that contains the ordinal number (0-based) of the series.
Property methods: ongetSeriesColorDisplayToLogical(), ongetSeriesColorGet(), ongetSeriesColorIsValid(), ongetSeriesColorLogicalToDisplay(), ongetSeriesColorLogicalToOdbc(), ongetSeriesColorNormalize(), ongetSeriesColorSet()
property ongetTimeEvents as %ZEN.Datatype.eventHandler;
ongetTimeEvents event handler: This event handler, if defined, is called by the chart to get an array of "time events" to display for a time chart.
Property methods: ongetTimeEventsDisplayToLogical(), ongetTimeEventsGet(), ongetTimeEventsIsValid(), ongetTimeEventsLogicalToDisplay(), ongetTimeEventsLogicalToOdbc(), ongetTimeEventsNormalize(), ongetTimeEventsSet()
property onrenderData as %ZEN.Datatype.eventHandler;
onrenderData event handler: This event handler, if defined, is called by the chart just after it is finished displaying grid lines and data. The event handler is passed an argument, chart, that is this chart object. If it also passed group, which is the SVG group to which any new svg content should be added.
Property methods: onrenderDataDisplayToLogical(), onrenderDataGet(), onrenderDataIsValid(), onrenderDataLogicalToDisplay(), onrenderDataLogicalToOdbc(), onrenderDataNormalize(), onrenderDataSet()
property onrenderPlotArea as %ZEN.Datatype.eventHandler;
onrenderPlotArea event handler: This event handler, if defined, is called by the chart just after it displays its underlying plot area (and bands) but before it display grid lines and data.
Property methods: onrenderPlotAreaDisplayToLogical(), onrenderPlotAreaGet(), onrenderPlotAreaIsValid(), onrenderPlotAreaLogicalToDisplay(), onrenderPlotAreaLogicalToOdbc(), onrenderPlotAreaNormalize(), onrenderPlotAreaSet()
property onshowTooltip as %ZEN.Datatype.eventHandler;
onshowTooltip event handler: This event handler, if defined, is called by the chart just before it displays a tool tip.
Property methods: onshowTooltipDisplayToLogical(), onshowTooltipGet(), onshowTooltipIsValid(), onshowTooltipLogicalToDisplay(), onshowTooltipLogicalToOdbc(), onshowTooltipNormalize(), onshowTooltipSet()
property plotAreaStyle as %ZEN.Datatype.svgStyle;
Optional: style used for chart plot area panel.
Property methods: plotAreaStyleDisplayToLogical(), plotAreaStyleGet(), plotAreaStyleIsValid(), plotAreaStyleLogicalToDisplay(), plotAreaStyleLogicalToOdbc(), plotAreaStyleNormalize(), plotAreaStyleSet()
property plotEdgeStyle as %ZEN.Datatype.svgStyle;
Optional: for charts with a 3D look, this style is applied to the edges on the left and bottom.
Property methods: plotEdgeStyleDisplayToLogical(), plotEdgeStyleGet(), plotEdgeStyleIsValid(), plotEdgeStyleLogicalToDisplay(), plotEdgeStyleLogicalToOdbc(), plotEdgeStyleNormalize(), plotEdgeStyleSet()
property plotStyle as %ZEN.Datatype.svgStyle;
Optional: default style applied to svg elements used for plotting data by this chart (such as the bars within a bar chart). Note: lines within line charts use the lineStyle property.
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 scrollButtonStyle as %ZEN.Datatype.svgStyle;
Optional: style applied to zoom and scroll buttons when visible.
Property methods: scrollButtonStyleDisplayToLogical(), scrollButtonStyleGet(), scrollButtonStyleIsValid(), scrollButtonStyleLogicalToDisplay(), scrollButtonStyleLogicalToOdbc(), scrollButtonStyleNormalize(), scrollButtonStyleSet()
property selectedItem as %ZEN.Datatype.integer [ InitialExpression = -1 ];
Item number (0-based) of currently selected chart element, if any.
Property methods: selectedItemDisplayToLogical(), selectedItemGet(), selectedItemIsValid(), selectedItemLogicalToDisplay(), selectedItemLogicalToOdbc(), selectedItemNormalize(), selectedItemSet(), selectedItemStyleDisplayToLogical(), selectedItemStyleGet(), selectedItemStyleIsValid(), selectedItemStyleLogicalToDisplay(), selectedItemStyleLogicalToOdbc(), selectedItemStyleNormalize(), selectedItemStyleSet()
property selectedItemStyle as %ZEN.Datatype.svgStyle [ InitialExpression = "stroke:darkgreen;stroke-width:3px;" ];
Optional: style used to indicate the current selected chart element.
Property methods: selectedItemStyleDisplayToLogical(), selectedItemStyleGet(), selectedItemStyleIsValid(), selectedItemStyleLogicalToDisplay(), selectedItemStyleLogicalToOdbc(), selectedItemStyleNormalize(), selectedItemStyleSet()
property selectedSeries as %ZEN.Datatype.integer [ InitialExpression = -1 ];
Series number (0-based) of currently selected chart element, if any.
Property methods: selectedSeriesDisplayToLogical(), selectedSeriesGet(), selectedSeriesIsValid(), selectedSeriesLogicalToDisplay(), selectedSeriesLogicalToOdbc(), selectedSeriesNormalize(), selectedSeriesSet()
property seriesColorScheme as %ZEN.Datatype.string (VALUELIST = ",urban,tuscan,caribbean,rustbelt,bright,glow,gray,pastel,solid") [ InitialExpression = "tuscan" ];
This is the name of a built-in color scheme used to plot data series for the chart.
If seriesColors is defined, then this property is ignored.
Property methods: seriesColorSchemeDisplayToLogical(), seriesColorSchemeGet(), seriesColorSchemeIsValid(), seriesColorSchemeLogicalToDisplay(), seriesColorSchemeLogicalToOdbc(), seriesColorSchemeNormalize(), seriesColorSchemeSet()
property seriesColors as %ZEN.Datatype.csv;
Comma-delimited list of CSS color values used for data series. This can be set to a list of SVG fill color values, e.g., "red,green,blue" or "url(#glow-red),url(#glow-green),url(#glow-blue)".
The first color is used by the first data series and so on. If there are more data series than colors, the colors are repeated.
If this is not defined the colors defined by seriesColorScheme are used.
Property methods: seriesColorsDisplayToLogical(), seriesColorsGet(), seriesColorsIsValid(), seriesColorsLogicalToDisplay(), seriesColorsLogicalToOdbc(), seriesColorsNormalize(), seriesColorsOverrideDisplayToLogical(), seriesColorsOverrideGet(), seriesColorsOverrideIsValid(), seriesColorsOverrideLogicalToDisplay(), seriesColorsOverrideLogicalToOdbc(), seriesColorsOverrideNormalize(), seriesColorsOverrideSet(), seriesColorsSet()
property seriesColorsOverride as %ZEN.Datatype.csv;
Additional Comma-delimited list of CSS color values used for data series. If supplied, this is merged with the colors in the seriesColors list. This makes it possible to override specific colors within a chart while preserving the underlying default colors.
Property methods: seriesColorsOverrideDisplayToLogical(), seriesColorsOverrideGet(), seriesColorsOverrideIsValid(), seriesColorsOverrideLogicalToDisplay(), seriesColorsOverrideLogicalToOdbc(), seriesColorsOverrideNormalize(), seriesColorsOverrideSet()
property seriesCount as %ZEN.Datatype.integer (MINVAL = 0);
Number of data series to display on this chart. If "", then this is computed automatically from the chart's data source when the chart is connected to a dataController.
Property methods: seriesCountDisplayToLogical(), seriesCountGet(), seriesCountIsValid(), seriesCountLogicalToDisplay(), seriesCountLogicalToOdbc(), seriesCountNormalize(), seriesCountSet()
property seriesNames as %ZEN.Datatype.csv (ZENLOCALIZE = 1);
Comma-delimited list of names used to label each data series in the legend box.
This is a localized value (the entire list is treated as one localized string).
Property methods: seriesNamesDisplayToLogical(), seriesNamesGet(), seriesNamesIsValid(), seriesNamesLogicalToDisplay(), seriesNamesLogicalToOdbc(), seriesNamesNormalize(), seriesNamesSet()
property seriesNumber as %ZEN.Datatype.integer (MINVAL = 0);
Optional. If defined then the chart will only plot the specified data series (0-based) when connected to a data controller. This is used by DeepSee in some cases.
Property methods: seriesNumberDisplayToLogical(), seriesNumberGet(), seriesNumberIsValid(), seriesNumberLogicalToDisplay(), seriesNumberLogicalToOdbc(), seriesNumberNormalize(), seriesNumberSet()
property seriesSize as %ZEN.Datatype.integer (MINVAL = 0);
Number of items within each data series to display on this chart. If "", then this is computed automatically from the chart's data source when the chart is connected to a dataController.
Property methods: seriesSizeDisplayToLogical(), seriesSizeGet(), seriesSizeIsValid(), seriesSizeLogicalToDisplay(), seriesSizeLogicalToOdbc(), seriesSizeNormalize(), seriesSizeSet()
property seriesYAxes as %ZEN.Datatype.csv;
Optional. If defined, specifies which y-axis should be used for each data series. This is a csv-list of y-axis numbers (0-based). By default, the every data series uses y-axis 0.
Property methods: seriesYAxesDisplayToLogical(), seriesYAxesGet(), seriesYAxesIsValid(), seriesYAxesLogicalToDisplay(), seriesYAxesLogicalToOdbc(), seriesYAxesNormalize(), seriesYAxesSet()
property showMultiples as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Optional: If true, display chart as number of small multiple charts, one per data series. This is only used by charts that support small multiples otherwise it is ignored.
Property methods: showMultiplesDisplayToLogical(), showMultiplesGet(), showMultiplesIsValid(), showMultiplesLogicalToDisplay(), showMultiplesLogicalToOdbc(), showMultiplesLogicalToXSD(), showMultiplesNormalize(), showMultiplesSet(), showMultiplesXSDToLogical()
property startTime as %ZEN.Datatype.string;
Earliest displayed time (as YYYY-MM-DD HH:MM:SS). This is used for the x axis in a timeBased chart.
Property methods: startTimeDisplayToLogical(), startTimeGet(), startTimeIsValid(), startTimeLogicalToDisplay(), startTimeLogicalToOdbc(), startTimeNormalize(), startTimeSet()
property stripeStyle as %ZEN.Datatype.svgStyle;
Optional: style used for grid stripes (when enabled).
Property methods: stripeStyleDisplayToLogical(), stripeStyleGet(), stripeStyleIsValid(), stripeStyleLogicalToDisplay(), stripeStyleLogicalToOdbc(), stripeStyleNormalize(), stripeStyleSet()
property stripesVisible as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Optional: if true, draw stripes over value axis grid lines.
Property methods: stripesVisibleDisplayToLogical(), stripesVisibleGet(), stripesVisibleIsValid(), stripesVisibleLogicalToDisplay(), stripesVisibleLogicalToOdbc(), stripesVisibleLogicalToXSD(), stripesVisibleNormalize(), stripesVisibleSet(), stripesVisibleXSDToLogical()
property subtitle as %ZEN.Datatype.caption;
Subtitle to display for chart.
Property methods: subtitleDisplayToLogical(), subtitleGet(), subtitleIsValid(), subtitleLogicalToDisplay(), subtitleLogicalToOdbc(), subtitleNormalize(), subtitleSet(), subtitleStyleDisplayToLogical(), subtitleStyleGet(), subtitleStyleIsValid(), subtitleStyleLogicalToDisplay(), subtitleStyleLogicalToOdbc(), subtitleStyleNormalize(), subtitleStyleSet()
property subtitleStyle as %ZEN.Datatype.svgStyle;
Optional: style used for subtitle text.
Property methods: subtitleStyleDisplayToLogical(), subtitleStyleGet(), subtitleStyleIsValid(), subtitleStyleLogicalToDisplay(), subtitleStyleLogicalToOdbc(), subtitleStyleNormalize(), subtitleStyleSet()
property textSize as %ZEN.Datatype.string (VALUELIST = ",small,medium,large") [ InitialExpression = "medium" ];
Optional: if "medium", use the default font sizes specified by the CSS for the chart. if "small" or "large" adjust the size of any text in the chart that does not have an explicit style set (via a property).
Property methods: textSizeDisplayToLogical(), textSizeGet(), textSizeIsValid(), textSizeLogicalToDisplay(), textSizeLogicalToOdbc(), textSizeNormalize(), textSizeSet()
property timeBased as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Optional: If true, then the x-axis for this chart is a time line displaying date values from startTime to endTime. In this case, the series names for data are interpreted as time values (YYYY-MM-DD HH:MM:SS). This setting only works in a few cases, namely non-pivotted line charts. For all other cases this setting is ignored.
Property methods: timeBasedDisplayToLogical(), timeBasedGet(), timeBasedIsValid(), timeBasedLogicalToDisplay(), timeBasedLogicalToOdbc(), timeBasedLogicalToXSD(), timeBasedNormalize(), timeBasedSet(), timeBasedXSDToLogical()
property title as %ZEN.Datatype.caption;
Title to display for chart.
Property methods: titleAlignDisplayToLogical(), titleAlignGet(), titleAlignIsValid(), titleAlignLogicalToDisplay(), titleAlignLogicalToOdbc(), titleAlignNormalize(), titleAlignSet(), titleBoxStyleDisplayToLogical(), titleBoxStyleGet(), titleBoxStyleIsValid(), titleBoxStyleLogicalToDisplay(), titleBoxStyleLogicalToOdbc(), titleBoxStyleNormalize(), titleBoxStyleSet(), titleDisplayToLogical(), titleGet(), titleImageDisplayToLogical(), titleImageGet(), titleImageIsValid(), titleImageLogicalToDisplay(), titleImageLogicalToOdbc(), titleImageNormalize(), titleImageSet(), titleImageStyleDisplayToLogical(), titleImageStyleGet(), titleImageStyleIsValid(), titleImageStyleLogicalToDisplay(), titleImageStyleLogicalToOdbc(), titleImageStyleNormalize(), titleImageStyleSet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet(), titleStyleDisplayToLogical(), titleStyleGet(), titleStyleIsValid(), titleStyleLogicalToDisplay(), titleStyleLogicalToOdbc(), titleStyleNormalize(), titleStyleSet(), titleXDisplayToLogical(), titleXGet(), titleXIsValid(), titleXLogicalToDisplay(), titleXLogicalToOdbc(), titleXNormalize(), titleXSet(), titleYDisplayToLogical(), titleYGet(), titleYIsValid(), titleYLogicalToDisplay(), titleYLogicalToOdbc(), titleYNormalize(), titleYSet()
property titleAlign as %ZEN.Datatype.string (VALUELIST = ",center,left,right") [ InitialExpression = "center" ];
Optional: alignment for title and subtitle.
Property methods: titleAlignDisplayToLogical(), titleAlignGet(), titleAlignIsValid(), titleAlignLogicalToDisplay(), titleAlignLogicalToOdbc(), titleAlignNormalize(), titleAlignSet()
property titleBoxStyle as %ZEN.Datatype.svgStyle;
Optional: style used for box underneath title text.
Property methods: titleBoxStyleDisplayToLogical(), titleBoxStyleGet(), titleBoxStyleIsValid(), titleBoxStyleLogicalToDisplay(), titleBoxStyleLogicalToOdbc(), titleBoxStyleNormalize(), titleBoxStyleSet()
property titleImage as %ZEN.Datatype.uri;
Optional: URL of image to display within the title area.
Property methods: titleImageDisplayToLogical(), titleImageGet(), titleImageIsValid(), titleImageLogicalToDisplay(), titleImageLogicalToOdbc(), titleImageNormalize(), titleImageSet(), titleImageStyleDisplayToLogical(), titleImageStyleGet(), titleImageStyleIsValid(), titleImageStyleLogicalToDisplay(), titleImageStyleLogicalToOdbc(), titleImageStyleNormalize(), titleImageStyleSet()
property titleImageStyle as %ZEN.Datatype.svgStyle;
Optional. Style for titleImage: left,top,width, and height.
Property methods: titleImageStyleDisplayToLogical(), titleImageStyleGet(), titleImageStyleIsValid(), titleImageStyleLogicalToDisplay(), titleImageStyleLogicalToOdbc(), titleImageStyleNormalize(), titleImageStyleSet()
property titleStyle as %ZEN.Datatype.svgStyle;
Optional: style used for title text.
Property methods: titleStyleDisplayToLogical(), titleStyleGet(), titleStyleIsValid(), titleStyleLogicalToDisplay(), titleStyleLogicalToOdbc(), titleStyleNormalize(), titleStyleSet()
property titleX as %ZEN.Datatype.length;
If this chart has a title, x-position (within the chart coordinate space) of the title. If not specified, then a default value is calculated.
Property methods: titleXDisplayToLogical(), titleXGet(), titleXIsValid(), titleXLogicalToDisplay(), titleXLogicalToOdbc(), titleXNormalize(), titleXSet()
property titleY as %ZEN.Datatype.length;
If this chart has a title, y-position (within the chart coordinate space) of the title. If not specified, then a default value is calculated.
Property methods: titleYDisplayToLogical(), titleYGet(), titleYIsValid(), titleYLogicalToDisplay(), titleYLogicalToOdbc(), titleYNormalize(), titleYSet()
property tooltipRectStyle as %ZEN.Datatype.svgStyle;
if non-null used to set style for tool tip rectangle
Property methods: tooltipRectStyleDisplayToLogical(), tooltipRectStyleGet(), tooltipRectStyleIsValid(), tooltipRectStyleLogicalToDisplay(), tooltipRectStyleLogicalToOdbc(), tooltipRectStyleNormalize(), tooltipRectStyleSet()
property unselectedItemStyle as %ZEN.Datatype.svgStyle [ InitialExpression = "opacity:0.5;" ];
Optional: style used to indicate unselected chart elements. This is used when there is a selected element.
Property methods: unselectedItemStyleDisplayToLogical(), unselectedItemStyleGet(), unselectedItemStyleIsValid(), unselectedItemStyleLogicalToDisplay(), unselectedItemStyleLogicalToOdbc(), unselectedItemStyleNormalize(), unselectedItemStyleSet()
property valueBoxStyle as %ZEN.Datatype.svgStyle;
Optional: style used for boxes around value labels. This only applies to charts that display element values (such as bar charts).
Property methods: valueBoxStyleDisplayToLogical(), valueBoxStyleGet(), valueBoxStyleIsValid(), valueBoxStyleLogicalToDisplay(), valueBoxStyleLogicalToOdbc(), valueBoxStyleNormalize(), valueBoxStyleSet()
property valueLabelFormat as %ZEN.Datatype.string;
Optional: numeric format applied to value labels. This only applies to charts that display element values (such as bar charts).
Property methods: valueLabelFormatDisplayToLogical(), valueLabelFormatGet(), valueLabelFormatIsValid(), valueLabelFormatLogicalToDisplay(), valueLabelFormatLogicalToOdbc(), valueLabelFormatNormalize(), valueLabelFormatSet()
property valueLabelStyle as %ZEN.Datatype.svgStyle;
Optional: style used for value labels. This only applies to charts that display element values (such as bar charts).
Property methods: valueLabelStyleDisplayToLogical(), valueLabelStyleGet(), valueLabelStyleIsValid(), valueLabelStyleLogicalToDisplay(), valueLabelStyleLogicalToOdbc(), valueLabelStyleNormalize(), valueLabelStyleSet()
property valueLabelsVisible as %ZEN.Datatype.boolean [ InitialExpression = ..#DEFAULTVALUELABELSVISIBLE ];
Specifies whether values should be displayed for elements within the chart. This only applies to charts that display element values (such as bar charts).
Property methods: valueLabelsVisibleDisplayToLogical(), valueLabelsVisibleGet(), valueLabelsVisibleIsValid(), valueLabelsVisibleLogicalToDisplay(), valueLabelsVisibleLogicalToOdbc(), valueLabelsVisibleLogicalToXSD(), valueLabelsVisibleNormalize(), valueLabelsVisibleSet(), valueLabelsVisibleXSDToLogical()
property warnIfNoData as %ZEN.Datatype.boolean;
Set to 1 to display a localized warning message if chart has no data
Property methods: warnIfNoDataDisplayToLogical(), warnIfNoDataGet(), warnIfNoDataIsValid(), warnIfNoDataLogicalToDisplay(), warnIfNoDataLogicalToOdbc(), warnIfNoDataLogicalToXSD(), warnIfNoDataNormalize(), warnIfNoDataSet(), warnIfNoDataXSDToLogical()
property xAxis as %ZEN.Auxiliary.axis (ZENSETTING = 0);
x axis specification for this chart.
Property methods: xAxisGet(), xAxisGetSwizzled(), xAxisIsValid(), xAxisNewObject(), xAxisSet()
property yAxis as %ZEN.Auxiliary.axis (XMLPROJECTION = "none", ZENSETTING = 0);
Deprecated. y axis specifications for this chart. This is replaced by yAxisList. This property is kept here so that applications that set yAxis directly will still function.
Property methods: yAxisGet(), yAxisGetSwizzled(), yAxisIsValid(), yAxisListBuildValueArray(), yAxisListCollectionToDisplay(), yAxisListCollectionToOdbc(), yAxisListDisplayToCollection(), yAxisListGet(), yAxisListGetObject(), yAxisListGetObjectId(), yAxisListGetSwizzled(), yAxisListIsValid(), yAxisListOdbcToCollection(), yAxisListSet(), yAxisListSetObject(), yAxisListSetObjectId(), yAxisNewObject(), yAxisSet()
property yAxisList as list of %ZEN.Auxiliary.axis (XMLPROJECTION = "ELEMENT", XMLREF = 1, XMLTYPECONSTRAINT = "CHOICE", ZENSETTING = 0);
List of y axis specifications for this chart.
Property methods: yAxisListBuildValueArray(), yAxisListCollectionToDisplay(), yAxisListCollectionToOdbc(), yAxisListDisplayToCollection(), yAxisListGet(), yAxisListGetObject(), yAxisListGetObjectId(), yAxisListGetSwizzled(), yAxisListIsValid(), yAxisListOdbcToCollection(), yAxisListSet(), yAxisListSetObject(), yAxisListSetObjectId()

Methods

clientmethod adjustChartTitle() [ Language = javascript ]
Adjust position of chart title and legend (if needed).
clientmethod calculateAxisConstraints() [ Language = javascript ]
If the plot has axes, pre-calculate the internal values that will be used to govern how those axes are rendered
clientmethod calculateXAxisHeight() [ Language = javascript ]
clientmethod calculateXAxisTitleHeight() [ Language = javascript ]
clientmethod calculateYAxisWidth(which) [ Language = javascript ]
Internl method to calculate how much room should be reserved for the Y axis area. This includes both the axis title and the individual labels
clientmethod chartElementClickHandler(evt, series, item) [ Language = javascript ]
Mouse click handler for chart elements. Subclasses can use this method to associated click events with chart elements.
clientmethod computeEffectiveExtents(x, y, w, h, angle) [ Language = javascript ]
clientmethod computeStyle(className, idName) [ Language = javascript ]
Compute and return the effective style that governs the rendering of a given SVG element based on class and Id
clientmethod computeXAxisTimeLine() [ Language = javascript ]
Compute scaling information for a time-based x-axis.
clientmethod createMarker(series, item, x, y, color, type, noevents) [ Language = javascript ]
Create a plot marker. This may be used by subclasses to display markers. type can be 'up','down','circle','square'.
clientmethod createSVGTextNode(caption, fontSize, autoScale, align, rotate, parentNode, txtClass, txtStyle) [ Language = javascript ]
Create a text node.
clientmethod createXLabelNode(index, fontSize, style, angle, group) [ Language = javascript ]
clientmethod embedStyle(element, styleNVP) [ Language = javascript ]
Embed the various settings of a computed style name-value object as direct attributes of the given node.
clientmethod formatNumeric(nStr) [ Language = javascript ]
Format numeric value.
clientmethod getChartElement(series, item) [ Language = javascript ]
Return the svg object for a specified data element (if any).
clientmethod getChartElementStyle(series, item) [ Language = javascript ]
Return default style for the specified data element (if any). This is used to restore styles when chart elements are unselected. Subclasses can override this.
clientmethod getChartRelatedElements(series, item) [ Language = javascript ]
Return an array of related svg objects for a specified data element (if any). (such as the edges of a 3d rendering).
clientmethod getChartSubtitle() [ Language = javascript ]
Get subtitle for the chart.
clientmethod getChartTitle() [ Language = javascript ]
Get title for the chart.
clientmethod getColorSchemeArray(scheme) [ Language = javascript ]
Return an array of color values for given data series color scheme.
clientmethod getComputedFontSize(styleNVP, defaultMedium, defaultSmall, defaultLarge) [ Language = javascript ]
Given a resolved style name-value pairing object, return the specified font size, if none has been specified, return one of three default values based on the value of the textSize property.
clientmethod getCurrYAxis(which) [ Language = javascript ]
Get the current y Axis definition used for this chart. which is "left" or "right".
clientmethod getEndTime() [ Language = javascript ]
Get the end time for a time-based chart.
clientmethod getLegendLabels() [ Language = javascript ]
Return an array of labels to display within the Legend box.
Default implementation is to return a list of series names.
clientmethod getLegendRectStyle(s) [ Language = javascript ]
clientmethod getLegendsCount(legends) [ Language = javascript ]
clientmethod getMarkerShape(series) [ Language = javascript ]
Return the marker type that should be used for the given series.
clientmethod getNumericAbbreviation(val, min, max) [ Language = javascript ]
Return a numeric abbreviation for a value. min and max are range that value falls within. E.g., 10K for 10000
clientmethod getPelToPixelHRatio() [ Language = javascript ]
The Normalized viewbox ranges from 0 0 to 100 100, the physical space occupied by the chart is specified as the width and height (in pixels) of the base SVG group. This function returns a mapping of logical picture units to pixels in the horizontal direction.
clientmethod getPelToPixelVRatio() [ Language = javascript ]
The Normalized viewbox ranges from 0 0 to 100 100, the physical space occupied by the chart is specified as the width and height (in pixels) of the base SVG group. This function returns a mapping of logical picture units to pixels in the vertical direction.
clientmethod getPlotX(val) [ Language = javascript ]
Given a logical value, return the corresponding x-axis coordinate.
clientmethod getPlotY(val, yAxisNo) [ Language = javascript ]
Given a logical value, return the corresponding y-axis coordinate.
clientmethod getRangeGroupForSeries(series) [ Language = javascript ]
Indicate which "group" should be used for computing axis ranges. This is overridden by combo charts.
clientmethod getRelatedElementStyle(series, item) [ Language = javascript ]
clientmethod getSelectedItem() [ Language = javascript ]
Returns index number (0-based) of the current selected item, or -1 if there is no current selection.
clientmethod getSelectedSeries() [ Language = javascript ]
Returns index number (0-based) of the data series of the current selected item, or -1 if there is no current selection.
clientmethod getSelectedStyle(series, item, isMarker) [ Language = javascript ]
Return any additional select/unselect style to apply to a chart element.
clientmethod getSeriesColor(series) [ Language = javascript ]
Return the CSS color that should be used for the given series.
clientmethod getSeriesCount() [ Language = javascript ]
Return the number of data series for this chart.
clientmethod getSeriesData(series) [ Language = javascript ]
Return data values for the given series (0-based) from the chart's data cache.
clientmethod getSeriesNames() [ Language = javascript ]
Return an array containing the names of the data series for this chart.
If a name is missing, the series number is used.
If the chart is connected to a data controller, get the names from the controller.
clientmethod getSeriesNamesSize() [ Language = javascript ]
clientmethod getSeriesSVGGroup() [ Language = javascript ]
Return the svg group element that contains the data series elements.
clientmethod getSeriesSize() [ Language = javascript ]
Return the number of items within each data series (this assumes that all data series have the same number of items).
clientmethod getSeriesType(series) [ Language = javascript ]
Return the type (how a series should be displayed) for the given data series (0-based). This is used by combo chart and ignored by all others.
clientmethod getStartTime() [ Language = javascript ]
Get the start time for a time-based chart.
clientmethod getTimeX(time) [ Language = javascript ]
For a given time value, YYYY-MM-DD, find the corresponding x coordinate in virtual pixels.
clientmethod getXAxis() [ Language = javascript ]
Return the x Axis definition for this chart.
clientmethod getXAxisTitle() [ Language = javascript ]
Return the x axis title.
clientmethod getXAxisType() [ Language = javascript ]
Return the type of x axis (category or value) used by this chart.
clientmethod getXLabelText(val, base, noformat) [ Language = javascript ]
Given a logical value, return the text to use for an axis label. Subclasses can override this for custom behavior. JSL4133 - pass an optional base we can add to val when label is null
clientmethod getYAxis(index) [ Language = javascript ]
Return the y Axis definition for this chart (or null if not found).
clientmethod getYAxisCount() [ Language = javascript ]
Return the number of y Axis definitions for this chart.
clientmethod getYAxisIndexForSeries(series) [ Language = javascript ]
Return the index (0-based) of the y-axis associated with the given data series. It may return -1 if the chart is not rendered yet.
clientmethod getYAxisTitle(which) [ Language = javascript ]
Return the y axis title.
clientmethod getYAxisType() [ Language = javascript ]
Return the type of y axis (category or value) used by this chart.
clientmethod getYLabelText(val, yAxisNo, base) [ Language = javascript ]
Given a logical value, return the text to use for an axis label. base is an arbitrary delta but can be used to make labels 0-based or 1-based default is 0-based for backwards compatibility Can be overriden by user through sub-classing
clientmethod hasAxes() [ Language = javascript ]
Indicates that this chart has axes and associated grids A subclass may override this to turn off axis display.
clientmethod hasMultiples() [ Language = javascript ]
Indicates that this chart supports and is in "show multiples" mode. A subclass may override this.
clientmethod hasSelectedItem() [ Language = javascript ]
Returns if there is a current selected element.
clientmethod initializeAxisProperties() [ Language = javascript ]
clientmethod integrateStyleSpec(styleNVP, newRule) [ Language = javascript ]
Integrate a new Style specification into an existing set of name-value style pairs, adding and overwriting existing styles as appropriate
clientmethod is3D() [ Language = javascript ]
Indicates whether this chart should be drawn with a 3-D appearance.
clientmethod isTimeBased() [ Language = javascript ]
Test if a time-based x axis should be used. This is overridden in subclasses.
clientmethod notifyViewHandler(reason, data1, data2, data3) [ Language = javascript ]
Notification that the dataController associated with this dataView has raised an event.
clientmethod parseStyleSVG(style) [ Language = javascript ]
Utility method. Split an SVG css value into individual style values. Return an object containing these values.
clientmethod pickVerticalSkips(flag, max) [ Language = javascript ]
This is the core of the vertical decimation algorithm. Given a maximum number of label to choose from an array, pick a subset that will (hopefully) use the available space effectively and keep things visually balanced.
clientmethod plotLineForSeries(group, s, data, stacked, chartFilled, markersVisible, hasEvents) [ Language = javascript ]
Draw a line for one data series, s (0-based). data contains the data for all series as an array of arrays.
clientmethod prepareAxisGroup(idName, parentNode) [ Language = javascript ]
Prepare the axis group for population with axis information
clientmethod removeChildNodes(node) [ Language = javascript ]
clientmethod removeNoDataMsg(plotAreaGroup) [ Language = javascript ]
Remove the NoDataMsg from the plot area.
clientmethod renderAxes() [ Language = javascript ]
Draw the x and y axes and grid lines.
clientmethod renderBands() [ Language = javascript ]
Draw the upper/lower bands for the chart.
clientmethod renderContents() [ Language = javascript ]
Client-side method to render control.
clientmethod renderLegend() [ Language = javascript ]
Draw the legend for the chart.
clientmethod renderPlotArea() [ Language = javascript ]
Draw the plot area of the chart.
clientmethod renderSeries(group) [ Language = javascript ]
Draw data series for this chart. This is implemented by subclasses. group is the SVG container for the chart components.
clientmethod renderSeriesGroup() [ Language = javascript ]
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.
clientmethod renderTimeEvents(group) [ Language = javascript ]
Render a set of time-events within the chart.
clientmethod renderTitle() [ Language = javascript ]
Draw the title for the chart. Return the height of the title.
clientmethod renderXAxisTimeLine(timeCellGroup, y) [ Language = javascript ]
Render x-axis labels and tick marks for time-based x-axis.
clientmethod renderXAxisTitle(group) [ Language = javascript ]
Draw the title section for the Y axis (if any) and return the height reserved for the rendering
clientmethod renderXLabels() [ Language = javascript ]
Draw the labels for the x axis.
clientmethod renderYAxisTitle(group, which, xpos) [ Language = javascript ]
Draw the title section for the Y axis (if any) and return the width reserved for the rendering
clientmethod renderYLabels(which) [ Language = javascript ]
Draw the labels for the y axis.
clientmethod selectElement(series, item) [ Language = javascript ]
Select the specified chart element.
clientmethod setCurrYAxis(axisNo) [ Language = javascript ]
Set the current y Axis definition used for this chart. axisNo is the index of the y-axis, 0-based.
clientmethod setDimToolTip(captions, values, x, y, final) [ Language = javascript ]
clientmethod setProperty(property, value1, value2) [ Language = javascript ]
Set the value of a named property.
clientmethod setSeeThrough(opacity) [ Language = javascript ]
clientmethod setSizeHandler() [ Language = javascript ]
Notification that this component has been resized.
clientmethod setTimeRange(startTime, endTime, final) [ Language = javascript ]
Set the timeline start and end dates and update the chart. If endTime is not provided, update it to preserve the current time range using startTime as a new starting time.
Time values are in 'yyyy-mm-dd' format. This prevents the repaint that would happen if start and end dates are set separately.
clientmethod setXAxis(axis) [ Language = javascript ]
Set the x Axis definition for this chart. Return the old axis if present.
clientmethod setYAxis(axis) [ Language = javascript ]
Set the y Axis definition for this chart. Return the old axis if present.
clientmethod showNoDataMsg(msg, plotAreaGroup, clipGroup) [ Language = javascript ]
Display the NoDataMsg. If the plotAreaGroup and clipGroup objects are known in the calling context, they may be passed in, otherwise the method will attempt to find them.
clientmethod stripWhitespace(str) [ Language = javascript ]
clientmethod updateChart() [ Language = javascript ]
Call this method to update contents of this chart.
clientmethod updateIndicator() [ Language = javascript ]
Update the "indicator" (crosshairs) for the selected item.
clientmethod usePercentForRange() [ Language = javascript ]
This method returns true if data series is a "percentage bar chart" and so calculated data range should be 0 to 100%
clientmethod useSumForRange() [ Language = javascript ]
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.
clientmethod xToLogical(val) [ Language = javascript ]
Convert a user-provided x-coordinate into 0-100 logical space. This means: 10 returns 10, but "10px" is converted using the current width of the chart.
clientmethod yToLogical(val) [ Language = javascript ]
Convert a user-provided y-coordinate into 0-100 logical space. This means: 10 returns 10, but "10px" is converted using the current height of the chart.

Inherited Members

Inherited Properties

Inherited Methods

Subclasses