Table of Contents

Timeline

Available from DataMiner 10.4.1/10.5.0 onwards.

The timeline component is a powerful way to visualize and interact with time-bound data, such as bookings, events, or schedules. It not only provides a clear overview of what’s happening when, but also lets you manage and update items directly on the timeline, with extensive customization options.

Timeline
MediaOps solution 1.3.2: Scheduling application

With this component, you can:

Supported data types

The timeline component is used to display the results of queries in a timeline format. It should therefore always be configured with query data input.

Each row in a query corresponds to an item on your timeline.

Interacting with the timeline component

The items displayed on a timeline component depend on the data you pass to it. How many items are visible at once depends on the displayed time range and the size of the component.

The component automatically adapts to the configured time range, but if more items fall within that range than can fit in the available space, a scrollbar appears when you hover over the component. You can then use the scrollbar to scroll up or down through the items.

Timeline scrollbar
Timeline component in DataMiner 10.5.9

Available interactions

You can interact with the timeline in several ways:

  • Selecting an item: Click an item to select it. The default timeline template highlights selected items with a distinct background and border color.

    Selecting a timeline item
    Timeline component in DataMiner 10.5.9

  • Selecting a time range: Right-click where you want the range to start, drag to the desired endpoint, and release the mouse button.

    Selecting a time range
    Timeline component in DataMiner 10.5.9

  • Resizing an item: Drag the edges of an item to adjust its start and end time.

    Resizing timeline item
    Timeline component in DataMiner 10.5.9

  • Moving an item: Select and drag an item to a new position. You can also drag it to another group. From DataMiner 10.3.0 CU14/10.4.0 CU2/10.4.5 onwards, you can hold SHIFT to move items with greater precision, or CTRL to move them precisely both horizontally and vertically.

    Moving timeline item
    Timeline component in DataMiner 10.5.9

At any time during an interaction, you can press ESC to cancel the action and restore the item ot its original state (available from DataMiner 10.3.0 CU14/10.4.0 CU2/10.4.5 onwards).

Important
  • To enable moving, resizing, or reassigning items to a different group, you must configure at least one action for that interaction. See Adding actions to a timeline.
  • To ensure that interactions update the underlying data and do not remain purely visual, configure an event that triggers a Launch a script action. This Automation script should update the original data objects with the modified ones exposed by the event triggered through user interaction. For more information, see Using event data in actions. If your data source does not support real-time updates, you also need to configure an Execute component action to refetch the data.

Changing the time range

A timeline component displays time-bound data within a defined time range. The default time range can be configured in the timeline settings. In read mode, you can adjust the view of the timeline by zooming or panning. Alternatively, you can link the timeline to a time range component for more flexible control.

Zooming

Zooming changes the duration of the displayed time range: zooming out shows a larger range, while zooming in shows a smaller range.

  • To zoom in, press Ctrl while scrolling up.

  • To zoom out, press Ctrl while scrolling down.

Ctrl + scroll
Timeline component in DataMiner 10.5.9

  • On mobile devices, zoom in by placing two fingers together on the screen and moving them apart. To zoom out, use a pinching motion, starting with your fingers apart and bringing them together.

  • To zoom in on a specific section of the timeline, right-click at the start of the range, drag to the endpoint, and release the mouse button. The timeline will zoom in to the selected range.

    Selecting a time range
    Timeline component in DataMiner 10.5.9

    For this behavior to work, you need to configure an On range select event in the Settings pane:

    1. Go to Events > On range select and select Configure actions.

    2. Add the following action:

      • Action: Execute component action

      • I want to: Timeline, Set viewport

      • Which timeline?: <name timeline component>

      • From: Click the Link to icon and configure:

        • Link to: Event

        • Type: Timespans

        • Property: From

      • To: Click the Link to icon and configure:

        • Link to: Event

        • Type: Timespans

        • Property: To

Note

The component has a minimum time range of 5 milliseconds and a maximum of 10 years, setting the zoom limit.

Panning

Panning changes the position of the displayed time range without affecting its duration.

  • To pan left or right:

    • Click and drag the timeline, or

    • Hold the Shift key and scroll up or down.

    Panning
    Timeline component in DataMiner 10.5.9

  • On mobile devices, move left or right by sliding one finger across the component.

Note

If you have enabled the Lock timeline to now setting, you will be unable to pan past the "now" indicator.

Linking to a time range component

Instead of adjusting the time range directly in the timeline, you can link it to a time range component. This allows you to control the displayed time range from a dedicated component, which offers both quick and custom selection options.

Time range
Timeline component and time range component in DataMiner 10.5.9

