Provides one way binding between an IBindable element and Observers. Any changes from the element will be propagated to the observers.

Hierarchy (View Summary)

Constructors

Accessors

  • get applyingChange(): boolean

    Gets whether the binding is currently applying a change, either to the observers or the element.

    Returns boolean

  • set applyingChange(value: boolean): void

    Sets whether the binding is currently applying a change, either to the observers or the element.

    Parameters

    • value: boolean

    Returns void

  • get historyCombine(): boolean

    Gets whether to combine history actions when applying changes to observers.

    Returns boolean

  • set historyCombine(value: boolean): void

    Sets whether to combine history actions when applying changes to observers. This is assuming a history module is being used.

    Parameters

    • value: boolean

    Returns void

Methods

  • Links the specified observers to the specified paths.

    Parameters

    • observers: Observer | Observer[]

      The observer(s).

    • paths: string | string[]

      The path(s). The behavior of the binding depends on how many paths are passed. If an equal amount of paths and observers are passed then the binding will map each path to each observer at each index. If more observers than paths are passed then the path at index 0 will be used for all observers. If one observer and multiple paths are passed then all of the paths will be used for the observer (e.g. for curves).

    Returns void