ChartSeries

With the 'ChartSeries' section, you will be able to configure the information to build data sets for chart components.

Fields

A ChartSeries contains the following fields to be defined:

PropertyName

The name of entity property to be used for chart operation.

Requirements Rules:

• Is Required;
• The name must exist in the Properties list for the UiStructure entity.

Example:

Series:
  PropertyName: My_Prop_01
  ...

---

Operator

The operator to be applied for the PropertyName.

Allowed Types:

• Count: Performs a count distinct operation with the PropertyName informed.
• Sum: Performs a sum operation with the PropertyName informed. Valid only for properties of numeric types.

Requirements Rules:

• Is Required;
• Must be a valid operator.

Example:

Series:
  PropertyName: My_Prop_01
  Operator: Count
  ...

---

Label

The label which will be rendered with the series dataset at chart component.

Requirements Rules:

• Must be unique within the series list;
• Max length of 100 chars.

Example:

Series:
  PropertyName: My_Prop_01
  Operator: Count
  Label: Prop Status
  ...

---

Type

The type of chart used to render the series.

Allowed Types:

• Non-Axis types: donut, pie, radialBar.
• Axis types: bar, area, line.

Requirements Rules:

• Is Required;
• Must be a valid type.

Example:

Series:
  PropertyName: My_Prop_01
  Operator: Count
  Label: Prop Status
  Type: donut
  ...

---

AggregatePropertyName

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

Requirements Rules:

• The name must exist in the Properties list for the UiStructure entity.

Example:

Series:
  PropertyName: My_Prop_01
  Operator: Count
  Label: Prop Status
  Type: donut
  AggregatePropertyName: My_Prop_Status_Id
  ...

---

AggregatePropertyLabel

The label to be used with AggregatePropertyName. If omitted the value of AggregatePropertyName 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:

Series:
  PropertyName: My_Prop_01
  Operator: Count
  Label: Prop Status
  Type: donut
  AggregatePropertyName: My_Prop_Status_Id
  AggregatePropertyLabel: My_Status.Name
  ...

---