Effector 6.3 developer manual

XML reference 6.3

Effector Studio 6.3 summary

Effector Studio 6.3 manual

Effector 6.2 developer manual

XML reference 6.0

Effector Studio 3.2 summary

Effector Studio 3.2 manual

Chart

In this chapter we are discussing the Chart view. With its help, we have a chance to graphically display data obtained from the DataDefinition set as a source.

For further information on the Chart component, please visit the website of the component manufacture: HighCharts.

Location

The files are located in the Chart directory of the XML package. The name of the file must always begin with the character string Chart.

Example:

<Chart xmlns="http://effector.hu/schema/ns/chart">
    <Caption />
    <DataDefinition>DataDefinitionCF1</DataDefinition>
    <Legend>None</Legend>
    <TopText>Munkával töltött órák száma</TopText>
    <BottomText>(összes ember)</BottomText>
    <SeriesIDColumn>SeriesID</SeriesIDColumn>
    <SeriesColumn>Series</SeriesColumn>
    <CategoriesColumn>Category</CategoriesColumn>
    <DataColumns>
        <DataColumn columnName="Data">
            <ChartType>pie</ChartType>
        </DataColumn>
    </DataColumns>
    <ControlPanel />
</Chart>

Available features

  • Defining diagrams
  • Specifying data series
  • Setting linked objects
  • Defining filters and action buttons

Defining diagrams

The definition of diagrams can be done by setting the following mandatory nodes. Only one of each can be present. The descriptor’s root element is the Chart node that may include the following nodes:

  • Caption: With its help, we can set the caption of the diagram.
  • DataDefinition: In this node we can set the DataDefinition associated with the diagram. The DataDefinition set here provides the data and also plays a role in the handling of filters.
  • ChartType: With this node we can set the default diagram type.
  • Legend: With the help of this node the visibility of the legend can be set. Its possible values are: None, Left, Right, Bottom. It defaults to None.
  • By setting the TopText and BottomText nodes, static texts can be specified, which will be displayed on the top or bottom of the diagram.
  • AutoRefreshInterval: By using this node we can set the refresh interval. Its value is understood in minutes.
  • BackgroundColor: With its help we can set the background color. It is optional.
  • MarkerRadiusColumn: Here we can set which column contains the radius of the indicators.
  • IsNavigationButtonVisible: Its value may be true or false. By default, it is false. With its help a small button can be turned on, with which the diagram can be exported.
  • ChartJSONObject: Effector generates a JSON string, based on which HighChart is able to build a diagram. This can be appended with a given JSON string in this node.

Using the following nodes, we can specify how the chart view should interpret the data source and the columns therein.

  • SeriesIDColumn: The system is capable of handling more than one series at a time, therefore it must be specified which column in the database should represent the field identifying the series. For example, if the ID of more than one person (PeopleID) is sent to the input filter, the DataDefinition will contain data for each ID (if there is any). The system will group the created series using the column IDs set here. Its setting is the following: <SeriesIDColumn>PeopleID</SeriesIDColumn>, if the PeopleID column is defined in the DataDefinition. The ID of the series in the example will be the value of the PeopleID field.
  • SeriesColumn: The name of the field containing the description appearing with the series.
  • CategoriesColumn: The name of the column containing the tick values of the X-axis.
  • ColorColumn: Here we can set the name of the column that provides the colors for the diagram. It modifies only the array of available colors, from which the appropriate color will be selected by Highchart. It is an optional setting.

Defining data series

We can connect the data columns in the DataDefinition with the diagram using the following nodes. The individual series must be set under the DataColumn elements of the DataColumns collection. In case of certain series, we can define default chart types and other functions. These can be configured by setting nodes. With the exception of the ChartType node, all nodes are optional.

  • For the configuration of the DataColumn node:
    • The value of the columnName attribute of the DataColumn node contains the column representing the data of the series.
    • ChartType: It defines the type of the diagram, which can be the following: areaspline, spline, line, area, bar, pie, column, gauge, solidgauge. For more information visit the manufacturer’s website. (See above.)
    • Caption: Here, we can set a unique ending.
    • FillGapWithValue: In case of an absent value, the absence will be filled with this value. It is a floating-point number. It's an optional setting.
    • AxisOptions: This note is used to configure the usabe asix options. Its value is a JSON string, which contains the available options. See the manufacturer’s website. It is an optional element.
    • MarkerOptions: This node is used for setting the available markers. Its value is a JSON string, which contains the available options. See the manufacturer’s website. It is an optional element.
    • ShowInLegend: With its help we can regulate weather the given series be featured in a legend.
    • bar {"min": 0}

Defining linked objects

The configuration of Linked objects is consistent with the use of the Links generally present in the system. For further information on this see Tables and ControlPanel-controls.

Defining filters and action buttons

Their operation and definition are consistent with those set forth in Tables and ControlPanel-controls.

  • Last update: 2 weeks 5 days ago
  • Effector