'always' - Always show entity lines.
'individualEvents' - Show entity lines with individual events only, not with the heatmap.
'never' - Never show entity lines.

standardRowHeight

number default: 24

Standard height of entity rows in px, with a minimum value of 14. Font icons are only displayed on events if this height is set to 20 or more.

truncateLabelsAt

number default: 40

When entity label area width mode is set to 'auto', specifies the number of characters at which the labels are truncated - using Intl.Segmenter. To disable truncation, set to 0.

rowSpacing

'centered' | 'justified' default: 'centered'

Controls how entity rows are spaced vertically in the timeline:

'centered' - Vertically clustered and centered along the timeline. Space above and below once a maximum separation is reached.
'justified' - Spread vertically across the height of the timeline, providing more space for event labels and font icons.

See Timeline Options for more information.

events

object

Options relating to events.

heatmapColor

null | string | string[] | HeatmapColorStep[] | HeatmapEventTypePriority[] default: null

The color to apply to the heatmap:

null - Cells use the average color of their underlying events, with an alpha applied based on the cell's value.
string - All cells will use the color specified, with an alpha applied based on the cell's value.
string[] - The array of colors specified will be used to assign colors based on each cell's value within the distribution of the cells in the visible range.
heatmapColorStep[] - Colors are assigned to cells based on the step values provided.
heatmapEventTypePriority[] - Colors are assigned to cells if they include an event of the specified event type. Event types are prioritised by the index values of the array; the first index is given the highest priority.

See the Heatmap Colors docs for details.

heatmapDirection

'any' | 'from' | 'to' default: 'any'

The direction of the joins at each entity row for the underlying events that the heatmap will show:

'any' - Shows a heatmap for all underlying event directions.
'from' - Only shows a heatmap for entity rows that are the source of their underlying events.
'to' - Only shows a heatmap for entity rows that are the target of their underlying events.

heatmapPadding

boolean default: true

Whether to apply padding to heatmap cells.

heatmapThreshold

number default: 100

The number of visible events when the heatmap starts fading in.

heatmapValue

string | null default: null

If a string, the value of the corresponding property on the event's data object is used for the heatmap. If null, the underlying event count is used.

joinStyle

'auto' | 'horizontal' default: 'auto'

Controls how events are drawn:

'auto' - Automatically chooses the clearest way of drawing each event. Multi-directional events are drawn as a vertical line with horizontal arrowheads indicating the source/target role of each entity row, whereas uni-directional events are drawn as a single vertical arrow.
'horizontal' - All events are drawn as a vertical line with horizontal arrowheads indicating the source/target role of each entity row.

revealHeatmapAlpha

number default: 1

Alpha applied to fade out rows that have no revealed events.

showLines

'all' | 'focus' default: 'all'

Controls when to show event lines :

'all' - Show event lines for all individual events.
'focus' - Only show event lines for focused entities.

expandedRows

object

Options relating to expanding entity rows, see Expanded Rows.

durationEventsOnly

boolean default: true

Only entity rows with overlapping duration events are expanded.

showSubRowLines

boolean default: false

When entities are expanded, show lines for their sub-rows.

focus

object

Options relating to focus behavior.

backgroundColor

string default: '#8b041b'

The background color to use for focused items.

reorder

boolean default: true

Whether to reorder the entities on focus when the ordering is set to 'shorteneventlines'.

rescale

boolean default: true

Whether to rescale the events on focus when scaleMode is set to 'nonlinear'.

Controls if all events on neighbors of focused entities should be shown. For example, if entity A is focused and is linked to entity B via an event, this option controls if all events involving entity B should be shown.

fontFamily

string default: 'sans-serif'

The name of the font family to use across the timeline.

highlightColor

string default: '#515f6c'

The color to use for the background of highlighted entities, highlighted scale intervals and the marquee drag area. A translucent version of this color will be applied.

hover

number default: 150

The number of milliseconds delay before the hover event is triggered.

rangeEventDelay

number default: 500

The time, in milliseconds, between triggering range events. Note that adjusting this delay may interact with your application's flow rate and so cause unexpected changes in behavior.

scaleGuide

object

Options relating to the scale guide.

lineColor

string default: '#e5e8eb'

The color of the line.

showAtBottom

boolean default: false

Controls if the bottom time readout and scale guide line is shown.

showAtTop

boolean default: false

Controls if the top time readout and scale guide line is shown.

snapDistance

number default: 10

The distance in pixels to snap the line to events. Set to 0 to disable snapping.

textColor

string default: '#e5e8eb'

The color of the text.

textFormat

string default: 'auto'

The date and time format. Set to auto to have the scale precision adapt to the current visible range. See Localization for more details.

width

number default: 1

The width of the line in pixels.

scales

object

