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

A path to a component's event property

Type parameters

  • T

Hierarchy

Index

Properties

Methods

Properties

Readonly id

id: string

The id of this path. Set to a random string, or the id provided when creating the path

Readonly object

object: Scene.IObject

The object this path is associated with

Methods

bind

disable

  • disable(): void

  • Disable this.emit and the associated Component's onEvent from being triggered

    Returns void

emit

  • emit(payload: T): void

  • Emit the event associated with this path. This is similar to calling IComponent.onEvent directly.

    Parameters

    • payload: T

    Returns void

enable

  • enable(): void

  • Enable this.emit and the associated Component's onEvent so it can receive the event again

    Returns void