Chart

It can be used to display a diagram. The files can be found in the Chart directory of the XML package. The file`s name must begin with the Chart string.

/Chart

This clamps together the structure of the XML file describing the display.

/Chart/Caption (String)

The name of the file as used by the Effector Studio.

/Chart/DataDefinition (String)

The name of the DataDefinition file returning the data of the diagram. More information on the DataDefiniton can be found in the DataDefinition and the management of filters.

/Chart/Legend

Regulated the visibility and location of the legend.

  • None: no legend
  • Right: on the right side (default)
  • Left: on the left side
  • Bottom: at the bottom

/Chart/TopText (String)

Optional setting. It is possible to write a static text above the diagram.

/Chart/BottomText (String)

Optional setting. It is possible to write a static text under the diagram.

/Chart/SeriesIDColumn (String)

The system is able to display more than one series (for example on the left side two people are selected and on the right side on the diagram the two people will be displayed as two series). The unique identifier of the series (for example PeopleID).

/Chart/SeriesColumn (String)

The name of the column that contains the text description of the series, for example the name of the person.

/Chart/CategoriesColumn (String)

The name of the column that contains the division of the X axis (for example the number of the week).

/Chart/ColorColumn (String)

Optional setting. The name of the column in which the colors are defined. This only changes the array of possible colors, the correct selection will be still made by the Highchart.

/Chart/SeriesColors (String)

Optional setting. It is possible to set which colors should be used to draw the given series. This means a list separated by commas.

/Chart/BackgroundColor (String)

Optional setting. Serves to set the background color.

/Chart/MarkerRadiusColumn (String)

Optional setting. The name of the column that contains the size settings for the given marker (for example displaying different size points...).

/Chart/ChartJSONObject (String)

Optional setting. The Effector creates a JSON text according to which the HighChart will be able to create a diagram. This can be supplemented by the JSON text specified in this setting.

/Chart/AutoRefreshInterval (Integer)

Optional setting. Switches on the automatic refreshment. The value is in minutes.

/Chart/IsNavigationButtonVisible (Boolean)

Optional setting. Its value can be true / false. Default value false. Switches on a diagram button which serves to export the diagram.

/Chart/Links

Optional setting. It is possible to parameterize a linked screen, more information can be found in the DisplayDefinition and Control types chapter.

/Chart/ControlPanel

Optional setting. It is possible to parameterize further filter fields, more information can be found in the DisplayDefinition and Control types chapter.

/Chart/xAxis

Optional setting. The tag collecting the settings of the x axis.

/Chart/LabelRotation

The rotation of the labels in degrees.

Attributes:

  • xAxis: rotation of the x axis` captions

/Chart/DataColumns

Collection node. The name and settings of the data containing columns must be listed in this node.

/Chart/DataColumns/DataColumn

The value of the node is the name of the data containing DataDefinition column. There can be multiple ones, in that case more diagrams belong to the same series.

/Chart/DataColumns/DataColumn/Stacking

Optional setting. Setting of stacked display. Its value can be Normal, Percent, None. Default value is None.

/Chart/DataColumns/DataColumn/ChartType

Mandatory setting, the types of the diagram, its values:

  • pie: pie
  • bar: bar
  • line: line
  • area: line diagram where the area under the curve is filled
  • areaspline: Spline line diagram where the area under the curve is filled
  • column: column
  • spline: spline
  • gauge: gauge
  • solidgauge: gauge (solid)

/Chart/DataColumns/DataColumn/Caption

Optional setting. The Caption attributes serves to set a differentiating ending.

/Chart/DataColumns/DataColumn/FillGapWithValue

Optional setting. This setting can be used to set

/Chart/DataColumns/DataColumn/AxisOptions

Optional setting. This node is used for parameterizing the applicable axis options. Its value is a JSON string that contains the available options. See the site of the manufacturer.

/Chart/DataColumns/DataColumn/MarkerOptions

Optional setting. Node used to set the markers. Its value is a JSON string that contains the available options. See the site of the manufacturer.

/Chart/DataColumns/DataColumn/ShowInLegend

Optional, if the given series should be shown in the legend.

Example

<?xml version="1.0" encoding="utf-8" ?> <Chart xmlns="http://effector.hu/schema/ns/Chart"> <Caption></Caption> <DataDefinition></DataDefinition> <CategoriesColumn></CategoriesColumn> <SeriesIDColumn></SeriesIDColumn> <SeriesColumn></SeriesColumn> <ColorColumn></ColorColumn> <Legend></Legend> <TopText></TopText> <BottomText></BottomText> <AutoRefreshInterval></AutoRefreshInterval> <LabelRotation xAxis="" yAxis=""></LabelRotation> <SeriesColors></SeriesColors> <MarkerRadiusColumn></MarkerRadiusColumn> <BackgroundColor></BackgroundColor> <IsNavigationButtonVisible></IsNavigationButtonVisible> <ChartJSONObject></ChartJSONObject> <DataColumns> <DataColumn columnName=""> <ChartType></ChartType> <Caption></Caption> <FillGapWithValue></FillGapWithValue> <AxisOptions></AxisOptions> <MarkerOptions></MarkerOptions> <ShowInLegend></ShowInLegend> <Stacking></Stacking> </DataColumn> </DataColumns> <ControlPanel></ControlPanel> <Links></Links> </Chart>

  • Last update: 10 weeks 1 days ago
  • Effector