Table of Contents

Items Settings

Items in the Timeline component are rectangular areas overlaid on the timeline, used to visually represent specific time ranges with distinct characteristics. They represent data like activities, events, ...

Example Item

Item Example

The items settings page consists of the following parts:

  • Method Configuration
  • Grouping
  • Mapping

Items Settings Page

Method Configuration

To configure the method settings, select an object, method and profile.

This is required

Grouping

Level

There are 3 levels. Level 1 is always the level at the top and level 3 the lowest / deepest.

  • Level 1
    • Level 2
      • Level 3

To select a level, make sure you have a method selected. Now you can use the selectbox to select a method field from the selected method.

The groups are generated by 3 group keys, given through the grouping settings.

E.g. in this case, the groupings are "Fabriek (1) => Werkplek (2) => Machine (3)"

Example Dataset

Whenever an item is supposed to belong to "Machine 4", "Werkplek 1" and "Fabriek 1", then make sure the spelling and the case are the same.

The order of the provided data does not matter.

Warning

Performance

High amount of items (> 1000) will have an impact on performance due to group generating.

Sorting

You can also sort the groups on certain levels by text. Next to the method field select box, you have a sort button. There are 3 sorting options:

  • Ascending
  • Descending
  • None
Note

The sorting is based on characters.

Whenever you got 2 groupings called "Machine 11" and "Machine 2" and you select the sorting option "Ascending", "Machine 11" will still be placed before "Machine 2". This is because "11" will be viewed as '1' and '1' and the character '1' value is less than the value of character '2'.

Display Text

Display text is useful when you want to display other text than the group level value.

For example, you can render an icon infront of the group level value.

To use it, use the switch to toggle it on. Now you have access to the selectbox with two options:

Text (quickest and easiest)

By selecting text, you can configure the template you want quick and easy in the text area below.

By using right click on the text area, you can select method fields from your selected method.

Display Text By Text Example

Script (advanced)

When you select the mode "Script", the text area will disappear and you will get a button that takes you to the script to configure the formatter. This script should return a desired string.

For more information about scripts, visit Scripts Page.

Mapping

An item has 5 fields

  • ID (string)
    • Used to identify a certain item.
  • Start Date (DateTime, required)
    • The start date of this item.
  • End Date (DateTime)
    • The end date of this item.
  • Status (string)
    • A string that represents a status. Used to give items status colors.
  • Color (string)
    • The color of the item. Must be a hexcode.

Map these fields to any method field from your method.