Options relating to the timeline scales.

backgroundColor

string | null default: null

The color of the background of the scale. If null, backgroundColor is used.

borderColor

string | null default: '#e5e8eb'

The color of the scale borders. If null, backgroundColor is used.

dateOrder

'dmy' | 'mdy' default: 'mdy'

The order of dates:

'dmy' - For day-month-year.
'mdy' - For month-day-year.

dateTimeFormats

object

Specifies the formats for displaying dates and times in the scale. See Localization for more details.

centiseconds

string

One hundredth of a second, or 0.01 of a second.

date

string

Year, month, and day of month.

dateNoYear

string

Month, and day of month.

dateNoYearTime

string

Month, day of month, hour, and minutes.

dateNoYearTimeSeconds

string

Month, day of month, hour, minutes, and seconds.

dateTimeSeconds

string

Year, month, day of month, hour, minutes, and seconds.

dayOfMonth

string

Day of month.

dayOfMonthTime

string

Day of month, hour, and minutes.

dayOfMonthTimeSeconds

string

Day of month, hour, minutes, and seconds.

fullDayOfWeek

string

Full day of week.

fullDayOfWeekTime

string

Full day of week, hour and minutes.

fullDayOfWeekTimeSeconds

string

Full day of week, hour, minutes, and seconds.

fullMonth

string

Full month.

fullMonthYear

string

Year and full month.

hundredMicroseconds

string

One tenth of a millisecond, or 0.0001 of a second.

hundredNanoseconds

string

One tenth of a microsecond, or 0.0000001 of a second.

microseconds

string

One millionth of a second, or 0.000001 of a second.

milliseconds

string

One thousandth of a second, or 0.001 of a second.

nanoseconds

string

One billionth of a second, or 0.000000001 of a second.

shortDayOfWeek

string

Short day of week.

shortMonth

string

Short month.

tenMicroseconds

string

One hundredth of a millisecond, or 0.00001 of a second.

tenNanoseconds

string

One hundredth of a microsecond, or 0.00000001 of a second.

time

string

Hours and minutes.

timeSeconds

string

Hour, minutes, and seconds.

timeSecondsTenths

string

Hour, minutes, seconds, and tenths of a second.

timeMilliseconds

string

Hour, minutes, seconds, and thousandths of a second.

timeMicroseconds

string

Hour, minutes, seconds, and millionths of a second.

timeNanoseconds

string

Hour, minutes, seconds, and billionths of a second.

year

string

Full year.

dateTimeNames

object

Specifies names to use when displaying dates and times in the scale. See Localization for more details.

ampmNames

string[]

The names of the AM and PM symbols.

fullDayOfWeekNames

string[]

The full names of days of the week, starting with Sunday.

fullMonthNames

string[]

The full names of months, starting with January.

fullMonthNamesInDate

string[]

The full names of months as part of a date, starting with January.

shortDayOfWeekNames

string[]

The short names of days of the week, starting with Sunday.

shortMonthNames

string[]

The short names of months, starting with January.

fadeAtLeft

boolean default: true

Controls whether the scale fades at the left.

panLimit

'auto' | 'off' default: 'auto'

Controls how far the user can pan.

'auto' - Limits the range the user can pan so data is always in view.
'off' - Allows the user to pan to anywhere on the timeline. Use this option for lazy loading content.

For 'nonlinear' scaleMode, the panLimit cannot be 'off'; it will always revert to the 'auto' behavior.

scaleMode

'linear' | 'nonlinear' default: 'linear'

Controls the spacing between events on the timeline.

showAtBottom

boolean default: true

Controls if the scale at the bottom of the timeline is shown.

showAtTop

boolean default: true

Controls if the scale at the top of the timeline is shown.

textColor

string default: '#e5e8eb'

The color of the scale's text. Also changes the color of the markers and their labels.

twelveHourClock

boolean default: true

Whether a 12-hour clock should be used. False specifies a 24-hour clock.

wrapping

'off' | 'day' | 'week' | 'month' | 'year' default: 'off'

Controls Scale Wrapping, i.e. the way time is wrapped in the scale:

'off' - No wrapping, the scale shows time in a linear way.
'day' - The scale shows the time since the start of the day.
'week' - The scale shows the time since the start of the week.
'month' - The scale shows the time since the start of the month.
'year' - The scale shows the time since the start of the year.

zoomOutLimit

'auto' | object default: 'auto'

Sets a limit for how far a user can zoom out.

'auto' - The limit is set by KronoGraph

Use the parameters to specify the limit. Can be used for lazy loading content to improve performance and loading times for large datasets. For 'nonlinear' scaleMode, the zoomOutLimit is always the 'auto' behavior; any specified limits will be ignored.

unit

required

Sets the time interval of the limit.