DsPdfJS API - v9.1.0
    Preparing search index...

    Type Alias DrawRectangleOptions

    Provides options for drawing and filling a rectangle.

    type DrawRectangleOptions = {
        brushBounds?: Bounds;
        brushTransform?: Transform | null;
        fillBrush?: Brush | null;
        fillColor?: Color;
        lineCap?: PenLineCap;
        lineColor?: Color;
        lineJoin?: PenLineJoin;
        lineStyle?: DashStyle;
        lineWidth?: number;
        radius?: number;
        radiusX?: number;
        radiusY?: number;
        strokePen?: Pen | null;
    }
    Index

    Properties

    brushBounds? brushTransform? fillBrush? fillColor? lineCap? lineColor? lineJoin? lineStyle? lineWidth? radius? radiusX? radiusY? strokePen?

    Properties

    brushBounds?: Bounds

    The optional bounds for the fill brush.

    brushTransform?: Transform | null

    The transformation applied to the brush.

    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?: Color

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

    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?: Color

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

    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?: DashStyle

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

    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?: number

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

    radiusX?: number

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

    radiusY?: number

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

    strokePen?: Pen | null

    A reference to the pen to draw the rectangle outline.

    Settings

    Member Visibility

    On This Page

    Properties