The Event List web component

A content area to display a list of events.

Demo

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.

eventColorByIndex

A list of colors for each item, by index.

Type	array
Array values	string
Configurability	Read-only
Default	null

---

eventEndDateByIndex

A list of event end dates, by index.

Type	array
Array values	string
Configurability	Read-only
Default	null

---

eventIdByIndex

A list of event IDs, by index.

Type	array
Array values	string
Configurability	Read-only
Default	null

---

eventPropertiesByIndex

A list of event properties, by index.

Type	array
Array values	string
Configurability	Read-only
Default	null

---

events

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

Type	array
Array values	object
Configurability	Inspector > Interaction > Event handlers
Default	null

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
Default	null

---

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
Default	null

---

type

The type of action to perform.

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Action
Allowed Values	Value Description 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).
Default	null

---

---

eventStartDateByIndex

A list of event start dates, by index.

Type	array
Array values	string
Configurability	Read-only
Default	null

---

eventTitleByIndex

A list of event titles, by index.

Type	array
Array values	string
Configurability	Read-only
Default	null

---

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	Value Description day Group items by day. none Disable grouping.
Default	null

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Configurability	Inspector
Default	eventList1

Examples

query1

button1

---

initialDate

The initial date to display.

Type	string
Configurability	Inspector
Default	null

---

isHiddenOnDesktop

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

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on desktop
Default	false

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
Default	true

Examples

true

---

items

The items in the Event List.

Type	array
Format	Plain Text
Array values	string
Configurability	Inspector > Content > Items
Default	null

---

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
Default	false

Examples

true

---

margin

The amount of margin to render outside.

Type	string
Format	Plain Text
Configurability	Inspector > Spacing > Margin
Allowed Values	Value UI Option Description 4px 8px Normal Normal margin. 0 None No margin.
Default	4px 8px

Examples

4px 8px

---

metaEventColorByIndex

A list of meta event colors, by index.

Type	array
Array values	string
Configurability	Read-only
Default	null

---

metaEventData

The metadata for the event.

Type	object
Configurability	Inspector
Default	null

---

metaEventEndDateByIndex

A list of meta event end dates, by index.

Type	array
Array values	string
Configurability	Read-only
Default	null

---

metaEventStartDateByIndex

A list of meta event start dates, by index.

Type	array
Array values	string
Configurability	Read-only
Default	null

---

metaEventTitleByIndex

A list of meta event titles, by index.

Type	array
Array values	string
Configurability	Read-only
Default	null

---

milestoneColorByIndex

A list of milestone colors, by index.

Type	array
Array values	string
Configurability	Read-only
Default	null

---

milestoneData

The data.

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

---

milestoneDateByIndex

A list of milestone dates, by index.

Type	array
Array values	string
Configurability	Read-only
Default	null

---

milestoneTitleByIndex

A list of milestone titles, by index.

Type	array
Array values	string
Configurability	Read-only
Default	null

---

quarterStartDay

The day of the month when Q1 starts.

Type	number
Configurability	Read-only
Default	null

---

quarterStartMonth

The month when Q1 starts.

Type	number
Configurability	Read-only
Default	null

---

renderOneEventPerRow

Whether to render one event per row.

Type	boolean
Configurability	Read-only
Default	null

---

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
Default	false

Examples

true

---

showTodayIndicator

Whether to show the current date indicator.

Type	boolean
Configurability	Read-only
Default	null

---

style

Custom style options.

Type	object
Configurability	Inspector > Appearance > style
Default	null

---

timescale

The visible period of time to render.

Type	object
Configurability	Inspector
Default	null

Object Properties

split

The unit of time with which to split.

Type	string
Configurability	Read-only
Allowed Values	Value Description week Week month Month day Day
Default	null

---

unit

The unit of time with which to render.

Type	string
Configurability	Read-only
Allowed Values	Value Description week Week month Month quarter Quarter year Year
Default	null

---

---

Methods

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

eventList.scrollIntoView()

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

Definition

eventList.scrollIntoView(options)

Parameters

options

The scroll options.

Type

object

Object Properties

behavior

The scroll behavior.

Type	string
Allowed Values	Value Description 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	Value Description 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 eventList into view.

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

---

eventList.setHidden()

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

Definition

eventList.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide eventList.

eventList.setHidden(true);

Unhide eventList.

eventList.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.

Event	Description
Click	An item is clicked or pressed.