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

    Type Alias PenProperties

    Provides settings for creating a new Pen.

    type PenProperties = {
        basePen?: Pen | null;
        color?: Color;
        dashOffset?: number;
        dashPattern?: number[] | null;
        dashStyle?: DashStyle;
        lineCap?: PenLineCap;
        lineJoin?: PenLineJoin;
        miterLimit?: number;
        width?: number;
    }
    Index

    Properties

    basePen? color? dashOffset? dashPattern? dashStyle? lineCap? lineJoin? miterLimit? width?

    Properties

    basePen?: Pen | null

    A reference to the pen used as the base for the new pen.

    color?: Color

    The pen color. The default is Black. Overrides the value from base pen if PenProperties.basePen is specified.

    dashOffset?: number

    The distance within the dash pattern where a dash begins. The default value is 0. Overrides the value from base pen if PenProperties.basePen is specified.

    dashPattern?: number[] | null

    The custom dash pattern of lines drawn with this pen. Overrides the value from base pen if PenProperties.basePen is specified.

    dashStyle?: DashStyle

    The style of dashed lines drawn with this pen. Overrides the value from base pen if PenProperties.basePen is specified.

    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 value from base pen if PenProperties.basePen is specified.

    lineJoin?: PenLineJoin

    The line join style specifies the shape to be used at the corners of paths that are stroked. Overrides the value from base pen if PenProperties.basePen is specified.

    miterLimit?: number

    A maximum on the ratio of the miter length to the pen width. When the limit is exceeded, the join is converted from a miter to a bevel. Overrides the value from base pen if PenProperties.basePen is specified.

    width?: number

    The pen width, in units used for drawing. The default is 1. Overrides the value from base pen if PenProperties.basePen is specified.

    Settings

    Member Visibility

    On This Page

    Properties