- Preparing search index...
- The search index is not available
PdfPaths Class
Heirarchy
- PdfPaths
Constructors
Methods
Constructors
constructor
-
Initializes a new instance of the PdfPaths class.
Parameters
-
doc: PdfDocument
Document.
-
offset: Point
Offset.
Returns PdfPaths
-
Methods
bezierCurveTo
-
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
clip
-
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
ellipse
-
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
-
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
-
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
moveTo
polygon
quadraticCurveTo
-
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
-
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
-
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
-
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
Returns PdfPaths
The PdfPaths object.
svgPath
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:
This class is not intended to be instantiated in your code.