PdfPaths Class

Provides methods for creating graphics paths and drawing them or using them for clipping.

Path creation method calls must be finished with the PdfPaths.stroke, PdfPaths.fill, PdfPaths.fillAndStroke or PdfPaths.clip method. Any document methods which don't apply directly to path creation/ drawing/ clipping (changing a pen, drawing a text, saving the graphics state etc) are prohibited to use until the path is finished. The PdfPaths.lineTo, PdfPaths.bezierCurveTo and PdfPaths.quadraticCurveTo methods should not start the path, they must be preceded with the PdfPaths.moveTo.

The methods are chainable:

doc.paths.moveTo(0, 0).lineTo(100, 100).stroke();

This class is not intended to be instantiated in your code.

Heirarchy

PdfPaths

Constructors

constructor

Methods

Constructors

constructor

new PdfPaths(doc: PdfDocument, offset: Point): PdfPaths

Initializes a new instance of the PdfPaths class.

Parameters
- doc: PdfDocument
  
  Document.
- offset: Point
  
  Offset.
Returns PdfPaths

Methods

bezierCurveTo

bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, y: number): PdfPaths

Draws a bezier curve from the current point to a new point using the (cp1x, cp1y) and (cp2x, cp2y) as the control points.

The new current point is (x, y).

Parameters
- cp1x: number
  
  The X-coordinate of the first control point, in points.
- cp1y: number
  
  The Y-coordinate of the first control point, in points.
- cp2x: number
  
  The X-coordinate of the second control point, in points.
- cp2y: number
  
  The Y-coordinate of the second control point, in points.
- x: number
  
  The X-coordinate of the new point, in points.
- y: number
  
  The Y-coordinate of the new point, in points.
Returns PdfPaths

The PdfPaths object.

circle

circle(x: number, y: number, radius: number): PdfPaths

Draws a circle.

Parameters
- x: number
  
  The X-coordinate of the center of the circle, in points.
- y: number
  
  The Y-coordinate of the center of the circle, in points.
- radius: number
  
  The radius of the circle, in points.
Returns PdfPaths

The PdfPaths object.

clip

clip(rule?: PdfFillRule): PdfPaths

Creates a clipping path used to limit the regions of the page affected by painting operators.

Parameters
- Optional rule: PdfFillRule
  
  The fill rule to use.
Returns PdfPaths

The PdfPaths object.

closePath

closePath(): PdfPaths

Closes the current path and draws a line from the current point to the initial point of the current path.

Returns PdfPaths

The PdfPaths object.

ellipse

ellipse(x: number, y: number, radiusX: number, radiusY?: number): PdfPaths

Draws an ellipse.

Parameters
- x: number
  
  The X-coordinate of the center of the ellipse, in points.
- y: number
  
  The Y-coordinate of the center of the ellipse, in points.
- radiusX: number
  
  The radius of the ellipse along the X-axis, in points.
- Optional radiusY: number
  
  The radius of the ellipse along the Y-axis, in points. If it is not provided, then it is assumed to be equal to radiusX.
Returns PdfPaths

The PdfPaths object.

fill

fill(brush?: PdfBrush | Color | string, rule?: PdfFillRule): PdfPaths

Fills the path with the specified brush and rule. If brush is not specified, then the default document brush will be used (see the PdfDocument.setBrush method).

The brush argument can accept the following values:
- A PdfBrush object.
- A wijmo.Color object or any string acceptable by the wijmo.Color.fromString method. In this case, the PdfBrush object with the specified color will be created internally.
Parameters
- Optional brush: PdfBrush | Color | string
  
  The brush or color to use.
- Optional rule: PdfFillRule
  
  The fill rule to use.
Returns PdfPaths

The PdfPaths object.

fillAndStroke

fillAndStroke(brush?: PdfBrush | Color | string, pen?: PdfPen | Color | string, rule?: PdfFillRule): PdfPaths

Fills and strokes the path with the specified brush, pen and rule. If brush and pen is not specified, then the default document brush and pen will be used (See the PdfDocument.setBrush, PdfDocument.setPen methods).

The brush argument can accept the following values:
- A PdfBrush object.
- A wijmo.Color object or any string acceptable by the wijmo.Color.fromString method. In this case, the PdfBrush object with the specified color will be created internally.
The pen argument can accept the following values:
- A PdfPen object.
- A wijmo.Color object or any string acceptable by the wijmo.Color.fromString method. In this case, the PdfPen object with the specified color will be created internally.
Parameters
- Optional brush: PdfBrush | Color | string
  
  The brush or color to use.
- Optional pen: PdfPen | Color | string
  
  The pen or color to use.
