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

Hierarchy

Index

Properties

Accessors

Methods

Properties

Tag

Tag: Omit<Tag, "attachments" | "data" | "openTags" | "close" | "dock" | "open" | "registerAttachment" | "registerSandbox" | "toggleDocking" | "toggleNavControls" | "toggleSharing">

A subset of the Tag namespace's functionality to manipulate Tags on this layer.

Provides access to Tag mutations including Tag.add to add directly to a layer.

Does not include observables or enums.

Accessors

common

  • get common(): boolean

  • Whether this layer is common (shared across all views)

    Returns boolean

id

  • get id(): string

  • The unique id of the Layer

    Returns string

name

  • get name(): string

  • The human-readable name of the Layer

    Returns string

toggled

  • get toggled(): boolean

  • Whether this Layer toggled on or off. If toggled off, this Layer's objects are hidden.

    Returns boolean

type

Methods

subscribe

  • Subscribe to changes on this object. When this observable detects a change, the observer provided will be called with the data associated with this observable.

    // Example: subscribe to changes in the app state
sdk.App.state.subscribe((appState) => {
  console.log(`App state changed to: ${appState.phase}`);
});

    or:

    sdk.App.state.subscribe({
  onChanged(appState) {
    console.log(`App state changed to: ${appState.phase}`);
  }
});

    Parameters

    Returns ISubscription

    A subscription that can be used to remove the subscribed observer.

toggle

  • toggle(active?: undefined | false | true): Promise<void>

  • Toggle this Layer's state to active.

    Parameters

    • Optional active: undefined | false | true

      Whether this Layer should be toggled on or off. If active is undefined, the state is flipped.

    Returns Promise<void>

waitUntil

  • Wait for a specific condition on this object to be met. When this observable detects a change, the condition provided will be called. When the condition returns true, the returned Promise will be resolved.

     // Example: pause execution of code until the app state is in the "playing" phase
 await sdk.App.state.waitUntil(
  appState => appState.phase == sdk.App.Phase.PLAYING
 );

    or:

    await sdk.App.state.waitUntil({
  waitUntil(appState) {
    return appState.phase == sdk.App.Phase.PLAYING;
  }
});

    Parameters

    Returns Promise<View.Layer>

    A promise that is resolved when condition returns true.