Skip to main content
Applies to: Cloud and 3.259.0-edge

The Timeline web component

Display a Gantt chart of events.

Demo

For more information about this component, refer to the Timeline guide.

Properties​

All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

data​

The data.

Type string | number | boolean | object | array
Format Custom data
Configurability Inspector
Defaultnull

eventColorByIndex​

A list of colors for each item, by index.

Type array
Array values string
Configurability Read-only
Defaultnull

eventEndDateByIndex​

A list of event end dates, by index.

Type array
Array values string
Configurability Read-only
Defaultnull

eventIdByIndex​

A list of event IDs, by index.

Type array
Array values string
Configurability Read-only
Defaultnull

eventPropertiesByIndex​

A list of event properties, by index.

Type array
Array values string
Configurability Read-only
Defaultnull

events​

A list of configured event handlers that trigger actions or queries.

Type array
Array values object
Configurability Inspector > Interaction > Event handlers
Defaultnull
Array Object Properties

event​

The event that triggers the action. Refer to the events section for details of available events for this object.

Type string
Configurability Inspector > Interaction > Event handlers > Event
Defaultnull

method​

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

Type string
Configurability Inspector > Interaction > Event handlers > Edit event handler > Run script actions
Defaultnull

type​

The type of action to perform.

Type string
Configurability Inspector > Interaction > Event handlers > Edit event handler > Action
Allowed Values
ValueDescription
datasource

Control query.

widget

Control component.

script

Run script.

state

Set variable.

localStorage

Set localStorage.

util

Perform utility action (e.g., Open URL or Confetti).

Defaultnull

eventStartDateByIndex​

A list of event start dates, by index.

Type array
Array values string
Configurability Read-only
Defaultnull

eventTitleByIndex​

A list of event titles, by index.

Type array
Array values string
Configurability Read-only
Defaultnull

eventTooltipLabelByIndex​

A list of tooltips for each item, by index.

Type array
Array values string
Configurability Read-only
Default[]
Examples
["Tooltip 1", "Tooltip 2"]

groupBy​

The grouping option when isGrouped is true.

Type string
Configurability Read-only
Allowed Values
ValueDescription
day

Group items by day.

none

Disable grouping.

Defaultnull

hidden​

Whether this object is hidden from view.

Type boolean
Format True/False
Configurability Inspector > Appearance > Hidden
Defaultfalse
Examples
true

id​

The unique identifier (name).

Type string
Format Plain Text
Configurability Inspector
Defaulttimeline1
Examples
query1
button1

initialDate​

The initial date to display.

Type string
Configurability Inspector
Defaultnull

isHiddenOnDesktop​

Whether to show or hide this object in the desktop layout.

Type boolean
Format True/False
Configurability Inspector > Appearance > Advanced > Show on desktop
Defaultfalse
Examples
true

isHiddenOnMobile​

Whether to show or hide this object in the mobile layout.

Type boolean
Format True/False
Configurability Inspector > Appearance > Advanced > Show on mobile
Defaulttrue
Examples
true

maintainSpaceWhenHidden​

Whether to take up space on the canvas if hidden is true.

Type boolean
Format True/False
Configurability Inspector > Appearance > Advanced > Maintain space when hidden
Defaultfalse
Examples
true

margin​

The amount of margin to render outside.

Type string
Format Plain Text
Configurability Inspector > Spacing > Margin
Allowed Values
ValueUI OptionDescription
4px 8pxNormal

Normal margin.

0None

No margin.

Default4px 8px
Examples
4px 8px

metaEventColorByIndex​

A list of meta event colors, by index.

Type array
Array values string
Configurability Read-only
Defaultnull

metaEventData​

The metadata for the event.

Type object
Configurability Inspector
Defaultnull

metaEventEndDateByIndex​

A list of meta event end dates, by index.

Type array
Array values string
Configurability Read-only
Defaultnull

metaEventStartDateByIndex​

A list of meta event start dates, by index.

Type array
Array values string
Configurability Read-only
Defaultnull

metaEventTitleByIndex​

A list of meta event titles, by index.

Type array
Array values string
Configurability Read-only
Defaultnull

milestoneColorByIndex​

A list of milestone colors, by index.

Type array
Array values string
Configurability Read-only
Defaultnull

milestoneData​

The data.

Type string | number | boolean | object | array
Format Custom data
Configurability Inspector
Defaultnull

milestoneDateByIndex​

A list of milestone dates, by index.

Type array
Array values string
Configurability Read-only
Defaultnull

milestoneTitleByIndex​

A list of milestone titles, by index.

Type array
Array values string
Configurability Read-only
Defaultnull

quarterStartDay​

The day of the month when Q1 starts.

Type number
Configurability Read-only
Defaultnull

quarterStartMonth​

The month when Q1 starts.

Type number
Configurability Read-only
Defaultnull

renderOneEventPerRow​

Whether to render one event per row.

Type boolean
Configurability Read-only
Defaultnull

showInEditor​

Whether the component remains visible in the editor if hidden is true.

Type boolean
Format True/False
Configurability Inspector > Appearance > Advanced > Always show in edit mode
Defaultfalse
Examples
true

showTodayIndicator​

Whether to show the current date indicator.

Type boolean
Configurability Read-only
Defaultnull

style​

Custom style options.

Type object
Configurability Inspector > Appearance > style
Defaultnull

timescale​

The visible period of time to render.

Type object
Configurability Inspector
Defaultnull
Object Properties

split​

The unit of time with which to split.

Type string
Configurability Read-only
Allowed Values
ValueDescription
week

Week

month

Month

day

Day

Defaultnull

unit​

The unit of time with which to render.

Type string
Configurability Read-only
Allowed Values
ValueDescription
week

Week

month

Month

quarter

Quarter

year

Year

Defaultnull

Methods​

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

timeline.scrollIntoView()​

Scrolls the canvas or parent container so that the selected component appears in the visible area.

Definition
timeline.scrollIntoView(options)
Parameters

options​

The scroll options.

Type object
Object Properties

behavior​

The scroll behavior.

Type string
Allowed Values
ValueDescription
auto

Scroll immediately to the specified position.

smooth

Scroll gradually to the specified position.

block​

The scroll position relative to the component.

Type string
Allowed Values
ValueDescription
nearest

Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.

start

Scrolls to position the component at the top of the visible area.

center

Scrolls to position the component in the middle of the visible area.

end

Scrolls to position the component at the bottom of the visible area.

Examples

Scroll the minimum amount to immediately bring timeline into view.

timeline.scrollIntoView({behavior: 'auto', block: 'nearest'});

timeline.setHidden()​

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

Definition
timeline.setHidden(hidden)
Parameters

hidden​

Whether this object is hidden from view.

Type boolean
Format True/False
Default
false
Examples
true
Examples

Hide timeline.

timeline.setHidden(true);

Unhide timeline.

timeline.setHidden(false);

Events​

Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.

EventDescription
ClickAn item is clicked or pressed.