Type Alias TLabelState

Type declaration

• appearance: LabelAppearance

  Customize the appearance of the Label and its pin

• enabled: boolean

  Whether the label is enabled.

  Default

  true
  Copy

• interactive: boolean

  Whether the Label should be clickable.

  Default

  false
  Copy

• occlude: boolean

  Whether the label should be occluded by 3D geometry.

  Default

  true
  Copy

• rank: TCollisionRankingTier | "initial"

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

  Default

  'medium'
  Copy

• 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"