categoryplot Element

 

Content

categoryplot Element

Description

Example

Properties

Description

The categoryplot Element configures the Category Chart in Data Entry Page Types.

Example

See Data Trending.

categoryplot Element Properties

Property Name Description
Plot Orientation Orientation for the Plot. Choose Vertical or Horizontal.
Series Group Rendering Order Sets the rendering order of series groups. Choose Reverse or Forward.
Series Rendering Order Sets the rendering order of series. Choose Ascending or Descending.
Range Grid Line Paint Paint for the grid lines plotted against the range axis.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorColors in the default sRGB color space. Choose the name of color from a list of values or arbitrary color defined by its hex code (must start with # or 0x).
Range Grid Line Stroke Stroke for the grid lines plotted against the range axis.
Property NameDescription
StrokeChoose the Stroke. Choose Solid, Short Dash, Long Dash, Dotted or Mixed Dash
Stroke WidthThe Stroke Width. Choose Bold, Standard or Light. Default is Standard.
Range Grid Line Visible Whether or not the range axis grid lines are visible.
Domain Grid Line Paint Paint for the grid lines plotted against the domain axis.
Property NameDescription
Paint TypeDefines the type of paint to use.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorColors in the default sRGB color space. Choose the name of the color from a list of values or arbitrary color defined by its hex code (must start with # or 0x).
Domain Grid Line Stroke Stroke for the grid lines plotted against the domain axis.
Property NameDescription
StrokeChoose Solid, Short Dash, Long Dash, Dotted or Mixed Dash
Stroke WidthThe Stroke Width. Choose Bold, Standard or Light. Default is Standard.
Domain Grid Line Visible Whether or not the Grid Line is visible.
Domain Axes Collection containing all domain axes to draw. Series groups can be mapped to show their data on specified axis.
Property NameDescription
Domain Axis IDIdentifier for axis. Series groups can be mapped to axis using this ID. This identifier must be unique within range axes.
LabelLabel for the axis.
Label AngleSets the angle for the label (in radians).
Category AxisAn axis that displays Categories.
Property NameDescription
Label PositionSets the Category label position specification for the axis. Choose: Down 45, Down 90, Standard, Up 45 or Up 90.
Lower MarginLower margin for the axis as a percentage of the axis range (for example, 0.05 is five percent).
Upper MarginUpper margin for the axis as a percentage of the axis range (for example, 0.05 is five percent).
Domain Axis Location Location of the Domain axis.
Property IdDescription
Domain Axis IDDomain axis identifier.
Axis LocationLocation of an axis on a plot. Choose Bottom or Left, Bottom or Right, Top or Left, Top or Right.
Range Axes Collection containing all Range axes to draw. Series groups can be mapped to show their data on specified axis.
Property IdDescription
Range Axis IDIdentifier for axis. Series groups can be mapped to axis using this ID. This identifier must be unique within range axes.
VisibleDetermines whether or not the Range axis is visible.
LabelLabel for the axis.
Label PaintPaint used to draw the axis label.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorColors in the default sRGB color space. Choose the name of the color from a list of values or arbitrary color defined by its hex code (must start with # or 0x).
Label AngleSets the angle for the label (in radians).
Axis Line PaintDefine the type of paint to use when drawing the Axis Line.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorColors in the default sRGB color space. Choose the name of the color from a list of values or arbitrary color defined by its hex code (must start with # or 0x).
Tick Label PaintDefine the type of paint to use when drawing the Tick Label.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorColors in the default sRGB color space. Choose the name of the color from a list of values or arbitrary color defined by its hex code (must start with # or 0x).
Tick Mark PaintDefine the type of paint to use when drawing the Tick Mark.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorColors in the default sRGB color space. Choose the name of the color from a list of values or arbitrary color defined by its hex code (must start with # or 0x).
Minor tick Marks VisibleWhether or not the minor tick marks are visible.
Value AxisThe base for axes that display value data, where values are measured using number.
Property IdDescription
Value Axis TypeType of value axis. Choose Number, Date or Log.
Auto Tick Unit SelectionDetermines whether or not the tick unit is automatically selected from a range of standard tick units.
Lower MarginLower margin for the axis as a percentage of the axis range (for example, 0.05 is five percent).
Upper MarginUpper margin for the axis as a percentage of the axis range (for example, 0.05 is five percent).
Number AxisAn axis for displaying numerical data.
Property IdDescription
Standard Tick Unit SourceType of standard tick unit source. Used only if auto tick unit selection is enabled on value axis configuration. Choose Standard or Integer.
Auto-range Includes ZeroDetermines whether or not the axis range is forced to include zero.
Date AxisAn Axes that displays dates.
Property IdDescription
Date Format OverrdeDate format override to use on date axis. Choose Short, Medium or Long.
Time Format OverrideTime format to use with date format, if date format is empty then this time format will be used with default date format.
Log AxisA numerical axis that uses a logarithmic scale.
Property IdDescription
BaseBase for the logarithm calculation.
Number Format OverrideNumber format override such as 0.00.
Range Axis Locations Location of the Range axis.
Property IdDescription
Domain Axis IDRange axis identifier.
Axis LocationLocation of an axis on a plot. Choose Bottom or Left, Bottom or Right, Top or Left, Top or Right.
Renderers Collection of Renderers which draw a visual representation of a single (x,y) item on an XY plot. Series groups can be mapped to have their data drawn by a specific renderer.
Property IdDescription
Renderer IDIdentifier for the renderer. Series groups can be mapped to renderer using this ID. This identifier must be unique within renderers. If left empty then this property list will be considered as anonymous and will be applied to all renderers which do not have actual property list assigned.
Renderer TypeDefines the type of renderer. Choose Line and Shape, Bar, Bar 3D, Stacked Bar or Stacked Bar 3D.
Auto Populate Series PaintDetermines whether or not to auto populate series paint controls if base series paint should be used when explicit series paint is not defined.
PaintPaint to use for series if auto populate series paint is turned off and series paint is not set.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorColors in the default sRGB color space. Choose the name of the color from a list of values or arbitrary color defined by its hex code (must start with # or 0x).
Auto Populate Series Outline PaintDetermines whether or not to auto populate series outline paint controls if base series outline paint should be used when explicit series outline paint is not defined.
Outline PaintPaint to use for series when auto populate series outline paint is turned off and series outline paint is not set.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorColors in the default sRGB color space. Choose the name of the color from a list of values or arbitrary color defined by its hex code (must start with # or 0x).
Auto Populate Series Fill PaintControls whether or not to auto populate series fill paint controls if base series fill paint should be used when explicit series fill paint is not defined.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorColors in the default sRGB color space. Choose the name of the color from a list of values or arbitrary color defined by its hex code (must start with # or 0x).
Fill PaintPaint to use for series if auto populate series fill paint is turned off and series fill paint is not set.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorColors in the default sRGB color space. Choose the name of the color from a list of values or arbitrary color defined by its hex code (must start with # or 0x).
Auto Populate Series ShapeWhether or not to auto populate series shape controls if base series shape should be used when explicit series shape is not defined.
ShapeShape to be used for series.
Property NameDescription
ShapeChoose a shape for the series.
Shape SizeDefine the size of the shape. Choose Large, Standard or Small.
Auto Populate Series StrokeWhether or not to auto populate series stroke controls if base series stroke should be used when explicit series stroke is not defined.
StrokeCollection containing Renderers which draw a visual representation of a single (Category, value) item on a Category plot. Series groups can be mapped to have their data drawn by a specific renderer.
Property NameDescription
StrokeChoose the Stroke. Choose Solid, Short Dash, Long Dash, Dotted or Mixed Dash
Stroke WidthThe Stroke Width. Choose Bold, Standard or Light. The default is Standard.
Series visibleBase visibility flag for all series using this renderer.
Series Visible in LegendBase legend visibility flag for all series using this renderer.
Item LabelsItem label configuration for renderer.
Property NameDescription
Labels VisibleDetermines whether or not labels are visible.
FontFont for title.
Property NameDescription
SizeEnter the font size.
BoldY for Bold font.
ItalicY for Italic font.
Item Label TypeType of item label.
Standard Item LabelItem label configuration for renderer.
Property NameDescription
Standard Item LabelFor the label format, use {0} where the Series key should be inserted, {1} for the domain axis value and {2} for the range value (y-value).
Number FormatNumber format for absolute value.
Number Format for PercentageNumber format for percentage value.
Expression Item LabelGroovy script for fetching item labels.
Category Item RenderSeries properties for the Renderer which provides the visual representation of a single (x,y) item on an XY plot.
Property NameDescription
URL Generator IDURL generator to use for this Renderer. This ID is mapped to URL generator defined on plot.
Line and Shape RendererRenderer that draws shapes for each data item, and lines between data items.
Property NameDescription
Shapes VisibleWhether or not Shapes are visible.
Shapes FilledWhether or not Shapes are filled.
Lines VisibleWhether or not Lines are visible.
Use Fill paintWhether or not the fill paint is used to fill shapes.
Use Outline paintWhether or not the outline paint is used for shape outlines.
Bar RendererRenderer that draaws bars for each item.
Property NameDescription
Shadow VisibleChoose whether or not Shadows are drawn for a series.
Bar PainterSets the bar painter for this renderer. Choose Standar or Gradient. The default is Gradient.
Draw Bar OutlinesDetermines whether or not bar outlines are drawn.
Item MarginSets the item margin in percentage. Value between 0.0 - 1.0. The value is expressed as a percentage of the available width for plotting all the bars, with the resulting amount to be distributed between all the bars evenly.
Series stylesCollection of series styles for this renderer. Series style overrides base style from renderer.
Property NameDescription
Series style IDIdentifier for series style. If left empty, this property list will be considered as anonymous and will be applied to all series in this series group that do not have an explicit series style ID defined.
PaintPaint used to draw the series. If none is defined here then series paint will be auto populated or base paint will be used when auto population of series paint is turned off.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorColors in the default sRGB color space. Choose the name of the color from a list of values or arbitrary color defined by its hex code (must start with # or 0x).
Outline PaintPaint to use for series if auto populate series outline paint is turned off and series outline paint is not set.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorColors in the default sRGB color space. Choose the name of the color from a list of values or arbitrary color defined by its hex code (must start with # or 0x).
Fill PaintPaint to use for series if auto populate series fill paint is turned off and series fill paint is not set.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorColors in the default sRGB color space. Choose the name of the color from a list of values or arbitrary color defined by its hex code (must start with # or 0x).
ShapeShape to be used for series.
Property NameDescription
ShapeChoose a shape for the series.
Shape SizeDefine the size of the shape. Choose Large, Standard or Small.
StrokeCollection of series styles for this renderer. Series style overrides the base style from the Renderer.
Property NameDescription
StrokeChoose the Stroke. Choose Solid, Short Dash, Long Dash, Dotted or Mixed Dash
Stroke WidthThe Stroke Width. Choose Bold, Standard or Light.
Series VisibleWhether or not this series is visibleusing this renderer.
Series Visible In LegendWhether or not the Legend is visible for all series using this renderer.
Item LabelsItem label configuration for the series.
Property NameDescription
Labels VisibleWhether or not Labels are visible.
FontFont for label.
Property NameDescription
SizeEnter the font size.
BoldY for Bold font.
ItalicY for Italic font.
Item Label TypeType of Item Label. Choose Standard or Expression.
Standard Item Label
Property NameDescription
Standard Item LabelFor the label format, use {0} where the Series key should be inserted, {1} for the domain axis value and {2} for the range value (y-value).
Number FormatNumber format for absolute value.
Number Format for PercentageNumber format for percentage value.
Expression Item LabelGroovy script for fetching item labels.
Category Item RendererSeries properties for the Renderer which provide the visual representation of a single (x,y) item on and XY plot.
Property NameDescription
Line and Shape RendererSeries properties for a Renderer that connects data points with lines and/or draws shapes ate each data point.
Property NameDescription
Shapes VisibleWhether or not Shapes are visible.
Shapes FilledWhether or not Shapes are filled.
Lines VisibleWhether or not Lines are visible.
Item stylesCollection of item styles for this Renderer. Item style overrides style from series.
Property NameDescription
Item style IDCollection of item styles for this Renderer. Item style overrides style from series.
PaintPaint used to draw the item. This paint overrides series paint and base paint.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorColors in the default sRGB color space. Choose the name of the color from a list of values or arbitrary color defined by its hex code (must start with # or 0x).
Outline PaintPaint to use for series if auto populate series outline paint is turned off and series outline paint is not set.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorColors in the default sRGB color space. Choose the name of the color from a list of values or arbitrary color defined by its hex code (must start with # or 0x).
Fill PaintPaint to use for series if auto populate series fill paint is turned off and series fill paint is not set.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorColors in the default sRGB color space. Choose the name of the color from a list of values or arbitrary color defined by its hex code (must start with # or 0x).
ShapeShape to be used for series.
Property NameDescription
ShapeChoose a shape for the series.
Shape SizeDefine the size of the shape. Choose Large, Standard or Small.
StrokeCollection of item styles for this Renderer. Item style overrides style from series.
Property NameDescription
StrokeChoose the Stroke. Choose Solid, Short Dash, Long Dash, Dotted or Mixed Dash
Stroke WidthThe Stroke Width. Choose Bold, Standard or Light.
Item LabelsItem label configuration for item.
Property NameDescription
Labels VisibleWhether or not Labels are visible.
FontFont for label.
Property NameDescription
SizeEnter the font size.
BoldY for Bold font.
ItalicY for Italic font.
Item Label TypeType of Item Label. Choose Standard or Expression.
Standard Item Label
Property NameDescription
Standard Item LabelFor the label format, use {0} where the Series key should be inserted, {1} for the domain axis value and {2} for the range value (y-value).
Number FormatNumber format for absolute value.
Number Format for PercentageNumber format for percentage value.
Expression Item LabelGroovy script for fetching item labels.
Category Item RendererItem properties for renderer which provides the visual representation of a single item on a Category plot.
Property NameDescription
XY Line and Shape RendererItem properties for a Renderer that connedts data points with lines and/or draws shapes at teac data point.
Property NameDescription
Shapes VisibleWhether or not Shapes are visible.
Shapes FilledWhether or not Shapes are filled.
Series Groups Collection of groups properties. Each series group can be mapped to actual (with ID) or anonymous (with empty ID) axis or renderer.
Property NameDescription
Series Group IDIdentifier for series group. If left empty then this property list will be considered as anonymous and will be applied to all series groups which do not have an actual property list assigned.
Range Axis IDRange axis to use for this series group. If left empty then a unique auto ID will be generated.
Domain Axis IDDomain axis to use for this series group. If left empty then a unique auto ID will be generated.
Renderer IDRenderer to use for this series group. If left empty then a unique auto ID will be generated.
Show Legend ItemsShow or hide legend items of this series group.
Range MarkersRange markers to associate with this series group. Markers that can be added to plots to highlight a value or range of values.
Domain MarkersDomain markers to associate with this series group. Markers that can be added to plots to highlight a value or range of values.
Include in Data ExportWhether or not to include this series group in the data export file.
SeriesCollection of series properties. Each series can be mapped to actual (with ID) or anonymous (with empty ID) renderer series style.
Property NameDescription
Series IDIdentifier for the series. If left empty then this property list will be considered as anonymous and will be applied to all series groups which do not have an actual property list assigned.
Series style IDIdentifier for renderer series style. If left empty then this value will default to series ID.
Show Legend ItemWhether or not to show this series in the legend.
Legend LabelLegend label for this series. Defaults to the series ID.
Translate Legend LabelDetermines whether or not the legend label should be translated.
ItemItem properties can be used to define data item specific styles.
Property NameDescription
Item stylesCollection of item styles. Each item can be mapped to a renderer item style by using the same style ID.
Property NameDescription
Item style IDIdentifier for renderer ite style. Cannot be empty.
EnableWhether or not to enable this style.
Legend LabelLabel to use in legend for this item style. The actual legend label is concatenated from each legend label applied to them.
Show Legend ItemDetermines whether or not this style should show on the legend. For item style to show in legend, each legend item which was applied to item must have this flag enabled to actually show the legend item.
Range MarkersCollection of range markers to show. Identifier of marker.
Domain MarkersCollection of domain markers to show.
Toolbar Actual toolbar to show for this plot. Details for these buttons are defined in chart toolbar.
Property NameDescription
Button SetsButton set is a group of buttons rendered together.
Property NameDescription
Button Set IDButton to show. This ID is mapped to button on the chart toolbar.
ButtonsCollection of buttons to show for this plot.
Property NameDescription
Button IDButton to show. This ID is mapped to a button on the chart toolbar.
VisibleDetermines whether or not the button should be visible.
Annotations Annotations of this plot. Use annotation ID to map annotations from plot annotation collection.
Range Markers Range markers that can be added to plots to highlight a value or range of values.
Property NameDescription
Marker IDUnique identifier for marker.
VisibleDetermines whether or not the Range Markers are visible.
Marker TypeType of marker. Choose Value or Interval.
LabelLabel of marker.
Label FontLabel font properties.
Property NameDescription
SizeEnter the font size.
BoldY for Bold font.
ItalicY for Italic font.
Label PaintChoose the paint for the label.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorColors in the default sRGB color space. Choose the name of the color from a list of values or arbitrary color defined by its hex code (must start with # or 0x).
Label AnchorDefines the position of the label anchor, relative to the bounds of the marker.
Label Text AnchorLabel text anchor. Choose a position, top left, top center for example.
PaintPaint for the marker.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorColors in the default sRGB color space. Choose the name of the color from a list of values or arbitrary color defined by its hex code (must start with # or 0x).
StrokeStroke for the marker.
Property NameDescription
StrokeChoose the Stroke. Choose Solid, Short Dash, Long Dash, Dotted or Mixed Dash
Stroke WidthThe Stroke Width. Choose Bold, Standard or Light.
AlphaAlpha transparency that should be used when drawing the marker. Must be in the range 0.0 to 1.0, where 0.0 is transparent and 1.0 is opaque.
LayerLayer (foreground or background) of the marker.
Value MarkerA marker that represents a single value.
Interval MarkerRepresents an interval to be highlighted in some way. Enter the interval Start and End values.
Domain Markers Domain markers that can be added to plots to highlight a value or range of values.
Property NameDescription
Marker IDUnique identifier for marker.
VisibleDetermines whether or not the Range Markers are visible.
LabelLabel of marker.
Label FontLabel font properties.
Property NameDescription
SizeEnter the font size.
BoldY for Bold font.
ItalicY for Italic font.
Label PaintChoose the paint for the label.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorColors in the default sRGB color space. Choose the name of the color from a list of values or arbitrary color defined by its hex code (must start with # or 0x).
Label AnchorDefines the position of the label anchor, relative to the bounds of the marker.
Label Text AnchorLabel text anchor. Choose a position, top left, top center for example.
PaintPaint for the marker.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorColors in the default sRGB color space. Choose the name of the color from a list of values or arbitrary color defined by its hex code (must start with # or 0x).
StrokeStroke for the marker.
Property NameDescription
StrokeChoose the Stroke. Choose Solid, Short Dash, Long Dash, Dotted or Mixed Dash
Stroke WidthThe Stroke Width. Choose Bold, Standard or Light.
AlphaAlpha transparency that should be used when drawing the marker. Must be in the range 0.0 to 1.0, where 0.0 is transparent and 1.0 is opaque.
LayerLayer (foreground or background) of the marker.
Category MarkerA marker for a Category. Enter the Category Key.