TextMarkOptions

Defined in: src/index.ts:772

Options for text watermark

Example

backgroundImage: {
   src: require('./images/logo.png'),
   scale: 0.5,
   rotate: 45,
   alpha: 0.5
 },
 watermarkTexts: [
 {
   text: 'hello world',
   position: {
     X: 10,
     Y: 10,
     // or
     // position: Position.center
   },
   style: {
     color: '#aacc22',
     fontName: 'Arial',
     fontSize: 12,
     shadowStyle: {
       dx: 10,
       dy: 10,
       radius: 10,
       color: '#aacc22'
     },
     textBackgroundStyle: {
       paddingX: 10,
       paddingY: 10,
       type: TextBackgroundType.stretchX,
       color: '#aacc22'
     },
     underline: true,
     strikeThrough: true,
     textAlign: 'left',
     italic: true,
     //or
     // skewX: -0.25,
     bold: true,
     rotate: 45
   }
 }],
 quality: 100,
 filename: 'test',
 saveFormat: ImageFormat.jpg,

Properties

backgroundImage

backgroundImage: ImageOptions

Defined in: src/index.ts:783

background image options

Example

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

---

filename?

optional filename?: string

Defined in: src/index.ts:837

save image name

Example

filename: 'test'

---

matteColor?

optional matteColor?: string

Defined in: src/index.ts:853

Matte color used when an output with transparency is encoded as JPEG. JPEG has no alpha channel, so transparent pixels are composited over this color before encoding.

Default Value

#FFFFFF

Example

matteColor: '#FFFFFF'

---

maxSize?

optional maxSize?: number

Defined in: src/index.ts:869

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

Example

maxSize: 2048

---

quality?

optional quality?: number

Defined in: src/index.ts:831

Integer image quality from 0 to 100, where 100 is best. Quality has the most visible effect when the output format is jpg. See #159.

Default Value

100

Example

quality: 100

---

rotationCanvasMode?

optional rotationCanvasMode?: RotationCanvasMode

Defined in: src/index.ts:861

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

Default Value

RotationCanvasMode.expand

Example

rotationCanvasMode: RotationCanvasMode.crop

---

saveFormat?

optional saveFormat?: ImageFormat

Defined in: src/index.ts:844

save image format

Default Value

jpg

Example

saveFormat: ImageFormat.png

---

watermarkTexts

watermarkTexts: TextOptions[]

Defined in: src/index.ts:823

text options

Example

watermarkTexts: [
{
 text: 'hello world',
 position: {
   X: 10,
   Y: 10,
   // or
   // position: Position.center
 },
 style: {
   color: '#aacc22',
   fontName: 'Arial',
   fontSize: 12,
   shadowStyle: {
     dx: 10,
     dy: 10,
     radius: 10,
     color: '#aacc22'
   },
   textBackgroundStyle: {
     paddingX: 10,
     paddingY: 10,
     type: TextBackgroundType.stretchX,
     color: '#aacc22'
   },
   underline: true,
   strikeThrough: true,
   textAlign: 'left',
   italic: true,
   //or
   // skewX: -0.25,
   bold: true,
   rotate: 45
 }
}]