Class Footprint

Implements

IPrimitive

Index

Constructors

Methods

attached autoscaleInfo detached draw hitTest hoverAt options setBars setOptions stats zOrder

Constructors

constructor

new Footprint(opts?: Partial<FootprintOptions>): Footprint
Parameters
- opts: Partial<FootprintOptions> = {}
Returns Footprint
- Defined in src/profile/footprint-primitive.ts:144

Methods

attached

attached(host: PrimitiveHost): void
Parameters
- host: PrimitiveHost
Returns void
Implementation of IPrimitive.attached
- Defined in src/profile/footprint-primitive.ts:148

autoscaleInfo

autoscaleInfo(): null | { max: number; min: number }
Footprint rows span the bar's traded range, so unlike the profile overlays this one does drive autoscale — otherwise the top and bottom rows clip.

Returns null | { max: number; min: number }
Implementation of IPrimitive.autoscaleInfo
- Defined in src/profile/footprint-primitive.ts:156

detached

detached(): void
Returns void
Implementation of IPrimitive.detached
- Defined in src/profile/footprint-primitive.ts:149

draw

draw(ctx: CanvasRenderingContext2D, rc: PrimitiveRenderContext): void
Parameters
- ctx: CanvasRenderingContext2D
- rc: PrimitiveRenderContext
Returns void
Implementation of IPrimitive.draw
- Defined in src/profile/footprint-primitive.ts:238

hitTest

hitTest(x: number, y: number): null | PrimitiveHit
Report the column (and row) under the pointer so a host can show a tooltip. Returns a hit id of footprint:<time> — the payload is on hoverAt.
Parameters
- x: number
- y: number
Returns null | PrimitiveHit
Implementation of IPrimitive.hitTest
- Defined in src/profile/footprint-primitive.ts:483

hoverAt

hoverAt(
    x: number,
    y: number,
    rc?: PrimitiveRenderContext,
): null | FootprintHover
Full hover payload for (x, y) in media px, for a host-drawn tooltip. rc defaults to the context of the last paint, so a crosshair handler can just call hoverAt(p.x, p.y).
Parameters
- x: number
- y: number
- Optionalrc: PrimitiveRenderContext
Returns null | FootprintHover
- Defined in src/profile/footprint-primitive.ts:495

options

options(): FootprintOptions
Returns FootprintOptions
- Defined in src/profile/footprint-primitive.ts:178

setBars

setBars(bars: FootprintBar[]): void
Parameters
- bars: FootprintBar[]
Returns void
- Defined in src/profile/footprint-primitive.ts:167

setOptions

setOptions(patch: Partial<FootprintOptions>): void
Parameters
- patch: Partial<FootprintOptions>
Returns void
- Defined in src/profile/footprint-primitive.ts:173

stats

stats(): readonly FootprintBarStats[]
Per-bar aggregates, in bar order.

Returns readonly FootprintBarStats[]
- Defined in src/profile/footprint-primitive.ts:183

zOrder

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

Returns ZOrder
Implementation of IPrimitive.zOrder
- Defined in src/profile/footprint-primitive.ts:150