[]
        
(Showing Draft Content)

DrawRectangleOptions

DsPdfJS API v9.1.0


DsPdfJS API / DrawRectangleOptions

Type Alias: DrawRectangleOptions

DrawRectangleOptions = object

Provides options for drawing and filling a rectangle.

Properties

brushBounds?

optional brushBounds: Bounds

The optional bounds for the fill brush.


brushTransform?

optional brushTransform: Transform | null

The transformation applied to the brush.


fillBrush?

optional fillBrush: Brush | null

A reference to the brush to fill the interior of the rectangle. This property has a priority over the DrawRectangleOptions.fillColor.


fillColor?

optional fillColor: Color

The color to fill the interior of the rectangle. This property is ignored if the DrawRectangleOptions.fillBrush is assigned.


lineCap?

optional lineCap: PenLineCap

The line cap style specifies the shape to be used at the ends of open subpaths (and dashes, if any) when they are stroked. Overrides the existing value if DrawRectangleOptions.strokePen is specified.


lineColor?

optional lineColor: Color

The color of the rectangle outline. Overrides the existing value if DrawRectangleOptions.strokePen is specified.


lineJoin?

optional lineJoin: PenLineJoin

The line join style specifies the shape to be used at the corners of line segments. Overrides the existing value if DrawRectangleOptions.strokePen is specified.


lineStyle?

optional lineStyle: DashStyle

The style of dashed pen to draw the rectangle outline. Overrides the existing value if DrawRectangleOptions.strokePen is specified.


lineWidth?

optional lineWidth: number

The width of the line pen to draw the rectangle outline, in units used for drawing. Overrides the existing value if DrawRectangleOptions.strokePen is specified.


radius?

optional radius: number

The radius for the quarter ellipse that is drawn to replace every corner of the rectangle.


radiusX?

optional radiusX: number

The x-radius for the quarter ellipse that is drawn to replace every corner of the rectangle.


radiusY?

optional radiusY: number

The y-radius for the quarter ellipse that is drawn to replace every corner of the rectangle.


strokePen?

optional strokePen: Pen | null

A reference to the pen to draw the rectangle outline.