Class BindingObserversToElement

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)

BindingBase
- BindingObserversToElement

Index

Constructors

constructor

new BindingObserversToElement(args?): BindingObserversToElement
Creates a new BindingObserversToElement instance.
Parameters
- args: Readonly<BindingObserversToElementArgs> = {}
  The arguments.
Returns BindingObserversToElement
Overrides BindingBase.constructor
- Defined in pcui/src/binding/BindingObserversToElement/index.ts:28

Accessors

applyingChange

get applyingChange(): boolean
Gets whether the binding is currently applying a change, either to the observers or the element.

Returns boolean
Inherited from BindingBase.applyingChange
- Defined in pcui/src/binding/BindingBase/index.ts:190
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
Inherited from BindingBase.applyingChange
- Defined in pcui/src/binding/BindingBase/index.ts:180

element

get element(): IBindable
Gets the element.

Returns IBindable
Inherited from BindingBase.element
- Defined in pcui/src/binding/BindingBase/index.ts:173
set element(value): void
Sets the element.
Parameters
- value: IBindable
Returns void
Inherited from BindingBase.element
- Defined in pcui/src/binding/BindingBase/index.ts:166

historyCombine

get historyCombine(): boolean
Gets whether to combine history actions when applying changes to observers.

Returns boolean
Inherited from BindingBase.historyCombine
- Defined in pcui/src/binding/BindingBase/index.ts:212
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
Inherited from BindingBase.historyCombine
- Defined in pcui/src/binding/BindingBase/index.ts:205

historyEnabled

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

Returns any
Inherited from BindingBase.historyEnabled
- Defined in pcui/src/binding/BindingBase/index.ts:271
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
Inherited from BindingBase.historyEnabled
- Defined in pcui/src/binding/BindingBase/index.ts:261

historyName

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

Returns string
Inherited from BindingBase.historyName
- Defined in pcui/src/binding/BindingBase/index.ts:226
set historyName(value): void
Sets the name of the history action when applying changes to observers.
Parameters
- value: string
Returns void
Inherited from BindingBase.historyName
- Defined in pcui/src/binding/BindingBase/index.ts:219

historyPostfix

get historyPostfix(): string
Gets the string to postfix historyName with.

Returns string
Inherited from BindingBase.historyPostfix
- Defined in pcui/src/binding/BindingBase/index.ts:254
set historyPostfix(value): void
Sets the string to postfix historyName with.
Parameters
- value: string
Returns void
Inherited from BindingBase.historyPostfix
- Defined in pcui/src/binding/BindingBase/index.ts:247

historyPrefix

get historyPrefix(): string
Gets the string to prefix historyName with.

Returns string
Inherited from BindingBase.historyPrefix
- Defined in pcui/src/binding/BindingBase/index.ts:240
set historyPrefix(value): void
Sets the string to prefix historyName with.
Parameters
- value: string
Returns void
Inherited from BindingBase.historyPrefix
- Defined in pcui/src/binding/BindingBase/index.ts:233

linked

get linked(): boolean
Gets whether the binding is linked to observers.

Returns boolean
Inherited from BindingBase.linked
- Defined in pcui/src/binding/BindingBase/index.ts:197

observers

get observers(): Observer[]
Gets the linked observers.

Returns Observer[]
Inherited from BindingBase.observers
- Defined in pcui/src/binding/BindingBase/index.ts:279

paths

get paths(): string[]
Gets the linked paths.

Returns string[]
Inherited from BindingBase.paths
- Defined in pcui/src/binding/BindingBase/index.ts:286

Methods

addValue

addValue(value): void
Adds (inserts) a value to the linked observers at the linked paths.
Parameters
- value: any
  The value.
Returns void
Inherited from BindingBase.addValue
- Defined in pcui/src/binding/BindingBase/index.ts:136

addValues

addValues(values): void
Adds (inserts) multiple values to the linked observers at the linked paths.
Parameters
- values: any[]
  The values.
Returns void
Inherited from BindingBase.addValues
- Defined in pcui/src/binding/BindingBase/index.ts:144

clone

clone(): BindingObserversToElement
Clone the BindingObserversToElement instance.

Returns BindingObserversToElement
Overrides BindingBase.clone
- Defined in pcui/src/binding/BindingObserversToElement/index.ts:127

link

link(observers, paths): void
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
Overrides BindingBase.link
- Defined in pcui/src/binding/BindingObserversToElement/index.ts:82

removeValue

removeValue(value): void
Removes a value from the linked observers at the linked paths.
Parameters
- value: any
  The value.
Returns void
Inherited from BindingBase.removeValue
- Defined in pcui/src/binding/BindingBase/index.ts:152

removeValues

removeValues(values): void
Removes multiple values from the linked observers from the linked paths.
Parameters
- values: any[]
  The values.
Returns void
Inherited from BindingBase.removeValues
- Defined in pcui/src/binding/BindingBase/index.ts:160

setValue

setValue(value): void
Sets a value to the linked observers at the linked paths.
Parameters
- value: any
  The value
Returns void
Inherited from BindingBase.setValue
- Defined in pcui/src/binding/BindingBase/index.ts:120

setValues

setValues(values): void
Sets an array of values to the linked observers at the linked paths.
Parameters
- values: any[]
  The values.
Returns void
Inherited from BindingBase.setValues
- Defined in pcui/src/binding/BindingBase/index.ts:128

unlink

unlink(): void
Unlink the binding from its set of observers.

Returns void
Overrides BindingBase.unlink
- Defined in pcui/src/binding/BindingObserversToElement/index.ts:110

Class BindingObserversToElement

Hierarchy (view full)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns BindingObserversToElement

Accessors

applyingChange

Returns boolean

Parameters

Returns void

element

Returns IBindable

Parameters

Returns void

historyCombine

Returns boolean

Parameters

Returns void

historyEnabled

Returns any

Parameters

Returns void

historyName

Returns string

Parameters

Returns void

historyPostfix

Returns string

Parameters

Returns void

historyPrefix

Returns string

Parameters

Returns void

linked

Returns boolean

observers

Returns Observer[]

paths

Returns string[]

Methods

addValue

Parameters

Returns void

addValues

Parameters

Returns void

clone

Returns BindingObserversToElement

link

Parameters

Returns void

removeValue

Parameters

Returns void

removeValues

Parameters

Returns void

setValue

Parameters

Returns void

setValues

Parameters

Returns void

unlink

Returns void

Settings

On This Page