WatermarkImageOptions

Defined in: index.ts:851

Options for one image watermark layer.

Example

src: require('./images/logo.png'),
 scale: 0.5,
 rotate: 45,
 alpha: 0.5
 position: {
  X: 10,
  Y: 10,
  // or
  // position: Position.center
}

Extends

• ImageOptions

Extended by

• ImageWatermarkLayer

Properties

alpha?

optional alpha?: number

Defined in: index.ts:834

Image opacity from 0 (transparent) to 1 (opaque).

Default Value

1

Example

alpha: 0.5

Inherited from

ImageOptions.alpha

---

blendMode?

optional blendMode?: BlendMode

Defined in: index.ts:857

How this watermark image is composited with the pixels already on the canvas. Background images intentionally do not expose this option.

Default Value

'normal'

---

layout?

optional layout?: WatermarkLayout

Defined in: index.ts:864

Render this watermark once or repeat it across the image. Tiled layouts cannot be combined with position.

Default Value

{ type: 'single' }

---

position?

optional position?: PositionOptions

Defined in: index.ts:858

---

rotate?

optional rotate?: number

Defined in: index.ts:827

rotate image rotate 0-360

Default Value

0

Example

rotate: 45

Inherited from

ImageOptions.rotate

---

scale?

optional scale?: number

Defined in: index.ts:820

image scale >0

Default Value

1

Example

scale: 1

Inherited from

ImageOptions.scale

---

src

src: any

Defined in: index.ts:813

Image source. Supports React Native image sources and base64 data URLs.

Example

src: require('./images/logo.png')

Inherited from

ImageOptions.src

---

trimTransparentPadding?

optional trimTransparentPadding?: boolean

Defined in: index.ts:870

Remove fully transparent outer rows and columns before scaling, rotating, and positioning the watermark.

Default Value

false