Interface IPrimitive

interface IPrimitive {
    attached(host: PrimitiveHost): void;
    autoscaleInfo(): null | { max: number; min: number };
    detached(): void;
    draw(ctx: CanvasRenderingContext2D, rc: PrimitiveRenderContext): void;
    hitTest(
        x: number,
        y: number,
        rc: PrimitiveRenderContext,
    ): null | PrimitiveHit;
    zOrder(): ZOrder;
}

Implemented by

Index

Methods

attached? autoscaleInfo? detached? draw hitTest? zOrder

Methods

`Optional`attached

attached(host: PrimitiveHost): void
Parameters
- host: PrimitiveHost
Returns void
- Defined in src/primitives/primitive.ts:56

`Optional`autoscaleInfo

autoscaleInfo(): null | { max: number; min: number }
Optional: expand the pane's autoscale range so this primitive isn't clipped.

Returns null | { max: number; min: number }
- Defined in src/primitives/primitive.ts:53

`Optional`detached

detached(): void
Returns void
- Defined in src/primitives/primitive.ts:57

draw

draw(ctx: CanvasRenderingContext2D, rc: PrimitiveRenderContext): void
Parameters
- ctx: CanvasRenderingContext2D
- rc: PrimitiveRenderContext
Returns void
- Defined in src/primitives/primitive.ts:51

`Optional`hitTest

hitTest(x: number, y: number, rc: PrimitiveRenderContext): null | PrimitiveHit
Optional: topmost hit under (x,y) in media px (relative to the pane plot).
Parameters
- x: number
- y: number
- rc: PrimitiveRenderContext
Returns null | PrimitiveHit
- Defined in src/primitives/primitive.ts:55

zOrder

zOrder(): ZOrder
Layer order vs series: 'bottom' (behind), 'normal' (over), 'top' (overlay).

Returns ZOrder
- Defined in src/primitives/primitive.ts:50