Skip to main content

Chart

Properties

General

commonDetails

AttributeTypeDescriptionCategory
Model Id RequiredString

This is a unique id for the component.

Every field on a form model needs a unique ID, which is automatically generated but can be changed if needed (e.g. to reference in expressions or for debugging purposes).

If the field type supports rendering a label, and most types do, it can be configured here. This label is a displayed on the form to the end user and typically indicates what value is expected in the field.

The documentation property holds free-form text that can be used to give more details about this chart field, like its purpose, usage in other models, etc.

Label Expression usage possibleTranslatable to different languagesText

The label attribute adds a label to the component.

Label position Selection:
  • Left
  • Top

The position of the label, you can choose between left or top.

Label tooltip Expression usage possibleTranslatable to different languagesText

When it is defined, a question mark icon will appear in the component label. When the user hovers over it it will show this text in a tooltip.

Documentation Multiline Text

A free-form text to explain the use cases for this form field.

details

AttributeTypeDescriptionCategory
Feature RequiredExpression usage possibleSelection:
  • Human tasks
  • Case instances
  • Process instances

Work feature to represent (tasks, cases, processes)

Filter RequiredExpression usage possibleSelection:
  • Created
  • Finished

Filter to apply on chart elements in time interval.

From RequiredExpression usage possibleDate

Initial date of the data to represent

To RequiredExpression usage possibleDate

End date of the data to represent

Chart type RequiredExpression usage possibleSelection:
  • Bar graph
  • Line graph
  • Pie chart

Type of chart for the representation (bars, lines, pie)

Group by Expression usage possibleSelection:
  • Hour
  • Day
  • Week
  • Month
  • Definition

X Axis. Group data by definition or by time amount

Report type Expression usage possibleSelection:
  • Frequency
  • Duration

Y Axis. Which attribute of the data to represent (frequency, duration)

Calculate Expression usage possibleSelection:
  • Average
  • min
  • Max
  • Total

Aggregate function for the duration report (min, max, total or average)

Show Legend Expression usage possibleBoolean

Show Chart Legend

Definition Id(s) Expression usage possibleText

Comma separated ids of instances to display

Definition Key(s) Expression usage possibleText

Comma separated Keys of instances to display

Validation

AttributeTypeDescriptionCategory
Validation Panel Display Selection:
  • Show
  • Only message
  • Hide

Display at validation panel and validation tooltip.

Providing proper data in form fields is important, especially when in process, case, decision or any other models the values provided in the form fields are used in subsequent steps.

To make sure that the data is correct, validation is crucial. For this reason, a form can only be submitted when all fields are valid and thus all validation properties configured on the left apply.

Check the tooltips on the properties for more information.

Custom validations List

List of additional validations to apply.

The chart field can have custom validation rules beyond the standard set of validations. Such a rule is written as a frontend expression in the form of {{myExpression}}. If this expression evaluates to false, the submission of the form won't be possible.

Rendering

AttributeTypeDescriptionCategory
Description Expression usage possibleTranslatable to different languagesText

The description attribute adds a description to the component.

Some field types have an extra line of text displayed to give the user more details about the field.

Ignored Expression usage possibleBoolean

If true the component will be hidden and the value will not be part of any payload.

Fields can also be shown or hidden based on the visible condition. This can be a frontend expression in the form of {{myExpression}} which can reference other form field values by their IDs.

Fields can also be enabled or disabled, and similarly this can be made dynamic based on a frontend expression.

Some field types can be ignored (the property is shown here if that's the case), which means that its value won't be taken into account.

Visible Expression usage possibleBoolean

Boolean value or expression specifies whether the component is visible or hidden. This expression might include another value in the same form, for instance use a checkbox bound to {{showAdditionalFields}} and use the very same expression as the visible attribute to show or hide the component according the checked state of the checkbox. If you want to only show the component, if the form is not used as the init-form, you can use the expression '{{root.id}}' which evaluates to true only, if there is a current case id which is not the case in an initialization form.

Style class Text

Stylesheet class name. Add any style classes to be applied to the component for the desired styling and rendering.

The chart field can get customized CSS classes to customize the default styling. Note that the CSS files needed for the customizations must be available on the runtime system.

Advanced

AttributeTypeDescriptionCategory
Events List

The chart field emits low-level events on which can be reacted with a frontend expression to implement various use cases that are not possible with regular modeling.

If the expression produces a value, it can be stored in a new variable using the Result variable property.

List Attribute Details

Custom validations

AttributeTypeDescription
Expression RequiredExpression usage possibleText

Validation passes when this expression is true.

Error message RequiredTranslatable to different languagesText

Message to display when the validation fails.

Events

AttributeTypeDescription
Event label RequiredText

This is a unique id for the component.

Event type Selection:
  • On value change

The type of event emitted by the form field.

Expression Expression usage possibleText

Validation passes when this expression is true.

Result variable Text

Capture the result of the expression in a result variable.