Scripted Elements form

  • Release version: Xanadu
  • Updated August 1, 2024
  • 1 minute to read

    • Use the Scripted Elements form to define the data script to fetch data for a complex report type such as line chart or bar chart.

    Table 1. Scripted Elements form
    Field Description
    Name Name for the element.
    Type Chart type (Line chart or Bar chart) that you want to generate.

    After the required chart type is selected, the suggested format of the scripted elements code format is displayed in the Data Script field.
    Description Description for the report. (Example: Comparison of planned vs. Actual costs.)
    Data Script Script used to fetch data for the report.

    For more information on how to manage Scripted Elements, see Manage Related Tables and Scripted Elements forms.

    Line chart parameter

    Following are the basic parameters used to define the properties and formatting of a line chart.

    Table 2. Line chart parameters
    Parameter Description Reference value
    @property {String} seriesArray.properties.color - Color of Line

    Color of the line.

    Use Hex code values to define a color of the line.

    For example, use the hex code #FF0000 for red color.
    @property {String} seriesArray.properties.type - type of Line

    Type of line.

    For more information about reference line formats, see https://poi.apache.org/apidocs/dev/org/apache/poi/xddf/usermodel/PresetLineDash.html#DASH.
    @property {String} seriesArray.properties.markerStyle - style of marker

    Style of the marker to identify key points on the chart.

    For more information about reference marker formats, see https://poi.apache.org/apidocs/dev/org/apache/poi/xddf/usermodel/chart/MarkerStyle.html.
    @property {Number} seriesArray.properties.markerSize - size of style

    Size of the marker on the chart.

    Minimum inclusive: 2, maximum inclusive: 72
    @property {String} legendPosition - Position of legend in chart. This is optional

    Legend position of the chart.

    For more information about legend position, see https://poi.apache.org/apidocs/dev/org/apache/poi/xddf/usermodel/chart/LegendPosition.html.

    Bar chart parameters

    Following are the basic parameters used to define the properties and formatting of a bar chart.

    Table 3. bar chart parameters
    Parameter Description Reference value
    @property {String} barProperties.direction

    The direction of plotting the bars in the chart.

    For more information about defining a bar direction, see https://poi.apache.org/apidocs/dev/org/apache/poi/xddf/usermodel/chart/BarDirection.html.
    @property {String} barProperties.grouping - grouping of bars

    Grouping style of the bar in the chart.

    Use options such as standard, clustered, stack. For more information about bar grouping properties, see https://poi.apache.org/apidocs/dev/org/apache/poi/xddf/usermodel/chart/BarGrouping.html.
    @property {Number} barProperties.overlay

    Size of overlapping among the bars in the chart.

    Accepted numeric value range is from 0 to 100.