Type Alias TAddLabelOptions

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

Options for creating a new Label with Labels.add.

Type declaration

  • Optionalappearance?: LabelAppearance

    Customize the appearance of the Label and its pin

  • Optionalenabled?: boolean

    Whether the label is enabled.

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

    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.

  • OptionaltextPlacement?: LabelTextPlacement[]

    The placement of the text relative to the pin.

Settings

Member Visibility