To link a timeline component to a time range component:

  1. In the Settings pane, click the Link to icon next to Link time range (called Link time range to feed in versions prior to DataMiner 10.3.0 [CU21]/10.4.0 [CU9]/10.4.12).

  2. From the dropdown list, select the time range component you want to link.

  3. (Optional) Select the time range component in your app or dashboard, go to the Layout tab, and enable Advanced > Use quick picks to add quick pick buttons.

Once linked, changing the time range in the time range component automatically updates the timeline. You can:

  • Select a custom time range using the calendar interface.

  • Apply common time ranges using the quick pick buttons.

Tip

For more information, see Time range.

Grouping items in a timeline

You can group items on a timeline to organize them by a common attribute, such as category, resource, or assignee. This allows you to quickly see which items belong together and makes it easier to compare groups side by side.

Timeline groups
Timeline component in DataMiner 10.5.4

To group items on the timeline based on one of the columns in your data:

  1. Hover over the component and click the Groups icon.

    After you click this icon, compatible data will be marked with the available groups icon in the Data pane.

  2. Drag compatible data onto the component.

    All groups are now displayed in a gray column to the left of the timeline. The timeline items are displayed next to the group they are part of.

    Note

    If a group is empty (i.e. there is no start and end time), it is still displayed in the timeline component.

Using the timeline component as an editing tool

A common use case is using the timeline component as an interactive editing tool, i.e. a component where you can directly update or modify items displayed on the timeline.

For example, using the Template Editor, you can add a pencil icon in the top-right corner of each timeline item. When a user clicks this icon, a panel opens where they can edit the details of that item. This makes it possible to manage and adjust data directly from the timeline view, without navigating away.

In the example below, clicking the pencil icon on a timeline item opens an edit panel that allows the user to update job information.

Timeline as editing tool
MediaOps solution 1.3.2: Scheduling application

Highlighting data

The timeline component offers two ways to highlight data, helping you draw attention the information that matters most:

Highlighting a time range

When you highlight a time range, the section of the timeline within the specified range receives a different background color based on the dashboard or app theme. Events that occur fully or partially within the time range are displayed with normal opacity, while events outside the range appear with reduced opacity.

Highlight
Timeline component in DataMiner 10.5.9

To highlight a time range:

  1. In the Settings pane, make sure the Highlight range > Use highlighting option is enabled.

    Once you have enabled this option, the Time range setting will become available.

  2. Set the time range to define which part of the timeline should be highlighted. The time range can be static or dynamic (using the Link to option).

Highlighting specific items

When you highlight items based on a query filter, only the items that match the filter are emphasized. Items outside the filter criteria remain visible, but with lowered opacity. The level of transparency can be adjusted.

Filtering & Highlighting
Query filter and timeline components in DataMiner 10.5.9

To highlight items with a query filter:

  1. In the Layout pane, make sure the Filtering & Highlighting > Highlight option is enabled.

  2. Set your preferred opacity, e.g. 20 %. This determines how clearly you will see the timeline items that do not meet the criteria specified in the query filter.

    Highlight filtered results
    Timeline layout settings in DataMiner 10.5.7

  3. Add a query filter visualization to your app or dashboard.

  4. Apply the same query data to the query filter that is used by the timeline component.

  5. In the Data pane, navigate to All available data > Components > Query filter #, and drag the Query columns data item onto your timeline component.

    In read mode, you can now use the query filter component to filter and refine the data displayed in the timeline component. Items that do not meet the specified criteria will be shown with lowered opacity.

Configuration options

Timeline layout

In the Layout pane, you can find the default options available for all components. See Customizing the component layout.

Additionally, the following layout options are also available:

Section Option Description
Filtering & Highlighting Highlight Available from DataMiner 10.1.11/10.2.0 onwards. Toggle the switch to determine whether the items that match the criteria specified in a query filter will be highlighted. Enabled by default. For more information, see Highlighting specific items.
Filtering & Highlighting Opacity Available from DataMiner 10.1.11/10.2.0 onwards. Set the level of transparency of the items that do not match the criteria specified in a query filter. This option is only available when Highlight is enabled. For more information, see Highlighting specific items.
Advanced Empty result message Available from 10.3.11/10.4.0 onwards. Specify a custom message that is displayed when a query returns no results. See also: Displaying a custom empty component message.
Style Grouping by Toggle the switch to determine whether the name of the column the data was grouped by (optionally) is shown. Disabled by default.
Style Segment lines Toggle the switch to determine whether segment lines are displayed in the timeline component. Enabled by default.
Style Lock timeline to now Select the checkbox to set a "now" indicator at a fixed position on the timeline. When this option is enabled, users can zoom in and out on the timeline, but are restricted from panning past the indicator. Disabled by default.
Item templates Browse templates or
Reuse template (depending on your DataMiner version)
Reuse a saved template from another component in the same dashboard or low-code app. This option is only available if a template is already in use.
Item templates Edit Open the Template Editor to customize the appearance of timeline items and configure actions triggered when a layer is selected. For more information, refer to Customizing timeline items.
Note
  • When you disable the Highlight option, items that do not match the filter will no longer be displayed, and the remaining items will be reorganized.
  • Prior to DataMiner 10.4.0 [CU13]/10.5.0 [CU1]/10.5.4, the option to reuse a template is only available when another timeline component in the dashboard or low-code app is configured with a custom template.

