Search

Login

Handled Events

In addition to standard events such as onClick, onKeyDown, and onFocus, the KronoGraph timeline also fires the following set of events.

For information about how to handle these, see Using Event Handlers.

onTimelineChange

Invoked whenever the timeline triggers a change of state.

Parameters

event
required
object

An object with details of the event.

annotations

{ [id: string]: Annotation }

The current set of annotations.

eventSelection

string[]

The ids of the selected events.

entitySelection

string[]

The ids of the selected entities.

expandedRows

{ mode: 'auto' | 'manual'; expandedRowIds: string[] }

The mode and ids of the expanded entity rows.

focus

string[]

The ids of the focused entities.

highlight

string[]

The ids of the highlighted entities.

lens

string | null

The id of the entity at the center of the lens.

pin

string[]

The ids of the pinned entities.

range

{ start: Date; startNanoseconds: number; end: Date; endNanoseconds: number }

An object containing the range of visible times.

why

required
ChangeReason

The reason this event was fired:

  • 'auto' - The event was triggered by internal KronoGraph state.
  • 'user' - The event was triggered by user action.

onTimelineClick

Invoked when the user clicks or taps on the timeline.

Default actions on the item controls :

  • Focus control - Focuses or unfocuses the entity row.
  • Pin control - Pins or unpins the entity row.
  • Annotation delete control - Deletes the annotation.

Parameters

event
required
object

An object with details of the event.

button

required
number

The index of the button used.

defaultPrevented

required
boolean

A read-only value indicating whether the default action was prevented.

endNanoseconds

number

The number of nanoseconds to add to endTime.

endTime

Date

The end of the time range covered by the targeted item. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

entitiesInRow

object

If the interaction event targets an entity row, a dictionary object containing the entities in the row, indexed by the entity ids.

eventIds

string[]

An array of ids of events within the targeted item. Only defined if targetType is event, eventSummary or cell.

id

required
string | null

The id of the targeted item.

label

string

The label of the targeted item.

modifierKeys

required
EventModifierKeys

An object describing which modifier keys were pressed when the event occurred.

pointerId

required
number

The unique identifier of the pointer.

pointerType

required
string

The type of pointing device: mouse, touch or pen.

preventDefault()

If called, the default action is prevented.

Returns void

startNanoseconds

number

The number of nanoseconds to add to startTime.

startTime

Date

The start of the time range covered by the targeted item. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

subItem

SubItem

An object containing details of the sub-item, or undefined if the cursor is not over a sub-item.

targetType

required
'annotationBody' | 'annotationDeleteButton' | 'annotationEditButton' | 'annotation' | 'cell' | 'entity' | 'entityGroup' | 'entityRun' | 'event' | 'eventSummary' | 'eventLabel' | 'focus' | 'fold' | 'foldControl' | 'glyph' | 'labelAreaBorder' | 'lensControl' | 'lensScrollbar' | 'pin' | 'scale' | 'timeSeriesChart' | null

The type of the targeted item.

time

Date

The timeline time corresponding to the pointer position. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

timeNanoseconds

number

The number of nanoseconds to add to time.

x

required
number

The distance from the left edge of the Timeline element to the pointer position.

y

required
number

The distance from the top edge of the Timeline element to the pointer position.

onTimelineDraw

Invoked whenever the timeline is drawn.

onTimelineContextMenu

Invoked on a right click or a long press on the timeline.

Default action:

  • Suppresses the click event.

Parameters

event
required
object

An object with details of the event.

button

required
number

The index of the button used.

defaultPrevented

required
boolean

A read-only value indicating whether the default action was prevented.

endNanoseconds

number

The number of nanoseconds to add to endTime.

endTime

Date

The end of the time range covered by the targeted item. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

entitiesInRow

object

If the interaction event targets an entity row, a dictionary object containing the entities in the row, indexed by the entity ids.

eventIds

string[]

An array of ids of events within the targeted item. Only defined if targetType is event, eventSummary or cell.

id

required
string | null

The id of the targeted item.

label

string

The label of the targeted item.

modifierKeys

required
EventModifierKeys

An object describing which modifier keys were pressed when the event occurred.

pointerId

required
number

The unique identifier of the pointer.

pointerType

required
string

The type of pointing device: mouse, touch or pen.

preventDefault()

If called, the default action is prevented.

Returns void

