Documentation - v19.12.0-dev
    Preparing search index...

    Class ViewerSignal<THandler>

    A Signal variant used across the viewer that defaults new connections to non-public, and exposes a subscribe shorthand for connecting a callback and getting back its own disconnect function.

    Type Parameters

    • THandler extends (...args: any[]) => any

    Hierarchy

    Index

    Constructors

    constructor

    Methods

    connect disconnect disconnectAll emit emitCollecting getConnectionsCount hasConnections subscribe

    Constructors

    Methods

    • Override the connect method of the Signal class to set the isPublic property by default to false

      Parameters

      • callback: THandler
      • __namedParameters: ConnectOptions = {}

      Returns SignalConnection

    • Unsubscribe from this signal with the original callback instance. While you can use this method, the SignalConnection returned by connect() will not be updated!

      Parameters

      • callback: THandler

        The callback you passed to connect().

      Returns boolean

    • Disconnect all handlers from this signal event.

      Returns void

    • Publish this signal event (call all handlers).

      Parameters

      Returns void

    • Parameters

      Returns void

    • Returns number

      The number of connections on this signal.

    • Returns boolean

      true if this signal has connections.

    • Parameters

      Returns () => boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods