IChartCandlestickSlots

interface
Chart

Slot signatures exposed by <OrigamChartCandlestick>. Extends IChartBaseSlots with an enriched tooltip slot that receives the full OHLC datum plus pre-computed change and direction.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

tooltip
(bindings: { point: IChartPoint series: IChartBaseProps['series'][0] category: string | number datum: IChartCandlestickDatum change: number changePct: number isBullish: boolean }) => any
Replace the default tooltip card. Receives the usual point / series / category bindings plus the full OHLC datum, change value, change percentage, and bullish direction flag.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Custom OHLC tooltip with change percentage

vue