Class Text3DApi

Methods

label labelAll remove removeAll

Methods

label

  • label(
        target: Space,
        content?: string,
        options?: AddText3DOptions,
    ): undefined | Text3D

  • Creates a 3D text label for a given space.

    Parameters

    • target: Space

      The target space or enterprise space to label.

    • Optionalcontent: string

      The content of the label. If not provided, target.name will be used

    • options: AddText3DOptions = {}

    Returns undefined | Text3D

    An array of Text3DView instances representing the created labels.

    Throws

    If the target is not a Space.

    Example

    const labels = mapView.Text3D.label(space, "Label Content", { fontSize: 12 });

labelAll

  • labelAll(options?: AddText3DOptions): Text3D[]

  • Creates polygon labels for all spaces.

    Parameters

    Returns Text3D[]

    An array of Text3DView instances representing the created labels. If the space is already labeled, the designated Text3D instance will be returned.

    Example

    const labels = mapView.Text3D.labelAll({
      // optional configuration options
    });

remove

  • remove(text3dView: Text3D): void

  • Removes one or more Text3D labels from the map

    Parameters

    Returns void

    Example

    // Remove single text label
    mapView.Text3D.remove(text);

    // Remove multiple text labels
    mapView.Text3D.remove([text, text]);

    // Remove by ID
    mapView.Text3D.remove("text3d-123");
  • remove(id: string): void

  • Removes one or more Text3D labels from the map

    Parameters

    • id: string

    Returns void

    Example

    // Remove single text label
    mapView.Text3D.remove(text);

    // Remove multiple text labels
    mapView.Text3D.remove([text, text]);

    // Remove by ID
    mapView.Text3D.remove("text3d-123");

removeAll

  • removeAll(): void

  • Removes all Text3D labels from the current map

    Returns void

    Example

    mapView.Text3D.removeAll();

Settings

Member Visibility

On This Page

Methods
MMNEPVFCICPMFPCPTTAAATR