Class Text

Classdesc

Set text style for vector features.

Param: opt_options

Options.

Api

Constructors

constructor

Methods

getFill getFont getOffsetX getOffsetY getRotateWithView getRotation getScale getStroke getText getTextAlign getTextBaseline setFill setFont setOffsetX setOffsetY setRotation setScale setStroke setText setTextAlign setTextBaseline

Constructors

constructor

Methods

getFill

  • getFill(): Fill

  • Get the fill style for the text.

    Returns Fill

    Fill style.

    Api

getFont

  • getFont(): string

  • Get the font name.

    Returns string

    Font.

    Api

getOffsetX

  • getOffsetX(): number

  • Get the x-offset for the text.

    Returns number

    Horizontal text offset.

    Api

getOffsetY

  • getOffsetY(): number

  • Get the y-offset for the text.

    Returns number

    Vertical text offset.

    Api

getRotateWithView

  • getRotateWithView(): boolean

  • Determine whether the text rotates with the map.

    Returns boolean

    Rotate with map.

    Api

getRotation

  • getRotation(): number

  • Get the text rotation.

    Returns number

    Rotation.

    Api

getScale

  • getScale(): number

  • Get the text scale.

    Returns number

    Scale.

    Api

getStroke

  • getStroke(): Stroke

  • Get the stroke style for the text.

    Returns Stroke

    Stroke style.

    Api

getText

  • getText(): string

  • Get the text to be rendered.

    Returns string

    Text.

    Api

getTextAlign

  • getTextAlign(): string

  • Get the text alignment.

    Returns string

    Text align.

    Api

getTextBaseline

  • getTextBaseline(): string

  • Get the text baseline.

    Returns string

    Text baseline.

    Api

setFill

  • setFill(fill): void

  • Set the fill.

    Parameters

    • fill: Fill

      Fill style.

    Returns void

    Api

setFont

  • setFont(font): void

  • Set the font.

    Parameters

    • font: string

      Font.

    Returns void

    Api

setOffsetX

  • setOffsetX(offsetX): void

  • Set the x offset.

    Parameters

    • offsetX: number

      Horizontal text offset.

    Returns void

    Api

setOffsetY

  • setOffsetY(offsetY): void

  • Set the y offset.

    Parameters

    • offsetY: number

      Vertical text offset.

    Returns void

    Api

setRotation

  • setRotation(rotation): void

  • Set the rotation.

    Parameters

    • rotation: number

      Rotation.

    Returns void

    Api

setScale

  • setScale(scale): void

  • Set the scale.

    Parameters

    • scale: number

      Scale.

    Returns void

    Api

setStroke

  • setStroke(stroke): void

  • Set the stroke.

    Parameters

    Returns void

    Api

setText

  • setText(text): void

  • Set the text.

    Parameters

    • text: string

      Text.

    Returns void

    Api

setTextAlign

  • setTextAlign(textAlign): void

  • Set the text alignment.

    Parameters

    • textAlign: string

      Text align.

    Returns void

    Api

setTextBaseline

  • setTextBaseline(textBaseline): void

  • Set the text baseline.

    Parameters

    • textBaseline: string

      Text baseline.

    Returns void

    Api

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc