Interface TextStyle

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

interface TextStyle {
    bold?: boolean;
    color?: string;
    fontName?: string;
    fontSize?: number;
    fontSizeRatio?: number;
    italic?: boolean;
    rotate?: number;
    shadowStyle?: ShadowLayerStyle | null;
    skewX?: number;
    strikeThrough?: boolean;
    textAlign?: "center" | "left" | "right";
    textBackgroundStyle?: TextBackgroundStyle | null;
    underline?: boolean;
}

Index

Properties

bold? color? fontName? fontSize? fontSizeRatio? italic? rotate? shadowStyle? skewX? strikeThrough? textAlign? textBackgroundStyle? underline?

Properties

`Optional`bold

bold?: boolean

text bold

Default Value

false

Example

bold: true

`Optional`color

color?: string

font color

Example

color: '#aacc22'

`Optional`fontName

fontName?: string

font name

Example

fontName: 'Arial'

`Optional`fontSize

fontSize?: number

font size used when rendering text onto the output image

Example

fontSize: 12

`Optional`fontSizeRatio

fontSizeRatio?: number

font size ratio relative to the background image width

Example

fontSizeRatio: 0.03

`Optional`italic

italic?: boolean

text italic

Default Value

false

Example

italic: true

`Optional`rotate

rotate?: number

rotate text

Default Value

Example

rotate: 45

`Optional`shadowStyle

shadowStyle?: ShadowLayerStyle | null

text shadow style

Example

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

`Optional`skewX

skewX?: number

css italic with degree, you can use italic instead

Example

skewX: 45

`Optional`strikeThrough

strikeThrough?: boolean

text stroke

Default Value

false

Example

strikeThrough: true

`Optional`textAlign

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

text align

Default Value

'left'

Example

textAlign: 'left'

`Optional`textBackgroundStyle

textBackgroundStyle?: TextBackgroundStyle | null

text background style

Example

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

`Optional`underline

underline?: boolean

text underline style

Default Value

false

Example

underline: true

Interface TextStyle

Example

Index

Properties

Properties

`Optional`bold

Default Value

Example

`Optional`color

Example

`Optional`fontName

Example

`Optional`fontSize

Example

`Optional`fontSizeRatio

Example

`Optional`italic

Default Value

Example

`Optional`rotate

Default Value

Example

`Optional`shadowStyle

Example

`Optional`skewX

Example

`Optional`strikeThrough

Default Value

Example

`Optional`textAlign

Default Value

Example

`Optional`textBackgroundStyle

Example

`Optional`underline

Default Value

Example

Settings

On This Page

Interface TextStyle

Example

Index

Properties

Properties

Optionalbold

Default Value

Example

Optionalcolor

Example

OptionalfontName

Example

OptionalfontSize

Example

OptionalfontSizeRatio

Example

Optionalitalic

Default Value

Example

Optionalrotate

Default Value

Example

OptionalshadowStyle

Example

OptionalskewX

Example

OptionalstrikeThrough

Default Value

Example

OptionaltextAlign

Default Value

Example

OptionaltextBackgroundStyle

Example

Optionalunderline

Default Value

Example

Settings

On This Page

`Optional`bold

`Optional`color

`Optional`fontName

`Optional`fontSize

`Optional`fontSizeRatio

`Optional`italic

`Optional`rotate

`Optional`shadowStyle

`Optional`skewX

`Optional`strikeThrough

`Optional`textAlign

`Optional`textBackgroundStyle

`Optional`underline