startNanoseconds

number

The number of nanoseconds to add to startTime.

startTime

Date

The start of the time range covered by the targeted item. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

subItem

SubItem

An object containing details of the sub-item, or undefined if the cursor is not over a sub-item.

targetType

required
'annotationBody' | 'annotationDeleteButton' | 'annotationEditButton' | 'annotation' | 'cell' | 'entity' | 'entityGroup' | 'entityRun' | 'event' | 'eventSummary' | 'eventLabel' | 'focus' | 'fold' | 'foldControl' | 'glyph' | 'labelAreaBorder' | 'lensControl' | 'lensScrollbar' | 'pin' | 'scale' | 'timeSeriesChart' | null

The type of the targeted item.

time

Date

The timeline time corresponding to the pointer position. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

timeNanoseconds

number

The number of nanoseconds to add to time.

x

required
number

The distance from the left edge of the Timeline element to the pointer position.

y

required
number

The distance from the top edge of the Timeline element to the pointer position.

onTimelineDoubleClick

Invoked on a double-click or a double-tap on the timeline.

Default actions:

  • On the background - Unfocuses any focused entity rows.
  • On an entity row - Focuses or unfocuses the entity row.
  • On the scale - Sets the timeline range to the startTime and endTime properties of the selected scale item.

Parameters

event
required
object

An object with details of the event.

button

required
number

The index of the button used.

defaultPrevented

required
boolean

A read-only value indicating whether the default action was prevented.

endNanoseconds

number

The number of nanoseconds to add to endTime.

endTime

Date

The end of the time range covered by the targeted item. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

entitiesInRow

object

If the interaction event targets an entity row, a dictionary object containing the entities in the row, indexed by the entity ids.

eventIds

string[]

An array of ids of events within the targeted item. Only defined if targetType is event, eventSummary or cell.

id

required
string | null

The id of the targeted item.

label

string

The label of the targeted item.

modifierKeys

required
EventModifierKeys

An object describing which modifier keys were pressed when the event occurred.

pointerId

required
number

The unique identifier of the pointer.

pointerType

required
string

The type of pointing device: mouse, touch or pen.

preventDefault()

If called, the default action is prevented.

Returns void

startNanoseconds

number

The number of nanoseconds to add to startTime.

startTime

Date

The start of the time range covered by the targeted item. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

subItem

SubItem

An object containing details of the sub-item, or undefined if the cursor is not over a sub-item.

targetType

required
'annotationBody' | 'annotationDeleteButton' | 'annotationEditButton' | 'annotation' | 'cell' | 'entity' | 'entityGroup' | 'entityRun' | 'event' | 'eventSummary' | 'eventLabel' | 'focus' | 'fold' | 'foldControl' | 'glyph' | 'labelAreaBorder' | 'lensControl' | 'lensScrollbar' | 'pin' | 'scale' | 'timeSeriesChart' | null

The type of the targeted item.

time

Date

The timeline time corresponding to the pointer position. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

timeNanoseconds

number

The number of nanoseconds to add to time.

x

required
number

The distance from the left edge of the Timeline element to the pointer position.

y

required
number

The distance from the top edge of the Timeline element to the pointer position.

onTimelineDragEnd

Invoked when the drag is finished and pointer is released, or when the drag is canceled. On touch devices this fires when the finger or pointing device is lifted.

Default action:

  • On MarqueeRange drag type - the timeline will zoom into the selected range.

Parameters

event
required
object

An object with details of the event.

button

required
number

The index of the button used.

defaultPrevented

required
boolean

A read-only value indicating whether the default action was prevented.

dragType

'annotationScrollBar' | 'labelAreaWidth' | 'lensScrollbar' | 'marqueeRange' | 'marqueeSelection' | 'moveAnnotation' | 'pan' | null

The type of drag.

endNanoseconds

number

The number of nanoseconds to add to endTime.

endTime

Date

The end of the time range covered by the targeted item. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

entitiesInRow

object

If the interaction event targets an entity row, a dictionary object containing the entities in the row, indexed by the entity ids.

entityRangeSubject

EntityRangeSubject

The entity range within the dragged area. Only present when dragType is 'marqueeSelection'.

eventIds

string[]

An array of ids of events within the targeted item. Only defined if targetType is event, eventSummary or cell.

id

required
string | null

The id of the targeted item.

label

string

