Skip to content
Menu
Auto
English
v1 is in long-term maintenance and continues to receive compatibility, security, and critical bug fixes. See the v2.

PositionOptions

Defined in: index.ts:246

PositionOptions for text watermark and image watermark. When position is set, X and Y are treated as offsets from that anchor.

position: {
X: 10,
Y: 10,
}
// or
position: {
position: Position.topLeft,
}
// or
position: {
position: Position.topRight,
X: 60, // 60px from the right edge
Y: 60, // 60px from the top edge
}
// or
position: {
X: '10%', // relative to the width of the background image
Y: '10%', // relative to the height of the background image
}

optional edgeInset?: string | number

Defined in: index.ts:261

Fallback distance from the selected anchor edges when the matching X or Y value is omitted. Named anchors use the compatibility default 20. Without a named anchor, set this value when omitted axes must behave the same on every platform; otherwise legacy text/image defaults are preserved. Percentages are resolved against the background image.

edgeInset: 0
// or
edgeInset: '5%'

optional position?: Position

Defined in: index.ts:249


optional X?: string | number

Defined in: index.ts:247


optional Y?: string | number

Defined in: index.ts:248