Class MarketProfile

Implements

IPrimitive

Index

Constructors

Methods

attached autoscaleInfo detached draw hitTest hoverAt isSessionSplit options setData setOptions setSessionSplit zOrder

Constructors

constructor

new MarketProfile(
result?: null | MarketProfileResult,
opts?: Partial<MarketProfilePrimitiveOptions>,
): MarketProfile
Parameters
- result: null | MarketProfileResult = null
- opts: Partial<MarketProfilePrimitiveOptions> = {}
Returns MarketProfile
- Defined in src/profile/market-profile-primitive.ts:214

Methods

attached

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

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 }
Implementation of IPrimitive.autoscaleInfo
- Defined in src/profile/market-profile-primitive.ts:224

detached

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

draw

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

hitTest

hitTest(x: number, y: number): null | PrimitiveHit
Report the session under the pointer so a host can show a tooltip.
Parameters
- x: number
- y: number
Returns null | PrimitiveHit
Implementation of IPrimitive.hitTest
- Defined in src/profile/market-profile-primitive.ts:271

hoverAt

hoverAt(
    x: number,
    y: number,
    rc?: PrimitiveRenderContext,
): null | MarketProfileHover
Full hover payload for (x, y) in media px. 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 | MarketProfileHover
- Defined in src/profile/market-profile-primitive.ts:282

isSessionSplit

isSessionSplit(sessionIndex: number): boolean
Effective display for an index in the current result; false if missing.
Parameters
- sessionIndex: number
Returns boolean
- Defined in src/profile/market-profile-primitive.ts:249

options

options(): MarketProfilePrimitiveOptions
Returns MarketProfilePrimitiveOptions
- Defined in src/profile/market-profile-primitive.ts:222

setData

setData(result: MarketProfileResult): void
Parameters
- result: MarketProfileResult
Returns void
- Defined in src/profile/market-profile-primitive.ts:236

setOptions

setOptions(patch: Partial<MarketProfilePrimitiveOptions>): void
Parameters
- patch: Partial<MarketProfilePrimitiveOptions>
Returns void
- Defined in src/profile/market-profile-primitive.ts:242

setSessionSplit

setSessionSplit(sessionIndex: number, split: null | boolean): boolean
Split/unsplit one session. Null restores its global default.
Parameters
- sessionIndex: number
- split: null | boolean
Returns boolean
- Defined in src/profile/market-profile-primitive.ts:255

zOrder

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

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