The label of the targeted item.

modifierKeys

required
EventModifierKeys

An object describing which modifier keys were pressed when the event occurred.

pointerId

required
number

The unique identifier of the pointer.

pointerType

required
string

The type of pointing device: mouse, touch or pen.

preventDefault()

If called, the default action is prevented.

Returns void

startNanoseconds

number

The number of nanoseconds to add to startTime.

startTime

Date

The start of the time range covered by the targeted item. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

subItem

SubItem

An object containing details of the sub-item, or undefined if the cursor is not over a sub-item.

targetType

required
'annotationBody' | 'annotationDeleteButton' | 'annotationEditButton' | 'annotation' | 'cell' | 'entity' | 'entityGroup' | 'entityRun' | 'event' | 'eventSummary' | 'eventLabel' | 'focus' | 'fold' | 'foldControl' | 'glyph' | 'labelAreaBorder' | 'lensControl' | 'lensScrollbar' | 'pin' | 'scale' | 'timeSeriesChart' | null

The type of the targeted item.

time

Date

The timeline time corresponding to the pointer position. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

timeNanoseconds

number

The number of nanoseconds to add to time.

x

required
number

The distance from the left edge of the Timeline element to the pointer position.

y

required
number

The distance from the top edge of the Timeline element to the pointer position.

onTimelineDragMove

Invoked continuously as the cursor moves during a drag.

Parameters

event
required
object

An object with details of the event.

button

required
number

The index of the button used.

defaultPrevented

required
boolean

A read-only value indicating whether the default action was prevented.

dragType

'annotationScrollBar' | 'labelAreaWidth' | 'lensScrollbar' | 'marqueeRange' | 'marqueeSelection' | 'moveAnnotation' | 'pan' | null

The type of drag.

endNanoseconds

number

The number of nanoseconds to add to endTime.

endTime

Date

The end of the time range covered by the targeted item. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

entitiesInRow

object

If the interaction event targets an entity row, a dictionary object containing the entities in the row, indexed by the entity ids.

eventIds

string[]

An array of ids of events within the targeted item. Only defined if targetType is event, eventSummary or cell.

id

required
string | null

The id of the targeted item.

label

string

The label of the targeted item.

modifierKeys

required
EventModifierKeys

An object describing which modifier keys were pressed when the event occurred.

pointerId

required
number

The unique identifier of the pointer.

pointerType

required
string

The type of pointing device: mouse, touch or pen.

preventDefault()

If called, the default action is prevented.

Returns void

startNanoseconds

number

The number of nanoseconds to add to startTime.

startTime

Date

The start of the time range covered by the targeted item. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

subItem

SubItem

An object containing details of the sub-item, or undefined if the cursor is not over a sub-item.

targetType

required
'annotationBody' | 'annotationDeleteButton' | 'annotationEditButton' | 'annotation' | 'cell' | 'entity' | 'entityGroup' | 'entityRun' | 'event' | 'eventSummary' | 'eventLabel' | 'focus' | 'fold' | 'foldControl' | 'glyph' | 'labelAreaBorder' | 'lensControl' | 'lensScrollbar' | 'pin' | 'scale' | 'timeSeriesChart' | null

The type of the targeted item.

time

Date

The timeline time corresponding to the pointer position. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

timeNanoseconds

number

The number of nanoseconds to add to time.

x

required
number

The distance from the left edge of the Timeline element to the pointer position.

y

required
number

The distance from the top edge of the Timeline element to the pointer position.

onTimelineDragStart

Invoked when a drag is started. Use setDragOptions to set the dragging behavior.

Default actions:

  • On the background - Pans the timeline.
  • On the scale - Draws a marquee range. On drag-end, the default action is to zoom into the selected range.
  • On the label area border - Adjusts the label area width.

Parameters

event
required
object

An object with details of the event.

button

required
number

The index of the button used.

defaultPrevented

required
boolean

A read-only value indicating whether the default action was prevented.

dragType

'annotationScrollBar' | 'labelAreaWidth' | 'lensScrollbar' | 'marqueeRange' | 'marqueeSelection' | 'moveAnnotation' | 'pan' | null

The type of drag.

endNanoseconds

number

The number of nanoseconds to add to endTime.

endTime

Date

The end of the time range covered by the targeted item. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

entitiesInRow

object

