Timeline Chart Node

Represents events or activities in chronological order along a linear timeline. Useful for visualizing sequences of events, project milestones, or historical timelines.

What is a Timeline Chart?

A timeline chart is a valuable visual tool designed to represent discrete events occurring over a specified period. Its primary purpose is to offer a graphical depiction of events, allowing users to understand the sequence and relationship between them. With the ability to create multiple related timelines, this chart facilitates the organization and comparison of events across different categories or contexts. Whether used for historical analysis, project management, or storytelling purposes, the timeline chart provides a clear and intuitive way to present chronological data. By visually mapping out events in time, users can gain insights into patterns, trends, and dependencies, aiding in decision-making and communication.

Inputs

The Timeline Chart node has two mandatory inputs. These are:

Input	Requirement	Comments
(Condition) Display Name	Mandatory	A field that provides an event condition.
Tooltip Field Name	Optional	A field that provides optional data to be displayed when the user hovers the cursor over the timeline segments.

How to Use

Implementation

In the Rayven Workflow Builder:

Select Visualizations.
Drag the Timeline Chart node to the canvas.
Provide an input to the Timeline Chart node by connecting it to another node.
Double click on the Timeline Chart node to open the configuration window.

Configuration

Section: General
This section contains basic configuration elements required for any Timeline Chart implementation
Field	Requirement	Comments
Widget Name	Mandatory	Enter a name for this node. This provides a handle to which you and others can refer, so it should be simple but meaningful and explain the node’s purpose.
Widget Subtitle	Optional	Additional text that can be used to explain the data presented by the node. This will appear directly under the Widget Name, in a smaller text size.
Device/Device Label Name	Optional	Select this checkbox to display the device or label name on the widget.
X - axis time interval	Mandatory	Provide an integer to determine the period of input data
Units of Measurement	Mandatory	Select from a dropdown menu Seconds Minutes Hours Days Weeks (Start on Monday) Weeks (Start on Sunday) Months Years
Widget refresh interval (sec)	Optional	Configure how often the chart widget will refresh. The default is every 60 seconds.
Comma separators at thousand mark	Optional	When checked, there will be comma separators at the thousand mark.
Interval Options Button	Mandatory	Users can either show or hide the interval options button on the Rayven dashboard.

Section: Column/Condition
This section contains configuration elements for Conditions used in any Timeline Chart implementation
Field	Requirement	Comments
Condition	Mandatory	To add a timeline, click the ⊕ Add Category button. This will open two new menu items: Condition 1 and Range 1. Condition 1 is the condition or event that you want to monitor. It has a: Input Data Field - the JSON key for data from the payload, Display Name - the name that you want to appear on the chart, Type - select an option from the dropdown menu; numeric or alphanumeric. Tooltip Field Name - the JSON key for tooltip data from the payload. This should not be the same as the data field name. Type: Numeric This widget creates a bar, the colour of which depends on the value of the data field. Range 1 allows you to set the bar colour for a numeric condition, you may set the: minimum and maximum range for the condition. a value or text to be displayed on the bar. a hex colour or use the colour picker to set the colour of the bar when the variable is in range. Type: Alphanumeric Value 1 allows you to set the bar colour for a alphanumeric condition, you may set the: value - the alphanumeric value to match (must be an exact match including capitalization). a value or text to be displayed on the bar. a hex colour or use the colour picker to set the colour of the bar when the variable is in range. To remove a Condition, Value, or Range, click the Ⓧ button at the end of the row to be deleted. If more colour ranges are required, you may click the ⊕ button next to the Condition. If more timelines are required, click the ⊕ Add Category button below the last Condition.
Input Data Field	Mandatory	This is the field name within the incoming JSON payload that contains the data to be displayed on the widget.
Display Name	Mandatory	This is the name for the column that will be displayed on the widget.
Numeric/Alphanumeric dropdown	Mandatory	Select one of the following from the dropdown menu Numeric Alphanumeric When “Numeric” is selected, you will be able to provide a range (or ranges) of numeric values, and refer to the “Section: Numeric Type” When “Alphanumeric” is selected, you will be able to provide an alphanumeric value (or values), and refer to the “Section: Alphanumeric Type” Note: Whichever selection you make applies to the entire Condition, so you need to have at least 2 Conditions if you wish to use both Numeric and Alphanumeric in the same chart.
Tooltip Field Name	Optional	A field that provides optional data to be displayed when the user hovers the cursor over the timeline segments.

Section: Numeric Type
This section contains configuration elements for the Timeline Chart condition when the Numeric Type is selected.
Field	Requirement	Comments
Range	Mandatory	Represents the individual range within a condition. Click and drag the small arrow to the left to rearrange ranges within a condition.
Range Min	Mandatory	Provide the minimum value for the range.
Range Max	Mandatory	Provide the maximum value for the range.
Display Value	Optional	This is the name for the range that will be displayed on the widget.
Decimal Precision	Optional	Enter the number of decimal places to display on the dashboard.
Hex Color	Optional	Hex code entry to select a color for this Condition’s output.

Section: Alphanumeric Type
This section contains configuration elements for the Timeline Chart condition when the Alphanumeric Type is selected.
Field	Requirement	Comments
Value	Mandatory	Represents the individual value within a condition. Click and drag the small arrow to the left to rearrange values within a condition.
Display Value	Optional	This is the name for the value that will be displayed on the widget.
Hex Color	Optional	Hex code entry to select a color for this Condition’s output.

Section: Delay
Field	Requirement	Comments
Apply Delay	Optional	When checked, it allows users to delay the display of the data on the timeline chart.
Delay Size	Mandatory (Only when Apply Delay is checked)	Enter a numeric value that will delay the display of data on the chart in any time measurement unit.
Delay Units	Mandatory (Only when Apply Delay is checked)	Select a time measurement unit from a dropdown menu: Seconds Minutes Hours Days Weeks Months Years

Section: Date Format
This section contains basic configuration elements required for any line chart implementation
Field	Requirement	Comments
X - axis	Optional	Select from a dropdown menu Default Date Only Time Only
Tooltip	Optional	Select from a dropdown menu Default Date Only Time Only

Section: Tooltip Info
Field	Requirement	Comments
Show Tooltip	Optional	When checked, it allows users to display their tooltip text on the widget.
Tooltip Text	Optional	This section only exists when “Show Tooltip” is checked. Users are able to write any tooltip message they desire which will be display on the widget.

Section: Group by Device Label
Field	Requirement	Comments
Device label name	Mandatory	There are no labels available in this box until you have saved at least one in the Device Labels section of the Workspace. Select a Label to use to filter devices.
Grouped	Mandatory	Select a method for grouping the widget on the dashboard from the dropdown: No Grouping (widget per device): one widget will appear for each device Group by device label value (Widget per label value): One widget will appear for each value of a label. For example, if the Label is ‘Colour’ and there are the values ‘Green’ and ‘Gold’, then two widgets will be displayed, one with devices with Colour Label equal to “Green” and one with devices with Colour Label equal to “Gold” Group by device label name (One widget): Only one widget will be displayed and this will contain data from all devices.