Type alias TAddLabelOptions

TAddLabelOptions: {
    appearance?: TLabelAppearance;
    groupRankingByCategory?: boolean;
    interactive?: boolean;
    layer?: string;
    rank?: TCollisionRankingTier;
}

Options for creating a new Label with ILabels.add.

Type declaration

  • Optional appearance?: TLabelAppearance

    Customize the appearance of the Label and its pin

  • Optional groupRankingByCategory?: boolean

    Group analytics based ranking

    Default

    false
  • Optional interactive?: boolean

    Whether the Label should be clickable.

    Default

    false
  • Optional layer?: string

    Optional layer to attach the Label to. If not provided, this will be empty.

  • Optional rank?: TCollisionRankingTier

    Optional. Determines the collision ranking tier of the label, which influences its visibility in relation to other colliders. For the possible values ('medium', 'high', 'always-visible') and their impact on label visibility, see TCollisionRankingTier.

Settings

Member Visibility

Theme