watchUtils | @types/arcgis-js-api

Various utilities and convenience functions for watching Accessor properties.

Hierarchy

watchUtils

Index

Methods

init

init(obj: Accessor, propertyName: string | string[], callback: WatchCallback): WatchHandle

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1831
Watches a property for changes and calls the callback with the initial value of the property.

Read more...

Parameters
- obj: Accessor
- propertyName: string | string[]
- callback: WatchCallback
Returns WatchHandle

on

on(obj: Accessor, propertyName: string | string[], eventName: string, eventHandler: Function, attachedHandler?: EventAttachedCallback, detachedHandler?: EventAttachedCallback): WatchHandle

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1837
Watches a property for changes and automatically attaches and detaches an event handler for a given event to the property value as needed.

Read more...

Parameters
- obj: Accessor
- propertyName: string | string[]
- eventName: string
- eventHandler: Function
- Optional attachedHandler: EventAttachedCallback
- Optional detachedHandler: EventAttachedCallback
Returns WatchHandle

once

once(obj: Accessor, propertyName: string | string[], callback?: WatchCallback): PromisedWatchHandle

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1850
Watches a property for changes once.

Read more...

Parameters
- obj: Accessor
- propertyName: string | string[]
- Optional callback: WatchCallback
Returns PromisedWatchHandle

pausable

pausable(obj: Accessor, propertyName: string | string[], callback?: WatchCallback): PausableWatchHandle

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1856
Watches a property for changes.

Read more...

Parameters
- obj: Accessor
- propertyName: string | string[]
- Optional callback: WatchCallback
Returns PausableWatchHandle

watch

watch(obj: Accessor, propertyName: string | string[], callback: WatchCallback): WatchHandle

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1862
Watches a property for changes.

Read more...

Parameters
- obj: Accessor
- propertyName: string | string[]
- callback: WatchCallback
Returns WatchHandle

when

when(obj: Accessor, propertyName: string | string[], callback: WatchCallback): WatchHandle

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1868
Watches a property for becoming truthy.

Read more...

Parameters
- obj: Accessor
- propertyName: string | string[]
- callback: WatchCallback
Returns WatchHandle

whenDefined

whenDefined(obj: Accessor, propertyName: string | string[], callback: WatchCallback): WatchHandle

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1874
Watches a property for becoming defined.

Read more...

Parameters
- obj: Accessor
- propertyName: string | string[]
- callback: WatchCallback
Returns WatchHandle

whenDefinedOnce

whenDefinedOnce(obj: Accessor, propertyName: string | string[], callback?: WatchCallback): PromisedWatchHandle

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1880
Watches a property for becoming defined once.

Read more...

Parameters
- obj: Accessor
- propertyName: string | string[]
- Optional callback: WatchCallback
Returns PromisedWatchHandle

whenEqual

whenEqual(obj: Accessor, propertyName: string, value: any, callback: WatchCallback): WatchHandle

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1886
Watches a property for becoming equal with a given value.

Read more...

Parameters
- obj: Accessor
- propertyName: string
- value: any
- callback: WatchCallback
Returns WatchHandle

whenEqualOnce

whenEqualOnce(obj: Accessor, propertyName: string, value: any, callback?: WatchCallback): PromisedWatchHandle

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1892
Watches a property for becoming equal with a given value.

Read more...

Parameters
- obj: Accessor
- propertyName: string
- value: any
- Optional callback: WatchCallback
Returns PromisedWatchHandle

whenFalse

whenFalse(obj: Accessor, propertyName: string | string[], callback: WatchCallback): WatchHandle

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1898
Watches a property for becoming false.

Read more...

Parameters
- obj: Accessor
- propertyName: string | string[]
- callback: WatchCallback
Returns WatchHandle

whenFalseOnce

whenFalseOnce(obj: Accessor, propertyName: string | string[], callback?: WatchCallback): PromisedWatchHandle

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1904
Watches a property for becoming false once.

Read more...

