Interface: TimelineFigureOptions

Options of timeline: the camelCase counterparts of px.timeline's parameters.

Properties

Property	Modifier	Type	Description
categoryOrders?	readonly	Readonly<Record<string, readonly unknown[]>>	Value orders per column, e.g. { Resource: ['Ana', 'Ben'] } orders the traces and legend, { Task: [...] } the rows. Values not listed follow in order of first appearance. Rows listed for y are kept even without a bar, so rows of other traces (milestones) can be placed too.
color?	readonly	string	Column to group by: one trace (and legend item) per distinct value.
colorDiscreteMap?	readonly	Readonly<Record<string, string>>	Fixed colors per color value. Other values take colorDiscreteSequence, else the colorway.
colorDiscreteSequence?	readonly	readonly string[]	Colors for color values in order. Default: the template's colorway (no marker.color).
data	readonly	TimelineData	The table: an array of row objects, or an object of equally long columns.
hoverData?	readonly	readonly string[]	Extra columns listed in the hover label (through customdata).
hoverName?	readonly	string	Column shown in bold at the top of the hover label.
labels?	readonly	Readonly<Record<string, string>>	Display names of columns, for hover lines, the legend title and the y axis title.
opacity?	readonly	number	Bar opacity (marker.opacity), 0–1.
reverseY?	readonly	boolean	List rows top-down, the first row (or the first entry of categoryOrders[y]) at the top, as Gantt charts read. Default true; false keeps Plotly's bottom-up category order.
text?	readonly	string	Column of labels drawn on the bars (textposition: 'auto').
title?	readonly	string	Figure title.
xEnd	readonly	string	Column of end dates.
xStart	readonly	string	Column of start dates (date strings, Dates or ms since the epoch).
y	readonly	string	Column of row labels (tasks): the categories of the y axis.