TextBackgroundStyle

Defined in: src/index.ts:577

background style for text watermark

thanks @onka13 for #38

Example

textBackgroundStyle: {
 paddingX: 10,
 paddingY: 10,
 type: TextBackgroundType.stretchX,
 color: '#aacc22'
}
// or
textBackgroundStyle: {
 padding: '10% 50 15%',
 color: '#aacc22'
}
// or
textBackgroundStyle: {
 padding: 10,
 color: '#aacc22',
 cornerRadius: {
   topLeft: {
     x: '10%',
     y: 10,
   },
   topRight: {
     x: 10,
     y: 10,
   },
 }
}

Extends

• Padding

Properties

color

color: string

Defined in: src/index.ts:590

background color

Example

color: '#aacc22'

---

cornerRadius?

optional cornerRadius?: CornerRadius

Defined in: src/index.ts:614

background corner radius

Example

cornerRadius: {
 topLeft: {
   x: '10%',
   y: 10,
 },
 topRight: {
   x: 10,
   y: 10,
 },
 bottomLeft: {
   x: 10,
   y: 10,
 },
 bottomRight: {
   x: '10%',
   y: 10,
 },
}

---

padding?

optional padding?: string | number

Defined in: src/index.ts:222

padding for text background

Example

padding: 10
// or
padding: '10%'
// or
padding: '10% 20%'
// or
padding: '10% 20% 30%'
// or
padding: '10% 20% 30% 40%'
// or
padding: '10 20% 30 40%'
// or
padding: '10 20 30'

Inherited from

Padding.padding

---

paddingBottom?

optional paddingBottom?: string | number

Defined in: src/index.ts:254

padding bottom for text background

Example

paddingBottom: 10
// or
paddingBottom: '10%'

Inherited from

Padding.paddingBottom

---

paddingHorizontal?

optional paddingHorizontal?: string | number

Defined in: src/index.ts:262

padding left and right (horizontal) for text background

Example

paddingHorizontal: 10
// or
paddingHorizontal: '10%'

Inherited from

Padding.paddingHorizontal

---

paddingLeft?

optional paddingLeft?: string | number

Defined in: src/index.ts:230

padding left for text background

Example

paddingLeft: 10
// or
paddingLeft: '10%'

Inherited from

Padding.paddingLeft

---

paddingRight?

optional paddingRight?: string | number

Defined in: src/index.ts:238

padding right for text background

Example

paddingRight: 10
// or
paddingRight: '10%'

Inherited from

Padding.paddingRight

---

paddingTop?

optional paddingTop?: string | number

Defined in: src/index.ts:246

padding top for text background

Example

paddingTop: 10
// or
paddingTop: '10%'

Inherited from

Padding.paddingTop

---

paddingVertical?

optional paddingVertical?: string | number

Defined in: src/index.ts:270

padding top and bottom (vertical) for text background

Example

paddingVertical: 10
// or
paddingVertical: '10%'

Inherited from

Padding.paddingVertical

---

paddingX?

optional paddingX?: string | number

Defined in: src/index.ts:279

padding x, alias of paddingHorizontal

Example

paddingX: 10
// or
paddingX: '10%'

Inherited from

Padding.paddingX

---

paddingY?

optional paddingY?: string | number

Defined in: src/index.ts:288

padding y, alias of paddingVertical

Example

paddingY: 10
// or
paddingY: '10%'

Inherited from

Padding.paddingY

---

type?

optional type?: TextBackgroundType | null

Defined in: src/index.ts:584

background type

Default Value

TextBackgroundType.stretchX

Example

type: TextBackgroundType.stretchX