Type Alias TLabelState

TLabelState: {
    appearance: LabelAppearance;
    enabled: boolean;
    interactive: boolean;
    occlude: boolean;
    rank: TCollisionRankingTier | "initial";
    text: string;
    textPlacement:
        | "hidden"
        | "right"
        | "left"
        | "top"
        | "center"
        | ("hidden" | "right" | "left" | "top" | "center")[];
    type: "label";
}

The serialized state of a label, including its position, appearance, and rank. Returned by state APIs and used by extensions that need to inspect or persist label state.

Type declaration

  • appearance: LabelAppearance

    Customize the appearance of the Label and its pin

  • enabled: boolean

    Whether the label is enabled.

    Default

    true
  • interactive: boolean

    Whether the Label should be clickable.

    Default

    false
  • occlude: boolean

    Whether the label should be occluded by 3D geometry.

    Default

    true
  • rank: TCollisionRankingTier | "initial"

    Determines the collision ranking tier of the label, which influences its visibility in relation to other colliders.

    Default

    'medium'
  • text: string

    Text content of the label

  • textPlacement:
        | "hidden"
        | "right"
        | "left"
        | "top"
        | "center"
        | ("hidden" | "right" | "left" | "top" | "center")[]

    The placement of the text relative to the pin.

  • type: "label"

Settings

Member Visibility