Skip to content

ChartParams

With the 'ChartParams' section, you will be able to configure and build a set of chart components.

Fields

A ChartParams contains the following fields to be defined:

Title

The title of the chart which will be rendered at the chart component.

Requirements Rules:

  • Max length of 100 chars.

Example: 

1
2
3
ChartParams:
  Title: Data Kpi
  ...

Description

The description of the chart which will be rendered at the chart component.

Requirements Rules:

  • Max length of 300 chars.

Example: 

1
2
3
4
ChartParams:
  Title: Data Items Kpi
  Description: Items per status
  ...

RenderAsSpark

If the chart should be rendered as a spark-chart or not. Defaults to false. A spark-chart omit the grid info and the chart legend showing as a simple data indicator. The spark-chart should be used only with axis series.

Example: 

1
2
3
4
5
ChartParams:
  Title: Data Items Kpi
  Description: Items per status
  RenderAsSpark: false
  ...

AxisAggregatePropertyName

The entity property name which will be used to group the data. Each value creates a group to be rendered as a category in the series.

Requirements Rules:

  • Is Required for charts with Series of Axis base type;
  • The name must exist in the Properties list for the UiStructure entity.

Example: 

1
2
3
4
5
6
7
8
ChartParams:
  Title: Data Items Kpi
  Description: Items per status
  RenderAsSpark: false
  AxisAggregatePropertyName: My_Prop_Type_Id
  Series:
  - Type: bar # bar, line and area are Axis types
    ...

AxisAggregatePropertyLabel

The label to be used with AxisAggregatePropertyName. If omitted the value of AxisAggregatePropertyName will be used. In case the UiStructure Entity has relationship with the entity used for aggregation you will be able to use the nested properties of the aggregation Entity.

Requirements Rules:

  • Must be a valid property or nested property for UiStructure entity;
  • Only one level of deep at nested properties is allowed.

Example: 

1
2
3
4
5
6
7
8
9
ChartParams:
  Title: Data Items Kpi
  Description: Items per status
  RenderAsSpark: false
  AxisAggregatePropertyName: My_Prop_Type_Id
  AxisAggregatePropertyLabel: My_Type.Name
  Series:
  - Type: bar # bar, line and area are Axis types
    ...

Series

The information used to build chart data series.

Requirements Rules:

  • Is Required;
  • One single series is allowed per chart;
  • The series must not mix the base chart type (e.g.: Axis series with Non-Axis series);
  • Must follows rules as specified in Chart-Series;

Example: 

1
2
3
4
5
6
7
ChartParams:
  Title: Data Items Kpi
  Description: Items per status
  RenderAsSpark: false
  Series:
  - Type: donut
    ...

Back to top