[toc] [elements] [attributes] [types]
<annotation |
||
[href="MessageFormat"] | Specifies the action of an annotation. | |
> |
||
| [<text/>] | ||
| {<attr/>} | ||
</annotation> |
||
This tag is used for annotating areas in the resulting chart. For example, bars in a bar chart can have hyperlinks that direct the user to another page.
Most attributes for annotation are given with attr elements. However, there exists a special attribute for the action of an annotation and a special element for the description of an annotation.
With annotation elements, it is
guaranteed that the action of an annotation is defined with
href attribute.
Likewise, it is guaranteed that the description of an annotation is defined
with text element. The output
format of the chart does not have any effect on the guarantees. For example,
for charts used in HTML pages and for charts in SVG format, the action of
an annotation is defined with href attribute.
If multiple annotation elements
exist within the same parent element, the attributes defined within
annotation elements will be combined. If
the same attribute is defined in many annotation
elements within the same parent element, the definition within the last
annotation element is used.
The annotation tag is just one way to obtain annotation
links for data values. The tag is well suited for giving a common
annotation link for many data values. When each data value should have a
unique annotation link, the column element with
url value in
type attribute could be used. Another way is to use annotation
possibility given in PaintValue attribute type for data values.
Specifies the action of an annotation.
See href description.
| <annotation href="MessageFormat"/> | |
|---|---|
| NULL | |
[toc] [elements] [attributes] [types]
<area |
||
[backColor="PaintValue"] | Background borderline color. | |
[backPaint="PaintValue"] | Background fill paint. | |
[backStroke="Stroke"] | Background borderline width and style. | |
[color="PaintValue"] | Default area generic color. | |
[paint="PaintValue"] | Default area generic paint. | |
[stroke="Stroke"] | Default area generic line width and style. | |
> |
||
</area> |
||
This tag defines chart background area series attributes which control the appearance of chart background area.
Chart background area extends the whole area over which the chart is drawn upon. The background area is surrounded with a borderline, and filled with background paint. The background area will be partially painted over with shapes and forms that make the actual chart, but the areas that remain untouched will show the background paint. The background will also show through any partially transparent chart components. The background itself may also be partially and totally transparent, in which case any graphics placed beneath the chart in the final page layout will also show through.
Chart background area borderline will always surround the whole chart area, and all chart component will always be strictly contained within the borderline. The borderline may also be infinitely thin (stroke width zero), in which case the chart will appear to have no borderline.
<area paint="red-vertical" color="black" stroke="2"/>
Background borderline color. The borderline surrounds the entire chart image outer edge, but it will be visible and painted with this color only if the borderline stroke width is also not zero.
See backColor description.
| <area backColor="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |
|---|---|---|---|
| unsupported |
|
Table chart ignores this setting. |
Background fill paint. The background area covers the entire chart image, and it will be filled with this paint before anything else is drawn on it. Chart visualizations will then be drawn on top of the backgound area, leaving parts of it visible, and obscuring the rest either partially or completely.
See backPaint description.
| <area backPaint="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
Background borderline width and style. A zero borderline width (the default) indicates no borderline. Anything else will make the borderline visible, and painted with the borderline color.
Borderline width will eat away space from the actual chart visualizations, up to an point where an extreamly wide borderline fills the entire chart image area.
See backStroke description.
| <area backStroke="Stroke"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| unsupported |
|
Table chart ignores this setting. |
||||
| exception |
|
Only width setting is supported. |
Default area generic color. If set, it will be used as the default color for all area specific color settings within this area.
Please note that areas do currently support only one color attribute, backColor. This may change in the future.
See color description.
| <area color="PaintValue"/> | |
|---|---|
| black | |
Default area generic paint. If set, it will be used as the default paint for all area specific paint settings within this area.
Please note that areas do currently support only one paint attribute, backPaint. This may change in the future.
See paint description.
| <area paint="PaintValue"/> | |
|---|---|
| white | |
Default area generic line width and style. If set, it will be used as the default width and style for all area specific line settings within this area.
Please note that areas do currently support only one line width and style attribute, backStroke. This may change in the future.
See stroke description.
| <area stroke="Stroke"/> | |
|---|---|
| 0 | |
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| exception |
|
Only width setting is supported. |
[toc] [elements] [attributes] [types]
<attr |
||
name="Text" | Name of the attribute. | |
[value="Text"] | Value of the attribute. | |
> |
||
</attr> |
||
Attribute for annotation is given with this element. In theory, attribute name and value are free for the user to choose. Given attribute name and value are passed to the resulting chart as they were given after possible macro expansion.
Depending from the output format of the chart, there might be some attribute names that are read but later ignored. For example, with charts that are used in HTML pages, the following two attribute names will be ignored:
The reason for ignoring these attribute names is the fact that areas for annotation are known only after creating the chart. After the chart is created, the values for these attributes are created automatically.
With charts that are created with SVG format, the following two attribute names will be ignored:
The reason for ignoring these attributes is the guaranteeing of using href attribute for defining the action of an annotation and using text element for defining the description of an annotation. Due to these guarantees, the following attributes will be ignored for all output formats of a chart:
Name of the attribute.
See name description.
| <attr name="Text"/> | |
|---|---|
| NULL | |
Value of the attribute.
See value description.
| <attr value="Text"/> | |
|---|---|
| NULL | |
[toc] [elements] [attributes] [types]
<attributes |
||
[chartType="ChartType"] | Chart type. | |
[id="Id"] | Attribute set identity. | |
[locale="Locale"] | String formatting and parsing locale. | |
[multiseriesMode="Boolean"] | Determines the behaviour of palette colors and paints, and legend rendering. | |
[namespace="Text"] | Property file for determining areas. | |
[urlContext="Url"] | Base URL address. | |
> |
||
| [<image/>] | ||
| [<lighting/>] | ||
| [<legend/>] | ||
| [<area/>] | ||
| [<plot/>] | ||
| {<axes/>} | ||
</attributes> |
||
This tag and it's children define all aspects of chart visual appearance and style. This tag is one of the two main chart control tags, the other being the <data/> tag which controls all chart input data.
Attribute tags may appear alone or together with other
attribute tags which each defining a set of visual appearance and
style settings. If more than one attribute tags are defined together,
each should be given an unique id
attribute value so that the individual sets can be told apart, and
referenced at individually. If an attribute tag appears alone, no
id is necessary, as all functions that
need chart attributes will default to the first attribute set
available.
Besides visual appearance, chart attributes define also a set of contextual attributes that affect how attribute and data values are intepreted. Please see locale and urlContext for more information.
<attributes id="style1">
<area color="black" paint="red-vertical"
stroke="dot-1"/>
</attributes>
Chart type. If the chart type uses sub-charts, they are defined by enclosed <axes/> tags, each with it's own sub-chart type attribute. If the selected chart type does not use sub-charts, the enclosed tags are expected to define only one <axes/> tag, without any sub-chart type attribute.
See chartType description.
| <attributes chartType="ChartType"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| note |
|
At the moment, the only chart type to support sub-charts is
the |
Attribute set identity. If defined, applications may explicitly refer to and select which attribute set to use when there are several different sets available. If there is any ambiguity of which set to use, the set that gets selected depends on the application in question, although the most typical and recommended behaviour is always to select the first available set.
If there is only one attribute set defined in given context, there is no ambiguity about which set should be used. In these cases it is not strictly necessary to give the sets any identities. However, it would be good coding practice to define identites even in these cases, in case more attribute sets are defined in the same contexts in the future.
See id description.
| <attributes id="Id"/> | |
|---|---|
| NULL | |
String formatting and parsing locale. This locale will be used when formatting and parsing attribute and data value strings, unless explicitly set otherwise for some particular item.
See locale description.
| <attributes locale="Locale"/> | |
|---|---|
| runtime environment default locale | |
| Note | Affects | Description |
|---|---|---|
| note |
|
Currently |
Determines the behaviour of palette colors and paints, and legend rendering. Given multiseries mode affects the whole chart.
See multiseriesMode description.
| <attributes multiseriesMode="Boolean"/> | |
|---|---|
| depends from the count of value series | |
| Note | Affects | Description | |
|---|---|---|---|
| unsupported |
|
Table chart ignores this attribute. |
|
| unsupported |
|
Scale legends ignore this attribute. |
Property file for determining areas.
See namespace description.
| <attributes namespace="Text"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| supported |
|
Only map chart supports namespace attribute. Requires Thematic Mapping Extension. |
Base URL address. If defined, relative URL addresses will be evaluated against given base URL address instead of a default one.
See urlContext description.
| <attributes urlContext="Url"/> | |
|---|---|
| use case specific value | |
[toc] [elements] [attributes] [types]
<axes |
||
[axisColor="PaintValue"] | Axis line default color. | |
[axisStroke="Stroke"] | Axis line default width and style. | |
[backColor="PaintValue"] | Axis borderline default color. | |
[backPaint="PaintValue"] | Default axis background fill paint. | |
[backStroke="Stroke"] | Axis borderline default width and style. | |
[color="PaintValue"] | Axis default color. | |
[dataGroup="Id"] | Source data group. | |
[font="Font"] | Axis default font. | |
[gap="Percentage"] | Default relative distance between uniformly laid elements. | |
[gridColor="PaintValue"] | Grid line default color. | |
[gridLines="Boolean"] | Controls if axis grid lines should be drawn by default or not. | |
[gridStroke="Stroke"] | Grid line default width and style. | |
[labelAlignment="Alignment"] | Axis label default alignment. | |
[labelColor="PaintValue"] | Axis label default color. | |
[labelFont="Font"] | Axis label default font. | |
[labelFormat="DataFormat"] | Axis value label default format. | |
[labelOffset="Size"] | Default distance between axis line and labels. | |
[labelPaint="PaintValue"] | Axis label background paint. | |
[labelRotation="Degrees"] | Axis label default orientation. | |
[markerOffset="Size"] | Default distance between axis and marker labels. | |
[opposite="Boolean"] | Axis default side of the placement of labels and title. | |
[paint="PaintValue"] | Axis default paint. | |
[position="Position"] | Axis default position. | |
[reversed="Boolean"] | Axis default positive growth direction. | |
[silent="Boolean"] | Axis default omission of labels. | |
[stroke="Stroke"] | Default axis line line width and style. | |
[subChartType="SubChartType"] | Sub-chart type. | |
[ticColor="PaintValue"] | Color of tic marks. | |
[ticStroke="Stroke"] | Rendering details of tic marks. | |
[titleAlignment="TitleAlignment"] | Defines default alignment for axis title. | |
[titleColor="PaintValue"] | Axis title default color. | |
[titleFont="Font"] | Defines default font for axis title. | |
[titleOffset="Size"] | Defines default offset for axis title. | |
[titleRotation="Degrees"] | Defines default rotation for axis title. | |
> |
||
| [<plot/>] | ||
| {<axis/>} | ||
</axes> |
||
This tag defines a coordinate axis system, made of a number of data axes (X, Y, Z, and others). Axis system attributes define how data is laid on a coordinate system, what value ranges of the data are shown, what decorations and titles are placed on each axis, and what viewing angle will be used to look at the result.
Each coordinate axis system displays data coming from a single data group. Basic charts accept data from only one such group, and hence use exactly one coordinate axis system. Combination charts combine data from several data groups, and hence use multiple coordinate axis systems.
Certain charts ignore certain coordinate axis system
attributes as irrelevant. For example, pie charts use axes only to control the viewing angle
from which the resulting pie will be looked at. Please see the
exception notes associated with affected attributes below.
An <axes/> tag may contain a number of <axis/> children tags which define axis specific details and exceptions, and a single <plot/> tag that defines coordinate axis system specific plot area attributes. The plot tag is useful in particular with combination charts with multiple axis systems.
Axis line default color. All axis lines in this axis group will be draw with this color, unless explicitly set otherwise for some particular axis.
See axisColor description.
| <axes axisColor="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
Axis line default width and style. All axis lines in this axis group will be draw with this stroke, unless explicitly set otherwise for some particular axis.
See axisStroke description.
| <axes axisStroke="Stroke"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| exception |
|
Only width setting is supported. |
Axis borderline default color. Please see <axis/> tag description for more information about axis borderlines.
Individual axes may override this setting with <axis/> tag backColor attribute.
See backColor description.
| <axes backColor="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |
|---|---|---|---|
| unsupported |
|
Table chart ignores this setting. |
Default axis background fill paint. Please see <axis/> tag description for more information about axis background.
Individual axes may override this setting with <axis/> tag backPaint attribute.
See backPaint description.
| <axes backPaint="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
Axis borderline default width and style. All axis borderlines in this axis group will be drawn with this width and stylecolor, unless explicitly set otherwise for some particular axis.
See backStroke description.
| <axes backStroke="Stroke"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| unsupported |
|
Table chart ignores this setting. |
||||
| exception |
|
Only width setting is supported. |
Axis default color. If set, it will be used as the default color for all axis specific color settings within this axis group. In particular, the following color settings will use this attribute as their default value.
Each listed attribute may later be set individually, overriding this generic setting. The values may also be overridden further with axis specific settings.
See color description.
| <axes color="PaintValue"/> | |
|---|---|
| black | |
| Note | Affects | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| exception |
|
These charts apply the given default color for axisColor only. |
Source data group. If defined, all rendering that goes into this coordinate system will take primary data from the given data group. If this is a composite chart with multiple <axes/> tags, each may use a different different data group.
For more information about data groups, please see group and dataGroup attribute documentation.
See dataGroup description.
| <axes dataGroup="Id"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |||||
|---|---|---|---|---|---|---|---|
| unimplemented |
|
The current versions of 3D charts do not yet implement this feature. |
Axis default font. If set, it will be used as the default font for all axis specific font settings within this axis group. In particular, the following font settings will gain a new default value.
Each listed attribute may later be set individually, overriding this generic setting. The values may also be overridden further with axis specific settings.
See font description.
| <axes font="Font"/> | |
|---|---|
| Serif-12 | |
Default relative distance between uniformly laid elements. If set, it will be used as the default gap for all axis in this axis coordinate system.
Individual axes may override this setting with axis gap attribute.
See gap description.
| <axes gap="Percentage"/> | |
|---|---|
| 25 | |
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support gap attribute. |
Grid line default color. All axis grid lines in this axis group will be drawn with this color, unless explicitly set otherwise for some particular axis.
See gridColor description.
| <axes gridColor="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
Controls if axis grid lines should be drawn by default or not. Individual axes may override this setting with axis gridLines attribute.
The default is to draw the grid lines, although the exact default behaviour is chart type specific. Please also see <axis/> tag documentation for more information about axis backfaces.
See gridLines description.
| <axes gridLines="Boolean"/> | |
|---|---|
| true for value axes, false for others | |
| Note | Affects | Description | |||||
|---|---|---|---|---|---|---|---|
| exception |
|
Only vertical (X -axis) grid lines are drawn by default. |
|||||
| exception |
|
Only horizontal (Y -axis) grid lines are drawn by default. |
|||||
| unsupported |
|
These chart types do not ever draw any coordinate axes or gridlines. Instead they just ignore this setting. |
Grid line default width and style. All axis grid lines in this axis group will be drawn with this width and style, unless explicitly set otherwise for some particular axis.
See gridStroke description.
| <axes gridStroke="Stroke"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| exception |
|
Only width setting is supported. |
Axis label default alignment. All axis labels in this axis group will be aligned like this, unless explicitly set otherwise for some particular axis.
See labelAlignment description.
| <axes labelAlignment="Alignment"/> | |
|---|---|
| center | |
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| exception |
|
Only 'inside' and 'outside' values are implemented for pie charts. |
||||
| unsupported |
|
These charts do not support alignment attribute. |
Axis label default color. All axis labels and markers in this axis group will be drawn with this color, unless explicitly set otherwise for some particular axis.
See labelColor description.
| <axes labelColor="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
Axis label default font. All axis labels and markers in this axis group will be rendered with this font, unless explicitly set otherwise for some particular axis or marker.
See labelFont description.
| <axes labelFont="Font"/> | |||||
|---|---|---|---|---|---|
|
|||||
Axis value label default format. All axis value labels in this axis group will be formatted with this format template, unless explicitly set otherwise for some particular axis.
See labelFormat description.
| <axes labelFormat="DataFormat"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
Pie chart does not draw axes or labels along them and thus it ignores this setting. Instead, pie chart draws values, which are controlled with <plot/> tag valueFormat attribute. |
|||||||||
| unsupported |
|
These charts do not support labelFormat attribute. |
Default distance between axis line and labels. All labels along all axes in this axis group will be placed this far from their respective axis lines, unless explicitly set otherwise for some particular axis.
See labelOffset description.
| <axes labelOffset="Size"/> | |
|---|---|
| 25% of font size, or 3 pixels if font size is unknown | |
| Note | Affects | Description | |||||
|---|---|---|---|---|---|---|---|
| unsupported |
|
These chart types do not draw axes or labels along them, so they do just ignore this setting. |
|||||
| unsupported |
|
These charts do not support labelOffset attribute. |
|||||
| supported |
|
Only legend chart supports label offset in the legend tag. Furthermore, legend chart does not draw axes or labels along them, so label offset in axes and axis tags is ignored. |
Axis label background paint.
See labelPaint description.
| <axes labelPaint="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |
|---|---|---|---|
| supported |
|
Only table factory supports this attribute. |
|
| exception |
|
This attribute has an exceptional default path. First, default is searched normally as given in the default list. If, however, no value has been specified on the default path, the back paint of the plot tag is used. The default path of the back paint of the plot tag works normally. |
Axis label default orientation. All axis labels along all axes in this axis group will be oriented to given angle, unless explicitly set otherwise for some particular axis.
Please note that axis markers are unaffected by this attribute. Instead, they have their own label rotation attribute that affects each marker separately.
See labelRotation description.
| <axes labelRotation="Degrees"/> | |
|---|---|
| 0 | |
| Note | Affects | Description | |||||
|---|---|---|---|---|---|---|---|
| unsupported |
|
These chart types do not draw axes or labels along them, so they do just ignore this setting. |
|||||
| unsupported |
|
These chart types do draw axes or labels along them, but they do not support labelRotation attribute at the moment. |
|||||
| unsupported |
|
Table chart does not support labelRotation attribute. |
Default distance between axis and marker labels. All marker labels along all axes in this axis group will be placed this far from axis value labels, unless explicitly set otherwise for some particular axis.
See markerOffset description.
| <axes markerOffset="Size"/> | |
|---|---|
| 0 | |
| Note | Affects | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| note |
|
All markers in one axis have the same marker offset. |
||||||||||
| unsupported |
|
These charts do not support markers. |
Axis default side of the placement of labels and title. All axis in this axis group will have their side of the placement of labels and title determined with this attribute, unless explicitly set otherwise for some particular axis.
See opposite description.
| <axes opposite="Boolean"/> | |
|---|---|
| false | |
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| unsupported |
|
These chart types do not draw axes and thus they ignore this setting. |
||||
| unsupported |
|
These charts do not support opposite attribute. |
Axis default paint. If set, it will be used as the default paint for all axis specific paint settings within this axis group. In particular, the following paint settings will use this attribute as their default value.
Each listed attribute may later be set individually, overriding this generic setting. The values may also be overridden further with axis specific settings.
See paint description.
| <axes paint="PaintValue"/> | |
|---|---|
| lightgray (for backPaint) | NULL (for marker pointPaint) | backPaint of plot tag (for labelPaint) | |
Axis default position. All axis in this axis group will be intersected by other axes at this position, unless explicitly set otherwise for some particular axis.
Giving a default position in the form of
DataValue
to all axes does not necessarily work very well.
For example, if one axis represents days and another axis represents
salaries, specifying the default position as 4 days does not work.
See position description.
| <axes position="Position"/> | |
|---|---|
| (0) | |
| Note | Affects | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| exception |
|
Uses a fixed value of |
||||||||||
| unsupported |
|
These charts do not support position attribute on an axis (on axes, axis and marker tags.) |
Axis default positive growth direction. All axis in this axis group will have their positive growth direction determined with this attribute, unless explicitly set otherwise for some particular axis.
See reversed description.
| <axes reversed="Boolean"/> | |
|---|---|
| false | |
| Note | Affects | Description | |||||
|---|---|---|---|---|---|---|---|
| unsupported |
|
These chart types do not draw axes and thus they ignore this setting. |
|||||
| unsupported |
|
These charts do not support reversed attribute. |
Axis default omission of labels. All axis in this axis group will have their showing of labels determined with this attribute, unless explicitly set otherwise for some particular axis.
See silent description.
| <axes silent="Boolean"/> | |
|---|---|
| false | |
| Note | Affects | Description | |||||
|---|---|---|---|---|---|---|---|
| unsupported |
|
These chart types do not draw axes and thus they ignore this setting. |
|||||
| unsupported |
|
These charts do not support silent attribute. |
Default axis line line width and style. If set, it will be used as the default for all axis specific line width and style settings within this axis group. In particular, the following line width and style settings will use this attribute as their default value.
Each listed attribute may later be set individually, overriding this generic setting. The values may also be overridden further with axis specific settings.
See stroke description.
| <axes stroke="Stroke"/> | |
|---|---|
| (solid-)1 | |
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| exception |
|
Only axisStroke default value can be set using stroke. |
||||
| exception |
|
Only width setting is supported. |
Sub-chart type. Used for defining a sub-chart of this
<axes/> tag for charts with sub-chart
support.
See subChartType description.
| <axes subChartType="SubChartType"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| supported |
|
This attribute is meaningfull and mandatory for charts that
have can have sub-charts. One example of such charts is a combination
chart. For combination charts, any number of component charts
may be defined by defining an equal number of |
Color of tic marks. The default color of the tic marks of individual axes is not necessarily the color defined with this attribute. See the ticColor attribute of <axis/> tag for information about the defaults for the color of the tic marks.
See ticColor description.
| <axes ticColor="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support tic marks. |
Rendering details of tic marks. The default stroke of the tic marks of individual axes is not necessarily the stroke defined with this attribute. See the ticStroke attribute of <axis/> tag for information about the defaults for the stroke of the tic marks.
See ticStroke description.
| <axes ticStroke="Stroke"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support tic marks. |
Defines default alignment for axis title. Individual axes may override this setting with <axis/> tag titleAlignment attribute.
See titleAlignment description.
| <axes titleAlignment="TitleAlignment"/> | |
|---|---|
| center | |
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not have titles for axes. Therefore, titleAlignment attribute is not supported. |
||||
| unsupported |
|
These charts do not support titleAlignment. |
Axis title default color. All axis titles in this axis group will be drawn with this color, unless explicitly set otherwise for some particular axis.
See titleColor description.
| <axes titleColor="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |||
|---|---|---|---|---|---|
| unsupported |
|
These charts do not draw axes and thus they ignore this setting. |
Defines default font for axis title. Individual axes may override this setting with <axis/> tag titleFont attribute.
See titleFont description.
| <axes titleFont="Font"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |||
|---|---|---|---|---|---|
| unsupported |
|
These charts do not draw axes and thus they ignore this setting. |
Defines default offset for axis title. Individual axes may override this setting with <axis/> tag titleOffset attribute.
Offset defines the gap between the title and axis labels.
See titleOffset description.
| <axes titleOffset="Size"/> | |
|---|---|
| 0 | |
| Note | Affects | Description | |||||
|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not have titles for axes. Therefore, titleOffset attribute is not supported. |
|||||
| unsupported |
|
These charts do not support titleOffset attribute. |
Defines default rotation for axis title. Individual axes may override this setting with <axis/> tag titleRotation attribute.
The default title orientation (zero degrees) is along the axis.
See titleRotation description.
| <axes titleRotation="Degrees"/> | |
|---|---|
| 0 | |
| Note | Affects | Description | |||||
|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not have titles for axes. Therefore, titleRotation attribute is not supported. |
|||||
| unsupported |
|
These charts do not supports title rotation. |
[toc] [elements] [attributes] [types]
<axis |
||
[angle="Degrees"] | Chart 3D viewpoint orientation angle around this axis. | |
[axisColor="PaintValue"] | Axis line color. | |
[axisStroke="Stroke"] | Axis line width and style. | |
[backColor="PaintValue"] | Axis background line color. | |
[backPaint="PaintValue"] | Axis background fill paint. | |
[backStroke="Stroke"] | Axis background line width and style. | |
[color="PaintValue"] | Axis default color. | |
[dim="Dim"] | Axis dimension index or name. | |
[font="Font"] | Axis default font. | |
[gap="Percentage"] | Relative distance between uniformly laid elements. | |
[gridColor="PaintValue"] | Grid line color. | |
[gridLines="Boolean"] | Controls if axis grid lines should be drawn or not. | |
[gridStroke="Stroke"] | Grid line width and style. | |
[labelAlignment="Alignment"] | Axis label alignment. | |
[labelColor="PaintValue"] | Axis label and marker color. | |
[labelFont="Font"] | Axis label and marker font. | |
[labelFormat="DataFormat"] | Axis value label format. | |
[labelOffset="Size"] | Distance between axis line and labels. | |
[labelPaint="PaintValue"] | Axis label background paint. | |
[labelRotation="Degrees"] | Axis label orientation. | |
[markerOffset="Size"] | Distance between axis and marker labels. | |
[max="DataValue"] | Axis maximum data value. | |
[min="DataValue"] | Axis minimum data value. | |
[opposite="Boolean"] | Side of the placement of labels and title. | |
[paint="PaintValue"] | Axis default paint. | |
[position="Position"] | Axis position. | |
[reversed="Boolean"] | Axis positive growth direction. | |
[silent="Boolean"] | Omission of axis labels. | |
[step="DataValue"] | Defines the unit step for the value range of this axis. | |
[stroke="Stroke"] | Axis line width and style. | |
[ticColor="PaintValue"] | Color of tic marks. | |
[ticStroke="Stroke"] | Rendering details of tic marks. | |
[titleAlignment="TitleAlignment"] | Defines alignment for axis title. | |
[titleColor="PaintValue"] | Axis title color. | |
[titleFont="Font"] | Defines font for axis title. | |
[titleOffset="Size"] | Defines offset for axis title. | |
[titleRotation="Degrees"] | Defines rotation for axis title. | |
[titleText="Text"] | Defines text for axis title. | |
> |
||
| {<marker/>} | ||
</axis> |
||
This tag defines one individual data axis. Axis attributes define how data is laid on this axis, what value ranges of the data are shown, what decorations and titles are placed on this axis, and what viewing angle around this axis will be used to look at the result. Axis specific attributes values take preference over corresponding axis system attribute values, defined by <axes/> parent tag.
The data dimension an axis controls is controlled by the dim attribute. It is an error if two axes belonging to the same coordinate axis group try to control the same dimension.
An axis controls all visual aspects of all items laid along the axis. These include:
The axis background concept needs some further clarification. First, in a simple two-dimensional case, the area between the X- and Y -axes is the only axis background area visible. The decoration of this area is simply controlled by the X -axis background attributes, while the background attributes of all the other axes are simply ignored. In three-dimensional case things become a slightly more complicated, since we now have also "left" and "bottom" background areas to consider. These background areas are controlled by the Y- and Z -axis attributes, respectively and independently of all the other axes. Finally, each backface not explicitly configured will inherit it's decoration settings from the axis coordinate system the respective axes belong to.
Chart axes control also chart viewing angle. Each axis has an angle attribute that tells the angle the chart viewing angle should be rotated around the axis in question. For example, to view a chart from above, the viewing angle may be turned there by setting horizontal X -axis angle to some positive value. To view the same chart from left, set Y axis angle to some positive value. Axis angle settings may also be combined so that to view the chart from above and left, set both X- and Y -axis angles. Finally, please note that many chart types have only limited support for viewing angle transformations. For details, please see the exception notes associated with affected attributes below.
<axis titleText="X -axis" min="10" max="40"
labelFormat=".00"/>
<axis dim="1" titleText="Y -axis"/>
<axis dim="z" backPaint="blue"/>
Chart 3D viewpoint orientation angle around this axis.
See angle description.
| <axis angle="Degrees"/> | |
|---|---|
| 0 | |
| Note | Affects | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not have any three dimensional representation, and therefore they will just ignore this attribute. |
|||||||
| exception |
|
These charts do not support angle for Z-axis. Furthermore, angles for X- and Y-axis are restricted to values 0-90. |
|||||||
| note |
|
These charts support angle for Z-axis. The Z -axis angle rotates the pie disk around it's central axis. Positive values turn the disk to anti-clockwise direction, negative values turn the disk to clockwise direction. |
Axis line color.
See axisColor description.
| <axis axisColor="PaintValue"/> | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||
Axis line width and style.
See axisStroke description.
| <axis axisStroke="Stroke"/> | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| exception |
|
Only width setting is supported. |
Axis background line color.
See backColor description.
| <axis backColor="PaintValue"/> | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||
| Note | Affects | Description | |
|---|---|---|---|
| unsupported |
|
Table chart ignores this setting. |
Axis background fill paint.
See backPaint description.
| <axis backPaint="PaintValue"/> | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||
Axis background line width and style.
See backStroke description.
| <axis backStroke="Stroke"/> | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| unsupported |
|
Table chart ignores this setting. |
||||
| exception |
|
Only width setting is supported. |
Axis default color. If set, it will be used as the default color for all axis specific color settings for this axis. In particular, the following color settings will gain a new default value.
Each listed attribute may later be set individually, overriding this generic setting.
See color description.
| <axis color="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| exception |
|
These charts apply the given default color for axisColor only. |
Axis dimension index or name.
See dim description.
| <axis dim="Dim"/> | |
|---|---|
| 0|1|2 (in this order) | |
Axis default font. If set, it will be used as the default font for all axis specific font settings for this axis. In particular, the following font settings will gain a new default value.
Each listed attribute may later be set individually, overriding this generic setting.
See font description.
| <axis font="Font"/> | |||||
|---|---|---|---|---|---|
|
|||||
Relative distance between uniformly laid elements.
See gap description.
| <axis gap="Percentage"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support gap attribute. |
Grid line color.
See gridColor description.
| <axis gridColor="PaintValue"/> | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||
Controls if axis grid lines should be drawn or not. The default is to draw the grid lines, although the exact default behaviour is chart type specific. Please also see <axis/> tag documentation for more information about axis backfaces.
See gridLines description.
| <axis gridLines="Boolean"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |||||
|---|---|---|---|---|---|---|---|
| exception |
|
Only vertical (X -axis) grid lines are drawn by default. |
|||||
| exception |
|
Only horizontal (Y -axis) grid lines are drawn by default. |
|||||
| unsupported |
|
These chart types do not ever draw any coordinate axes or gridlines. Instead they just ignore this setting. |
Grid line width and style.
See gridStroke description.
| <axis gridStroke="Stroke"/> | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| exception |
|
Only width setting is supported. |
Axis label alignment.
See labelAlignment description.
| <axis labelAlignment="Alignment"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| exception |
|
Only 'inside' and 'outside' values are implemented for pie charts. |
||||
| unsupported |
|
These charts do not support alignment attribute. |
Axis label and marker color. In particular, all axis markers will be draw with this color, too, unless explicitly set otherwise for some particular marker.
See labelColor description.
| <axis labelColor="PaintValue"/> | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||
Axis label and marker font. In particular, all axis markers will be rendered with this font, too, unless explicitly set otherwise for some particular marker.
See labelFont description.
| <axis labelFont="Font"/> | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||
Axis value label format.
See labelFormat description.
| <axis labelFormat="DataFormat"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
Pie chart does not draw axes or labels along them and thus it ignores this setting. Instead, pie chart draws values, which are controlled with <plot/> tag valueFormat attribute. |
|||||||||
| unsupported |
|
These charts do not support labelFormat attribute. |
Distance between axis line and labels.
See labelOffset description.
| <axis labelOffset="Size"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |||||
|---|---|---|---|---|---|---|---|
| unsupported |
|
These chart types do not draw axes or labels along them, so they do just ignore this setting. |
|||||
| unsupported |
|
These charts do not support labelOffset attribute. |
|||||
| supported |
|
Only legend chart supports label offset in the legend tag. Furthermore, legend chart does not draw axes or labels along them, so label offset in axes and axis tags is ignored. |
Axis label background paint.
See labelPaint description.
| <axis labelPaint="PaintValue"/> | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||
| Note | Affects | Description | |
|---|---|---|---|
| supported |
|
Only table factory supports this attribute. |
|
| exception |
|
This attribute has an exceptional default path. First, default is searched normally as given in the default list. If, however, no value has been specified on the default path, the back paint of the plot tag is used. The default path of the back paint of the plot tag works normally. |
Axis label orientation.
Please note that axis markers are unaffected by this attribute. Instead, they have their own label rotation attribute that affects each marker separately.
See labelRotation description.
| <axis labelRotation="Degrees"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |||||
|---|---|---|---|---|---|---|---|
| unsupported |
|
These chart types do not draw axes or labels along them, so they do just ignore this setting. |
|||||
| unsupported |
|
These chart types do draw axes or labels along them, but they do not support labelRotation attribute at the moment. |
|||||
| unsupported |
|
Table chart does not support labelRotation attribute. |
Distance between axis and marker labels.
See markerOffset description.
| <axis markerOffset="Size"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| note |
|
All markers in one axis have the same marker offset. |
||||||||||
| unsupported |
|
These charts do not support markers. |
Axis maximum data value.
See max description.
| <axis max="DataValue"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| unsupported |
|
Table chart shows all data values. Therefore, the chart ignores this attribute. |
Axis minimum data value.
See min description.
| <axis min="DataValue"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| unsupported |
|
Table chart shows all data values. Therefore, the chart ignores this attribute. |
Side of the placement of labels and title.
See opposite description.
| <axis opposite="Boolean"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| unsupported |
|
These chart types do not draw axes and thus they ignore this setting. |
||||
| unsupported |
|
These charts do not support opposite attribute. |
Axis default paint. If set, it will be used as the default paint for all axis specific paint settings for this axis. In particular, the following paint settings will use this attribute as their default value.
Each listed attribute may later be set individually, overriding this generic setting.
See paint description.
| <axis paint="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
Axis position. Other axes will cross this axis at this position.
See position description.
| <axis position="Position"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| exception |
|
Uses a fixed value of |
||||||||||
| unsupported |
|
These charts do not support position attribute on an axis (on axes, axis and marker tags.) |
Axis positive growth direction.
See reversed description.
| <axis reversed="Boolean"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |||||
|---|---|---|---|---|---|---|---|
| unsupported |
|
These chart types do not draw axes and thus they ignore this setting. |
|||||
| unsupported |
|
These charts do not support reversed attribute. |
Omission of axis labels.
See silent description.
| <axis silent="Boolean"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |||||
|---|---|---|---|---|---|---|---|
| unsupported |
|
These chart types do not draw axes and thus they ignore this setting. |
|||||
| unsupported |
|
These charts do not support silent attribute. |
Defines the unit step for the value range of this axis. Axis labels and grid lines will be drawn to the axis so that the value distance from one grid line to another is one unit step.
See step description.
| <axis step="DataValue"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| unsupported |
|
Table chart does not use units when drawing axes. Therefore, this attribute is ignored. |
Axis line width and style. If set, it will be used as the default for all axis specific line width and style settings for this axis. In particular, the following line width and style settings will use this attribute as their default value.
Each listed attribute may later be set individually, overriding this generic setting.
See stroke description.
| <axis stroke="Stroke"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| exception |
|
Only width setting is supported. |
Color of tic marks.
See ticColor description.
| <axis ticColor="PaintValue"/> | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||
| Note | Affects | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support tic marks. |
Rendering details of tic marks.
See ticStroke description.
| <axis ticStroke="Stroke"/> | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||
| Note | Affects | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support tic marks. |
Defines alignment for axis title.
See titleAlignment description.
| <axis titleAlignment="TitleAlignment"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not have titles for axes. Therefore, titleAlignment attribute is not supported. |
||||
| unsupported |
|
These charts do not support titleAlignment. |
Axis title color.
See titleColor description.
| <axis titleColor="PaintValue"/> | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||
| Note | Affects | Description | |||
|---|---|---|---|---|---|
| unsupported |
|
These charts do not draw axes and thus they ignore this setting. |
Defines font for axis title.
See titleFont description.
| <axis titleFont="Font"/> | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||
| Note | Affects | Description | |||
|---|---|---|---|---|---|
| unsupported |
|
These charts do not draw axes and thus they ignore this setting. |
Defines offset for axis title.
Offset defines the gap between the title and axis labels.
See titleOffset description.
| <axis titleOffset="Size"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |||||
|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not have titles for axes. Therefore, titleOffset attribute is not supported. |
|||||
| unsupported |
|
These charts do not support titleOffset attribute. |
Defines rotation for axis title.
The default title orientation (zero degrees) is along the axis.
See titleRotation description.
| <axis titleRotation="Degrees"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |||||
|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not have titles for axes. Therefore, titleRotation attribute is not supported. |
|||||
| unsupported |
|
These charts do not supports title rotation. |
Defines text for axis title.
See titleText description.
| <axis titleText="Text"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |||
|---|---|---|---|---|---|
| unsupported |
|
These charts do not have titles for axes. Therefore, titleText attribute is not supported. |
|||
| unsupported |
|
These charts do not draw axes and thus they ignore this setting. |
[toc] [elements] [attributes] [types]
<bean |
||
source="Source" | Name of the bean from which data is to be extracted. | |
> |
||
| { | ||
| <beanColumn/> | | ||
| <beanGroup/> | ||
| }+ | ||
</bean> |
||
This tag defines a bean data source. Bean data source is used to import data
from a bean in a jsp page. The bean should be added to the attributes of the
pageContext of the page.
The addition happens with:
pageContext.setAttribute("name",bean);
, where the value of the name is the
same as the value of the source attribute.
Beans imported should have a property getter which serves a collection.
It is implicitly assumed that objects in the returned collection
are all of the same data type and the first object in the collection
fixes the data type for the collection. Therefore, the first element served
from a collection should not be null. If the
first element happens to be null,
the column type of the collection will be set to
label.
<bean source="beanA">
<beanColumn propertyName="summary"
name="bean summary"/>
<bean/>
Name of the bean from which data is to be extracted.
See source description.
| <bean source="Source"/> | |
|---|---|
| NULL | |
[toc] [elements] [attributes] [types]
<beanColumn |
||
[dataFormat="DataFormat"] | Format of the data values available from the collection. | |
[dataType="DataType"] | Type of the data available from the collection. | |
[id="Id"] | ID for the output column. | |
[name="Text"] | Name for the output column. | |
propertyName="Text" | The name of the property of the bean from which collection can be queried. | |
[type="ColumnType"] | Type for the output column. | |
> |
||
</beanColumn> |
||
BeanColumn defines from which property in the bean the data of the collection
is to be imported from. The bean should provide a method of the format:
Collection get<propertyName>();
, where the value of the <propertyName> is
the same as the value of the
propertyName
attribute.
Format of the data values available from the collection.
See dataFormat description.
| <beanColumn dataFormat="DataFormat"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| note |
|
For other charts but |
|
| supported |
|
Transforming a data value to a user readable text is supported only
by |
Type of the data available from the collection.
See dataType description.
| <beanColumn dataType="DataType"/> | |
|---|---|
| NULL | |
ID for the output column.
See id description.
| <beanColumn id="Id"/> | |
|---|---|
| NULL | |
Name for the output column.
See name description.
| <beanColumn name="Text"/> | |
|---|---|
| NULL | |
The name of the property of the bean from which collection can be queried.
See propertyName description.
| <beanColumn propertyName="Text"/> | |
|---|---|
| NULL | |
Type for the output column.
See type description.
| <beanColumn type="ColumnType"/> | |
|---|---|
| NULL | |
[toc] [elements] [attributes] [types]
<beanGroup |
||
[group="Id"] | Column group data group. | |
[id="Id"] | Channel group identity. | |
[name="Text"] | Name for this value group. | |
type="ColumnType" | The role this data channel plays in a chart. | |
> |
||
| {<beanColumn/>} | ||
</beanGroup> |
||
This tag joins two or more bean data channels into one composite
channel. The tag works exactly as <group/>, but the joined
channels are bean data channels. See <group/> for more
documentation about grouping data channels.
<bean source="beanA">
<beanGroup type="value" id="participants">
<beanColumn
propertyName="X-coordinate"/>
<beanColumn
propertyName="Y-coordinate"/>
</beanGroup>
</bean>
Column group data group.
See group description.
| <beanGroup group="Id"/> | |
|---|---|
| NULL | |
Channel group identity. <series/> tag id attributes may later refer to this identity value, in order to add or overwrite channel group attribute values.
See id description.
| <beanGroup id="Id"/> | |
|---|---|
| NULL | |
Name for this value group.
See name description.
| <beanGroup name="Text"/> | |
|---|---|
| NULL | |
The role this data channel plays in a chart.
See type description.
| <beanGroup type="ColumnType"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |||
|---|---|---|---|---|---|
| note |
|
Only these charts expect structured data at
the moment. The charts expect only structured
|
[toc] [elements] [attributes] [types]
<cell |
||
x="PositiveInteger" | Horizontal index of the cell to be selected. | |
y="PositiveInteger" | Vertical index of the cell to be selected. | |
> |
||
</cell> |
||
This element is used to select cell from a (trained) SOM map. Elements are identified from the lower right hand corener in the grid. X-dimension is 0 at the right most edgde. Similarly the bottom most row is 0 in Y-dimension.
Horizontal index of the cell to be selected.
See x description.
| <cell x="PositiveInteger"/> | |
|---|---|
| NULL | |
Vertical index of the cell to be selected.
See y description.
| <cell y="PositiveInteger"/> | |
|---|---|
| NULL | |
[toc] [elements] [attributes] [types]
<chart> |
|
| <data/> | |
| <attributes/>{<attributes/>} | |
</chart> |
|
This is the root tag for chart XML documents. It contains everything a chart image generator needs to generate one image. In particular, it declares one chart data source, and at least one chart attribute set that tells all visual appearance details the chart image should be generated with. If a chart XML document defines more than one attribute set, one of them must be explicitly selected at chart image generation time, or else the first of them will be used by default.
<chart>
<data>
<column type="value"
values="34 45 67 89"/>
<column type="paint"
values="red green blue orange"/>
</data>
<attributes>
<area paint="red-vertical"
color="black" stroke="2"/>
</attributes>
</chart>
[toc] [elements] [attributes] [types]
<collection |
||
source="Source" | Name of the collection object from which the data is to be extracted. | |
> |
||
| {<collectionColumn/>} | ||
| {<collectionGroup/>} | ||
</collection> |
||
This tag defines a collection data source. Collection data source is used
to import data from a collection object in a jsp page. The collection object
should be added to the attributes of the pageContext of the page. The
addition happens with:
pageContext.setAttribute("name",object);
, where the value of the name is the
same as the value of the source attribute.
It is implicitly assumed that objects in a collection are all
of the same data type and the first object in the collection
fixes the data type for this collection. Therefore, the first element served
from a collection should not be null. If the
first element happens to be null,
the column type of the collection will be set to
label.
<collection source="summaryList"/>
<collection source="summaryList" >
<collectionColumn name="summary data">
</collection>
Name of the collection object from which the data is to be extracted.
See source description.
| <collection source="Source"/> | |
|---|---|
| NULL | |
[toc] [elements] [attributes] [types]
<collectionColumn |
||
[dataFormat="DataFormat"] | Format of the data values available from the collection. | |
[dataType="DataType"] | Type of the data available from the collection. | |
[id="Id"] | ID for the output column. | |
[name="Text"] | Name for the output column. | |
[type="ColumnType"] | Type for the output column. | |
> |
||
</collectionColumn> |
||
CollectionColumn can be used to define attributes for the imported collection data. For example, name for the imported column can be defined.
Format of the data values available from the collection.
See dataFormat description.
| <collectionColumn dataFormat="DataFormat"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| note |
|
For other charts but |
|
| supported |
|
Transforming a data value to a user readable text is supported only
by |
Type of the data available from the collection.
See dataType description.
| <collectionColumn dataType="DataType"/> | |
|---|---|
| NULL | |
ID for the output column.
See id description.
| <collectionColumn id="Id"/> | |
|---|---|
| NULL | |
Name for the output column.
See name description.
| <collectionColumn name="Text"/> | |
|---|---|
| NULL | |
Type for the output column.
See type description.
| <collectionColumn type="ColumnType"/> | |
|---|---|
| NULL | |
[toc] [elements] [attributes] [types]
<collectionGroup |
||
[group="Id"] | Column group data group. | |
[id="Id"] | Channel group identity. | |
[name="Text"] | Name for this value group. | |
type="ColumnType" | The role this data channel plays in a chart. | |
> |
||
| {<collectionColumn/>} | ||
</collectionGroup> |
||
This tag joins two or more collection data channels into one
composite channel. The tag works exactly as <group/>, but the joined
channels are collection data channels. See <group/> for more
documentation about grouping data channels.
<collection source="pairlist">
<collectionGroup type="value" id="participants">
<collectionColumn
name="driver"/>
<collectionColumn
name="mapper"/>
</collectionGroup>
</collection>
Column group data group.
See group description.
| <collectionGroup group="Id"/> | |
|---|---|
| NULL | |
Channel group identity. <series/> tag id attributes may later refer to this identity value, in order to add or overwrite channel group attribute values.
See id description.
| <collectionGroup id="Id"/> | |
|---|---|
| NULL | |
Name for this value group.
See name description.
| <collectionGroup name="Text"/> | |
|---|---|
| NULL | |
The role this data channel plays in a chart.
See type description.
| <collectionGroup type="ColumnType"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |||
|---|---|---|---|---|---|
| note |
|
Only these charts expect structured data at
the moment. The charts expect only structured
|
[toc] [elements] [attributes] [types]
<colorPoint |
||
color="PaintValue" | Determines the color of the upper end of this point. | |
[interpolationMode="InterpolationMode"] | Determines whether interpolation is used for this point in determining a color for rendering a data value. | |
[minColor="ColorValue"] | Determines the color of the lower end of this point. | |
position="Position" | Determines the position of this point in a color scale. | |
[positionType="PositionType"] | Interpretation type for position. | |
> |
||
</colorPoint> |
||
Each color point defines a point in a color scale. The value of the point is defined by the position and positionType attributes.
When a data value is rendered, a possible value attached to the data value with a color channel is compared to the values of color points. The color point that has the smallest value that is greater than or equal to the value attached to a data value is selected. Therefore, there is a certain range of values attached to data values that correspond to the same color point. The maximum value of this range, which happens to be the value of the point itself, is considered to be the upper end of the point. The minimum value of this range, which is a value that is just a little bit greater than the value of the previous point, is considered to be the lower end of the point. The previous point is the point with a value that is the greatest of those points that have a value that is smaller than the value of this point.
Depending from the chart, the color(s) of the selected color point may be used in the rendering of the data value.
Determines the color of the upper end of this point. If the minColor and interpolationMode attributes are not defined, this color is used for the whole range of values that correspond to this point.
See color description.
| <colorPoint color="PaintValue"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| exception |
|
If the minColor and interpolationMode attributes are defined, the type of this color is ColorValue, not PaintValue. |
Determines whether interpolation is used for this point in determining a color for rendering a data value.
See interpolationMode description.
| <colorPoint interpolationMode="InterpolationMode"/> | |||||
|---|---|---|---|---|---|
|
|||||
Determines the color of the lower end of this point. This color is used only if interpolationMode attribute has been defined for this point.
See minColor description.
| <colorPoint minColor="ColorValue"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support minColor setting in plot tag. |
Determines the position of this point in a color scale.
See position description.
| <colorPoint position="Position"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support position attribute on an axis (on axes, axis and marker tags.) |
Interpretation type for position.
See positionType description.
| <colorPoint positionType="PositionType"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| note |
|
If the position type is set to |
[toc] [elements] [attributes] [types]
<colorScale |
||
[interpolationMode="InterpolationMode"] | Provides default interpolation mode for the points of this scale. | |
> |
||
| {<colorPoint/>} | ||
</colorScale> |
||
Color scale defines how the values of color channels should be used for rendering the chart. Each color scale is composed of a number of color points. The color points that are collected to a color scale define a sequence of colors that are used for rendering the chart. The sequence can be continuous and cover all values in color channels or the sequence can have gaps for which no visible color is defined.
Provides default interpolation mode for the points of this scale.
See interpolationMode description.
| <colorScale interpolationMode="InterpolationMode"/> | |
|---|---|
| NULL | |
[toc] [elements] [attributes] [types]
<column |
||
[dataFormat="DataFormat"] | Data element string value interpretation details. | |
[dataType="DataType"] | Data type tells how a string value should be interpreted as a data value. | |
[group="Id"] | Column data group. | |
[id="Id"] | Channel identity. | |
[name="Text"] | Name for this column of values. | |
[separator="Separator"] | Defines the separator character that separates individual data values in a values data string. | |
[sqlColumnIndex="ColumnIndex"] | Associates the XML data column to a SQL column of given number. | |
[sqlColumnName="Text"] | Associates the XML data column to a SQL column of given name. | |
type="ColumnType" | The role this data channel plays in a chart. | |
[values="Values"] | A list of data values. | |
> |
||
| { | ||
| text | | ||
| {<element/>} | | ||
| {<e/>} | ||
| } | ||
</column> |
||
This tag defines one data channel. A data channel contains
a finite sequence of data values of equal type and significance. Some
or even all of the elements in the sequence may have a special
null value, signaling the absense of
any specific value. A sequence may also be completely empty,
containing zero elements.
Each channel has a column type that
specifies for what purpose the data in this channel is meant for. For
example, the channel may be flagged to contain data values to be visualized in chart specific way, or
labels that explain and tag such
values. Please see ColumnType for a list of recognized data
channel types.
All elements in a single data channel share a common data type and data format. These attributes specify what kind of arithmetic operations can be applied on the data values, and how they may be parsed from and formatted as strings. Some example data types would be simple scalar values and Gregorian calendar dates; both can be expressed as decimal values, but when such decimal values are interpreted, it is vital to known which are expected.
Each data channel has also an identity with which it can be explicitly referenced at, and a channel group it belongs to. A channel that does not belong to any explicit group still belong to an implisit group of ungrouped channels. Chart image generators use channel identity and group to select values from data channels for various purposes. For example, label formatters make use of channel identities, while combination charts make use of channel groups.
In addition to the attributes given with the channel data, the interpreting and rendering of the channel data depends from a number of other attributes. These attributes are given in chart <series/> attribute tags. All attributes except channel identity given in series tag for the corresponding channel will override the corresponding attributes given with the channel data. This makes it possible to define generic data sources with default attribute sets without any prior knowledge of or restrictions over the applications the data is later used for. If a channel belongs to a specified channel group, channel specific series attributes are ignored.
<column id="results" type="value" values="1.4 562.2 -15.345 0"/>
<column id="colorcodes" separator="," type="paint">
red,black
<e>green</e>
<element>blue</element>
</column>
<column id="dates" type="value" dataType="date"
dataFormat="E-h:m">
<element>Monday-9:0</element>
<element>Wednesday-10:9</element>
<element>Friday-11:58</element>
<element>Sunday-13:33</element>
</column>
Data element string value interpretation details.
See dataFormat description.
| <column dataFormat="DataFormat"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| note |
|
For other charts but |
|
| supported |
|
Transforming a data value to a user readable text is supported only
by |
Data type tells how a string value should be interpreted as a data value. This can be useful, for example, when retrieving data from database. String interpretation details may be further defined with data format attribute.
See dataType description.
| <column dataType="DataType"/> | |
|---|---|
| NULL | |
Column data group. <axes/> tag dataGroup attribute may later be used to refer to this group identity to select input only from the channels belonging to the named data group. See group attribute for an example.
See group description.
| <column group="Id"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| supported |
|
In combo charts, column group definition can be utilised. |
Channel identity. These identity values, if defined, are expected to be unique over all <column/> and <group/>tags within the same chart data source. <series/> tag id attributes may later refer to these identity values to select which data channel attribute values to modify. See id attribute for an example.
See id description.
| <column id="Id"/> | |
|---|---|
| NULL | |
Name for this column of values.
In 3D charts, the name is displayed on the Z-axis of some chart types. If the name should not be displayed, the font of the Z-axis should be set to zero.
See name description.
| <column name="Text"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| exception |
|
|
Defines the separator character that separates individual data values in a values data string.
<data>
<column id="a" type="value" values="1 3 5"/>
<column id="b" separator="x-x" type="value"
values="2x4x6"
/>
</data>
See separator description.
| <column separator="Separator"/> | |
|---|---|
| white-space character | |
Associates the XML data column to a SQL column of given number. See sqlColumnName for an example.
See sqlColumnIndex description.
| <column sqlColumnIndex="ColumnIndex"/> | |
|---|---|
| NULL | |
Associates the XML data column to a SQL column of given name. 'sqlColumnName' overrides 'sqlColumnIndex' if both are given. If neither are given, 'sqlColumnName' defaults to the XML data column id.
<chart:sql query="SELECT name,age FROM FRIENDS">
<chart>
<data>
<column sqlColumnName="age"
type="value"/>
<column sqlColumnIndex="1"
type="label"/>
</data>
</chart>
</chart:sql>
See sqlColumnName description.
| <column sqlColumnName="Text"/> | |
|---|---|
| NULL | |
The role this data channel plays in a chart.
See type description.
| <column type="ColumnType"/> | |
|---|---|
| NULL | |
A list of data values. An alternative for <element> tags.
See values description.
| <column values="Values"/> | |
|---|---|
| NULL | |
[toc] [elements] [attributes] [types]
<csv |
||
source="Source" | URL to the csv file. | |
[separatorChar="PrintableCharacter"] | Separator character separates columns in a data row. | |
[commentChar="PrintableCharacter"] | Data rows beginning with this character are skipped. | |
[quotationChar="PrintableCharacter"] | A text between two quotation characters is handled as one value. | |
[nullMarker="Text"] | Missing data values are represented using this string in csv file. | |
[firstDataRow="PositiveInteger"] | The row number of the first data row from the beginning of the file. | |
[namesRow="PositiveInteger"] | This row is used to name columns. | |
> |
||
| {<csvColumn/>} | ||
| {<csvGroup/>} | ||
</csv> |
||
This tag defines a csv data source. CSV data source is used to import data from a text file. It is assumed that each data row is in its own line and columns are separated from each other by a separation character.
data.txt - config.xml -config2.xml
#performance summary
#employee;sales;costs
Mike;9000;5000
Anne;4000;4500
Leila;12000;6500
James;9000;5500
...
<csv source="http://fileserver:8080/chart/Data.txt" separatorChar=";"
firstDataRow="3"
/>
<csv source="http://fileserver:8080/chart/Data.txt" namesRow="2"
separatorChar=";"/>
<csvColumn column="1" id="a" />
<csvColumn column="3" id="b" />
<csvColumn column="2" id="c" />
<csv/>
URL to the csv file.
See source description.
| <csv source="Source"/> | |
|---|---|
| NULL | |
Separator character separates columns in a data row.
See separatorChar description.
| <csv separatorChar="PrintableCharacter"/> | |
|---|---|
| space character | |
Data rows beginning with this character are skipped.
See commentChar description.
| <csv commentChar="PrintableCharacter"/> | |
|---|---|
| # | |
A text between two quotation characters is handled as one value.
See quotationChar description.
| <csv quotationChar="PrintableCharacter"/> | |
|---|---|
| " | |
Missing data values are represented using this string in csv
file. When such string is encountered in csv file, a
null data value is
created to represent missing data value.
See nullMarker description.
| <csv nullMarker="Text"/> | |
|---|---|
| NULL | |
The row number of the first data row from the beginning of the file. Numbering starts from 1.
See firstDataRow description.
| <csv firstDataRow="PositiveInteger"/> | |
|---|---|
| NULL | |
This row is used to name columns. Numbering of rows starts from 1. The name row should consist of column names separated with separatorChar. The name row line can start with comment character(s) that are ignored.
See namesRow description.
| <csv namesRow="PositiveInteger"/> | |
|---|---|
| NULL | |
[toc] [elements] [attributes] [types]
<csvColumn |
||
column="Text" | ID of the input column to be selected. | |
[dataFormat="DataFormat"] | Format of the data values available from the collection. | |
[dataType="DataType"] | Type of the data available from the collection. | |
[id="Id"] | ID for the output column. | |
[name="Text"] | Name for the output column. | |
[type="ColumnType"] | Type for the output column. | |
> |
||
</csvColumn> |
||
CsvColumn is used for selecting the column that is to be imported from the text file. Selection is done by indicating the number of the column by using the column attribute. Extra information for the resulting column can also be given.
ID of the input column to be selected.
See column description.
| <csvColumn column="Text"/> | |
|---|---|
| NULL | |
Format of the data values available from the collection.
See dataFormat description.
| <csvColumn dataFormat="DataFormat"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| note |
|
For other charts but |
|
| supported |
|
Transforming a data value to a user readable text is supported only
by |
Type of the data available from the collection. If the type is not
given and the data can not be expressed as a
float, the type of the data is considered to be
text.
See dataType description.
| <csvColumn dataType="DataType"/> | |
|---|---|
| float | |
ID for the output column.
See id description.
| <csvColumn id="Id"/> | |
|---|---|
| NULL | |
Name for the output column.
See name description.
| <csvColumn name="Text"/> | |
|---|---|
| NULL | |
Type for the output column.
See type description.
| <csvColumn type="ColumnType"/> | |
|---|---|
| NULL | |
[toc] [elements] [attributes] [types]
<csvGroup |
||
[group="Id"] | Column group data group. | |
[id="Id"] | Channel group identity. | |
[name="Text"] | Name for this value group. | |
type="ColumnType" | The role this data channel plays in a chart. | |
> |
||
| {<csvColumn/>} | ||
</csvGroup> |
||
This tag joins two or more csv data channels into one
composite channel. The tag works exactly as <group/>, but the joined
channels are csv data channels. See <group/> for more
documentation about grouping data channels.
<csv source="http://fileserver:8080/chart/Data.txt" namesRow="2"
separatorChar=";">
<csvGroup type="value" id="items">
<csvColumn column="hammer"/>
<csvColumn column="nail"/>
<csvColumn column="saw"/>
</csvGroup>
</csv>
Column group data group.
See group description.
| <csvGroup group="Id"/> | |
|---|---|
| NULL | |
Channel group identity. <series/> tag id attributes may later refer to this identity value, in order to add or overwrite channel group attribute values.
See id description.
| <csvGroup id="Id"/> | |
|---|---|
| NULL | |
Name for this value group.
See name description.
| <csvGroup name="Text"/> | |
|---|---|
| NULL | |
The role this data channel plays in a chart.
See type description.
| <csvGroup type="ColumnType"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |||
|---|---|---|---|---|---|
| note |
|
Only these charts expect structured data at
the moment. The charts expect only structured
|
[toc] [elements] [attributes] [types]
<data> |
|
| {<bean/>} | |
| {<collection/>} | |
| {<column/>} | |
| {<csv/>} | |
| {<group/>} | |
| {<movingAverage/>} | |
| {<pivot/>} | |
| {<som/>} | |
| {<somCellFilter/>} | |
| {<sort/>} | |
| {<sql/>} | |
| {<xpath/>} | |
</data> |
|
This tag defines a chart data source. A data source declares a number of data channels that each may contain a number of data elements. Data channels may also be grouped, in which case corresponding data elements in the grouped channels form more complex, structured data elements made of two or more simpler elements.
The data elements within each channel form data sequences
where each element has a well-defined place within that sequence, and
a corresponding index number. All elements with equal index numbers
are said to correspond to each other. For example, the first element
in a data value stream corresponds to the first element in a data
label stream. When these two streams are then fed to a chart image
generator, it will render the first label text next to the first data
value. The same goes with grouped channels: the first elements in the
grouped channels form the first complex element, and so on. Finally,
when two or more streams are used together and some of them have fewer
element than some other streams, all shorter streams are padded with
null elements to make them all of equal
length.
In certain circumtances, in particular when working with chart JSP tag libraries, a chart data source may omit the actual data elements alltogether, and rely on that the data itself will be fetched from some external source, like a SQL database or a non-XML data file. The data column declarations will then just tell how this external data will be mapped to corresponding chart data streams. Please see for example the SQL column index attribute in <column/> tag for a mechanism of how to bind SQL table columns to corresponding chart data streams.
<data>
<group id="points" type="value">
<column
values="1 2 4 8 16 32"/>
<column
values="0.5 -4.3 -4.2 8 8.2 8.201"/>
</group>
<column id="texts" type="label"
>
<element>Sample
1</element>
<element>Sample
2</element>
<element>Sample
3</element>
<element>Sample
4</element>
<element>Sample
5</element>
</column>
</data>
[toc] [elements] [attributes] [types]
<directional |
||
[lightColor="SolidColorValue"] | Direct light color. | |
[direction="Direction"] | Direction vector. | |
> |
||
</directional> |
||
This tag defines a directional light source that emits light rays parallel to a given 3D direction vector. The direction vector is expressed relative to chart world coordinate system. All chart 3D models are placed at world coordinate origo, while the camera the models are viewed through is always fixed at a point along the positive Z -axis from where it looks back towards the origo, along the negative Z -direction. Useful reference directions for any directional light source would therefore be:
0 0 -1: behind the camera
1 0 -1: behind and left of
the camera0 1 -1: behind and below the
camera-1 0 -1: behind and right of
the camera0 -1 -1: behind and above the
cameraDirectional light intensity does not attenuate with
distance. Direction vector length does not also affect the light
intensity in any way, so directional vectors "0 0
-1" and "0 0 -1000"
will have exactly the same effect.
<chart>
<attributes>
<lighting>
<directional lightColor="white"
direction="-1 -1 -1"/>
</lighting>
</attributes>
</chart>
Direct light color.
See lightColor description.
| <directional lightColor="SolidColorValue"/> | |
|---|---|
| NULL | |
Direction vector. The direction specifies the direction vector of the illumination emanating from the light source. Light is emitted along parallel rays from an infinite distance away.
See direction description.
| <directional direction="Direction"/> | |
|---|---|
| NULL | |
[toc] [elements] [attributes] [types]
<e> |
|
| DataValue | |
</e> |
|
Alternate shorthand form of the <element/> tag.
[toc] [elements] [attributes] [types]
<element> |
|
| DataValue | |
</element> |
|
This tag and it's equivalent shorthand version the <e/> tag define one data element within a data channel. The data element value is defined by tag body content, which will be interpreted according the rules set by enclosing data channel data type and data format.
In certain circumtances channel data is fetched from some
external source, and all <element/> and <e/> tags, if any, are
ignored. Please see <data/> tag documentation for more
information.
<e>text without preceding and trailing
whitespace</e>
<e> text with preceding and trailing
whitespace </e>
<element>text with significant
newlines</element>
<column dataType="text">
<element>1/2/2000</element>
</column>
<column dataType="date" dataFormat="us">
<element>1/2/2000</element>
</column>
<column dataType="date" dataFormat="d/M/y">
<element>1/2/2000</element>
</column>
[toc] [elements] [attributes] [types]
<group |
||
[group="Id"] | Column group data group. | |
[id="Id"] | Channel group identity. | |
[name="Text"] | Name for this value group. | |
type="ColumnType" | The role this data channel plays in a chart. | |
> |
||
| {<column/>} | ||
</group> |
||
This tag joins two or more data channels into one composite channel. The new composite channel contains structured composite elements, made by corresponding member channel elements: for example, the first elements of all group member channels will together form the first element of the composite channel. The member elements retain their original values and characteristics, but the elements are now just bundled together, and treated as a single structured value. Likewise, the resulting group behaves like any other data channel.
Structured elements are used in particular with scatter charts that plot X,Y coordinate value pairs as points in a two-dimensional coordinate system. Indeed, such charts expect that their value channels contain composite elements made of two simple, arithmetically computable values like scalar, time, or date values. Please see DataType for more information.
It is possible to give series attributes for nested
<column/> tags with
<series
/> tag. However, such attributes are usually ignored
because there is no use for such attributes. For example, giving a paint for
the X-coordinate of a coordinate value pair in a scatter chart does not affect
anything, because the paint of the pair is used. For a table chart, however,
giving a paint for the X-coordinate of a coordinate value pair has a noticeable
effect.
<chart>
<data>
<group type="value"
id="participants">
<column name="height"
values="150 165 176 180"/>
<column name="weight"
values="50 52 76 80"/>
</group>
</data>
<attributes chartType="scatter"/>
</chart>
<group id="networthestimates" type="value">
<column id="x-x">
<e>1/1/2002</e>
<e>3/1/2002</e>
<e>6/1/2002</e>
<e>9/1/2002</e>
</column>
<column id="y"
values="1,000.000 1,100.000 800.000 1,500.000"/>
</group>
Column group data group.
See group description.
| <group group="Id"/> | |
|---|---|
| NULL | |
Channel group identity. <series/> tag id attributes may later refer to this identity value, in order to add or overwrite channel group attribute values.
See id description.
| <group id="Id"/> | |
|---|---|
| NULL | |
Name for this value group.
See name description.
| <group name="Text"/> | |
|---|---|
| NULL | |
The role this data channel plays in a chart.
See type description.
| <group type="ColumnType"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |||
|---|---|---|---|---|---|
| note |
|
Only these charts expect structured data at
the moment. The charts expect only structured
|
[toc] [elements] [attributes] [types]
<image |
||
[antialiasMode="AntialiasMode"] | Preferred rendering antialiasing policy. | |
[contentType="ContentType"] | Chart output format. | |
[height="Size"] | Chart image vertical size. | |
[imageParams="ImageParams"] | Image content specific parameters. | |
[resolution="Resolution"] | Image pixels-per-millimeter resolution, if any. | |
[width="Size"] | Defines chart image horizontal size. | |
> |
||
</image> |
||
This tag defines chart image attributes that define on what kind of "canvas" the chart will be painted at. In particular, a typical chart image is rendered on a raster image, made of a finite number of pixels. The number of these pixels limits the amount of details that can be painted on the chart canvas. A raster canvas size should therefore usually exceed certain minimum size, since any attempt to draw too fine details on a too coarse a raster image will loose much of the original information, and result only an unreadable mess of pixels.
It is difficult to give any exact formula for required minimum raster image size, but one coarse rule would be that a raster width and height in pixels should be at least ten times the number of data points that is to be drawn into it. In typical simple cases where there are maybe 10-20 data points this gives raster sizes about 100-200 pixels wide and high. This falls well into the range of typical image sizes displayable on typical desktop display devices. However, it is easy to see that if there is ten times more data, or the display device width and height is ten times smaller, the ratio between visualization details and canvas resolution falls rapidly.
To reduce the negative effects of coarse raster canvases, chart image generators apply smart space conservation strategies on chart graphics component layout and rendering when the size of a raster chart image is decreased below chart raster "natural" size. This ensures the best possible text and symbol readability even in the most tighly packed chart images, intended to be displayed for example in small mobile devices.
If there are no strict outside constrains on chart raster image size, chart image generators may also be given the freedom to select and use a raster image size of their own choosing by simply leaving the canvas width and height undetermined. The resulting natural chart raster image size will depend in very complex ways on the selected chart type, attributes, and data. It is also possible to set only either raster width and height, in which case the other dimension size will be determined automatically.
It is also possible to use SVG vector graphics canvas instead of a raster image canvas. This largely avoids the resolution problem discussed above, or rather delegates it on the image display phase where a SVG capable display device must solve the problem of displaying a given SVG image on a given resolution display device.
If the chart output format is chosen to be a variant of text, most of the attributes that are used with an image output format are ignored.
<image width="200" height="100"/>
<image contentType="image/svg+xml"/>
Preferred rendering antialiasing policy.
See antialiasMode description.
| <image antialiasMode="AntialiasMode"/> | |
|---|---|
| off | |
| Note | Affects | Description | |
|---|---|---|---|
| unsupported |
|
Table chart does not support antialiasing. |
Chart output format.
See contentType description.
| <image contentType="ContentType"/> | |
|---|---|
| image/png | |
Chart image vertical size.
See height description.
| <image height="Size"/> | |
|---|---|
| 300 (for 3d charts) | varies (for 2d charts) | |
| Note | Affects | Description | |
|---|---|---|---|
| unsupported |
|
Table chart ignores this attribute. |
Image content specific parameters.
See imageParams description.
| <image imageParams="ImageParams"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| unsupported |
|
Table chart does not create an image and thus ignores image parameters. |
Image pixels-per-millimeter resolution, if any.
See resolution description.
| <image resolution="Resolution"/> | |
|---|---|
| 1 | |
Defines chart image horizontal size.
See width description.
| <image width="Size"/> | |
|---|---|
| 400 (for 3d charts) | varies (for 2d charts) | |
| Note | Affects | Description | |
|---|---|---|---|
| note |
|
Table chart creates a table with the given width. Rendering the table, however, might show a wider table. This can happen if the table with long texts in the cells is rendered with a browser, for example. |
[toc] [elements] [attributes] [types]
<init |
||
[initializer="SOMInitializer"] | SOM initialization method. | |
[height="Size"] | Vertical size of the Self-Organized Map in cells. | |
[neighborhood="SOMNeighborhood"] | Used neighborhood function. | |
[seed="PositiveInteger"] | Seed for random number generator. | |
[topology="SOMTopology"] | Used map topology. | |
[width="Size"] | Horizontal size of the Self-Organized Map in cells. | |
> |
||
</init> |
||
Initialization parameters for SOM. Controls the size, topology, used neighborhood function, and the intialization of a Self-Organizing Map. If init tag is given, only initialization will be performed, unless there are other SOM controlling tags.
<init width="12" height="8" seed="342074" />
SOM initialization method. If "linear" initializer is used, then the ordering phase can be left out. When using "rand" intializer, then the map training is usually made in two phases - i.e. two train-tags are needed.
See initializer description.
| <init initializer="SOMInitializer"/> | |
|---|---|
| linear | |
| Note | Affects | Description | |
|---|---|---|---|
| supported |
|
Requires SOM Extension. |
Vertical size of the Self-Organized Map in cells.
See height description.
| <init height="Size"/> | |
|---|---|
| 2/3*width | f(sample count) | |
| Note | Affects | Description | |
|---|---|---|---|
| unsupported |
|
Table chart ignores this attribute. |
Used neighborhood function. Affects to how the neighborhood is calculated (e.g. during training).
See neighborhood description.
| <init neighborhood="SOMNeighborhood"/> | |
|---|---|
| bubble | |
| Note | Affects | Description | |
|---|---|---|---|
| supported |
|
Requires SOM Extension. |
Seed for random number generator. Map initialization uses random numbers, so this affects to it. If all paramters are the same (including the seed) and the same data set is used, the resulted SOM will be the same.
See seed description.
| <init seed="PositiveInteger"/> | |
|---|---|
| null | |
| Note | Affects | Description | |
|---|---|---|---|
| supported |
|
Requires SOM Extension. |
Used map topology. Affects to how the cells are laid onto the map and how the distances between cells are calcluated.
See topology description.
| <init topology="SOMTopology"/> | |
|---|---|
| hexagon | |
| Note | Affects | Description | |
|---|---|---|---|
| supported |
|
Requires SOM Extension. |
Horizontal size of the Self-Organized Map in cells.
See width description.
| <init width="Size"/> | |
|---|---|
| 3/2*height | f(sample count) | |
| Note | Affects | Description | |
|---|---|---|---|
| note |
|
Table chart creates a table with the given width. Rendering the table, however, might show a wider table. This can happen if the table with long texts in the cells is rendered with a browser, for example. |
[toc] [elements] [attributes] [types]
<label |
||
[clearLabels="Boolean"] | Clears old labels from the SOM before labeling. | |
> |
||
</label> |
||
Labels SOM. If the labeling is asked for a ready-made SOM (given in the source-attribute of som-element), then the SOM is just labeled using the given data source. Otherwise the SOM is initialized and trained before labeling. If there are no given initialization nor training parameters then those tasks are performed using default parameters.
<label />
Clears old labels from the SOM before labeling. This is not necessary when creating a new SOM due to the fact that it hasn't got labels yet.
Typical case when labels are cleared is when the data contains several columns suitable for labeling and user asks relabeling. A typical case when labels are not cleared is when mapping new data rows to an existing SOM.
See clearLabels description.
| <label clearLabels="Boolean"/> | |
|---|---|
| false | |
| Note | Affects | Description | |
|---|---|---|---|
| supported |
|
Requires SOM Extension. |
[toc] [elements] [attributes] [types]
<legend |
||
[backColor="PaintValue"] | Background borderline color. | |
[backPaint="PaintValue"] | Background color of the legend box. | |
[backStroke="Stroke"] | Legend background area borderline width and style. | |
[color="PaintValue"] | Legend default color. | |
[font="Font"] | Default legend font. | |
[gap="Percentage"] | Relative gap between legend edge and symbols. | |
[height="Size"] | Defines legend vertical size when the legend is embedded into chart image. | |
[hidden="Boolean"] | Defines if legend should be hidden or not. | |
[labelColor="PaintValue"] | Legend label color. | |
[labelFont="Font"] | Legend label font. | |
[labelOffset="Size"] | Distance between legend entries. | |
[legendAlignment="LegendAlignment"] | Legend placement. | |
[legendType="LegendType"] | Legend type. | |
[margin="MarginString"] | Default margins around chart. | |
[marginBottom="Margin"] | Bottom margin. | |
[marginLeft="Margin"] | Left margin. | |
[marginRight="Margin"] | Right margin. | |
[marginTop="Margin"] | Top margin. | |
[orientation="Orientation"] | Orientation of the legend. | |
[paint="PaintValue"] | Default paint. | |
[stroke="Stroke"] | Default legend line width and style. | |
[width="Size"] | Defines legend horizontal size when the legend is embedded into chart image. | |
> |
||
</legend> |
||
This tag adds a legend to a chart image. A legend explains the symbols and color codes used in a chart, and therefore binds more meaning to the actual data visualizations.
The <legend/> tag
attributes control legend placement relative to the actual chart, and
some major appearance aspects like font and legend area background
paint. All other layout and appearance aspects and legend content are
derived automatically from the main chart.
Please note that legends may also be generated separately
by selecting legend as the main
chart type. This procedure produces a stand-alone legend image, which is
useful when chart and and legends images need to be laid out
carefully amongst some other content. However, if no custom legend
layout control is needed, the <legend/> tag is the recommended method of
legend construction.
<legend legendAlignment="down"/>
<legend paint="lightBlue" legendAlignment="left"
marginLeft="10"/>
Background borderline color.
See backColor description.
| <legend backColor="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |
|---|---|---|---|
| unsupported |
|
Table chart ignores this setting. |
Background color of the legend box.
See backPaint description.
| <legend backPaint="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
Legend background area borderline width and style.
See backStroke description.
| <legend backStroke="Stroke"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| note |
|
Chart and legend background areas are two separate things, and their appearance can be controlled separately. In particular, if they are both set, and a legend chart is drawn alone, the legend will be surrounded with two border lines, the outer one controlled by chart area background attributes, and the inner one controlled by legend background attribute. |
||||
| unsupported |
|
Table chart ignores this setting. |
||||
| exception |
|
Only width setting is supported. |
Legend default color. If set, it will be used as the default color for all legend specific color settings for this legend. In particular, the following color settings will use this attribute as their default value.
Each listed attribute may later be set individually, overriding this generic setting.
See color description.
| <legend color="PaintValue"/> | |
|---|---|
| black | |
Default legend font. If set, it will be used as the default font for all legend specific font settings within this legend. In particular, the following font settings will gain a new default value.
Each listed attribute may later be set individually, overriding this generic setting.
See font description.
| <legend font="Font"/> | |||||
|---|---|---|---|---|---|
|
|||||
Relative gap between legend edge and symbols. In particular, making the gap larger will make legend symbols relatively smaller, and vice versa.
See gap description.
| <legend gap="Percentage"/> | |
|---|---|
| 20 | |
Defines legend vertical size when the legend is embedded into chart image. The legend height may not exceed the chart image height.
See height description.
| <legend height="Size"/> | |
|---|---|
| varies | |
| Note | Affects | Description | |
|---|---|---|---|
| unsupported |
|
Table chart ignores this attribute. |
Defines if legend should be hidden or not. If left undefined, the legend will be visible if a legend tag is defined, and hidden otherwise. In particular, even an empty legend tag will generate a visible legend.
See hidden description.
| <legend hidden="Boolean"/> | |
|---|---|
| false | |
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support hidden attribute. |
Legend label color. This color affects to the color of the text of the labels. The symbols before the texts take their color and paint values from column and plot tags.
See labelColor description.
| <legend labelColor="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
Legend label font.
See labelFont description.
| <legend labelFont="Font"/> | |||||||||
|---|---|---|---|---|---|---|---|---|---|
|
|||||||||
Distance between legend entries.
See labelOffset description.
| <legend labelOffset="Size"/> | |
|---|---|
| label font size / 4 | |
| Note | Affects | Description | |||||
|---|---|---|---|---|---|---|---|
| note |
|
The default value for horizontal and vertical label offsets may differ from each other in scale legends. |
|||||
| unsupported |
|
These chart types do not draw axes or labels along them, so they do just ignore this setting. |
|||||
| unsupported |
|
These charts do not support labelOffset attribute. |
|||||
| supported |
|
Only legend chart supports label offset in the legend tag. Furthermore, legend chart does not draw axes or labels along them, so label offset in axes and axis tags is ignored. |
Legend placement.
See legendAlignment description.
| <legend legendAlignment="LegendAlignment"/> | |
|---|---|
| right | |
Legend type.
See legendType description.
| <legend legendType="LegendType"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| note |
|
If the main chart does not support the type of the visualization scale that is selected for the legend, the information value of the legend is questionable. |
Default margins around chart. If set, it will be used as the default margin for all chart specific margin settings for this chart. In particular, the following margin settings will use this attribute as their default value.
Each listed attribute may later be set individually, overriding this generic setting.
See margin description.
| <legend margin="MarginString"/> | |
|---|---|
| 0|5(if between chart and legend box) | |
Bottom margin.
See marginBottom description.
| <legend marginBottom="Margin"/> | |||||
|---|---|---|---|---|---|
|
|||||
Left margin.
See marginLeft description.
| <legend marginLeft="Margin"/> | |||||
|---|---|---|---|---|---|
|
|||||
Right margin.
See marginRight description.
| <legend marginRight="Margin"/> | |||||
|---|---|---|---|---|---|
|
|||||
Top margin.
See marginTop description.
| <legend marginTop="Margin"/> | |||||
|---|---|---|---|---|---|
|
|||||
Orientation of the legend.
See orientation description.
| <legend orientation="Orientation"/> | |
|---|---|
| horizontal (legendAlignment is down or up) | vertical (legendAlignment is left or right) | |
| Note | Affects | Description | |
|---|---|---|---|
| exception |
|
Scale legends do not support |
|
| note |
|
Only legend types that show scales support the selection of descending or ascending order of entries. |
|
| supported |
|
Only legend chart supports orientation attribute. |
Default paint. If set, it will be used as the default paint for all paint specific settings for this legend. In particular, the following paint settings will use this attribute as their default value.
Each listed attribute may later be set individually, overriding this generic setting.
See paint description.
| <legend paint="PaintValue"/> | |
|---|---|
| NULL | |
Default legend line width and style. If set, it will be used as the default for all line width and style settings for this legend. In particular, the following line width and style settings will use this attribute as their default value.
Each listed attribute may later be set individually, overriding this generic setting.
See stroke description.
| <legend stroke="Stroke"/> | |
|---|---|
| 0 | |
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| exception |
|
Only width setting is supported. |
Defines legend horizontal size when the legend is embedded into chart image. The legend width may not exceed the chart image width.
See width description.
| <legend width="Size"/> | |
|---|---|
| varies | |
| Note | Affects | Description | |
|---|---|---|---|
| note |
|
Table chart creates a table with the given width. Rendering the table, however, might show a wider table. This can happen if the table with long texts in the cells is rendered with a browser, for example. |
[toc] [elements] [attributes] [types]
<lighting |
||
[ambientColor="SolidColorValue"] | Ambient light is that light that seems to come from all directions. | |
> |
||
| [<directional/>] | ||
</lighting> |
||
This tag defines lighting aspects applied on true 3D charts. Charts that do not use 3D modeling will ignore this tag.
Chart lighting is composed of an ambient light component, and any number of directional light components. The resulting lighting is the sum of all these light sources.
<lighting ambientColor="white"/>
<lighting ambientColor="white">
<directional lightColor="yellow"
direction="0 0 1" >
</lighting>
Ambient light is that light that seems to come from all directions. Ambient reflections do not depend on the orientation or position of the Chart. The ambientColor attribute specifies the spectral color property of the ambient light emission.
See ambientColor description.
| <lighting ambientColor="SolidColorValue"/> | |
|---|---|
| black | |
| Note | Affects | Description | |||||
|---|---|---|---|---|---|---|---|
| supported |
|
These charts support the 3D lighting model. |
[toc] [elements] [attributes] [types]
<marker |
||
[alignment="Alignment"] | Marker default alignment. | |
[color="PaintValue"] | Marker default color. | |
[font="Font"] | Marker default font. | |
[labelAlignment="Alignment"] | Marker label alignment. | |
[labelColor="PaintValue"] | Marker label color. | |
[labelFont="Font"] | Marker label font. | |
[labelPaint="PaintValue"] | Marker label background fill color. | |
[labelRotation="Degrees"] | Marker label orientation. | |
[labelText="Text"] | Marker label text. | |
[lineColor="PaintValue"] | Marker line color. | |
[linePaint="PaintValue"] | Paint for the area designated by the marker. | |
[lineStroke="Stroke"] | Marker line width and style. | |
[paint="PaintValue"] | Marker default paint. | |
[pointColor="PaintValue"] | Symbol edge color. | |
[pointPaint="PaintValue"] | Symbol interior color. | |
[pointShape="Shape"] | Symbol shape. | |
[pointStroke="Stroke"] | Symbol edge line width and style. | |
position="Position" | Marker position. | |
[shape="Shape"] | Sets default shape for the pointShape attribute. | |
[stroke="Stroke"] | Default line width and style for this marker. | |
> |
||
</marker> |
||
This tag defines an axis value marker that highlights a certain point along an axis. Any number of markers may be defined, and each marker will hightlight exactly one point.
The exact marker visualization depends on the chart type in question, but in each case the marker is associated with a label text, a symbol, and a line that divides the axis range into values smaller and greater than given marker position value.
<chart>
<data>
<column type="value" values="100
150 200"/>
</data>
<attributes chartType="column">
<axes>
<axis dim="1">
<marker
position="200" linecolor="red" labelText="MAX"/>
</axis>
</axes>
</attributes>
</chart>
<chart>
<data>
<column type="value" values="100
150 200"/>
</data>
<attributes chartType="column">
<axes>
<axis dim="1">
<marker
position="100" labelText="MIN"/>
<marker
position="200" labelText="MAX" linePaint="green-20%"/>
</axis>
</axes>
</attributes>
</chart>
<chart>
<data>
<column type="value"
values="100 150 200"/>
</data>
<attributes chartType="column">
<axes>
<axis dim="1">
<marker
position="100" labelText="MIN" linePaint="red-20%"/>
<marker
position="200" labelText="MAX" linePaint="green-20%"/>
<marker
position="after" linePaint="blue-20%"/>
</axis>
</axes>
</attributes>
</chart>
Marker default alignment. If set, it will be used as the default alignment for all marker specific alignment settings for this marker. In particular, the following alignment settings will use this attribute as their default value.
Each listed attribute may later be set individually, overriding this generic setting.
See alignment description.
| <marker alignment="Alignment"/> | |
|---|---|
| center | |
Marker default color. If set, it will be used as the default color for all marker specific color settings for this marker. In particular, the following color settings will use this attribute as their default value.
Each listed attribute may later be set individually, overriding this generic setting.
See color description.
| <marker color="PaintValue"/> | |||||||||
|---|---|---|---|---|---|---|---|---|---|
|
|||||||||
Marker default font. If set, it will be used as the default font for all marker specific font settings within this marker. In particular, the following font settings will gain a new default value.
Each listed attribute may later be set individually, overriding this generic setting.
See font description.
| <marker font="Font"/> | |||||||||
|---|---|---|---|---|---|---|---|---|---|
|
|||||||||
Marker label alignment.
See labelAlignment description.
| <marker labelAlignment="Alignment"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| exception |
|
Only 'inside' and 'outside' values are implemented for pie charts. |
||||
| unsupported |
|
These charts do not support alignment attribute. |
Marker label color.
See labelColor description.
| <marker labelColor="PaintValue"/> | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||||||||||
Marker label font.
See labelFont description.
| <marker labelFont="Font"/> | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||||||||||
Marker label background fill color.
See labelPaint description.
| <marker labelPaint="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
Marker label orientation.
Please note that this is a marker specific attribute that does not inherit it's value from anywhere, and is therefore unaffected in particular by any axis value label rotation attributes.
See labelRotation description.
| <marker labelRotation="Degrees"/> | |
|---|---|
| 0 | |
| Note | Affects | Description | |||||
|---|---|---|---|---|---|---|---|
| unsupported |
|
These chart types do not draw axes or labels along them, so they do just ignore this setting. |
|||||
| unsupported |
|
These chart types do draw axes or labels along them, but they do not support labelRotation attribute at the moment. |
|||||
| unsupported |
|
Table chart does not support labelRotation attribute. |
Marker label text. The label of a marker will reside next to the labels of the axis that this marker intersects.
See labelText description.
| <marker labelText="Text"/> | |
|---|---|
| NULL | |
Marker line color. This line consists of a line perpendicular to the marker's axis, and crossing the axis at the point given by the value of a position attribute.
See lineColor description.
| <marker lineColor="PaintValue"/> | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||||||||||
| Note | Affects | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not adjance data points with lines and thus ignore this setting. |
Paint for the area designated by the marker. This paint will be applied to the area before the value of the position of this marker. Area until the position of the previous marker, if any, in the axis will be affected.
See linePaint description.
| <marker linePaint="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not adjance data points with lines and thus ignore this setting. |
Marker line width and style. This setting affects the line that crosses the axis at the value given by the position attribute of this marker.
See lineStroke description.
| <marker lineStroke="Stroke"/> | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||||||||||
| Note | Affects | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not adjance data points with lines and thus ignore this setting. |
|||||||||||||
| exception |
|
Only width setting is supported. |
Marker default paint. If set, it will be used as the default paint for all marker specific paint settings for this marker. In particular, the following paint settings will use this attribute as their default value.
Each listed attribute may later be set individually, overriding this generic setting.
If this attribute is not set, the default values for the attributes listed above are taken from different axis attributes. See their documentation for defaulting details.
See paint description.
| <marker paint="PaintValue"/> | |
|---|---|
| NULL | |
Symbol edge color. The edges of the symbol of the marker are painted with this color.
See pointColor description.
| <marker pointColor="PaintValue"/> | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||||||||||
| Note | Affects | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts ignore this setting. |
|||||||||
| exception |
|
The default value for these charts is "default". |
|||||||||
| exception |
|
These charts support shapes defined in marker tag. |
Symbol interior color. The interior of the symbol of the marker is painted with this color.
See pointPaint description.
| <marker pointPaint="PaintValue"/> | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||
| Note | Affects | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts ignore this setting. |
||||||||||
| exception |
|
The default value for these charts is "default". |
||||||||||
| exception |
|
The default value for this chart is "white,black". |
||||||||||
| exception |
|
These charts support shapes defined in marker tag. |
Symbol shape. The symbol of the marker has this shape.
See pointShape description.
| <marker pointShape="Shape"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support custom shapes and thus they ignore this setting. |
||||||||||||||
| exception |
|
These charts support shapes defined in marker tag. |
Symbol edge line width and style. The edges of the symbol of the marker are rendered with this stroke.
See pointStroke description.
| <marker pointStroke="Stroke"/> | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|||||||||||||||||||||
| Note | Affects | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts ignore this setting. |
|||||||||
| exception |
|
These charts support shapes defined in marker tag. |
Marker position. This marker line will intersect this axis at this position.
See position description.
| <marker position="Position"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| exception |
|
When the value of the position is The position of |
||||||||||
| unsupported |
|
These charts do not support position attribute on an axis (on axes, axis and marker tags.) |
Sets default shape for the pointShape attribute.
See shape description.
| <marker shape="Shape"/> | |
|---|---|
| tic mark | |
| Note | Affects | Description | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support shapes in any form and thus they ignore this setting. |
|||||||||||
| exception |
|
These charts support only shapes defined in marker tag. |
Default line width and style for this marker. If set, it will be used as the default for all marker specific line width and style settings for this marker. In particular, the following marker line width and style settings will use this attribute as their default value.
Each listed attribute may later be set individually, overriding this generic setting.
If this attribute is not set, the default values for the attributes listed above are taken from different axis attributes. See their documentation for defaulting details.
See stroke description.
| <marker stroke="Stroke"/> | |
|---|---|
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| exception |
|
Only width setting is supported. |
[toc] [elements] [attributes] [types]
<memoryBuffer> |
|
| {<bean/>} | |
| {<collection/>} | |
| {<column/>} | |
| {<csv/>} | |
| {<group/>} | |
| {<movingAverage/>} | |
| {<pivot/>} | |
| {<sort/>} | |
| {<sql/>} | |
| {<xpath/>} | |
</memoryBuffer> |
|
Memory buffer data source can be used to cache incoming data stream to the memory. This can be useful, for example, when training a SOM map.
[toc] [elements] [attributes] [types]
<movAvgColumn |
||
column="Text" | ID of the input column to be selected as the source. | |
id="Id" | ID for the output column. | |
[name="Text"] | Name for the output column. | |
[type="ColumnType"] | Type for the output column. | |
> |
||
</movAvgColumn> |
||
This element is used to identify the column for which the average is calculated and to define the properties of the output column. Basically, one should select one column from the input data by column attribute.
If the given id is the same as of one of the input data series ids, then the matched input data series is replaced by the moving average in the output data. Otherwise, all input data series are present in the output data and a new column for moving average is added to the output data.
ID of the input column to be selected as the source.
See column description.
| <movAvgColumn column="Text"/> | |
|---|---|
| NULL | |
ID for the output column.
See id description.
| <movAvgColumn id="Id"/> | |
|---|---|
| NULL | |
Name for the output column. If the name is not specified, the output column will be named as:
mov.avg. for + 'input column name', if the name for the input column is specified in the incoming
datamov.avg. for + 'input column id', otherwiseSee name description.
| <movAvgColumn name="Text"/> | |
|---|---|
| mov.avg. for <input column name> mov.avg. for <input column id> |
|
Type for the output column.
See type description.
| <movAvgColumn type="ColumnType"/> | |
|---|---|
| NULL | |
[toc] [elements] [attributes] [types]
<movingAverage |
||
[period="PositiveInteger"] | Length of an average period. | |
[avgType="AverageType"] | Type of moving average. | |
> |
||
| [<movAvgColumn/>] | ||
| <bean/> | | ||
| <collection/> | | ||
| <csv/> | | ||
| <movingAverage/> | | ||
| <pivot/> | | ||
| <sort/> | | ||
| <sql/> | | ||
| <xpath/> | ||
</movingAverage> |
||
With moving average element one can calculate simple and exponential moving averages from incoming data.
Simple moving average (SMA) is calculated by taking a group that has
a length of period values from incoming data, summing the values together
and dividing the sum by the number of values. The next SMA value is calculated
by skipping the first incoming data value and taking the next group of values
from which the SMA is calculated. Up to the first
period-1 output values are undefined and set to
null.
Exponential moving average (EMA) adjusts the previous exponential moving average value by a certain fraction of the current value. For example, EMA for given time t from input Data can be calculated as follows:
EMA[t] = ( (Data[t] - EMA[t-1] ) x Multiplier) + EMA[t-1]
where Multiplier is defined as:
Multiplier = 2 / (1 + period)
Thus the longer the period is the slower EMA is
to adjust.
The first period-1 EMAs are not defined and are
set to null.
EMA[period] is calculated using
SMA[period].
Missing null values are treated as follows: In
SMA case, those values are not added to the sum and also the divisor is
reduced by one. If all the values in the last group are
null, then SMA is given a value of
null. In EMA case,
null values are just ignored and EMA stays
the same as it was for the previous calculation.
Averaging calculation is done by selecting one incoming column, which will produce one extra outgoing column to the output data.
When using moving average element one should define at least the
period for
calculating average, and incoming data source. As a default simple moving
average will be calculated. The first input data column of
value type is
selected unless the column for the average is specified with
movAvgColumn. Output
data will usually contain as many columns as the incoming
data, plus one containing the output of the operation.
<movingAverage period="4"/>
<sql source="..." query="..."/>
<movingAverage/>
<movingAverage avgType="exponential" period="3"/>
<movAvgColumn column="price" id="avgprice" name="EMA(price)"
/>
<csv url="...">
<movingAverage/>
Length of an average period. For simple moving average this determines number of data values used for determining average value. For exponential moving average period affects how quickly average reacts to trend changes. The longer the period, the slower the exponential average is to adjust.
See period description.
| <movingAverage period="PositiveInteger"/> | |
|---|---|
| 5 | |
Type of moving average.
See avgType description.
| <movingAverage avgType="AverageType"/> | |
|---|---|
| simple | |
[toc] [elements] [attributes] [types]
<normalize |
||
[weightsFrom="DataValue"] | Input SOM map. | |
> |
||
| {<normalizeColumn/>} | ||
| <bean/> | | ||
| <collection/> | | ||
| <csv/> | | ||
| <movingAverage/> | | ||
| <pivot/> | | ||
| <sort/> | | ||
| <sql/> | | ||
| <xpath/> | ||
</normalize> |
||
This datasource can be used to normalize numeric input data. Normalization is done columnwise, by removin average and dividing by standard deviation. Purpose of this operation is to make all columns of equal weight, when euclidiean distance between datavectors is calculated. For example, when training SOM maps, it is often advisable to normalize input data.
As a default, all the input data columns of numeric format are normalized. Other data, such as labels, are passed through as is.
One can select only some of the input data columns. This can be done by introducing each imported column by normalizeColumn elements.
Each of the imported columns can be given a scalar weigth. After normalization is done, each element belonging to this column are multiplied by this factor. If the weight is negative, then normalization is omitted and the column is passed through as is.
Normalization can be reveserd. Meta information is attached to all normalized data.
<normalize>
<csv> ... </csv>
</normalize>
<normalize>
<csv> ... </csv>
<normalizeColumn column="colA" weight="2">
<normalizeColumn column="colB" >
<normalizeColumn column="label" weight="-1">
</normalize>
Input SOM map. If this input SOM map contains normalization information, it is used instead of normalization information derived from input data.
See weightsFrom description.
| <normalize weightsFrom="DataValue"/> | |
|---|---|
| NULL | |
[toc] [elements] [attributes] [types]
<normalizeColumn |
||
[column="Text"] | ID of the input column to be selected from the result set. | |
[weight="DataValue"] | This column is weighted by multiplying by this weight after normalization. | |
> |
||
</normalizeColumn> |
||
If any normalizeColumns have been defined, then only identified columns are imported. If columns are not given, all input data columns are subject to normalization operation.
ID of the input column to be selected from the result set.
See column description.
| <normalizeColumn column="Text"/> | |
|---|---|
| NULL | |
This column is weighted by multiplying by this weight after normalization. The default weight value is 1. If weight is given a negative value, then this column is passed through as is, without normalization. Negative weights can be used to include labels, for example.
See weight description.
| <normalizeColumn weight="DataValue"/> | |
|---|---|
| NULL | |
[toc] [elements] [attributes] [types]
<paintPoint |
||
[interpolationMode="InterpolationMode"] | Determines whether interpolation is used for this point in determining a paint for rendering a data value. | |
[legendFormat="LegendFormat"] | Legend entry text format. | |
[minPaint="ColorValue"] | Determines the paint of the lower end of this point. | |
paint="PaintValue" | Determines the paint of the upper end of this point. | |
position="Position" | Determines the position of this point in a paint scale. | |
[positionType="PositionType"] | Interpretation type for position. | |
> |
||
</paintPoint> |
||
Each paint point defines a point in a paint scale. The value of the point is defined by the position and positionType attributes.
When a data value is rendered, a possible value attached to the data value with a paint channel is compared to the values of paint points. The paint point that has the smallest value that is greater than or equal to the value attached to a data value is selected. Therefore, there is a certain range of values attached to data values that correspond to the same paint point. The maximum value of this range, which happens to be the value of the point itself, is considered to be the upper end of the point. The minimum value of this range, which is a value that is just a little bit greater than the value of the previous point, is considered to be the lower end of the point. The previous point is the point with a value that is the greatest of those points that have a value that is smaller than the value of this point.
Depending from the chart, the paint(s) of the selected paint point may be used in the rendering of the data value.
Determines whether interpolation is used for this point in determining a paint for rendering a data value.
See interpolationMode description.
| <paintPoint interpolationMode="InterpolationMode"/> | |||||
|---|---|---|---|---|---|
|
|||||
Legend entry text format.
See legendFormat description.
| <paintPoint legendFormat="LegendFormat"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |
|---|---|---|---|
| note |
|
Only scale legend types support legendFormat. |
Determines the paint of the lower end of this point. This paint is used only if interpolationMode attribute has been defined for this point.
See minPaint description.
| <paintPoint minPaint="ColorValue"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support minPaint setting in plot tag. |
Determines the paint of the upper end of this point. If the minPaint and interpolationMode attributes are not defined, this paint is used for the whole range of values that correspond to this point.
See paint description.
| <paintPoint paint="PaintValue"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| exception |
|
If the minPaint and interpolationMode attributes are defined, the type of this paint is ColorValue, not PaintValue. |
Determines the position of this point in a paint scale.
See position description.
| <paintPoint position="Position"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support position attribute on an axis (on axes, axis and marker tags.) |
Interpretation type for position.
See positionType description.
| <paintPoint positionType="PositionType"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| note |
|
If the position type is set to |
[toc] [elements] [attributes] [types]
<paintScale |
||
[interpolationMode="InterpolationMode"] | Provides default interpolation mode for the points of this scale. | |
[legendFormat="LegendFormat"] | Legend entry text format. | |
> |
||
| {<paintPoint/>} | ||
</paintScale> |
||
Paint scale defines how the values of paint channels should be used for rendering the chart. Each paint scale is composed of a number of paint points. The paint points that are collected to a paint scale define a sequence of paints that are used for rendering the chart. The sequence can be continuous and cover all values in paint channels or the sequence can have gaps for which no visible paint is defined.
Provides default interpolation mode for the points of this scale.
See interpolationMode description.
| <paintScale interpolationMode="InterpolationMode"/> | |
|---|---|
| NULL | |
Legend entry text format.
See legendFormat description.
| <paintScale legendFormat="LegendFormat"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| note |
|
Only scale legend types support legendFormat. |
[toc] [elements] [attributes] [types]
<pivot> |
|
| [<pivotCategories/>] | |
| [<pivotSeries/>] | |
| [<pivotValues/>] | |
| <bean/> | | |
| <collection/> | | |
| <csv/> | | |
| <movingAverage/> | | |
| <pivot/> | | |
| <sort/> | | |
| <sql/> | | |
| <xpath/> | |
</pivot> |
|
Assume that one has collected transaction data similar to:
and one would like to see graph of weekly sales generated by different
tools. Required data manipulation can be performed by pivot operation.
..time..|.tool.|.price
--------+------+-------
01.01.03|hammer| 1
01.02.03|knife | 4
01.05.03|hammer| 2
01.09.03|wedge | 5
01.10.03|knife | 2
....
First one should define input data source from which data is coming. Pivot
can handle many different data sources.
One should configure the pivot so that <pivotCategories> is linked
with time (with a precision of a week),
<pivotSeries> with tool and
<pivotValues> with price.
A possible pivot configuration might look like:
<pivot>
<pivotCategories column="time" step="week"/>
<pivotSeries column="tool" />
<pivotValues column="price" function="sum"/>
<sql source="jdbc:..." query="select * from
transactiontable"/>
</pivot>
Pivot operation will aggregate all pivot series within one pivot categories (all similar tools sold within one week) and determine value for this class. The value determination depends on the pivot value(s) and function selected (such as sum or count).
As a result one will get datastream similar to:
..week..|hammer| knife|wedge
--------+------+------+------
01.01.03|..18..|..8...|.14
01.08.03|..11..|..3...|.24
01.15.03|...5..|.13...|.12
01.22.03|..21..|..4...|..6
....
Data in the format above can be feeded, for example, to a column chart, to get graph of weekly sales generated by different tools.
The number of resulting data columns from pivot operation is not
necessarily known before the operation. Even if the number of data columns
were known, the column given for the pivot operation in the
pivotSeries tag is
not usually enough to be the column id of the resulting data columns. Due to
these reasons, the resulting data columns, which are of
value
type, are identified with ids of column for pivotSeries +
running numbering starting from 0. For example, if the
configuration for pivot operation is:
...
the resulting column ids after pivot operation will be:
<pivotSeries column="tool"/>
...
tool0
tool1
tool2
...
The resulting column ids can be used for further purposes. For example, the
column with which sort data source
will sort given data can be identified with a column id that the pivot data
source has generated.
It is possible to omit <pivotSeries>, <pivotCategories> and <pivotValues> configuration elements. Omitting:
series0.
label column will be selected as the category
column.
value column is selected.
[toc] [elements] [attributes] [types]
<pivotCategories |
||
column="Text" | Column defines which input data source column is associated with pivot categories. | |
[dataFormat="DataFormat"] | Input data values format. | |
[descending="Boolean"] | Determines if the sorting order of category labels is descending. | |
[includeNulls="Boolean"] | Determines whether null values in the pivot category column in the incoming data are accepted. | |
[max="DataValue"] | Maximum value for category labels. | |
[min="DataValue"] | Minimum value for category labels. | |
[step="DataValue"] | Defines aggregating of categories. | |
> |
||
</pivotCategories> |
||
PivotCategories define input data column to be associated with one of the axis. Pivot operation determines values for category label and series name pairs. See the documentation of pivot element for an example.
A typical example is a column chart displaying value of products sold in different dates. Here products are associated with series names and dates with category labels. Column chart would display category labels on x-axis and value of different products in y-axis. Each pair of a series name and a category label would have a column in the chart unless the value for the pair would be zero.
Column defines which input data source column is associated with pivot categories. The value of the attribute should match with the id of an input data column.
See column description.
| <pivotCategories column="Text"/> | |
|---|---|
| NULL | |
Input data values format.
See dataFormat description.
| <pivotCategories dataFormat="DataFormat"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| note |
|
For other charts but |
|
| supported |
|
Transforming a data value to a user readable text is supported only
by |
Determines if the sorting order of category labels is descending.
When ordering is done, the position of
null values is after
non null values no matter which ordering is chosen.
See descending description.
| <pivotCategories descending="Boolean"/> | |
|---|---|
| false | |
Determines whether null values
in the pivot category column in the incoming
data are accepted. If this attribute is given a
true value, then these data tuples are
included.
If null data values are accepted, a separate
null category label is created
for null data values in
pivot category column. This category with a
null label is
served as the last category in the resulting data stream.
See includeNulls description.
| <pivotCategories includeNulls="Boolean"/> | |
|---|---|
| false | |
Maximum value for category labels. Only category labels that are smaller than
or equal to this maximum value are accepted. Thus if the column of
category label in incoming data tuple
contains a data value greater than the maximum value, the incoming data
tuple is ignored.
See max description.
| <pivotCategories max="DataValue"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| unsupported |
|
Table chart shows all data values. Therefore, the chart ignores this attribute. |
Minimum value for category labels. Only category labels that are greater than
or equal to this minimum value are accepted. Thus if the column of
category label in incoming data tuple
contains a data value smaller than the minimum value, the incoming data
tuple is ignored.
See min description.
| <pivotCategories min="DataValue"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| unsupported |
|
Table chart shows all data values. Therefore, the chart ignores this attribute. |
Defines aggregating of categories. All the categories belonging within this step are joined together.
For example, assume that the data type of categories is
date. One could then define step to be a
week. All dates belonging to the same week
are joined together. Aggregated categories will be named by the
starting date of a week.
See step description.
| <pivotCategories step="DataValue"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| unsupported |
|
Table chart does not use units when drawing axes. Therefore, this attribute is ignored. |
[toc] [elements] [attributes] [types]
<pivotSeries |
||
column="Text" | Defines which input data source column is associated with pivot series. | |
[dataFormat="DataFormat"] | Input data values format. | |
[descending="Boolean"] | Determines if the sorting order of series names is descending. | |
[includeNulls="Boolean"] | Should null series names data be accepted. | |
[max="DataValue"] | Maximum value for series names. | |
[min="DataValue"] | Minimum value for series names. | |
[step="DataValue"] | Defines aggregating of series names. | |
> |
||
</pivotSeries> |
||
PivotSeries define which input data column is associated with pivot series. See pivot tag description.
Defines which input data source column is associated with pivot series. Column value should match the id of an input column.
See column description.
| <pivotSeries column="Text"/> | |
|---|---|
| NULL | |
Input data values format.
See dataFormat description.
| <pivotSeries dataFormat="DataFormat"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| note |
|
For other charts but |
|
| supported |
|
Transforming a data value to a user readable text is supported only
by |
Determines if the sorting order of series names is descending.
When ordering is done, the position of
null values is after
non null values no matter which ordering is
chosen.
See descending description.
| <pivotSeries descending="Boolean"/> | |
|---|---|
| false | |
Should null series names data be accepted. It
is possible that incoming data has null
(i.e. missing) value in the column of
pivot series. If this attribute is given a
true value, then these kind of data tuples
are included.
If null data values are accepted, a separate
null series name is created
for null data values in
series name column.
See includeNulls description.
| <pivotSeries includeNulls="Boolean"/> | |
|---|---|
| false | |
Maximum value for series names. Only series names that are smaller or equal to
this maximum value are accepted. Thus if the column of
series name in incoming data tuple
contains a data value greater than the maximum value, the incoming data
tuple is ignored.
See max description.
| <pivotSeries max="DataValue"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| unsupported |
|
Table chart shows all data values. Therefore, the chart ignores this attribute. |
Minimum value for series names. Only series names that are greater or equal
to this minimum value are accepted. Thus if the column of
series name in incoming data tuple
contains a data value smaller than the minimum value, the incoming data
tuple is ignored.
See min description.
| <pivotSeries min="DataValue"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| unsupported |
|
Table chart shows all data values. Therefore, the chart ignores this attribute. |
Defines aggregating of series names. All the series names belonging within this step are joined together.
See step description.
| <pivotSeries step="DataValue"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| unsupported |
|
Table chart does not use units when drawing axes. Therefore, this attribute is ignored. |
[toc] [elements] [attributes] [types]
<pivotValues |
||
column="Text" | Defines which input data source column is associated with pivot values. | |
[function="Function"] | Defines the function to be used to join series values. | |
> |
||
</pivotValues> |
||
PivotValues defines which input data column is asssociated with pivot values. See pivot tag description for a description.
Defines which input data source column is associated with pivot values. The value of the attribute should match the id of a column in input data.
See column description.
| <pivotValues column="Text"/> | |
|---|---|
| NULL | |
Defines the function to be used to join series values. In pivoting, each category - series pair will be assigned a value. All pivot values belonging to the same category - series name class are joined using this function.
See function description.
| <pivotValues function="Function"/> | |
|---|---|
| sum | |
[toc] [elements] [attributes] [types]
<plot |
||
[alignment="Alignment"] | Defines default generic alignment for plot tag. | |
[backPaint="PaintValue"] | Backgrounds of data cells are painted with this color. | |
[color="PaintValue"] | Defines default generic color for plot. | |
[dataFormat="DataFormat"] | Output format of the data values. | |
[enclose="Boolean"] | Controls if symbols are enclosed within plotting area. | |
[font="Font"] | Defines default generic font for plot. | |
[lineAlignment="LineAlignment"] | Border line alignment. | |
[lineColor="PaintValue"] | Line color for data elements. | |
[linePaint="PaintValue"] | Line fill color for data elements. | |
[lineSmoothness="Percentage"] | Defines smoothness of curve joining data points. | |
[lineStroke="Stroke"] | Line width and style for data elements. | |
[maxColor="ColorValue"] | Upper color of draw color range for magnitude visualization. | |
[maxPaint="ColorValue"] | Upper color of fill paint range for magnitude visualization. | |
[maxSize="Scale"] | Upper size of size range for magnitude visualization. | |
[minColor="ColorValue"] | Lower color of draw color range for magnitude visualization. | |
[minPaint="ColorValue"] | Lower color of fill paint range for magnitude visualization. | |
[minSize="Scale"] | Lower size of size range for magnitude visualization. | |
[paint="PaintValue"] | Plot default paint. | |
[pointColor="PaintValue"] | Symbol edge color. | |
[pointPaint="PaintValue"] | Symbol interior color. | |
[pointShape="Shape"] | Symbol shape. | |
[pointStroke="Stroke"] | Symbol edge line width and style. | |
[shape="Shape"] | Defines default generic shape for plot. | |
[stroke="Stroke"] | Default plot line width and style. | |
[valueAlignment="Alignment"] | Value label alignment. | |
[valueColor="PaintValue"] | Value label text color. | |
[valueFont="Font"] | Value label text font size and style. | |
[valueFormat="MessageFormat"] | Value label text format. | |
[valuePaint="PaintValue"] | Value label background fill color. | |
> |
||
| {<annotation/>} | ||
| [<colorScale/>] | ||
| [<paintScale/>] | ||
| [<shapeScale/>] | ||
| {<series/>} | ||
</plot> |
||
This tag defines plot area rendering attributes. The plot area is where anything related to a chart is drawn. The plot area resides over and is a subset of chart background area, while chart axis area, if there is one, resides over and is a subset of the plot area. In general, anything drawn on a chart image uses plot area attributes, unless a more specific attribute definition for the item being drawn is in effect.
Plot area attributes are defined within <attributes/> tag, and again in <axes/> tags. Any plot attribute not given within <axes/> tag inherit it's value from the general plot attributes.
<plot paint="red-vertical" color="black" stroke="2"/>
Defines default generic alignment for plot tag. If set, it will be used as the default alignment for all plot specific alignment settings. In particular, the following alignment settings will gain a new default value.
Each listed attribute may later be set individually, overriding this generic setting.
See alignment description.
| <plot alignment="Alignment"/> | |
|---|---|
| center (line and scatter charts) | inside (pie and map charts) | outside (bar and column charts) | |
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support alignment attribute. |
Backgrounds of data cells are painted with this color.
See backPaint description.
| <plot backPaint="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |
|---|---|---|---|
| supported |
|
Only table chart supports back paint for series. |
Defines default generic color for plot. If set, it will be used as the default color for all plot specific color settings. In particular, the following color settings will gain a new default value.
Each listed attribute may later be set individually, overriding this generic setting.
See color description.
| <plot color="PaintValue"/> | |
|---|---|
| default (lineColor for line and scatter charts with multiseriesmode) | default (pointColor for line and scatter charts) | black (otherwise) | |
Output format of the data values.
See dataFormat description.
| <plot dataFormat="DataFormat"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |
|---|---|---|---|
| note |
|
For other charts but |
|
| supported |
|
Transforming a data value to a user readable text is supported only
by |
Controls if symbols are enclosed within plotting area.
See enclose description.
| <plot enclose="Boolean"/> | |
|---|---|
| true | |
| Note | Affects | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support shapes. Therefore, enclose attribute is not supported. |
|||||||||
| unsupported |
|
These charts do not support enclosing. |
Defines default generic font for plot. If set, it will be used as the default font for all plot specific font settings. In particular, the following font settings will gain a new default value.
Each listed attribute may later be set individually, overriding this generic setting.
See font description.
| <plot font="Font"/> | |
|---|---|
| Serif-12 | |
Border line alignment.
See lineAlignment description.
| <plot lineAlignment="LineAlignment"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |
|---|---|---|---|
| note |
|
Although lineAlignment takes it's default from an alignment attribute, most of the values that the alignment attribute may have are not supported by lineAlignment. Such values are ignored and the default lineAlignment value is used. |
|
| supported |
|
Only map chart supports line alignment. Other charts do not draw multiple areas suitable for borders. |
Line color for data elements. Borders of data elements will be drawn with this color where applicable.
See lineColor description.
| <plot lineColor="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not adjance data points with lines and thus ignore this setting. |
Line fill color for data elements. Interior of data elements will be painted with this color where applicable.
See linePaint description.
| <plot linePaint="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not adjance data points with lines and thus ignore this setting. |
Defines smoothness of curve joining data points.
See lineSmoothness description.
| <plot lineSmoothness="Percentage"/> | |
|---|---|
| 0 | |
| Note | Affects | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| supported |
| These charts do not support lineSmoothness with pseudo 3D. | |||||||||||||||
| unsupported |
|
These charts do not support lineSmoothness. |
Line width and style for data elements. Borders of data elements will be drawn with this stroke where applicable.
See lineStroke description.
| <plot lineStroke="Stroke"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not adjance data points with lines and thus ignore this setting. |
|||||||||||||
| exception |
|
Only width setting is supported. |
Upper color of draw color range for magnitude visualization.
See maxColor description.
| <plot maxColor="ColorValue"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support maxColor setting. |
Upper color of fill paint range for magnitude visualization.
See maxPaint description.
| <plot maxPaint="ColorValue"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support maxPaint setting. |
Upper size of size range for magnitude visualization.
See maxSize description.
| <plot maxSize="Scale"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support such shapes that can be affected with
|
Lower color of draw color range for magnitude visualization.
See minColor description.
| <plot minColor="ColorValue"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support minColor setting in plot tag. |
Lower color of fill paint range for magnitude visualization.
See minPaint description.
| <plot minPaint="ColorValue"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support minPaint setting in plot tag. |
Lower size of size range for magnitude visualization.
See minSize description.
| <plot minSize="Scale"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support such shapes that can be affected with
|
Plot default paint. If set, it will be used as the default paint for the following plot specific paint settings. In particular, the valuePaint setting will not use this attribute as it's default value.
Each listed attribute may later be set individually, overriding this generic setting.
See paint description.
| <plot paint="PaintValue"/> | |
|---|---|
| default (for 3d charts) | default (pointPaint for bar, column, line, pie and scatter charts) | default (linePaint for area chart) | NULL (otherwise) | |
Symbol edge color. This attribute provides the default edge color for symbols of data points.
See pointColor description.
| <plot pointColor="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts ignore this setting. |
|||||||||
| exception |
|
The default value for these charts is "default". |
|||||||||
| exception |
|
These charts support shapes defined in marker tag. |
Symbol interior color. This attribute provides the default interior color for symbols of data points.
See pointPaint description.
| <plot pointPaint="PaintValue"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts ignore this setting. |
||||||||||
| exception |
|
The default value for these charts is "default". |
||||||||||
| exception |
|
The default value for this chart is "white,black". |
||||||||||
| exception |
|
These charts support shapes defined in marker tag. |
Symbol shape. This attribute provides the default shape for symbols of data points.
See pointShape description.
| <plot pointShape="Shape"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts do not support custom shapes and thus they ignore this setting. |
||||||||||||||
| exception |
|
These charts support shapes defined in marker tag. |
Symbol edge line width and style. This attribute provides the default stroke for symbols of data points.
See pointStroke description.
| <plot pointStroke="Stroke"/> | |||||
|---|---|---|---|---|---|
|
|||||
| Note | Affects | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| unsupported |
|
These charts ignore this setting. |
|||||||||
| exception |
|
These charts support shapes defined in marker tag. |
Defines default generic shape for plot. If set, it will be used as the default shape for all plot specific shape settings. In particular, the following shape settings will gain a new default value.
Each listed attribute may later be set individually, overriding this generic setting.
See shape description.
| <plot shape="Shape"/> | |
|---|---|
| NULL | |
| Note | Affects | Description | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| exception |
|
These charts recognise shapes "col1" to "col7". Each shape defines different roundedness for the column. As a default, "col3" shape is used. |
|||||||||||
| unsupported |
|
These charts do not support shapes in any form and thus they ignore this setting. |
|||||||||||
| exception |
|
These charts support only shapes defined in marker tag. |
Default plot line width and style. If set, it will be used as the default for all plot specific line width and style settings. In particular, the following line width and style settings will use this attribute as their default value.
Each listed attribute may later be set individually, overriding this generic setting.
See stroke description.
| <plot stroke="Stroke"/> | |
|---|---|
| (solid-)1 | |
| Note | Affects | Description | ||||
|---|---|---|---|---|---|---|
| exception |
|
Only width setting is supported. |
||||
| unsupported |
|
Table chart does not render any plot specific lines and thus ignores this setting. |
||||
| exception |
|
Only width setting is support |