Class Reference
IRIS for UNIX 2024.1.2
|
Class Reference
IRIS for UNIX 2024.1.2
|
|
|
Private
Storage
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
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
|
|
|
|
|
|
Default appearance of this component.
Do not worry about preserving the aspect ratio.
Default setting for autoscaling text as chart resizes
Default value for the markersVisible property.
Parameter SYSMODULE = "chart"; Default value for the plotToEdge property.
Default value for the valueLabelsVisible property.
Default viewBoxHeight of this component. This is set to 100 to provide a fixed coordinate system for meters.
Default viewBoxWidth of this component. This is set to 100 to provide a fixed coordinate system for meters.
|
|
Internal used by DeepSee to support data-driven series colors
adjust calculated width of text by multiplying by FontXScale
adjust calculated height of text by multiplying by FontYScale
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 are 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.
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
Optional: style applied to line drawn for x and y axes.
Optional: default style applied to axis titles for this chart.
This is applied in addition to the style supplied bylabelStyle .
Optional: style used for chart background panel.
If defined, then a colored band (specified bybandLeftStyle ) is displayed on the plot area covering the range lower than this value;
Optional: style used for left band on plot area.
If defined, then a colored band (specified bybandLowerStyle ) is displayed on the plot area covering the range lower than this value;
Optional: style used for upper band on plot area.
If defined, then a colored band (specified bybandRightStyle ) is displayed on the plot area covering the range greater than this value;
Optional: style used for right band on plot area.
If defined, then a colored band (specified bybandUpperStyle ) is displayed on the plot area covering the range greater than this value;
Optional: style used for upper band on plot area.
Optional: style applied to base line.
Optional: distance (in pixels) between the background rectangle and the border.
Optional: radius applied to the chart's background rectangle and border.
Optional: style used for border line inset from outer edge of chart.
Optional. The id of the%ZEN.Report.Display.COSChart.abstractController object that provides data for this chart.
If provided, this must be the valid id of a%ZEN.Report.Display.COSChart.abstractController object.
Specifies which yAxis definition is used to drive the chart yaxis (0 based).
Internal used by DeepSee to support data-driven series colors
A dataSeries used to provide a series-worth of data for the report
used for debugging label placement JSL3955
Latest displayed time (as YYYY-MM-DD HH:MM:SS). This is used for the x axis in a timeBased chart.
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.
Optional: if true, display zoom in/out buttons (for certain chart types).
Height of the chart within the report.
Optional: style used for indicators.
Specifies whether indicator lines should be displayed for the selected item within the chart.
This only applies to charts that display indicator lines.
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.
If true, display axis labels for this chart (or slice labels in the case of a pie chart).
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.
Optional: style used for text within the legend box.
Optional: legendLabels
Optional: legend position
Optional: style used for rectangle indicating the current legend within the legend box.
Optional: style used for background of the legend box.
Title to display for legend box.
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.
If this chart has a legend, width (within the chart coordinate space) of legend box. If not specified a default width will be used.
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.
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.
Optional: default style applied to svg line elements within line-style charts.
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.
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.
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.
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.
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.
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.
Optional: style used for series markers.
Specifies whether markers should be displayed for the data points within the chart.
This only applies to charts that display markers.
Maximum number of characters to display for an axis label.
localized warning message if chart has no data
Optional: style used for title text within each "multiple" charts. Used whenshowMultiples is enabled.
fill color rectange
opacity of no data message background rectangle
color of message
turns on category value calcuation of JMD1100 (this is in JSL3955)
ongetData method This method is called by the chart to get an array of values to plot for a data series. The array has the format values(s,i) where s is the series and is i is the member of the series and values(s,i) is numeric.
The method is passed an argument, chart, that is this chart object.
ongetLabelX event handler: This method, if defined, is called by the chart to get the text for a given label on the x axis.
The method is passed an argument, value, that contains the ordinal number (0-based) of the label.
The method is passed an argument, chart, that is this chart object.
ongetLabelY event handler: This method, if defined, is called by the chart to get the text for a given label on the y axis.
The method is passed an argument, value, that contains the ordinal number (0-based) of the label.
The method is passed an argument, chart, that is this chart object.
ongetSeriesName event handler: This method, if defined, is called by the chart to get the text for a given series number.
The method is passed an argument that contains the ordinal number (0-based) of the series name.
The method is passed an argument, chart, that is this chart object.
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.
onrenderData callback: This callback, 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.
pass the chart object to onget... methods, set it to false for old behavior where no chart object passed
Optional: style used for chart plot area panel.
Optional: for charts with a 3D look, this style is applied to the edges on the left and bottom.
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 thelineStyle property.
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.
Optional: style applied to zoom and scroll buttons when visible.
Item number (0-based) of currently selected chart element, if any.
Optional: style used to indicate the current selected chart element.
Series number (0-based) of currently selected chart element, if any.
This is the name of a built-in color scheme used to plot data series for the chart.
IfseriesColors is defined, then this property is ignored.
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 byseriesColorScheme are used.
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.
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.
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).
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.
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.
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.
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.
Earliest displayed time (as YYYY-MM-DD HH:MM:SS). This is used for the x axis in a timeBased chart.
Optional: style used for grid stripes (when enabled).
Optional: if true, draw stripes over value axis grid lines.
Subtitle to display for chart.
Optional: style used for subtitle text.
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).
Optional: If true, then the x-axis for this chart is a time line displaying date values fromstartTime toendTime . 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.
Title to display for chart.
Optional: alignment for title and subtitle.
Optional: style used for box underneath title text.
Optional: URL of image to display within the title area.
Optional. Style for titleImage: left,top,width, and height.
Optional: style used for title text.
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.
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.
Optional: style used to indicate unselected chart elements. This is used when there is a selected element.
Optional: style used for boxes around value labels. This only applies to charts that display element values (such as bar charts).
Optional: numeric format applied to value labels. This only applies to charts that display element values (such as bar charts).
Optional: style used for value labels. This only applies to charts that display element values (such as bar charts).
Specifies whether values should be displayed for elements within the chart. This only applies to charts that display element values (such as bar charts).
If defined, this is used to calculate the height of the viewBox attribute of the enclosing svg element.
If defined, this is used to calculate the width of the viewBox attribute of the enclosing svg element.
Set to 1 to display a localized warning message if chart has no data
x axis specification for this chart.
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.
List of y axis specifications for this chart.
|
|
This method outputs the necessary stylesheet information for the HTML report. Every tag should override this method.
This method outputs the necessary stylesheet information for the PDF report. Every tag should override this method.
Parse an SVGStyle XData block and put results in pParseClasses pParsedClasses(classname, attribute)=value
Adjust position of chart title and legend (if needed).
If the plot has axes, pre-calculate the internal values that will be used to govern how those axes are rendered
Draw the legend for the chart.
JMD1100 - this is in canvas in ZEN Calculate the value of the viewBox attribute of this component's enclosing svg element.
Subclasses can override this, should they need to provide a different behavior. The default behavior is to use the width and height of this component to come up with a 1 to 1 coordinate mapping; If the component provides values for theviewboxWidth andviewboxHeight properties, then these are used to calculate the viewBox (and thus define a fixed coordinate system for the component).
Compute and return the effective style that governs the rendering of a given SVG element based on class and Id
Compute scaling information for a time-based x-axis.
Create a plot marker. This may be used by subclasses to display markers. type can be 'up','down','circle','square'.
Create a text node.
Embed the various settings of a computed style name-value object as direct attributes of the given node.
Return information about a cell within a time line grid.
Get subtitle for the chart.
Get title for the chart.
Return an array of color values for given data series color scheme.
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.
Get the current y Axis definition used for this chart. which is "left" or "right".
Return the length of %dataSeries(0)
Get the end time for a time-based chart.
Return an array of labels to display within the Legend box.
Default implementation is to return a list of series names.
Use in chart to give a specifc style to legend Can be overriden by descendent class
Return the marker type that should be used for the given series.
Return a numeric abbreviation for a value. min and max are range that value falls within. E.g., 10K for 10000
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.
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.
Given a logical value, return the corresponding x-axis coordinate.
Given a logical value, return the corresponding y-axis coordinate.
Indicate which "group" should be used for computing axis ranges. This is overridden by combo charts.
Returns index number (0-based) of the current selected item, or -1 if there is no current selection.
Returns index number (0-based) of the data series of the current selected item, or -1 if there is no current selection.
Return any addition select/unselect style to apply to a chart element.
Return the CSS color that should be used for the given series. 0 based
Return the number of data series for this chart.
Return data values for the given series (0-based) from the chart's data cache. Return data in %List format.
Return an array containing the names of the data series for this chart.
If a name is missing, the series number is used.
Return svg group elemment that contains the data series elements.
Return the number of items within each data series (this assumes that all data series have the same number of items).
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.
Get the start time for a time-based chart.
For a given time value, YYYY-MM-DD, find the corresponding x coordinate in virtual pixels.
Return the x Axis definition for this chart.
Return the x axis title.
Return the type of x axis (category or value) used by this chart.
Given a logical value, return the text to use for an axis label. Subclasses can override this for custom behavior.
Return the y Axis definition for this chart.
Return the number of y Axis definitions for this chart.
Return the y axis title.
Return the type of y axis (category or value) used by this chart.
Given a logical value, return the text to use for an axis label. Subclasses can override this for custom behavior.
Indicates that this chart has axes and associated grids A subclass may override this to turn off axis display.
Indicates that this chart supports and is in "show multiples" mode. A subclass may override this.
Returns if there is a current selected element.
Integrate a new Style specification into an existing set of name-value style pairs, adding and overwriting existing styles as appropriate
Indicates whether this chart should be drawn with a 3-D appearance.
Test if a time-based x axis should be used. This is overridden in subclasses.
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.
Draw a line for one data series, s (0-based). data contains the data for all series as an array of arrays. in Java Script s was 0-based, in this code it is 0 based Data is 0-based, colors and shapes are 0-based
Prepare the axis group for population with axis information
Draw the x and y axes and grid lines.
Draw the upper/lower bands for the chart.
Client-side method to render control.
Draw the legend for the chart.
Draw the plot area of the chart.
Draw data series for this chart. This is implemented by subclasses. group is the SVG container for the chart components.
Draw the data series for this chart. This method renders the container for the data series and then invokes a sub-class specificrenderSeries method.
Render a set of time-events within the chart.
Draw the title for the chart. Return the height of the title.
Render x-axis labels and tick marks for time-based x-axis.
Draw the title section for the Y axis (if any) and return the height reserved for the rendering
Draw the labels for the x axis.
Draw the title section for the Y axis (if any) and return the width reserved for the rendering
Draw the labels for the y axis. If test is true, then this is a "test" plot to determine the max width of the labels.
Remove the inner SVG for this component. See %ZEN.Display.COSCHart.node for methods being called
Update the "indicator" (crosshairs) for the selected item.
This method returns true if data series is a "percentage bar chart" and so calculated data range should be 0 to 100%
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.
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.
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.
zen