If the interaction event targets an entity row, a dictionary object containing the entities in the row, indexed by the entity ids.

eventIds

string[]

An array of ids of events within the targeted item. Only defined if targetType is event, eventSummary or cell.

id

required
string | null

The id of the targeted item.

label

string

The label of the targeted item.

modifierKeys

required
EventModifierKeys

An object describing which modifier keys were pressed when the event occurred.

pointerId

required
number

The unique identifier of the pointer.

pointerType

required
string

The type of pointing device: mouse, touch or pen.

preventDefault()

If called, the default action is prevented.

Returns void

setDragOptions(options)

Controls the dragging behavior.

Parameters

options
required
DraggerOptions

Options to control the dragging behavior.

Returns void

startNanoseconds

number

The number of nanoseconds to add to startTime.

startTime

Date

The start of the time range covered by the targeted item. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

subItem

SubItem

An object containing details of the sub-item, or undefined if the cursor is not over a sub-item.

targetType

required
'annotationBody' | 'annotationDeleteButton' | 'annotationEditButton' | 'annotation' | 'cell' | 'entity' | 'entityGroup' | 'entityRun' | 'event' | 'eventSummary' | 'eventLabel' | 'focus' | 'fold' | 'foldControl' | 'glyph' | 'labelAreaBorder' | 'lensControl' | 'lensScrollbar' | 'pin' | 'scale' | 'timeSeriesChart' | null

The type of the targeted item.

time

Date

The timeline time corresponding to the pointer position. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

timeNanoseconds

number

The number of nanoseconds to add to time.

x

required
number

The distance from the left edge of the Timeline element to the pointer position.

y

required
number

The distance from the top edge of the Timeline element to the pointer position.

onTimelineHover

Invoked when the user hovers over an item for a specified time. The delay is defined by the hover option.

Parameters

event
required
object

An object with details of the event.

button

required
number

The index of the button used.

defaultPrevented

required
boolean

A read-only value indicating whether the default action was prevented.

endNanoseconds

number

The number of nanoseconds to add to endTime.

endTime

Date

The end of the time range covered by the targeted item. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

entitiesInRow

object

If the interaction event targets an entity row, a dictionary object containing the entities in the row, indexed by the entity ids.

eventIds

string[]

An array of ids of events within the targeted item. Only defined if targetType is event, eventSummary or cell.

id

required
string | null

The id of the targeted item.

label

string

The label of the targeted item.

modifierKeys

required
EventModifierKeys

An object describing which modifier keys were pressed when the event occurred.

pointerId

required
number

The unique identifier of the pointer.

pointerType

required
string

The type of pointing device: mouse, touch or pen.

preventDefault()

If called, the default action is prevented.

Returns void

startNanoseconds

number

The number of nanoseconds to add to startTime.

startTime

Date

The start of the time range covered by the targeted item. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

subItem

SubItem

An object containing details of the sub-item, or undefined if the cursor is not over a sub-item.

targetType

required
'annotationBody' | 'annotationDeleteButton' | 'annotationEditButton' | 'annotation' | 'cell' | 'entity' | 'entityGroup' | 'entityRun' | 'event' | 'eventSummary' | 'eventLabel' | 'focus' | 'fold' | 'foldControl' | 'glyph' | 'labelAreaBorder' | 'lensControl' | 'lensScrollbar' | 'pin' | 'scale' | 'timeSeriesChart' | null

The type of the targeted item.

time

Date

The timeline time corresponding to the pointer position. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

timeNanoseconds

number

The number of nanoseconds to add to time.

x

required
number

The distance from the left edge of the Timeline element to the pointer position.

y

required
number

The distance from the top edge of the Timeline element to the pointer position.

onTimelineKeyDown

Invoked when the user presses a key.

Parameters

event
required
object

An object with details of the event.

keyCode

required
number

The keyCode of the key pressed.

defaultPrevented

required
boolean

A read-only value indicating whether the default action was prevented.

modifierKeys

required
EventModifierKeys

An object describing which modifier keys were pressed when the event occurred.

onTimelineKeyUp

Invoked when the user releases a key.

Parameters

event
required
object

An object with details of the event.

keyCode

required
number

The keyCode of the key pressed.

defaultPrevented

required
boolean

A read-only value indicating whether the default action was prevented.

modifierKeys

required
EventModifierKeys

An object describing which modifier keys were pressed when the event occurred.

