ImageMarkOptions

Options for rendering image-only watermark layers.

Example

backgroundImage: {
   src: require('./images/bg.png'),
   scale: 0.5,
   rotate: 45,
   alpha: 0.5
 },
 watermarkImages: [
   {
     src: require('./images/logo.png'),
     scale: 0.5,
     rotate: 45,
     alpha: 0.5,
     position: {
       X: 10,
       Y: 10,
     },
   },
   {
     src: require('./images/logo1.png'),
     scale: 0.5,
     rotate: 45,
     alpha: 0.5,
     position: {
       position: Position.center,
    },
   },
 ],
 quality: 100,
 filename: 'test',
 saveFormat: ImageFormat.jpg,

Properties

backgroundImage

backgroundImage: ImageOptions

Defined in: index.ts:937

background image options

Example

backgroundImage: {
   src: require('./images/bg.png'),
   scale: 0.5,
   rotate: 45,
   alpha: 0.5
 }

filename?

optional filename?: string

Defined in: index.ts:977

save image name

Example

filename: 'test'

matteColor?

optional matteColor?: string

Defined in: index.ts:989

Matte color used when an output with transparency is encoded as JPEG.

Default Value

#FFFFFF

maxSize?

optional maxSize?: number

Defined in: index.ts:1003

Maximum width or height used while decoding or rendering source images. Larger images keep their aspect ratio on iOS, Android, and Web.

Default Value

Example

maxSize: 2048

quality?

optional quality?: number

Defined in: index.ts:971

Integer image quality from 0 to 100, where 100 is best.

Default Value

Example

quality: 100

rotationCanvasMode?

optional rotationCanvasMode?: RotationCanvasMode

Defined in: index.ts:995

Controls whether background rotation expands the output canvas or crops back to the original canvas dimensions.

Default Value

RotationCanvasMode.expand

saveFormat?

optional saveFormat?: ImageFormat

Defined in: index.ts:984

save image format

Default Value

jpg

Example

saveFormat: ImageFormat.jpg

watermarkImage?

optional watermarkImage?: WatermarkImageOptions

Defined in: index.ts:950

Since

1.1.0

Example

watermarkImage: {
   src: require('./images/logo.png'),
   scale: 0.5,
   rotate: 45,
   alpha: 0.5
 }

watermarkImages?

optional watermarkImages?: WatermarkImageOptions[]

Defined in: index.ts:1021

watermark images

Example

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

watermarkPositions?

optional watermarkPositions?: PositionOptions

Defined in: index.ts:964

Since

1.1.0

Example

watermarkPositions: {
 X: 10,
 Y: 10,
 // or
 position: Position.center
}
Note: use watermarkImages instead