Class Stroke

Classdesc

Set stroke style for vector features. Note that the defaults given are the Canvas defaults, which will be used if option is not defined. The get functions return whatever was entered in the options; they will not return the default.

Param: opt_options

Options.

Api

Constructors

constructor

Methods

getColor getLineCap getLineDash getLineJoin getMiterLimit getWidth setColor setLineCap setLineDash setLineJoin setMiterLimit setWidth

Constructors

constructor

  • new Stroke(opt_options?): Stroke

  • Parameters

    Returns Stroke

    Classdesc

    Set stroke style for vector features. Note that the defaults given are the Canvas defaults, which will be used if option is not defined. The get functions return whatever was entered in the options; they will not return the default.

    Api

Methods

getColor

  • getColor(): string | Color

  • Get the stroke color.

    Returns string | Color

    Color.

    Api

getLineCap

  • getLineCap(): string

  • Get the line cap type for the stroke.

    Returns string

    Line cap.

    Api

getLineDash

  • getLineDash(): number[]

  • Get the line dash style for the stroke.

    Returns number[]

    Line dash.

    Api

getLineJoin

  • getLineJoin(): string

  • Get the line join type for the stroke.

    Returns string

    Line join.

    Api

getMiterLimit

  • getMiterLimit(): number

  • Get the miter limit for the stroke.

    Returns number

    Miter limit.

    Api

getWidth

  • getWidth(): number

  • Get the stroke width.

    Returns number

    Width.

    Api

setColor

  • setColor(color): void

  • Set the color.

    Parameters

    • color: string | Color

      Color.

    Returns void

    Api

setLineCap

  • setLineCap(lineCap): void

  • Set the line cap.

    Parameters

    • lineCap: string

      Line cap.

    Returns void

    Api

setLineDash

  • setLineDash(lineDash): void

  • Set the line dash.

    Please note that Internet Explorer 10 and lower do not support the setLineDash method on the CanvasRenderingContext2D and therefore this property will have no visual effect in these browsers.

    Parameters

    • lineDash: number[]

      Line dash.

    Returns void

    Api

setLineJoin

  • setLineJoin(lineJoin): void

  • Set the line join.

    Parameters

    • lineJoin: string

      Line join.

    Returns void

    Api

setMiterLimit

  • setMiterLimit(miterLimit): void

  • Set the miter limit.

    Parameters

    • miterLimit: number

      Miter limit.

    Returns void

    Api

setWidth

  • setWidth(width): void

  • Set the width.

    Parameters

    • width: number

      Width.

    Returns void

    Api

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc