Class TextWatermark

Implements

IPrimitive

Index

Constructors

Methods

attached autoscaleInfo detached draw hitTest setOptions zOrder

Constructors

constructor

new TextWatermark(opts: TextWatermarkOptions): TextWatermark
Parameters
- opts: TextWatermarkOptions
Returns TextWatermark
- Defined in src/primitives/text-watermark.ts:45

Methods

attached

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

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/text-watermark.ts:60

detached

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

draw

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

hitTest

hitTest(): null
Never hit: the mark must not eat a click aimed at the chart beneath it.

Returns null
Implementation of IPrimitive.hitTest
- Defined in src/primitives/text-watermark.ts:62

setOptions

setOptions(patch: Partial<TextWatermarkOptions>): void
Parameters
- patch: Partial<TextWatermarkOptions>
Returns void
- Defined in src/primitives/text-watermark.ts:64

zOrder

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

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