onTimelinePointerDown

Invoked when a pointer presses down on the timeline.

Parameters

event
required
object

An object with details of the event.

button

required
number

The index of the button used.

defaultPrevented

required
boolean

A read-only value indicating whether the default action was prevented.

endNanoseconds

number

The number of nanoseconds to add to endTime.

endTime

Date

The end of the time range covered by the targeted item. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

entitiesInRow

object

If the interaction event targets an entity row, a dictionary object containing the entities in the row, indexed by the entity ids.

eventIds

string[]

An array of ids of events within the targeted item. Only defined if targetType is event, eventSummary or cell.

id

required
string | null

The id of the targeted item.

label

string

The label of the targeted item.

modifierKeys

required
EventModifierKeys

An object describing which modifier keys were pressed when the event occurred.

pointerId

required
number

The unique identifier of the pointer.

pointerType

required
string

The type of pointing device: mouse, touch or pen.

preventDefault()

If called, the default action is prevented.

Returns void

startNanoseconds

number

The number of nanoseconds to add to startTime.

startTime

Date

The start of the time range covered by the targeted item. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

subItem

SubItem

An object containing details of the sub-item, or undefined if the cursor is not over a sub-item.

targetType

required
'annotationBody' | 'annotationDeleteButton' | 'annotationEditButton' | 'annotation' | 'cell' | 'entity' | 'entityGroup' | 'entityRun' | 'event' | 'eventSummary' | 'eventLabel' | 'focus' | 'fold' | 'foldControl' | 'glyph' | 'labelAreaBorder' | 'lensControl' | 'lensScrollbar' | 'pin' | 'scale' | 'timeSeriesChart' | null

The type of the targeted item.

time

Date

The timeline time corresponding to the pointer position. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

timeNanoseconds

number

The number of nanoseconds to add to time.

x

required
number

The distance from the left edge of the Timeline element to the pointer position.

y

required
number

The distance from the top edge of the Timeline element to the pointer position.

onTimelinePointerMove

Invoked continuously as the pointer moves on the timeline, or the timeline moves beneath the pointer.

Default action:

  • On an entity row - Highlights the entity row and displays available controls (pin or focus).
  • On a time series chart - Highlights the nearest data point.

Parameters

event
required
object

An object with details of the event.

button

required
number

The index of the button used.

defaultPrevented

required
boolean

A read-only value indicating whether the default action was prevented.

endNanoseconds

number

The number of nanoseconds to add to endTime.

endTime

Date

The end of the time range covered by the targeted item. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

entitiesInRow

object

If the interaction event targets an entity row, a dictionary object containing the entities in the row, indexed by the entity ids.

eventIds

string[]

An array of ids of events within the targeted item. Only defined if targetType is event, eventSummary or cell.

id

required
string | null

The id of the targeted item.

label

string

The label of the targeted item.

modifierKeys

required
EventModifierKeys

An object describing which modifier keys were pressed when the event occurred.

pointerId

required
number

The unique identifier of the pointer.

pointerType

required
string

The type of pointing device: mouse, touch or pen.

preventDefault()

If called, the default action is prevented.

Returns void

startNanoseconds

number

The number of nanoseconds to add to startTime.

startTime

Date

The start of the time range covered by the targeted item. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

subItem

SubItem

An object containing details of the sub-item, or undefined if the cursor is not over a sub-item.

targetType

required
'annotationBody' | 'annotationDeleteButton' | 'annotationEditButton' | 'annotation' | 'cell' | 'entity' | 'entityGroup' | 'entityRun' | 'event' | 'eventSummary' | 'eventLabel' | 'focus' | 'fold' | 'foldControl' | 'glyph' | 'labelAreaBorder' | 'lensControl' | 'lensScrollbar' | 'pin' | 'scale' | 'timeSeriesChart' | null

The type of the targeted item.

time

Date

The timeline time corresponding to the pointer position. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

timeNanoseconds

number

The number of nanoseconds to add to time.

x

required
number

The distance from the left edge of the Timeline element to the pointer position.

y

required
number

The distance from the top edge of the Timeline element to the pointer position.

onTimelinePointerUp

Invoked when the pointer is released.

Parameters

event
required
object

An object with details of the event.

button

required
number

The index of the button used.

defaultPrevented

required
boolean

A read-only value indicating whether the default action was prevented.

endNanoseconds

