Label | Matterport SDK
Usage of the SDK constitutes your agreement with the Matterport SDK Agreement. Email developers@matterport.com with any questions.

Index

Enumerations

Types

Properties

Methods

Types

Label

Label: object

Type declaration

  • floor: number
  • floorInfo: object
    • id: string
    • sequence: number
  • position: Vector3
  • sid: string
  • text: string
  • visible: boolean

LabelDeprecated

LabelDeprecated: object

Type declaration

  • floor: number
  • floorInfo: object
    • id: string
    • sequence: number
  • position: Vector3
  • screenPosition: Vector2
  • sid: string
  • text: string
  • visible: boolean

Properties

data

data: IObservableMap<Label.Label>
embed
bundle

Introduced 3.1.68.12-7-g858688944a

An observable map of the current labels. Returns an object with a map of labels.

mpSdk.Label.data.subscribe({
 onAdded: function (index, item, collection) {
   console.log('Label added to the collection', index, item, collection);
 },
 onRemoved: function (index, item, collection) {
   console.log('Label removed from the collection', index, item, collection);
 },
 onUpdated: function (index, item, collection) {
   console.log('Label updated in place in the collection', index, item, collection);
 },
});

Methods

getData

  • deprecated

    Use data observable instead.

    This function returns the data of all labels.

    Returns Promise<Label.LabelDeprecated[]>