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

Hierarchy (view full)

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): 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): 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

  • get historyEnabled(): any
  • Gets whether history is enabled for the binding.

    Returns any

  • set historyEnabled(value): void
  • Sets whether history is enabled for the binding. A valid history object must have been provided first.

    Parameters

    • value: any

    Returns void

  • get historyName(): string
  • Gets the name of the history action when applying changes to observers.

    Returns string

  • set historyName(value): void
  • Sets the name of the history action when applying changes to observers.

    Parameters

    • value: string

    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