Parameters
- obj: Accessor
- propertyName: string | string[]
- Optional callback: WatchCallback
Returns PromisedWatchHandle

whenNot

whenNot(obj: Accessor, propertyName: string | string[], callback: WatchCallback): WatchHandle

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1910
Watches a property for becoming falsy.

Read more...

Parameters
- obj: Accessor
- propertyName: string | string[]
- callback: WatchCallback
Returns WatchHandle

whenNotOnce

whenNotOnce(obj: Accessor, propertyName: string | string[], callback?: WatchCallback): PromisedWatchHandle

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1916
Watches a property for becoming falsy once.

Read more...

Parameters
- obj: Accessor
- propertyName: string | string[]
- Optional callback: WatchCallback
Returns PromisedWatchHandle

whenOnce

whenOnce(obj: Accessor, propertyName: string | string[], callback?: WatchCallback): PromisedWatchHandle

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1922
Watches a property for becoming truthy once.

Read more...

Parameters
- obj: Accessor
- propertyName: string | string[]
- Optional callback: WatchCallback
Returns PromisedWatchHandle

whenTrue

whenTrue(obj: Accessor, propertyName: string | string[], callback: WatchCallback): WatchHandle

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1928
Watches a property for becoming true.

Read more...

Parameters
- obj: Accessor
- propertyName: string | string[]
- callback: WatchCallback
Returns WatchHandle

whenTrueOnce

whenTrueOnce(obj: Accessor, propertyName: string | string[], callback?: WatchCallback): PromisedWatchHandle

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1934
Watches a property for becoming true once.

Read more...

Parameters
- obj: Accessor
- propertyName: string | string[]
- Optional callback: WatchCallback
Returns PromisedWatchHandle

whenUndefined

whenUndefined(obj: Accessor, propertyName: string | string[], callback: WatchCallback): WatchHandle

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1940
Watches a property for becoming undefined.

Read more...

Parameters
- obj: Accessor
- propertyName: string | string[]
- callback: WatchCallback
Returns WatchHandle

whenUndefinedOnce

whenUndefinedOnce(obj: Accessor, propertyName: string | string[], callback?: WatchCallback): PromisedWatchHandle

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1946
Watches a property for becoming undefined once.

Read more...

Parameters
- obj: Accessor
- propertyName: string | string[]
- Optional callback: WatchCallback
Returns PromisedWatchHandle

Hierarchy

Index

Methods

Methods

init

Parameters

obj: Accessor

propertyName: string | string[]

callback: WatchCallback

Returns WatchHandle

on

Parameters

obj: Accessor

propertyName: string | string[]

eventName: string

eventHandler: Function

Optional attachedHandler: EventAttachedCallback

Optional detachedHandler: EventAttachedCallback

Returns WatchHandle

once

Parameters

obj: Accessor

propertyName: string | string[]

Optional callback: WatchCallback

Returns PromisedWatchHandle

pausable

Parameters

obj: Accessor

propertyName: string | string[]

Optional callback: WatchCallback

Returns PausableWatchHandle

watch

Parameters

obj: Accessor

propertyName: string | string[]

callback: WatchCallback

Returns WatchHandle

when

Parameters

obj: Accessor

propertyName: string | string[]

callback: WatchCallback

Returns WatchHandle

whenDefined

Parameters

obj: Accessor

propertyName: string | string[]

callback: WatchCallback

Returns WatchHandle

whenDefinedOnce

Parameters

obj: Accessor

propertyName: string | string[]

Optional callback: WatchCallback

Returns PromisedWatchHandle

whenEqual

Parameters

obj: Accessor

propertyName: string

value: any

callback: WatchCallback

Returns WatchHandle

whenEqualOnce

Parameters

obj: Accessor

propertyName: string

value: any

Optional callback: WatchCallback

Returns PromisedWatchHandle

whenFalse

Parameters

obj: Accessor

propertyName: string | string[]

callback: WatchCallback

Returns WatchHandle

whenFalseOnce

Parameters

obj: Accessor

propertyName: string | string[]

Optional callback: WatchCallback