XML Reference

Table of Contents

XML Elements

• annotation
• area
• attr
• attributes
• axes
• axis
• bean
• beanColumn
• beanGroup
• cell
• chart
• collection
• collectionColumn
• collectionGroup
• colorPoint
• colorScale
• column
• csv
• csvColumn
• csvGroup
• data
• directional
• e
• element
• group
• image
• init
• label
• legend
• lighting
• marker
• memoryBuffer
• movAvgColumn
• movingAverage
• normalize
• normalizeColumn
• paintPoint
• paintScale
• pivot
• pivotCategories
• pivotSeries
• pivotValues
• plot
• series
• shapePoint
• shapeScale
• som
• somCellFilter
• sort
• sortColumns
• sortRows
• sql
• sqlColumn
• sqlGroup
• text
• train
• xpath
• xpathColumn
• xpathGroup

XML Attributes

• alignment
• alpha
• alphaCalc
• ambientColor
• angle
• antialiasMode
• avgType
• axisColor
• axisStroke
• backColor
• backPaint
• backStroke
• byColumn
• chartType
• clearLabels
• color
• column
• commentChar
• contentType
• cumulative
• dataFormat
• dataGroup
• dataType
• descending
• dim
• direction
• enclose
• eval
• firstDataRow
• font
• function
• gap
• gridColor
• gridLines
• gridStroke
• group
• height
• hidden
• href
• id
• idRef
• imageParams
• includeNulls
• initializer
• interpolationMode
• labelAlignment
• labelColor
• labelFont
• labelFormat
• labelOffset
• labelPaint
• labelRotation
• labelText
• legendAlignment
• legendFormat
• legendType
• lightColor
• lineAlignment
• lineColor
• linePaint
• lineSmoothness
• lineStroke
• locale
• margin
• marginBottom
• marginLeft
• marginRight
• marginTop
• markerOffset
• max
• maxColor
• maxPaint
• maxSize
• min
• minColor
• minPaint
• minSize
• multiseriesMode
• name
• namespace
• namesRow
• neighborhood
• nullMarker
• opposite
• orientation
• paint
• period
• pointColor
• pointPaint
• pointShape
• pointStroke
• position
• positionType
• propertyName
• query
• quotationChar
• radius
• radiusCalc
• resolution
• reversed
• rounds
• seed
• select
• separator
• separatorChar
• shape
• silent
• source
• sqlColumnIndex
• sqlColumnName
• step
• stroke
• subChartType
• ticColor
• ticStroke
• titleAlignment
• titleColor
• titleFont
• titleOffset
• titleRotation
• titleText
• topology
• type
• urlContext
• value
• valueAlignment
• valueColor
• valueFont
• valueFormat
• valuePaint
• values
• weight
• weightsFrom
• width
• x
• y

XML Attribute Types

• Alignment
• AntialiasMode
• AverageType
• Boolean
• ChartType
• ColorValue
• ColumnIndex
• ColumnType
• ContentType
• DataFormat
• DataType
• DataValue
• Degrees
• Dim
• Direction
• Font
• Function
• GroupType
• Id
• IdRef
• ImageParams
• InterpolationMode
• LegendAlignment
• LegendFormat
• LegendType
• LineAlignment
• Locale
• Margin
• MarginString
• MessageFormat
• Orientation
• PaintValue
• Percentage
• Position
• PositionType
• PositiveFloat
• PositiveInteger
• PrintableCharacter
• Resolution
• Scale
• Separator
• Shape
• Size
• SolidColorValue
• Source
• SOMInitializer
• SOMNeighborhood
• SOMStepFunction
• SOMTopology
• Stroke
• SubChartType
• Text
• TitleAlignment
• Url
• Values
• XPath

XML elements

• annotation
• area
• attr
• attributes
• axes
• axis
• bean
• beanColumn
• beanGroup
• cell
• chart
• collection
• collectionColumn
• collectionGroup
• colorPoint
• colorScale
• column
• csv
• csvColumn
• csvGroup
• data
• directional
• e
• element
• group
• image
• init
• label
• legend
• lighting
• marker
• memoryBuffer
• movAvgColumn
• movingAverage
• normalize
• normalizeColumn
• paintPoint
• paintScale
• pivot
• pivotCategories
• pivotSeries
• pivotValues
• plot
• series
• shapePoint
• shapeScale
• som
• somCellFilter
• sort
• sortColumns
• sortRows
• sql
• sqlColumn
• sqlGroup
• text
• train
• xpath
• xpathColumn
• xpathGroup