Customizing timeline items

Using the Template Editor, you can fully customize the appearance of each timeline item. Additionally, conditional cases allow you not only to modify how items look when certain conditions are met, but also to update their underlying data simultaneously.

To access the Template Editor:

  1. In the Layout pane, navigate to the Item templates section.

    This section shows a preview of the template currently applied to the timeline component.

  2. Click Edit to open the Template Editor.

  3. Make your changes as described under Using the Template Editor.

Some real-life examples:

  • In this example, the Template Editor was used to add an icon in the lower-left corner of each timeline item, indicating whether a task is not started, on hold, or active (represented by an hourglass, pause, or play icon, respectively).

    Timeline - Change state
    Timeline component in DataMiner 10.5.4

    Beyond changing the visual appearance, actions were configured on the icon layer so that clicking it opens a context menu. This menu allows users to manually update the icon and, at the same time, modify the underlying task status via an Automation script.

  • In this example, the timeline component is used as an interactive TV schedule, styled with customized colors, icons, and more. A conditional case ensures that when a program has been recorded, a red dot appears in the top-right corner of the item.

    Timeline - TV schedule
    Timeline component in DataMiner 10.4.1

Default timeline template

By default, the template of a timeline component includes the following pre-configured layers:

Layer Type Description
Text layer Text Displays the value from the first column in the data source.
Rectangle layer 1 Rectangle Acts as the background of each timeline item. Default color is #F6F6F6, with conditional formatting for hover (#E8E8E9) and selection (#D5DBE9).
Rectangle layer 2 Rectangle Acts as a visual border by being slightly larger than the background layer. Default color is #D3D4D5, with conditional formatting for selection (#B8BABC).

This default template (available from DataMiner 10.4.0 [CU13]/10.5.0 [CU1]/10.5.4 onwards) ensures that a timeline item is highlighted when hovered over and stands out when selected, with a light-blue background and a blue border.

Selecting a timeline item
Timeline component in DataMiner 10.5.9

This can for instance be useful when the timeline's component data (i.e. Components > Timeline > Selected groups / Selected time ranges) is used in another component. The highlight helps users identify which data is driving the content of the linked component.

Timeline settings

In the Settings pane for this component, you can customize its behavior to suit your requirements.

Section Option Description
WebSocket settings Inherit WebSocket settings from page/panel Clear the checkbox to use a custom polling interval for this component. When cleared, you can specify a different polling interval (in seconds).
General Timeline Configure the start and end times of the timeline component. When you add a new timeline component, this is automatically configured.
General Override dynamic units Clear the checkbox to prevent parameter units from changing dynamically based on their value and protocol definition. Disabled by default.
General Use dynamic units Determine whether parameter units will change dynamically based on their value and protocol definition. This option is only available if Override dynamic units is enabled.
General Default time range Select a time range to zoom the timeline to, e.g. Today, Last 7 days, or Next hour. Options are grouped into the following categories: Still busy, In the past, Near future, Recently, Long run, Starting from now, and Distant future. If you select Custom, you can set a custom start and end time. Default: Still busy, This week.
General Link time range Synchronize the timeline's time range with another dashboard or app component, e.g. a time range component. Any changes in the linked component's time range are automatically applied to the timeline. See Linking to a time range component.
Data retrieval Update data Toggle the switch to determine whether the data in the timeline should be refreshed automatically (provided this is supported by the data source). See Query updates. Disabled by default.
Events On range select Available from DataMiner 10.3.0 CU14/10.4.0 CU2/10.4.5 onwards. Configure an action that is triggered when a section of the timeline is selected using the right mouse button. See Adding actions to a timeline.
Events On item resize Available from DataMiner 10.3.0 CU14/10.4.0 CU2/10.4.5 onwards. Configure an action that is triggered when an item on the timeline is resized. A timeline item can only resized if at minimum one action has been configured that is triggered on item resize. See Adding actions to a timeline.
Events On item move Available from DataMiner 10.3.0 CU14/10.4.0 CU2/10.4.5 onwards. Configure an action that is triggered when an item on the timeline is moved. See Adding actions to a timeline.
Events On group change Available from DataMiner 10.3.0 CU14/10.4.0 CU2/10.4.5 onwards. Configure an action that is triggered when an item on the timeline is moved to another group. See Adding actions to a timeline.
Highlight range Use highlighting Toggle the switch to determine whether a configured time range in the timeline component is highlighted. See Highlighting a time range.
Highlight range Time range Specify which time range of the timeline component should be highlighted. This option is only available when Use highlighting is enabled.
Note
  • The timeline component has a minimum time range of 5 milliseconds and a maximum of 10 years.
  • When you enable the Update data setting, real-time updates will only be applied for the data sources and operators listed on the Query updates page. Prior to DataMiner 10.4.0/10.4.3, data will only be updated every 30 seconds, and this will only be applied for GQI queries using the Get parameter table by ID data source.

