modern-pdf-lib

---

modern-pdf-lib / DrawSquareOptions

Interface: DrawSquareOptions

Defined in: src/core/pdfPage.ts:400

Options for PdfPage.drawSquare.

Properties

blendMode?

optional blendMode: BlendMode

Defined in: src/core/pdfPage.ts:418

Blend mode for compositing.

---

borderColor?

optional borderColor: Color

Defined in: src/core/pdfPage.ts:410

Border (stroke) colour.

---

borderDashArray?

optional borderDashArray: number[]

Defined in: src/core/pdfPage.ts:424

Dash pattern for border.

---

borderDashPhase?

optional borderDashPhase: number

Defined in: src/core/pdfPage.ts:426

Dash phase offset for border.

---

borderLineCap?

optional borderLineCap: 0 | 1 | 2

Defined in: src/core/pdfPage.ts:428

Line cap style for border.

---

borderOpacity?

optional borderOpacity: number

Defined in: src/core/pdfPage.ts:430

Border stroke opacity [0, 1].

---

borderWidth?

optional borderWidth: number

Defined in: src/core/pdfPage.ts:412

Border width in points.

---

color?

optional color: Color

Defined in: src/core/pdfPage.ts:408

Fill colour.

---

opacity?

optional opacity: number

Defined in: src/core/pdfPage.ts:416

Opacity [0, 1].

---

rotate?

optional rotate: Angle

Defined in: src/core/pdfPage.ts:414

Rotation angle.

---

size?

optional size: number

Defined in: src/core/pdfPage.ts:406

Side length of the square. Defaults to 100.

---

x?

optional x: number

Defined in: src/core/pdfPage.ts:402

X coordinate.

---

xSkew?

optional xSkew: Angle

Defined in: src/core/pdfPage.ts:420

Horizontal skew angle.

---

y?

optional y: number

Defined in: src/core/pdfPage.ts:404

Y coordinate.

---

ySkew?

optional ySkew: Angle

Defined in: src/core/pdfPage.ts:422

Vertical skew angle.