Search

Login

Time Bar Events

In 3.0 we deprecated the onTimeBar- events.

onChange(change)

Invoked whenever the range of the Time Bar changes. Returns a list of items in the updated range.

Parameters

change
required
object

An object describing the change.

items

object

Shows which items are currently in the visible range.

play

boolean

Indicates if the play state has changed.

range

object

The current visible time-range, always returned as Date objects in the end user's time zone.

end

required
number | Date

The end of the range.

start

required
number | Date

The start of the range.

onClick(props)

Invoked when the user clicks or taps on the time bar surface.

Parameters

props
required
object

button

required
number

The index of the button used.

end

Date

The date at the end of the clicked range.

index

number

The index of the clicked selection point, or null for other click types.

modifierKeys

required
object

A dictionary detailing which modifier keys were pressed when the event occurred. See Modifier Keys.

pointerId

required
number

The unique identifier of the pointer.

pointerType

required
string

The type of pointing device.

stackIndex

number

Index of clicked stack in the bar. Undefined if type parameter is not 'bar' or the bar is highlighted.

stackValues

array of numbers

Values of each stack in the bar. Undefined if type parameter is not 'bar' or the bar is highlighted.

start

Date

The date at the start of the clicked range.

tooltipX

required
number

A suggested location for the tooltip in the x direction - the center of the bar or selection point.

tooltipY

required
number

A suggested location for the tooltip in the y direction - the height of the bar or selection point.

type

required
'bar' | 'area' | 'selection' | 'scale' | 'left' | 'right' | 'slider' | null

The type of clicked item.

value

number

The value of either the bar or selection.

x

required
number

The x location of the pointer in view coordinates.

y

required
number

The y location of the pointer in view coordinates.

onContextMenu(props)

Invoked on a right click, long press or left click + Ctrl for MacOS.

Default action: Suppresses the onClick event.

Parameters

props
required
object

button

required
number

The index of the button used.

defaultPrevented

required
boolean

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

end

Date

The date at the end of the clicked range.

index

number

The index of the clicked selection point, or null for other click types.

modifierKeys

required
object

A dictionary detailing which modifier keys were pressed when the event occurred. See Modifier Keys.

pointerId

required
number

The unique identifier of the pointer.

pointerType

required
string

The type of pointing device.

preventDefault

required
function

Call to prevent the default action of the event.

stackIndex

number

Index of clicked stack in the bar. Undefined if type parameter is not 'bar' or the bar is highlighted.

stackValues

array of numbers

Values of each stack in the bar. Undefined if type parameter is not 'bar' or the bar is highlighted.

start

Date

The date at the start of the clicked range.

tooltipX

required
number

A suggested location for the tooltip in the x direction - the center of the bar or selection point.

tooltipY

required
number

A suggested location for the tooltip in the y direction - the height of the bar or selection point.

type

required
'bar' | 'area' | 'selection' | 'scale' | 'left' | 'right' | 'slider' | null

The type of clicked item.

value

number

The value of either the bar or selection.

x

required
number

The x location of the pointer in view coordinates.

y

required
number

The y location of the pointer in view coordinates.

onDoubleClick(props)

Invoked when the user double-clicks or double-taps on the time bar surface.

Default action: Animated zoom in that centres at the clicked time.

Parameters

props
required
object

button

required
number

The index of the button used.

defaultPrevented

required
boolean

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

end

Date

The date at the end of the clicked range.

index

number

The index of the clicked selection point, or null for other click types.

modifierKeys

required
object

A dictionary detailing which modifier keys were pressed when the event occurred. See Modifier Keys.

pointerId

required
number

The unique identifier of the pointer.

pointerType

required
string

The type of pointing device.

preventDefault

required
function

Call to prevent the default action of the event.

stackIndex

number

Index of clicked stack in the bar. Undefined if type parameter is not 'bar' or the bar is highlighted.

stackValues

array of numbers

Values of each stack in the bar. Undefined if type parameter is not 'bar' or the bar is highlighted.

start

Date

The date at the start of the clicked range.

tooltipX

required
number

A suggested location for the tooltip in the x direction - the center of the bar or selection point.

tooltipY

required
number

A suggested location for the tooltip in the y direction - the height of the bar or selection point.

type

required
'bar' | 'area' | 'selection' | 'scale' | 'left' | 'right' | 'slider' | null

