Mappedin JS - v6.14.0
    Preparing search index...

    Type Alias TAddLabelOptions

    Options for creating a new Label with Labels.add.

    type TAddLabelOptions = {
        appearance?: LabelAppearance;
        enabled?: boolean;
        interactive?: boolean;
        occlude?: boolean;
        rank?: TCollisionRankingTier | "initial";
        textPlacement?: LabelTextPlacement[];
    }
    Index

    Properties

    appearance? enabled? interactive? occlude? rank? textPlacement?

    Properties

    appearance?: LabelAppearance

    Customize the appearance of the Label and its pin

    enabled?: boolean

    Whether the label is enabled.

    interactive?: boolean

    Whether the Label should be clickable.

    false
    occlude?: boolean

    Whether the label should be occluded by 3D geometry.

    true
    rank?: TCollisionRankingTier | "initial"

    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.

    textPlacement?: LabelTextPlacement[]

    The placement of the text relative to the pin.

    Settings

    Member Visibility

    On This Page

    Properties