Model Namespace

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

Index

Enumerations

Types

Methods

Types

ModelData

ModelData: object

Type declaration

ModelDetails

ModelDetails: object

Type declaration

  • Optional address?: undefined | string
  • Optional contactEmail?: undefined | string
  • Optional contactName?: undefined | string
  • Optional formattedAddress?: undefined | string
  • Optional formattedContactPhone?: undefined | string
  • Optional name?: undefined | string
  • Optional phone?: undefined | string
  • Optional presentedBy?: undefined | string
  • Optional shareUrl?: undefined | string
  • sid: string
  • Optional summary?: undefined | string

Methods

getData

  • This function returns basic model information.

    This is no longer the canonical way to receive sweep information. See Sweep.data.

    mpSdk.Model.getData()
      .then(function(model) {
        // Model data retreival complete.
        console.log('Model sid:' + model.sid);
      })
      .catch(function(error) {
        // Model data retrieval error.
      });
    

    Returns Promise<Model.ModelData>

getDetails

  • This function returns model details.

    mpSdk.Model.getDetails()
      .then(function(modelDetails) {
        // Model details retreival complete.
        console.log('Model sid:' + modelDetails.sid);
        console.log('Model name:' + modelDetails.name);
        console.log('Model summary:' + modelDetails.summary);
      })
      .catch(function(error) {
        // Model details retrieval error.
      });
    

    Returns Promise<Model.ModelDetails>