Line

Defined in: components/line.ts:13

Implements

• Component

Constructor components/line.ts:20

new Line(options?): Line

Parameters

Parameter	Type
options?	LineOptions

Returns

Line

Properties

Property	Modifier	Type
color? line.ts:14	public	string | Color
dash? line.ts:16	public	number[] | "solid" | "dashed" | "dotted"
dashPhase? line.ts:17	public	number
height? line.ts:18	public	number
thickness? line.ts:15	public	number

Methods

draw() components/line.ts:34

draw(writer, x, y, width, availableHeight, context): Component | null

Draws the component (or a part of it) on the page.

Parameters

Parameter	Type	Description
writer	PDFPageWriter	The page writer to issue commands to.
x	number	The current relative X coordinate from the left margin.
y	number	The current relative Y coordinate from the bottom margin (top boundary of the element).
width	number	The width constraint allocated to this element.
availableHeight	number	The height constraint representing remaining space on the current page.
context	LayoutContext	The layout configuration context.

Returns

Component | null

A new Component representing the remainder of this component if it could not finish rendering, or null if it rendered completely.

Implementation of

Component.draw

measure() components/line.ts:28

measure(width, context): object

Returns the width and height required by this component when rendered within a given width constraint.

Parameters

Parameter	Type
width	number
context	LayoutContext

Returns

object

Name	Type
height line.ts:28	number
width line.ts:28	number

Implementation of

Component.measure