[toc] [elements] [attributes] [types]

<annotation/>

Element description

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.

Appears in

• plot
• series

Attribute Detail

<annotation href="MessageFormat"/>

Tag specific description

Specifies the action of an annotation.

General description

See href description.

Defaults

[toc] [elements] [attributes] [types]

<area/>

Element description

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.

Examples

<area paint="red-vertical" color="black" stroke="2"/>

Appears in

• attributes

Attribute Detail

<area backColor="PaintValue"/>

Tag specific description

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.

General description

See backColor description.

Defaults

Footnotes

<area backPaint="PaintValue"/>

Tag specific description

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.

General description

See backPaint description.

Defaults

<area backStroke="Stroke"/>

Tag specific description

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.

General description

See backStroke description.

Defaults

Footnotes

<area color="PaintValue"/>

Tag specific description

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.

General description

See color description.

Defaults

<area paint="PaintValue"/>

Tag specific description

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.

General description

See paint description.

Defaults

<area stroke="Stroke"/>

Tag specific description

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.

General description

See stroke description.

Defaults

Footnotes

[toc] [elements] [attributes] [types]

<attr/>

Element description

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:

• coords
• shape

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:

• xlink:href
• xlink:title

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:

• alt
• href

Appears in

• annotation

Attribute Detail

<attr name="Text"/>

Tag specific description

Name of the attribute.

General description

See name description.

Defaults

<attr value="Text"/>

Tag specific description

Value of the attribute.

General description

See value description.

Defaults

[toc] [elements] [attributes] [types]

<attributes/>

Element description

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.

Examples

<attributes id="style1">
   <area color="black" paint="red-vertical" stroke="dot-1"/>
</attributes>

Appears in

• chart

Attribute Detail

<attributes chartType="ChartType"/>

Tag specific description

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.

General description

See chartType description.

Defaults

Footnotes

<attributes id="Id"/>

Tag specific description

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.

General description

See id description.

Defaults

<attributes locale="Locale"/>

Tag specific description

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.

General description

See locale description.

Defaults

Footnotes

<attributes multiseriesMode="Boolean"/>

Tag specific description

Determines the behaviour of palette colors and paints, and legend rendering. Given multiseries mode affects the whole chart.

General description

See multiseriesMode description.

Defaults

Footnotes

<attributes namespace="Text"/>

Tag specific description

Property file for determining areas.

General description

See namespace description.

Defaults

Footnotes

<attributes urlContext="Url"/>

Tag specific description

Base URL address. If defined, relative URL addresses will be evaluated against given base URL address instead of a default one.

General description

See urlContext description.

Defaults

[toc] [elements] [attributes] [types]

<axes/>

Element description

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.

Appears in

• attributes

Attribute Detail

<axes axisColor="PaintValue"/>

Tag specific description

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.

General description

See axisColor description.

Defaults

<axes axisStroke="Stroke"/>

Tag specific description

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.

General description

See axisStroke description.

Defaults

Footnotes

<axes backColor="PaintValue"/>

Tag specific description

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.

General description

See backColor description.

Defaults

Footnotes

<axes backPaint="PaintValue"/>

Tag specific description

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.

General description

See backPaint description.

Defaults

<axes backStroke="Stroke"/>

Tag specific description

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.

General description

See backStroke description.

Defaults

Footnotes

<axes color="PaintValue"/>

Tag specific description

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.

• axisColor
• backColor
• gridColor
• labelColor
• ticColor
• titleColor

Each listed attribute may later be set individually, overriding this generic setting. The values may also be overridden further with axis specific settings.

General description

See color description.

Defaults

Footnotes

<axes dataGroup="Id"/>

Tag specific description

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.

General description

See dataGroup description.

Defaults

Footnotes

<axes font="Font"/>

Tag specific description

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.

• labelFont
• titleFont

Each listed attribute may later be set individually, overriding this generic setting. The values may also be overridden further with axis specific settings.

General description

See font description.

Defaults

<axes gap="Percentage"/>

Tag specific description

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.

General description

See gap description.

Defaults

Footnotes

<axes gridColor="PaintValue"/>

Tag specific description

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.

General description

See gridColor description.

Defaults

<axes gridLines="Boolean"/>

Tag specific description

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.

General description

See gridLines description.

Defaults

Footnotes

<axes gridStroke="Stroke"/>

