Skip to main content

Interface: EntityValuesResult

Charting Library.EntityValuesResult

Series and indicator values returned by IChartWidgetApi.getEntityValues.

Properties​

atCrosshairPosition​

atCrosshairPosition: boolean

true if the values were read at the current crosshair position.

false if the crosshair is not over the chart. In that case the values fall back to the latest bar of every source, matching what the data window and the legend display. Note that the bar the fallback resolves to can differ between sources, because indicator plot offsets are taken into account.

time​

time: number

The time coordinate the values were read at, represented with a UNIX timestamp in UTC.

null when atCrosshairPosition is false, because the fallback bar is resolved separately for every source, and when the time cannot be resolved yet.

values​

values: Record<EntityId, CrossHairMovedEventSource>

Series and indicator values. The object keys are indicator or series IDs. The ID for the main series will always be the string '_seriesId'.