The type of clicked item.

value

number

The value of either the bar or selection.

x

required
number

The x location of the pointer in view coordinates.

y

required
number

The y location of the pointer in view coordinates.

onDragEnd(props)

Invoked when the drag is finished and pointer is released, or when the drag is canceled.

Default actions depending on drag type:

  • 'slider' - Accepts the final panned range of the time bar and zooms to fit the view.
  • other types - Accepts the final panned range of the time bar. Prevent the default action to snap the pan back.

Parameters

props
required
object

button

required
number

The index of the button used.

defaultPrevented

required
boolean

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

end

Date

The date at the end of the clicked range.

index

number

The index of the clicked selection point, or null for other click types.

modifierKeys

required
object

A dictionary detailing which modifier keys were pressed when the event occurred. See Modifier Keys.

pointerId

required
number

The unique identifier of the pointer.

pointerType

required
string

The type of pointing device.

preventDefault

required
function

Call to prevent the default action of the event.

stackIndex

number

Index of clicked stack in the bar. Undefined if type parameter is not 'bar' or the bar is highlighted.

stackValues

array of numbers

Values of each stack in the bar. Undefined if type parameter is not 'bar' or the bar is highlighted.

start

Date

The date at the start of the clicked range.

tooltipX

required
number

A suggested location for the tooltip in the x direction - the center of the bar or selection point.

tooltipY

required
number

A suggested location for the tooltip in the y direction - the height of the bar or selection point.

type

required
'bar' | 'area' | 'selection' | 'scale' | 'left' | 'right' | 'slider' | null

The type of clicked item.

value

number

The value of either the bar or selection.

x

required
number

The x location of the pointer in view coordinates.

y

required
number

The y location of the pointer in view coordinates.

onDragStart(props)

Invoked when a drag is started.

Default actions depending on drag type:

  • 'slider' - Starts dragging the slider.
  • other types - Starts a pan controlled by the pointer. Prevent the default action to disable panning.

Parameters

props
required
object

button

required
number

The index of the button used.

defaultPrevented

required
boolean

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

end

Date

The date at the end of the clicked range.

index

number

The index of the clicked selection point, or null for other click types.

modifierKeys

required
object

A dictionary detailing which modifier keys were pressed when the event occurred. See Modifier Keys.

pointerId

required
number

The unique identifier of the pointer.

pointerType

required
string

The type of pointing device.

preventDefault

required
function

Call to prevent the default action of the event.

stackIndex

number

Index of clicked stack in the bar. Undefined if type parameter is not 'bar' or the bar is highlighted.

stackValues

array of numbers

Values of each stack in the bar. Undefined if type parameter is not 'bar' or the bar is highlighted.

start

Date

The date at the start of the clicked range.

tooltipX

required
number

A suggested location for the tooltip in the x direction - the center of the bar or selection point.

tooltipY

required
number

A suggested location for the tooltip in the y direction - the height of the bar or selection point.

type

required
'bar' | 'area' | 'selection' | 'scale' | 'left' | 'right' | 'slider' | null

The type of clicked item.

value

number

The value of either the bar or selection.

x

required
number

The x location of the pointer in view coordinates.

y

required
number

The y location of the pointer in view coordinates.

onHover(props)

Invoked when the user hovers over an item. Only invoked whenever the hover id changes.

Parameters

props
required
object

button

required
number

The index of the button used.

end

Date

The date at the end of the clicked range.

index

number

The index of the clicked selection point, or null for other click types.

modifierKeys

required
object

A dictionary detailing which modifier keys were pressed when the event occurred. See Modifier Keys.

pointerId

required
number

The unique identifier of the pointer.

pointerType

required
string

The type of pointing device.

stackIndex

number

Index of clicked stack in the bar. Undefined if type parameter is not 'bar' or the bar is highlighted.

stackValues

array of numbers

Values of each stack in the bar. Undefined if type parameter is not 'bar' or the bar is highlighted.

start

Date

The date at the start of the clicked range.

tooltipX

required
number

A suggested location for the tooltip in the x direction - the center of the bar or selection point.

tooltipY

required
number

A suggested location for the tooltip in the y direction - the height of the bar or selection point.

type

required
'bar' | 'area' | 'selection' | 'scale' | 'left' | 'right' | 'slider' | null

The type of clicked item.

value

number

The value of either the bar or selection.

x

required
number

