Class LogoWatermark

Implements

IPrimitive

Index

Constructors

Methods

attached autoscaleInfo detached draw hitTest href setOptions zOrder

Constructors

constructor

new LogoWatermark(opts?: LogoWatermarkOptions): LogoWatermark
Parameters
- opts: LogoWatermarkOptions = {}
Returns LogoWatermark
- Defined in src/primitives/watermark.ts:128

Methods

attached

attached(host: PrimitiveHost): void
Parameters
- host: PrimitiveHost
Returns void
Implementation of IPrimitive.attached
- Defined in src/primitives/watermark.ts:155

autoscaleInfo

autoscaleInfo(): null
Optional: expand the pane's autoscale range so this primitive isn't clipped.

Returns null
Implementation of IPrimitive.autoscaleInfo
- Defined in src/primitives/watermark.ts:167

detached

detached(): void
Returns void
Implementation of IPrimitive.detached
- Defined in src/primitives/watermark.ts:165

draw

draw(ctx: CanvasRenderingContext2D, rc: PrimitiveRenderContext): void
Parameters
- ctx: CanvasRenderingContext2D
- rc: PrimitiveRenderContext
Returns void
Implementation of IPrimitive.draw
- Defined in src/primitives/watermark.ts:252

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
Implementation of IPrimitive.hitTest
- Defined in src/primitives/watermark.ts:227

href

href(): undefined | string
The link to open, with attribution appended. A caller who supplied their own query string gets it back untouched.

Returns undefined | string
- Defined in src/primitives/watermark.ts:213

setOptions

setOptions(patch: Partial<LogoWatermarkOptions>): void
Live restyle. Pass a new src/image to swap the logo.
Parameters
- patch: Partial<LogoWatermarkOptions>
Returns void
- Defined in src/primitives/watermark.ts:170

zOrder

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

Returns ZOrder
Implementation of IPrimitive.zOrder
- Defined in src/primitives/watermark.ts:166