TextStyle

Defined in: src/index.ts:360

TextStyle for text watermark

Example

textStyle: {
   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,
   skewX: -0.25,
   strikeThrough: true,
   textAlign: 'left',
   italic: true,
   bold: true,
   rotate: 45
 }

Properties

bold?

optional bold?: boolean

Defined in: src/index.ts:478

text bold

Default Value

false

Example

bold: true

---

color?

optional color?: string

Defined in: src/index.ts:367

font color

Default Value

'#000000'

Example

color: '#aacc22'

---

direction?

optional direction?: "auto" | "ltr" | "rtl"

Defined in: src/index.ts:399

Unicode base direction used for layout.

Default Value

'auto'

---

fontFallbacks?

optional fontFallbacks?: string[]

Defined in: src/index.ts:375

Ordered platform font families tried after fontName.

---

fontName?

optional fontName?: string

Defined in: src/index.ts:373

font name

Example

fontName: 'Arial'

---

fontSize?

optional fontSize?: number

Defined in: src/index.ts:381

font size used when rendering text onto the output image

Example

fontSize: 12

---

fontSizeRatio?

optional fontSizeRatio?: number

Defined in: src/index.ts:387

font size ratio relative to the background image width

Example

fontSizeRatio: 0.03

---

italic?

optional italic?: boolean

Defined in: src/index.ts:471

text italic

Default Value

false

Example

italic: true

---

letterSpacing?

optional letterSpacing?: number

Defined in: src/index.ts:397

Additional spacing between grapheme clusters in output pixels.

---

lineHeight?

optional lineHeight?: number

Defined in: src/index.ts:395

Absolute distance between line origins in output pixels.

---

maxLines?

optional maxLines?: number

Defined in: src/index.ts:403

Maximum number of rendered lines.

---

maxWidth?

optional maxWidth?: string | number

Defined in: src/index.ts:393

Maximum text box width in output pixels or as a percentage of the background width.

Example

maxWidth: '60%'

---

overflow?

optional overflow?: "clip" | "ellipsis"

Defined in: src/index.ts:405

Behavior when text exceeds maxWidth or maxLines.

Default Value

'clip'

---

rotate?

optional rotate?: number

Defined in: src/index.ts:485

rotate text

Default Value

0

Example

rotate: 45

---

shadowStyle?

optional shadowStyle?: ShadowLayerStyle | null

Defined in: src/index.ts:416

text shadow style

Example

shadowStyle: {
   dx: 10,
   dy: 10,
   radius: 10,
   color: '#aacc22'
 }

---

skewX?

optional skewX?: number

Defined in: src/index.ts:450

Horizontal text shear factor. Use italic for font-provided italics.

Example

skewX: -0.25

---

strikeThrough?

optional strikeThrough?: boolean

Defined in: src/index.ts:457

text strikethrough

Default Value

false

Example

strikeThrough: true

---

strokeStyle?

optional strokeStyle?: TextStrokeStyle | null

Defined in: src/index.ts:437

Optional outline drawn around the text before the fill. The width is measured in output-image pixels. Set width to 0 to disable it.

Example

strokeStyle: {
  color: '#00000099',
  width: 2,
}

---

textAlign?

optional textAlign?: "center" | "left" | "right"

Defined in: src/index.ts:464

text align

Default Value

'left'

Example

textAlign: 'left'

---

textBackgroundStyle?

optional textBackgroundStyle?: TextBackgroundStyle | null

Defined in: src/index.ts:427

text background style

Example

textBackgroundStyle: {
   paddingX: 10,
   paddingY: 10,
   type: TextBackgroundType.stretchX,
   color: '#aacc22'
 }

---

underline?

optional underline?: boolean

Defined in: src/index.ts:444

text underline style

Default Value

false

Example

underline: true

---

wrap?

optional wrap?: "word" | "character" | "none"

Defined in: src/index.ts:401

Wrapping strategy.

Default Value

'word'