The x location of the pointer in view coordinates.

y

required
number

The y location of the pointer in view coordinates.

onPointerDown(props)

Invoked when the pointer presses down on the time bar surface.

Parameters

props
required
object

button

required
number

The index of the button used.

end

Date

The date at the end of the clicked range.

index

number

The index of the clicked selection point, or null for other click types.

modifierKeys

required
object

A dictionary detailing which modifier keys were pressed when the event occurred. See Modifier Keys.

pointerId

required
number

The unique identifier of the pointer.

pointerType

required
string

The type of pointing device.

stackIndex

number

Index of clicked stack in the bar. Undefined if type parameter is not 'bar' or the bar is highlighted.

stackValues

array of numbers

Values of each stack in the bar. Undefined if type parameter is not 'bar' or the bar is highlighted.

start

Date

The date at the start of the clicked range.

tooltipX

required
number

A suggested location for the tooltip in the x direction - the center of the bar or selection point.

tooltipY

required
number

A suggested location for the tooltip in the y direction - the height of the bar or selection point.

type

required
'bar' | 'area' | 'selection' | 'scale' | 'left' | 'right' | 'slider' | null

The type of clicked item.

value

number

The value of either the bar or selection.

x

required
number

The x location of the pointer in view coordinates.

y

required
number

The y location of the pointer in view coordinates.

onPointerMove(props)

Invoked continuously while the pointer moves on the time bar surface.

Parameters

props
required
object

button

required
number

The index of the button used.

end

Date

The date at the end of the clicked range.

index

number

The index of the clicked selection point, or null for other click types.

modifierKeys

required
object

A dictionary detailing which modifier keys were pressed when the event occurred. See Modifier Keys.

pointerId

required
number

The unique identifier of the pointer.

pointerType

required
string

The type of pointing device.

stackIndex

number

Index of clicked stack in the bar. Undefined if type parameter is not 'bar' or the bar is highlighted.

stackValues

array of numbers

Values of each stack in the bar. Undefined if type parameter is not 'bar' or the bar is highlighted.

start

Date

The date at the start of the clicked range.

tooltipX

required
number

A suggested location for the tooltip in the x direction - the center of the bar or selection point.

tooltipY

required
number

A suggested location for the tooltip in the y direction - the height of the bar or selection point.

type

required
'bar' | 'area' | 'selection' | 'scale' | 'left' | 'right' | 'slider' | null

The type of clicked item.

value

number

The value of either the bar or selection.

x

required
number

The x location of the pointer in view coordinates.

y

required
number

The y location of the pointer in view coordinates.

onPointerUp(props)

Invoked when the pointer is released.

Parameters

props
required
object

button

required
number

The index of the button used.

end

Date

The date at the end of the clicked range.

index

number

The index of the clicked selection point, or null for other click types.

modifierKeys

required
object

A dictionary detailing which modifier keys were pressed when the event occurred. See Modifier Keys.

pointerId

required
number

The unique identifier of the pointer.

pointerType

required
string

The type of pointing device.

stackIndex

number

Index of clicked stack in the bar. Undefined if type parameter is not 'bar' or the bar is highlighted.

stackValues

array of numbers

Values of each stack in the bar. Undefined if type parameter is not 'bar' or the bar is highlighted.

start

Date

The date at the start of the clicked range.

tooltipX

required
number

A suggested location for the tooltip in the x direction - the center of the bar or selection point.

tooltipY

required
number

A suggested location for the tooltip in the y direction - the height of the bar or selection point.

type

required
'bar' | 'area' | 'selection' | 'scale' | 'left' | 'right' | 'slider' | null

The type of clicked item.

value

number

The value of either the bar or selection.

x

required
number

The x location of the pointer in view coordinates.

y

required
number

The y location of the pointer in view coordinates.

onWheel(props)

Invoked continuously while the user is rotating a mouse wheel or scrolling using a trackpad.

Default action: Animated zoom in or out.

Parameters

props
required
object

defaultPrevented

required
boolean

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

deltaMode

required
number

The unit of measurement for the delta value.

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.

modifierKeys

required
object

A dictionary detailing which modifier keys were pressed when the event occurred. See Modifier Keys.

preventDefault

required
function

Call to prevent the default action of the event.

x

required
number

The x location of the pointer in view coordinates.

y

required
number

The y location of the pointer in view coordinates.

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.