Class FloatingLabel

A floating label that is attached to a node or coordinate on the map.

Hierarchy

  • FloatingLabel

Accessors

appearance id nodeOrCoordinate rank text

Methods

toJSON

Accessors

appearance

id

  • get id(): string

  • The ID of this label.

    Returns string

nodeOrCoordinate

rank

  • get rank(): number

  • The collision rank of this label.

    Returns number

text

  • get text(): undefined | string

  • The text of this label.

    Returns undefined | string

Methods

toJSON

  • Object representation of this label.

    Returns {
        appearance: Required<TFloatingLabelAppearance>;
        id: string;
        nodeOrCoordinate: any;
        rank: number;
        text: undefined | string;
    }

Settings

Member Visibility

Theme

On This Page