Type Alias TLabelUpdateState

TLabelUpdateState: {
    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";
}

Type declaration

  • Optionalappearance?: LabelAppearance

    Customize the appearance of the Label and its pin

  • Optionalenabled?: boolean

    Whether the label is enabled.

    Default

    true
  • Optionalinteractive?: boolean

    Whether the Label should be clickable.

    Default

    false
  • Optionalocclude?: boolean

    Whether the label should be occluded by 3D geometry.

    Default

    true
  • Optionalrank?: TCollisionRankingTier | "initial"

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

    Default

    'medium'
  • Optionaltext?: string

    Text content of the label

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

    The placement of the text relative to the pin.

  • Optionaltype?: "label"

Settings

Member Visibility