sesaparcours
    Preparing search index...

    Function addBrokenLine

    • Adds a broken line vertexes of which are given in the array points (array of the vertexes points names) syntaxes addBrokenLine(points), addBrokenLine(points, color), addBrokenLine(points, color, lineStyle) and addBrokenLine(points, color, lineStyle, thickness) are allowed too, where points is an array of points or name of points

      Parameters

      • options: {
            color?: string;
            hidden?: boolean;
            lineStyle?: string;
            opacity?: number;
            points: string[];
            tag?: string;
            thickness?: number;
        }
        • Optionalcolor?: string

          Color, black by default

        • Optionalhidden?: boolean

          true to get the polygon masked

        • OptionallineStyle?: string

          Line style (line|-|dot|.|dashdash|--|dashdotdot|-..|dashdotdotdot|-...|dashdashdash|---)

        • Optionalopacity?: number

          opacity (0 to 1), 1 by default

        • points: string[]

          array of the vertexes points names of the polygon

        • Optionaltag?: string

          Tag to be applied on the created broken line (if present)

        • Optionalthickness?: number

          Stroke thickness

      Returns Promise<undefined> | CLigneBrisee

      the created polygon if isPromiseMode is false else promise that will be resolved when the object is displayed

    Settings

    Member Visibility