The Timeline web component
A content area to display a timeline of events.
Settings
Timeline includes the following configurable options when building apps in the IDE.
FormatShow on desktopShow on mobileMaintain space when hiddenMarginAlways show in edit modeStylesFormat |
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.
dateFormat
The displayed date format.
global
Whether the object is globally scoped for use in all app pages.
groupBy
The grouping option when isGrouped
is true
.
Values
day | Group items by day. |
none | Disable grouping. |
id
The unique identifier.
isGrouped
Whether to group items.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
pending
The label to display for pending items when isGrouped
is false
.
pluginType
The plugin type.
renderAsHtml
Whether to render the text as HTML.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
sortedDesc
Whether to sort items in descending order when isGrouped
is true
.
timeFormat
The format of the time.
timestamps
A list of timestamps for each item when isGrouped
is true
.
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
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
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. |