Skip to main content
Version: v27

CrossHairMovedEventParams

Interface

Crosshair move event information.

Properties​

entityValues​

Optional

Series and study values at the crosshair position. The object keys are study or series IDs, and the object value are study or series values. The ID for the main series will always be the string '_seriesId'.

Type​

​Record<EntityId, CrossHairMovedEventSource>

offsetX​

Optional

X coordinate of the crosshair relative to the left edge of the element containing the library.

Type​

​number

offsetY​

Optional

Y coordinate of the crosshair relative to the top edge of the element containing the library.

Type​

​number

price​

The price coordinate of the crosshair.

Type​

​number

time​

The crosshair time coordinate represented with a UNIX timestamp in UTC. You can use this property to do some calculations or retrieve additional data from the datafeed.

Type​

​number

userTime​

Optional

The crosshair time coordinate represented with a UNIX timestamp in the selected time zone. You can use this property to display the crosshair time value in the UI, for example, in a tooltip or data window.

Type​

​number