number

The number of nanoseconds to add to endTime.

endTime

Date

The end of the time range covered by the targeted item. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

entitiesInRow

object

If the interaction event targets an entity row, a dictionary object containing the entities in the row, indexed by the entity ids.

eventIds

string[]

An array of ids of events within the targeted item. Only defined if targetType is event, eventSummary or cell.

id

required
string | null

The id of the targeted item.

label

string

The label of the targeted item.

modifierKeys

required
EventModifierKeys

An object describing which modifier keys were pressed when the event occurred.

pointerId

required
number

The unique identifier of the pointer.

pointerType

required
string

The type of pointing device: mouse, touch or pen.

preventDefault()

If called, the default action is prevented.

Returns void

startNanoseconds

number

The number of nanoseconds to add to startTime.

startTime

Date

The start of the time range covered by the targeted item. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

subItem

SubItem

An object containing details of the sub-item, or undefined if the cursor is not over a sub-item.

targetType

required
'annotationBody' | 'annotationDeleteButton' | 'annotationEditButton' | 'annotation' | 'cell' | 'entity' | 'entityGroup' | 'entityRun' | 'event' | 'eventSummary' | 'eventLabel' | 'focus' | 'fold' | 'foldControl' | 'glyph' | 'labelAreaBorder' | 'lensControl' | 'lensScrollbar' | 'pin' | 'scale' | 'timeSeriesChart' | null

The type of the targeted item.

time

Date

The timeline time corresponding to the pointer position. When the scale is wrapped, this is relative to the base range - see Scale Wrapping.

timeNanoseconds

number

The number of nanoseconds to add to time.

x

required
number

The distance from the left edge of the Timeline element to the pointer position.

y

required
number

The distance from the top edge of the Timeline element to the pointer position.

onTimelineWheel

Invoked continuously while the user is vertically or horizontally scrolling.

Default actions:

  • Vertical scrolling on the background - Zooms the timeline.
  • Vertical scrolling on the lens - Scrolls the lens up or down.
  • Horizontal scrolling - Pans the timeline.

Parameters

event
required
object

An object with details of the event.

deltaMode

required
number

The unit of measurement for the delta value.

defaultPrevented

required
boolean

A read-only value indicating whether the default action was prevented.

deltaX

required
number

The number of units that the wheel scrolled in the x direction.

deltaY

required
number

The number of units that the wheel scrolled in the y direction.

id

required
string | null

The id of the targeted item.

modifierKeys

required
EventModifierKeys

An object describing which modifier keys were pressed when the event occurred.

targetType

required
'annotationBody' | 'annotationDeleteButton' | 'annotationEditButton' | 'annotation' | 'cell' | 'entity' | 'entityGroup' | 'entityRun' | 'event' | 'eventSummary' | 'eventLabel' | 'focus' | 'fold' | 'foldControl' | 'glyph' | 'labelAreaBorder' | 'lensControl' | 'lensScrollbar' | 'pin' | 'scale' | 'timeSeriesChart' | null

The type of the targeted item.

x

required
number

The distance from the left edge of the Timeline element to the pointer position.

y

required
number

The distance from the top edge of the Timeline element to the pointer position.

Terms of use

These terms do not alter or supersede any existing agreements between you (or your employer) and us.

By accessing or using any Content you agree to be bound by these Terms of Use. Please review these terms carefully before using the website.

The contents of this website, including but not limited to any text, code samples, API references, schemas, interactive tools, and other materials (collectively, the 'Content'), are made available for informational and internal evaluation purposes only. All intellectual property rights in the Content are reserved. No licence is granted to use the Content for any commercial purpose, or to copy, distribute, modify, reverse-engineer, or incorporate any part of the Content into any product or service, without our prior written consent.

This Content is provided “as is” and “as available,” without any representations, warranties, or guarantees of any kind, whether express or implied, including but not limited to implied warranties of merchantability, fitness for a particular purpose, non-infringement, or accuracy. To the fullest extent permitted by applicable law, we expressly exclude and disclaim all implied warranties, conditions, and other terms that might otherwise be implied.

We disclaim all liability for any loss or damage, whether direct, indirect, incidental, consequential, or otherwise, arising from any reliance placed on the Content or from your use of it, to the fullest extent permitted by applicable law. By continuing to access or use the Content, you acknowledge and agree to these terms.