PathBuilder
Kind: class
Module/package: path-builder
SDK: pdfdancer-client-typescript 2.0.0
Builder for creating vector paths in PDF documents.
Supports creating paths with:
- Lines
- Bezier curves
- Custom stroke and fill colors
- Stroke width and dash patterns
Declaration
class PathBuilder
Members
constructor
constructor(_client: PDFDancer, _defaultPageNumber?: number): PathBuilder
add
add(): Promise<boolean>
Add the path to the PDF document.
addSegment
addSegment(segment: PathSegment): PathBuilder
Add a custom path segment.
at
at(pageNumber: number, x: number, y: number): PathBuilder
Set the position where the path will be added. Can be called with (x, y) for page-level or (pageNumber, x, y) for document-level.
at
at(x: number, y: number): PathBuilder
Set the position where the path will be added. Can be called with (x, y) for page-level or (pageNumber, x, y) for document-level.
atPosition
atPosition(position: Position): PathBuilder
Set the position using a Position object.
bezierTo
bezierTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, y: number): PathBuilder
Draw a cubic Bezier curve from the current point.
circle
circle(cx: number, cy: number, radius: number): PathBuilder
closePath
closePath(): PathBuilder
dashPattern
dashPattern(dashArray: number[], dashPhase?: number): PathBuilder
Set the dash pattern for subsequent path segments.
evenOddFill
evenOddFill(useEvenOdd: boolean): PathBuilder
Set whether to use even-odd fill rule (true) or nonzero winding rule (false).
fillColor
fillColor(color: Color): PathBuilder
Set the fill color for subsequent path segments.
lineTo
lineTo(x: number, y: number): PathBuilder
Draw a line from the current point to the specified point.
moveTo
moveTo(x: number, y: number): PathBuilder
Move to a point without drawing. Sets the current point for subsequent drawing operations.
rectangle
rectangle(x: number, y: number, width: number, height: number): PathBuilder
solid
solid(): PathBuilder
strokeColor
strokeColor(color: Color): PathBuilder
Set the stroke color for subsequent path segments.
strokeWidth
strokeWidth(width: number): PathBuilder
Set the stroke width for subsequent path segments.