Adding actions to a timeline

From DataMiner 10.3.0 CU14/10.4.0 CU2/10.4.5 onwards, you can configure actions for any timeline component you add to a low-code app. This feature is not available in the Dashboards app.

To configure actions:

  1. In the Settings pane, expand the Events section.

  2. Choose one of the available event types:

    • On range select: This event takes place when a section of the timeline is selected using the right mouse button.

    • On item resize: This event takes place when an item on the timeline is resized.

    • On item move: This event takes place when an item on the timeline is moved.

    • On group change: This event takes place when an item on the timeline is moved to another group.

    Note

    While the On range select event is timeline-based, other events can have a different configuration for each query on the timeline. For example, if there are multiple queries on the timeline, and you move an item belonging to a certain query, the timeline will look at the configuration of actions for the On move event of that specific query to decide which actions to execute.

  3. Click Configure actions next to your chosen event type.

  4. Configure any of the available actions, as detailed under Configuring low-code app events.

Timeline component actions

Component actions are operations that can be executed on a component when an event is triggered.

When you select the Execute component action option, you can choose from a list of components in the app and the specific actions available for each of them.

For the timeline component, the following component actions are available:

  • Clear highlights: Clears all highlights set by Highlight time range actions.

  • Fetch the data: Available from DataMiner 10.2.10/10.3.0 onwards. Fetches the data for the component.

  • Highlight time range: Highlights a range on the timeline component. The highlighted section will expose data in the form of a Timespan object. If multiple sections are highlighted, the data will contain an array of Timespan objects.

  • Set viewport: Sets the viewport of the timeline to a certain time range.

Note

Prior to DataMiner 10.3.0 CU14/10.4.0 CU2/10.4.5, highlights can be configured using the Highlight range setting. This setting is still available in later DataMiner versions and can be used in combination with highlights set by actions. Its behavior remains the same: a highlight set by the Highlight range setting will not expose data and it will not be cleared by the Clear highlights action.

Using event data in actions

When a user interacts with the timeline (e.g. moving an item), the event can provide details about what changed. From DataMiner 10.3.0 CU14/10.4.0 CU2/10.4.5 onwards, you can use this event data in your actions.

This is useful because it allows you to:

  • Update your data through an Automation script based on what the user did.

  • Keep the timeline and your data in sync, so changes are not just visual.

For example, if a user resizes an item, the event gives you both the old and new time range, along with the item's details. You can then pass that information to a script that updates the actual data behind the timeline.

Each event provides the following data:

Event Exposed data
Selecting a time range The selected time range as a Timespan object.
Resizing an item Old and new Timespan values (indicating the start and end of the item before and after the resize), plus the item's data as a Table object.
Moving an item Old and new Timespan values, plus the item's data as a Table object.
Changing an item's group Current and new item state, both as Table objects.
Tip

Watch the Building an enhanced timeline in Low-Code Apps video tutorial, which walks you through setting up interactions, using event data, and linking it to Automation scripts. You can also follow along yourself using the accompanying Catalog package.

Note
  • Prior to DataMiner 10.3.0 [CU21]/10.4.0 [CU9]/10.4.12, the data type "Table" is called "Query row" instead.
  • If your data source does not support real-time updates, the Launch a script action (to update your data) will need to be followed by an Execute component action (to refetch the data).

Enabling the component in soft launch

From DataMiner 10.1.10 onwards, the timeline component is available in soft launch, if the soft-launch option ReportsAndDashboardsScheduler is enabled. For more information, see Soft-launch options.

If you use the preview version of the timeline component, its functionality may be different from what is described on this page.