datachart Element

 

Content

datachart Element

Description

Example

Properties

Description

The datachart Element configures general infomation about the Data Trending charts used in Data Entry Page Types. The page configuration is divided into multiple elements that together define the page content. In addition to the datachart, the dataprovider Element fetches data from database and organizes it and the argumentbar Element defines arguments provided via URL or by user. The charts are plotted according to properties defined in the following Plot Elements:

xyplot Element defines the configuration of x/y chart
categoryplot Element defines the configuration of category chart
pieplot Element defines the configuration of pie chart.
combineddomainxyplot Element defines the configuration of multi-plot x/y chart; links multiple "xyplot" elements together.

Example

See Data Trending.

datachart Element Properties

Property Name Description
Anti-aliasing Determines whether or not anti-aliasing is used when the chart is drawn.
Text Anti-aliasing Determines whether or not text anti-aliasing is used when the chart is drawn.
Background Paint Background paint for the chart.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorName of color from list of values or arbitrary color defined by its hex code (must start with # or 0x).
Chart title ID Sets the chart title. Must be a text type title.
Subtitles Sets the subtitle list to show on the chart. Enter a title ID from title collection.
Legend title ID Sets the legend title. Must be legend type title. If this is left empty, then a default legend will be shown which can be hidden by using the show legend option.
Show Legend Determines whether or not to show the default legend based on plot.
titles Collection of chart titles. These titles can be mapped to chart title, legend, subtitle etc. by using their ID.
Property NameDescription
title IDUnique ID for title. Must not be empty. This ID is used to map title to chart Subtitle, Legend etc.
title TypeChoose a title Type, Text or Legend.
VisibleDetermines whether or not the title should be drawn.
Horizontal AlignmentSets the horizontal alignment for the title.
Vertical AlignmentSets the vertical alignment for the title. Choose Center, Bottom or Top.
PositionSets the positioin for the title. Choose Bottom, Top, Left or Right.
Padding TopTop padding.
Padding LeftLeft padding.
Padding BottomBottom padding.
Padding RightRight padding.
Show BorderDetermines whether or not to show a border around the title.
Text titleChart title that displays a text string with automatic wrapping as required.
Property NameDescription
Texttitle text.
PaintPaint for title.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorName of color from list of values or arbitrary color defined by its hex code (must start with # or 0x).
FontFont for title.
Property NameDescription
SizeEnter the font size.
BoldY for Bold font.
ItalicY for Italic font.
Legend titleA chart title that displays a legend for the data in the chart.
Property NameDescription
Background PaintBackground paint for legend title.
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).
Plot Plot is responsible for drawing of axes and data.
Property NameDescription
Element IDEnter a Plot Element ID.
Background PaintBackground paint for plot.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorName of color from list of values or arbitrary color defined by its hex code (must start with # or 0x).
Outline PaintPaint used to draw the outline of the plot area.
Property NameDescription
Paint TypeDefines type of paint to use.
ColorName of color from list of values or arbitrary color defined by its hex code (must start with # or 0x).
Outline VisibleDetermines whether or not the plot's outline is drawn.
AnnotationsDefine Plot Annotations.
Property NameDescription
Annotation IDAnnotation ID for this Annotation. This ID is used to map the Annotation to the plot or Renderer.
Annotation TypeType of Annotation. Choose XY or Category.
XY AnnotationAnnotations supported by XY plot and XY renderers.
Property IdDescription
Annotation TypeType of XY annotation. Choose Text or title.
XY Text AnnotationA text annotation that can be placed at a particular (x,y) location.
Property IdDescription
TextText for the annotation.
XX coordinate for the text anchor point (measured against the domain axis).
YY coordinate for the text anchor point (measured against the range axis).
Text AnchorThe point on the text bounding rectangle that is aligned to the (x,y) coordinate of the annotation.
XY title AnnotationAn annotation that allows any title to be placed at a location on an XY plot.
Property IdDescription
title IDtitle ID that is mapped to title collection of chart.
XX coordinate in data space (range from 0 to 1).
YY coordinate in data space (range from 0 to 1).
Rectangle AnchorThe point on the title bounding rectangle that is aligned to the (x,y) coordinate of the annotation.
Category AnnotationAnnotations supported by Category Plot.
Property IdDescription
Category Annotation TypeType of Category Annotation.
Category Text Annotation A text annotation that can be placed on a category plot.
Property IdDescription
TextThe text.
CategoryThe Category (domain axis).
ValueThe value (Range axis)
Category AnchorCategory anchor point.
URL GeneratorsURL generators are responsible of attaching JavaScript (DOM) events to plot items such as data points, categories or pie sections.
Property IdDescription
Generator IDURL generator ID must be a unique identifier. The ID is used for mapping renderer or plot URL generator to render URL generator.
EventsCollection of events registered to this URL generator.
Property IdDescription
Event IDUnique ID for event.
EnableDetermines whether or not this event is active or not.
Event TypeEvent type of this generator. DOM events are freely customizable events and standard events are pre-configured to do a specific task.
DOM Event Type DOM events are normal JavaScript events which can be attached to chart item.
Property NameDescription
DOM Event TypeDOM event type defines when the event occurs. Choose Click, Mouse Over, Mouse Out or Mouse Up.
JavaScriptJavaScript defines what actions to take when the event occurs. You can use [seriesgroupid], [seriesid], and [item] tokens in the script.
Standard Event Standard events are pre-configured events which handle a specific task.
Property NameDescription
Standard Event TypeType of standard event defines which task to perform.
Tool Tip EventTool tip event produces configurable tool tip for each chart item.
Property NameDescription
headerConfigurable tooltip header. May contain variables in brackets.
Tool tip ItemsDistinct Data Set columns displayed in tooltip.
Property IdDescription
Column IdDataset column id.
titletitle.
TranslateIf yes, the value is translated.
Display ValueDisplay value rule. The value can be converted for example into an icon.
Date FormatDate format. Choose Short, Medium or Long.
Time FormatTime format. If empty, only date part is shown.
Number FormatNumber format.
Pseudo ColumnPseudo-column value. May contain varieables in brackets.
Open URLOpen URL event opens the configured URL when series item is clicked. Enter the URL to open.
Expression Tool TipExpression tool tip supports expression base tool tips.
Open MenuOpen context menu.
Property IdDescription
Menu WidthMenu width in pixels.
Menu ItemsCollection of menu items to show when item is clicked.
Property NameDescription
Item IDUnique identifier for item, must not be empty.
TextText label for menu item. Must not be empty.
TipTool tip for menu item.
OperationOperation is the action taken when item is clicked.
Property NameDescription
Operation TypeType of Operation. Choose Standard or JavaScript.
Standard OperationStandard operations include ready made operations.
Property NameDescription
Standard Operation TypeType of standard operation. Choose Set Argument Value, Open URL, Show Notes.
Export DataExport data operation exports the data to a file. Define which type of file to generate.
Open URLDefine which URL to open.
Set Argument ValueSet argument bar argument value.
Property NameDescription
Argument DetailsCollection of argument values to change.
Property NameDescription
Argument IDArgument ID
ValueArgument value.
Show SDI NotesOperation which loads the notes of given primary to the Notes panel.
Property NameDescription
SDC ID ColumnSDC ID of the primary SDI.
Key ID 1 ColumnKey ID 1 of the primary SDI.
Key ID 2 ColumnKey ID 2 of the primary SDI.
Key ID 3 ColumnKey ID 3 of the primary SDI.
ContextKey of the context (usually a semicolon separated list of IDs).
Highlight ContextDetermines whether or not the context should be highlighted (for example, the data item).
JavaScript OperationJavaScript operation defines a JavaScript expression to run. Enter a JavaScript code to execute when item is clicked.
Drawing SupplierA supplier of Paint, Stroke and Shape objects for use by plots and renderers.
Property NameDescription
Paint SupplierSet Paints (colors) coming from Drawing Supplier.
Property NameDescription
Paint Supplier TypePaint configuration styles: Standard, choose colors manually or Color Scheme, use preset color scheme.
Color SchemeChoose a preset color scheme.
PaintsPaint sequence is used to get default colors for series.
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).
ShapesShape sequence is used to get default shapes for series.
Property NameDescription
ShapeShape to be used.
Property NameDescription
ShapeChoose a shape for the series.
Shape SizeDefine the size of the shape. Choose Large, Standard or Small. Default is Standard.
StrokesStroke sequence is used to get default stroke for series.
Property NameDescription
StrokeStrokes to be used.
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.
No Data MessageMessage displayed when the series group list is empty.
Toolbar Toolbar defines operations that the user can do to modify the chart or take action based on selected item.
Property NameDescription
FloatingDetermines whether or not the toolbar should be floating on top of the chart or have its own space.
CollapseDetermines whether or not the floating toolbar should only be shown when the mouse cursor is over the chart image.
Horizontal AlignHorizontal alignment of buttons. Choose Left, Center or Right.
Button SetsButton set is a group of buttons rendered together.
Property NameDescription
Button Set IDButton set identifier. This ID is used to map button sets to be visible on plot.
LabelLabel for the button set.
TipTool tip for button set.
ButtonsCollection containing all buttons available for this plot.
Property NameDescription
Button IDUnique identifier for this button. Must not be empty. This ID is used to map buttons to be visible on the plot.
Button TypeType of button. Choose Button, Menu, Toggle Button or Radio Button.
TextText shown on button.
Tip Tooltip on button.
Show TextDetermines whether or not to show button text.
DisableChoose Yes to disable this button.
Primary IconPrimary icon is shown on the left side of the button text.
Secondary IconSecondary icon is shown on the right side of the button text.
Simple ButtonA simple button takes action when the button is clicked by user.
Property NameDescription
OperationOperation is the action taken when the button is clicked.
Property NameDescription
Operation TypeType of Operation. Choose Standard or JavaScript.
Standard OperationStandard operations include ready made operations.
Property NameDescription
Standard Operation TypeType of Standard Operation.
Export DataExport data operation exports the data to a file. Choose an Export file type.
Set Argument ValueSet argument bar argument value.
Property NameDescription
Argument DetailsCollection of argument values to change.
Property NameDescription
Argument IDArgument ID
ValueArgument value.
JavaScript OperationJavaScript operation defines a JavaScript expression to run.
Menu ButtonMenu button opens a list of menu items when clicked.
Property NameDescription
Menu WidthWidth in pixels for the menu.
Menu ItemsCollection of menu items to show when button is clicked.
Property NameDescription
Item IDUnique identifier for item, must not be empty.
TextText label for menu item. Must not be empty.
TipTool tip for menu item.
OperationOperation is the action taken when button is clicked.
Property NameDescription
Operation TypeType of operation.
Standard OperationStandard operations include ready made operations.
Property NameDescription
Standard Operation TypeType of standard operation. Choose Export Data, Refresh or Set Argument Value.
Export DataExport data operation exports the data to a file. Choose an Export file type.
Set Argument ValueSet argument bar argument value.
Property NameDescription
Argument DetailsCollection of argument values to change.
Property NameDescription
Argument IDArgument ID
ValueArgument value.
JavaScript OperationJavaScript operation defines a JavaScript expression to run.
JavaScript OperationJavaScript operation defines a JavaScript expression to run.
Toggle ButtonToggle button has an on or off state based on the value of an argument.
Property NameDescription
Argument IDArgument ID of the value controlled by this radio button.
On ValueArgument value when toggle button is on.
Off ValueArgument value when toggle button is off.
Radion ButtonRadion button controls the value of an argument.
Property NameDescription
Argument IDArgument ID of the value controlled by this radion button.
Argument ValueArgument value to set when this radio button is activated.
Data Export Defines how data is exported to a file.
Property NameDescription
Excel ExportsExcel export properties define how data is exported to an Excel file.
Property NameDescription
File Name PrefixFile name will start with this text and is made unique with arbitrary numbers.
File TypeType of Excel file to produce. Choose XLSX or XLS.
Sheet NameData sheet will get this name.
First RowNumber of first row (first row is 1).
First ColumnNumber of first column (first column is 1).
FrontFont properties.
Property NameDescription
SizeEnter the font size.
BoldY for Bold font.
ItalicY for Italic font.
Row headersCollection of row headers to show on each row.
Column headersCollection of column headers to show on each column.
titlesCollection of texts to show in the workbook. These texts are configured as chart titles and mapped here using their title ID.
Property NameDescription
title IDtitle ID of a chart title to add in the workbook.
Row NumberNumber of target row for the text (first row is 1).
Column NumberNumber of target column for the text (first column is 1).
title Column TypeType of column for the text. Choose Text, Date or Number.
SortDefines row and column sort properties for export.
Property NameDescription
Row Sort DirectionDefines direction of row sort. Choose Ascending or Descending.
Column Sort DirectionDefines direction of column sort. Choose Ascending or Descending.
Column Sort headersDefines column IDs to use when sorting export columns.
Row Sort headersDefines column IDs to use when sorting export rows.