Skip to content

charton API


charton API / @chart-on/core / index / layoutWatermark

Function: layoutWatermark() ​

layoutWatermark(ctx, env, opts, origin?): WatermarkLayout | null

Defined in: packages/core/src/watermark.ts:252

Lay out the watermark in an area env.width × env.height; null when there is nothing to draw. origin is where the area starts on the canvas, in css px, so text and image land on whole device pixels of the canvas.

Parameters ​

ctx ​

CanvasRenderingContext2D

env ​

Pick<PrimitiveEnv, "width" | "height" | "pixelRatio" | "theme">

opts ​

WatermarkOptions

origin? ​

x ​

number

y ​

number

Returns ​

WatermarkLayout | null