- Optional rule: PdfFillRule
  
  The fill rule to use.
Returns PdfPaths

The PdfPaths object.

lineTo

lineTo(x: number, y: number): PdfPaths

Draws a line from the current point to a new point.

The new current point is (x, y).

Parameters
- x: number
  
  The X-coordinate of the new point, in points.
- y: number
  
  The Y-coordinate of the new point, in points.
Returns PdfPaths

The PdfPaths object.

moveTo

moveTo(x: number, y: number): PdfPaths

Sets a new current point.

Parameters
- x: number
  
  The X-coordinate of the new point, in points.
- y: number
  
  The Y-coordinate of the new point, in points.
Returns PdfPaths

The PdfPaths object.

polygon

polygon(points: number[][]): PdfPaths

Draws a polygon using a given points array.

Parameters
- points: number[][]
  
  An array of two-elements arrays [x, y] specifying the X and Y coordinates of the point, in points.
Returns PdfPaths

The PdfPaths object.

quadraticCurveTo

quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): PdfPaths

Draws a quadratic curve from the current point to a new point using the current point and (cpx, cpy) as the control points.

The new current point is (x, y).

Parameters
- cpx: number
  
  The X-coordinate of the control point, in points.
- cpy: number
  
  The Y-coordinate of the control point, in points.
- x: number
  
  The X-coordinate of the new point, in points.
- y: number
  
  The Y-coordinate of the new point, in points.
Returns PdfPaths

The PdfPaths object.

rect

rect(x: number, y: number, width: number, height: number): PdfPaths

Draws a rectangle.

Parameters
- x: number
  
  The X-coordinate of the topleft corner of the rectangle, in points.
- y: number
  
  The Y-coordinate of the topleft corner of the rectangle, in points.
- width: number
  
  The width of the rectangle, in points.
- height: number
  
  The width of the rectangle, in points.
Returns PdfPaths

The PdfPaths object.

roundedRect

roundedRect(x: number, y: number, width: number, height: number, cornerRadius?: number): PdfPaths

Draws a rounded rectangle.

Parameters
- x: number
  
  The X-coordinate of the upper-left corner of the rectangle, in points.
- y: number
  
  The Y-coordinate of the upper-left corner of the rectangle, in points.
- width: number
  
  The width of the rectangle, in points.
- height: number
  
  The width of the rectangle, in points.
- Optional cornerRadius: number
  
  The corner radius of the rectangle, in points. The default value is 0.
Returns PdfPaths

The PdfPaths object.

stroke

stroke(pen?: PdfPen | Color | string): PdfPaths

Strokes the path with the specified pen. If pen is not specified, then the default document pen will be used (See the PdfDocument.setPen method).

The pen argument can accept the following values:
- A PdfPen object.
- A wijmo.Color object or any string acceptable by the wijmo.Color.fromString method. In this case, the PdfPen object with the specified color will be created internally.
Parameters
- Optional pen: PdfPen | Color | string
  
  The pen or color to use.
Returns PdfPaths

The PdfPaths object.

svgPath

svgPath(path: string): PdfPaths

Draws a SVG 1.1 path.

Parameters
- path: string
  
  The SVG path to draw.
Returns PdfPaths

The PdfPaths object.

PdfPaths Class

Heirarchy

Constructors

Methods

Constructors

constructor

Parameters

doc: PdfDocument

offset: Point

Returns PdfPaths

Methods

bezierCurveTo

Parameters

cp1x: number

cp1y: number

cp2x: number

cp2y: number

x: number

y: number

Returns PdfPaths

circle

Parameters

x: number

y: number

radius: number

Returns PdfPaths

clip

Parameters

Optional rule: PdfFillRule

Returns PdfPaths

closePath

Returns PdfPaths

ellipse

Parameters

x: number

y: number

radiusX: number

Optional radiusY: number

Returns PdfPaths

fill

Parameters

Optional brush: PdfBrush | Color | string

Optional rule: PdfFillRule

Returns PdfPaths

fillAndStroke

Parameters

Optional brush: PdfBrush | Color | string

Optional pen: PdfPen | Color | string

Optional rule: PdfFillRule

Returns PdfPaths

lineTo

Parameters

x: number

y: number

Returns PdfPaths

moveTo

Parameters

x: number

y: number

Returns PdfPaths

polygon

Parameters

points: number[][]

Returns PdfPaths

quadraticCurveTo

Parameters

cpx: number

cpy: number

x: number

y: number

Returns PdfPaths

rect

Parameters

x: number

y: number

width: number

height: number

Returns PdfPaths

roundedRect

Parameters