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

    Type Alias DrawPolygonOptions

    Provides options for drawing and filling a polygon.

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

    Properties

    brushBounds?: Bounds | null

    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 polygon. This property has a priority over the DrawPolygonOptions.fillColor.

    fillColor?: Color

    The color to fill the interior of the polygon. This property is ignored if the DrawPolygonOptions.fillBrush is assigned.

    fillMode?: FillMode

    The fill mode ("Alternate" by default).

    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 DrawPolygonOptions.strokePen is specified.

    lineColor?: Color

    The color of the polygon outline. Overrides the existing value if DrawPolygonOptions.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 DrawPolygonOptions.strokePen is specified.

    lineStyle?: DashStyle

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

    lineWidth?: number

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

    strokePen?: Pen | null

    A reference to the pen to draw the polygon outline.