Tag specific description

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.

General description

See gridStroke description.

Defaults

Footnotes

<axes labelAlignment="Alignment"/>

Tag specific description

Axis label default alignment. All axis labels in this axis group will be aligned like this, unless explicitly set otherwise for some particular axis.

General description

See labelAlignment description.

Defaults

Footnotes

<axes labelColor="PaintValue"/>

Tag specific description

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.

General description

See labelColor description.

Defaults

<axes labelFont="Font"/>

Tag specific description

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.

General description

See labelFont description.

Defaults

<axes labelFormat="DataFormat"/>

Tag specific description

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.

General description

See labelFormat description.

Defaults

Footnotes

<axes labelOffset="Size"/>

Tag specific description

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.

General description

See labelOffset description.

Defaults

Footnotes

<axes labelPaint="PaintValue"/>

Tag specific description

Axis label background paint.

General description

See labelPaint description.

Defaults

Footnotes

<axes labelRotation="Degrees"/>

Tag specific description

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.

General description

See labelRotation description.

Defaults

Footnotes

<axes markerOffset="Size"/>

Tag specific description

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.

General description

See markerOffset description.

Defaults

Footnotes

<axes opposite="Boolean"/>

Tag specific description

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.

General description

See opposite description.

Defaults

Footnotes

<axes paint="PaintValue"/>

Tag specific description

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.

• backPaint
• labelPaint

Each listed attribute may later be set individually, overriding this generic setting. The values may also be overridden further with axis specific settings.

General description

See paint description.

Defaults

<axes position="Position"/>

Tag specific description

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.

General description

See position description.

Defaults

Footnotes

<axes reversed="Boolean"/>

Tag specific description

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.

General description

See reversed description.

Defaults

Footnotes

<axes silent="Boolean"/>

Tag specific description

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.

General description

See silent description.

Defaults

Footnotes

<axes stroke="Stroke"/>

Tag specific description

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.

• axisStroke
• backStroke
• gridStroke
• ticStroke

Each listed attribute may later be set individually, overriding this generic setting. The values may also be overridden further with axis specific settings.

General description

See stroke description.

Defaults

Footnotes

<axes subChartType="SubChartType"/>

Tag specific description

Sub-chart type. Used for defining a sub-chart of this <axes/> tag for charts with sub-chart support.

General description

See subChartType description.

Defaults

Footnotes

<axes ticColor="PaintValue"/>

Tag specific description

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.

General description

See ticColor description.

Defaults

Footnotes

<axes ticStroke="Stroke"/>

Tag specific description

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.

General description

See ticStroke description.

Defaults

Footnotes

<axes titleAlignment="TitleAlignment"/>

Tag specific description

Defines default alignment for axis title. Individual axes may override this setting with <axis/> tag titleAlignment attribute.

General description

See titleAlignment description.

Defaults

Footnotes

<axes titleColor="PaintValue"/>

Tag specific description

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.

General description

See titleColor description.

Defaults

Footnotes

<axes titleFont="Font"/>

Tag specific description

Defines default font for axis title. Individual axes may override this setting with <axis/> tag titleFont attribute.

General description

See titleFont description.

Defaults

Footnotes

<axes titleOffset="Size"/>

Tag specific description

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.

General description

See titleOffset description.

Defaults

Footnotes

<axes titleRotation="Degrees"/>

Tag specific description

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.

General description

See titleRotation description.

Defaults

Footnotes

[toc] [elements] [attributes] [types]

<axis/>

Element description

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 line itself
• axis tic marks
• gridlines perpendicular to the axis
• background area on the "left" side of the axis
• the labels laid along the axis
• a title laid along the axis
• the markers placed on specific axis values

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.

Examples

<axis titleText="X -axis" min="10" max="40" labelFormat=".00"/>
<axis dim="1" titleText="Y -axis"/>
<axis dim="z" backPaint="blue"/>

Appears in

• axes

Attribute Detail

<axis angle="Degrees"/>

Tag specific description

Chart 3D viewpoint orientation angle around this axis.

General description

See angle description.

Defaults

Footnotes

<axis axisColor="PaintValue"/>

Tag specific description

Axis line color.

General description

See axisColor description.

Defaults

<axis axisStroke="Stroke"/>

Tag specific description

Axis line width and style.

General description

See axisStroke description.

Defaults

Footnotes

<axis backColor="PaintValue"/>

Tag specific description

Axis background line color.

General description

See backColor description.

Defaults