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

Methods

Properties

Readonly id

id: string

The unique id of the Layer

Readonly name

name: string

The human-readable name of the Layer

Readonly toggled

toggled: boolean

Whether this Layer toggled on or off

Methods

subscribe

toggle

  • toggle(active?: undefined | false | true): Promise<void>
  • Toggle this Layer's state to active.

    Parameters

    • Optional active: undefined | false | true

      Whether this Layer 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.

    Parameters

    Returns Promise<void>

    A promise that is resolved when condition returns true.