Interface VolumeProfileHost

Minimal host surface the controller needs. Both OHLCVChart and ChartEngine satisfy it structurally — visibleCandleView is the thin getter both expose — so the profile module depends on neither concrete class and tree-shakes cleanly out of the base bundle. Typed structurally (rather than importing OHLCVChart) so a host doing import { VolumeProfileController } pulls nothing heavy in.

interface VolumeProfileHost {
    attachPrimitive(primitive: Primitive): void;
    detachPrimitive(id: string): boolean;
    render?(): void;
    requestRender?(): void;
    visibleCandleView(): CandleView | null;
}

Index

Methods

attachPrimitive detachPrimitive render? requestRender? visibleCandleView

Methods

attachPrimitive

attachPrimitive(primitive: Primitive): void
Parameters
- primitive: Primitive
Returns void
- Defined in profile/VolumeProfileController.ts:14

detachPrimitive

detachPrimitive(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in profile/VolumeProfileController.ts:15

`Optional`render

render?(): void
Returns void
- Defined in profile/VolumeProfileController.ts:20

`Optional`requestRender

requestRender?(): void
Optional explicit repaint hook (used by VolumeProfileController.update).

Returns void
- Defined in profile/VolumeProfileController.ts:19

visibleCandleView

visibleCandleView(): CandleView | null
Zero-copy view of the candles in the current visible window, or null.

Returns CandleView | null
- Defined in profile/VolumeProfileController.ts:17