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

Accessors

applyingChange element historyCombine historyEnabled historyName historyPostfix historyPrefix linked observers paths

Methods

addValue addValues clone removeValue removeValues setValue setValues unlink

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
Returns boolean
Inherited from BindingBase.applyingChange
- Defined in pcui/src/binding/BindingBase/index.ts:184
set applyingChange(value): void
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:177

element

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

historyCombine

get historyCombine(): boolean
Returns boolean
Inherited from BindingBase.historyCombine
- Defined in pcui/src/binding/BindingBase/index.ts:202
set historyCombine(value): void
If a history module is used whether to combine history actions when applying changes to observers.
Parameters
- value: boolean
Returns void
Inherited from BindingBase.historyCombine
- Defined in pcui/src/binding/BindingBase/index.ts:198

historyEnabled

get historyEnabled(): any
Returns any
Inherited from BindingBase.historyEnabled
- Defined in pcui/src/binding/BindingBase/index.ts:249
set historyEnabled(value): void
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:242

historyName

get historyName(): string
Returns string
Inherited from BindingBase.historyName
- Defined in pcui/src/binding/BindingBase/index.ts:213
set historyName(value): void
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:209

historyPostfix

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

historyPrefix

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

linked

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

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

observers

get observers(): Observer[]
The linked observers.

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

paths

get paths(): string[]
The linked paths.

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

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

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