MarkOptions

Defined in: src/index.ts:1116

Options for marking text and image watermarks with a single call.

Example

await Marker.mark({
  backgroundImage: {
    src: require('./images/bg.png'),
  },
  watermarks: [
    {
      type: 'text',
      text: 'hello world',
      position: {
        position: Position.bottomCenter,
        Y: 24,
      },
      style: {
        color: '#FFFFFF',
        fontSize: 32,
      },
    },
    {
      type: 'image',
      src: require('./images/logo.png'),
      position: {
        position: Position.topRight,
        X: 24,
        Y: 24,
      },
      scale: 0.5,
    },
  ],
  saveFormat: ImageFormat.png,
});

Properties

backgroundImage

backgroundImage: ImageOptions

Defined in: src/index.ts:1120

Background image options.

---

filename?

optional filename?: string

Defined in: src/index.ts:1141

save image name

---

matteColor?

optional matteColor?: string

Defined in: src/index.ts:1151

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

Default Value

#FFFFFF

---

maxSize?

optional maxSize?: number

Defined in: src/index.ts:1163

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

Default Value

2048

---

quality?

optional quality?: number

Defined in: src/index.ts:1137

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

Default Value

100

---

rotationCanvasMode?

optional rotationCanvasMode?: RotationCanvasMode

Defined in: src/index.ts:1157

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: src/index.ts:1146

save image format

Default Value

jpg

---

watermarkImages?

optional watermarkImages?: WatermarkImageOptions[]

Defined in: src/index.ts:1132

Image watermark options. Kept for compatibility; use watermarks instead for ordered mixed layers.

---

watermarks?

optional watermarks?: WatermarkLayer[]

Defined in: src/index.ts:1124

Ordered watermark layers. Layers are rendered in array order, so later layers draw over earlier layers.

---

watermarkTexts?

optional watermarkTexts?: TextOptions[]

Defined in: src/index.ts:1128

Text watermark options. Kept for compatibility; use watermarks instead for ordered mixed layers.