The Timeline web component

Display a Gantt chart of events.

Demo

Settings

Timeline includes the following configurable options when building apps in the IDE.

DataHiddenDefault dateShow on desktopShow on mobileMaintain space when hiddenMarginAlways show in edit modeStylesTimescaleHelper text

Properties

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

data

any[]

The source data.

---

eventColorByIndex

string[]

A list of colors for each item, by index.

---

eventEndDateByIndex

string[]

A list of event end dates, by index.

---

eventPropertiesByIndex

string[]

A list of event properties, by index.

---

eventStartDateByIndex

string[]

A list of event start dates, by index.

---

eventTitleByIndex

string[]

A list of event titles, by index.

---

eventTooltipLabelByIndex

string[]

A list of tooltips for each item, by index.

---

global

boolean

Whether the object is globally scoped for use in all app pages.

---

groupBy

enum

The grouping option when isGrouped is true.

Values

day	Group items by day.
none	Disable grouping.

---

hidden

boolean

Whether the component is visible.

---

id

string

The unique identifier.

---

initialDate

string

The initial date to display.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

maintainSpaceWhenHidden

boolean

Whether the component takes up space on the canvas if hidden is true.

---

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

---

metaEventColorByIndex

string[]

A list of meta event colors, by index.

---

metaEventEndDateByIndex

string[]

A list of meta event end dates, by index.

---

metaEventTitleByIndex

string[]

A list of meta event titles, by index.

---

milestoneColorByIndex

string[]

A list of milestone colors, by index.

---

milestoneData

any[]

The source data for milestones.

---

milestoneDateByIndex

string[]

A list of milestone dates, by index.

---

milestoneTitleByIndex

string[]

A list of milestone titles, by index.

---

pluginType

string

The plugin type.

---

quarterStartDay

number

The day of the month when Q1 starts.

---

quarterStartMonth

number

The month when Q1 starts.

---

renderOneEventPerRow

boolean

Whether to render one event per row.

---

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

---

showTodayIndicator

boolean

Whether to show the current date indicator.

---

style

object

Custom style options in use. Not all style options may be available for all components.

---

timescale

object

The visible period of time to render.

Properties

split

enum

The unit of time with which to split.

Values

week	Week
month	Month
day	Day

---

unit

enum

The unit of time with which to render.

Values

week	Week
month	Month
quarter	Quarter
year	Year

---

---

tooltipText

string

The tooltip text to display.

---

Methods

JavaScript API methods for interacting with Timeline. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

scrollIntoView

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

timeline.scrollIntoView(scrollIntoViewOptions)

Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

---

block

enum

The scroll position relative to the component.

Values

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.

---

---

---

setHidden

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

timeline.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

---

---