Class Text3D

Text3D in Mappedin JS

Text3D creates three-dimensional text labels that are rendered directly in the 3D scene. These labels are perfect for displaying space names, room numbers, or any text that needs to be visible from any angle in the 3D environment.

Features

3D text rendering with depth and perspective
Automatic text wrapping and sizing
Customizable fonts, colors, and materials
Performance-optimized with web worker support

Example Usage

// Create labels for all spaces
const labels = mapView.Text3D.labelAll();

// Create a label for a specific space
const label = mapView.Text3D.label(space, "Room 101", { fontSize: 12 });

// Remove a specific label
mapView.Text3D.remove(label);

// Remove all labels
mapView.Text3D.removeAll();

Performance Considerations

Use labelAll() for better performance when creating multiple labels.

Advanced

Customize text appearance with fonts, colors, and materials.
Use labelAll() with options to apply consistent styling to all labels.
Text3D labels are automatically positioned and sized based on space geometry.

This class is accessed using MapView.Text3D.

Index

Methods

label labelAll remove removeAll

Methods

label

label(
    target: Space,
    content?: string,
    options?: AddText3DOptions,
): undefined | Text3DView
Creates a 3D text label for a given space.
Parameters
- target: Space
  The target space to label.
- Optionalcontent: string
  The content of the label. If not provided, target.name will be used.
- options: AddText3DOptions = {}
  Configuration options for the text label creation (see AddText3DOptions).
Returns undefined | Text3DView
A Text3DView instance representing the created label, or undefined if creation failed.
Throws
If the target is not a Space.
Example: Create a label with custom text
```
const label = mapView.Text3D.label(space, "Conference Room A", { fontSize: 12 });
```
Example: Create a label using space name
```
const label = mapView.Text3D.label(space); // Uses space.name
```
Example: Create a label with custom styling
```
const label = mapView.Text3D.label(space, "VIP Room", {
  fontSize: 16,
  color: 'gold',
  backgroundColor: 'rgba(0, 0, 0, 0.8)'
});
```
See
Text3D Guide

labelAll

labelAll(options?: AddText3DOptions): Text3DView[]
Creates polygon labels for all spaces.
Parameters
- options: AddText3DOptions = {}
  Configuration options for text label creation (see AddText3DOptions).
Returns Text3DView[]
An array of Text3DView instances representing the created labels. If a space is already labeled, the existing Text3D instance will be returned.
Example: Create labels for all spaces with default settings
```
const labels = mapView.Text3D.labelAll();
```
Example: Create labels with custom styling
```
const labels = mapView.Text3D.labelAll({
  fontSize: 14,
  color: 'white',
  backgroundColor: 'rgba(0, 0, 0, 0.7)'
});
```
See
Text3D Guide

remove

remove(target: Text3DView): void
Removes one or more Text3D labels from the map.
Parameters
- target: Text3DView
  Can be either:
  
  A single Text3DView instance
  
  An array of Text3DView instances
  
  A string ID of the Text3DView to remove
Returns void
Example: Remove a single text label
```
mapView.Text3D.remove(text3dView);
```
Example: Remove multiple text labels
```
mapView.Text3D.remove([text3dView1, text3dView2]);
```
Example: Remove by ID
```
mapView.Text3D.remove("text3d-123");
```
remove(target: string): void
Removes one or more Text3D labels from the map.
Parameters
- target: string
  Can be either:
  
  A single Text3DView instance
  
  An array of Text3DView instances
  
  A string ID of the Text3DView to remove
Returns void
Example: Remove a single text label
```
mapView.Text3D.remove(text3dView);
```
Example: Remove multiple text labels
```
mapView.Text3D.remove([text3dView1, text3dView2]);
```
Example: 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();
```

Class Text3D

Text3D in Mappedin JS

Features

Example Usage

Performance Considerations

Advanced

Index

Methods

Methods

label

Parameters

Returns undefined | Text3DView

Throws

Example: Create a label with custom text

Example: Create a label using space name

Example: Create a label with custom styling

See

labelAll

Parameters

Returns Text3DView[]

Example: Create labels for all spaces with default settings

Example: Create labels with custom styling

See

remove

Parameters

Returns void

Example: Remove a single text label

Example: Remove multiple text labels

Example: Remove by ID

Parameters

Returns void

Example: Remove a single text label

Example: Remove multiple text labels

Example: Remove by ID

removeAll

Returns void

Example

Settings

On This Page