Interface: HoveredInfo<HorzScaleItem>

Represents rich information about the hovered chart object.

Type parameters

• HorzScaleItem = Time

Properties

type

type: HoveredItemType

The semantic kind of hovered item.

Prefer this when you want to know what kind of geometry the cursor is over.

---

sourceKind

sourceKind: "series" | "series-primitive" | "pane-primitive"

The kind of source that owns the hovered target.

Prefer this when you want ownership information about the hovered object.

---

objectKind

objectKind: "primitive" | "series" | "custom-object" | "custom-price-line" | "series-marker"

The kind of hovered target object.

---

series?

optional series: ISeriesApi<keyof SeriesOptionsMap, HorzScaleItem, AreaData<HorzScaleItem> | WhitespaceData<HorzScaleItem> | BarData<HorzScaleItem> | CandlestickData<HorzScaleItem> | BaselineData<HorzScaleItem> | LineData<HorzScaleItem> | HistogramData<HorzScaleItem> | CustomData<HorzScaleItem> | CustomSeriesWhitespaceData<HorzScaleItem>, CustomSeriesOptions | AreaSeriesOptions | BarSeriesOptions | CandlestickSeriesOptions | BaselineSeriesOptions | LineSeriesOptions | HistogramSeriesOptions, DeepPartial <AreaStyleOptions & SeriesOptionsCommon> | DeepPartial <BarStyleOptions & SeriesOptionsCommon> | DeepPartial <CandlestickStyleOptions & SeriesOptionsCommon> | DeepPartial <BaselineStyleOptions & SeriesOptionsCommon> | DeepPartial <LineStyleOptions & SeriesOptionsCommon> | DeepPartial <HistogramStyleOptions & SeriesOptionsCommon> | DeepPartial <CustomStyleOptions & SeriesOptionsCommon>>

The series that owns the hovered item, if any.

---

objectId?

optional objectId: unknown

The object id associated with the hovered item, if any.

---

paneIndex?

optional paneIndex: number

The pane index where the hover was resolved.