Collection | @types/arcgis-js-api

Type parameters

T = any

Hierarchy

Evented
__esriImplementsIteration<T>
Accessor
- Collection
  - SceneModifications

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Collection<T>(values?: any[] | Collection<any> | CollectionPropertiesBase<any>): Collection<T>

Inherited from Accessor.constructor
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:109
Type parameters
- T = any
Parameters
- Optional values: any[] | Collection<any> | CollectionPropertiesBase<any>
Returns Collection<T>

Properties

declaredClass

declaredClass: string

destroyed

destroyed: boolean

initialized

initialized: boolean

Readonly length

length: number

Methods

[iterator]

[iterator](): IterableIterator<T>

Inherited from __esriImplementsIteration.[iterator]
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:16
Returns IterableIterator<T>

Protected _get

_get(propertyName: string): any
_get<T>(propertyName: string): T

Inherited from Accessor._get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:35
Parameters
- propertyName: string
Returns any
Inherited from Accessor._get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:36
Type parameters
- T
Parameters
- propertyName: string
Returns T

Protected _set

_set<T>(propertyName: string, value: T): Collection<T>

Inherited from Accessor._set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:37
Type parameters
- T
Parameters
- propertyName: string
- value: T
Returns Collection<T>

add

add(item: T, index?: number): void

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:113
Parameters
- item: T
- Optional index: number
Returns void

addMany

addMany(items: Collection<T> | T[], index?: number): void

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:114
Parameters
- items: Collection<T> | T[]
- Optional index: number
Returns void

clone

clone(): Collection<T>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:115
Returns Collection<T>

concat

concat(value: Collection<T> | T[]): Collection<T>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:116
Parameters
- value: Collection<T> | T[]
Returns Collection<T>

destroy

destroy(): void

Inherited from Accessor.destroy
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:26
Returns void

emit

emit(type: string, event?: any): boolean

Inherited from Evented.emit
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1106
Emits an event on the instance.

Read more...

Parameters
- type: string
- Optional event: any
Returns boolean

every

every(callback: ItemTestCallback<T>): boolean

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:117
Parameters
- callback: ItemTestCallback<T>
Returns boolean

filter

filter(callback: ItemTestCallback<T>): Collection<T>
filter<S>(callback: (item: T, index: number) => item is S): Collection<S>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:118
Parameters
- callback: ItemTestCallback<T>
Returns Collection<T>
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:119
Type parameters
- S
Parameters
- callback: (item: T, index: number) => item is S
 - - (item: T, index: number): item is S
 - Parameters
 - item: T
 - index: number
 Returns item is S
Returns Collection<S>

find

find(callback: ItemTestCallback<T>): T

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:120
Parameters
- callback: ItemTestCallback<T>
Returns T

findIndex

findIndex(callback: ItemTestCallback<T>): number

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:121
Parameters
- callback: ItemTestCallback<T>
Returns number

flatten

flatten(callback: (item: T, index: number) => Collection<T> | T[]): Collection<T>
flatten(callback: (item: U, index: number) => U[] | Collection): Collection

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:122
Parameters
- callback: (item: T, index: number) => Collection<T> | T[]
 - - (item: T, index: number): Collection<T> | T[]
 - Parameters
 - item: T
 - index: number
 Returns Collection<T> | T[]
Returns Collection<T>
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:123
Type parameters
- U
Parameters
- callback: (item: U, index: number) => U[] | Collection
 - - (item: U, index: number): U[] | Collection
 - Parameters
 - item: U
 - index: number
 Returns U[] | Collection
Returns Collection

forEach

forEach(callback: ItemCallback<T>): void

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:124
Parameters
- callback: ItemCallback<T>
Returns void

get

get<T>(propertyName: string): T
get(propertyName: string): any

Inherited from Accessor.get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:28
Type parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Accessor.get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:29
Parameters
- propertyName: string
Returns any

getItemAt

getItemAt(index: number): T

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:125
Parameters
- index: number
Returns T

hasEventListener

hasEventListener(type: string): boolean

Inherited from Evented.hasEventListener
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1112
Indicates whether there is an event listener on the instance that matches the provided event name.

Read more...

Parameters
- type: string
Returns boolean

includes

includes(searchElement: T): boolean

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:126
Parameters
- searchElement: T
Returns boolean

indexOf

indexOf(searchElement: T, fromIndex?: number): number

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:127
Parameters
- searchElement: T
- Optional fromIndex: number
Returns number

join

join(separator?: string): string

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:128
Parameters
- Optional separator: string
Returns string

lastIndexOf

lastIndexOf(searchElement: T, fromIndex?: number): number

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:129
Parameters
- searchElement: T
- Optional fromIndex: number
Returns number

map

map<R>(callback: ItemMapCallback<T, R>): Collection<R>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:130
Type parameters
- R = T
Parameters
- callback: ItemMapCallback<T, R>
Returns Collection<R>

Protected notifyChange

notifyChange(propertyName: string): void

Inherited from Accessor.notifyChange
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:34
Parameters
- propertyName: string
Returns void

on

on(type: "after-add", listener: CollectionAfterAddEventHandler<T>): IHandle
on(type: "after-changes", listener: CollectionAfterChangesEventHandler<T>): IHandle
on(type: "after-remove", listener: CollectionAfterRemoveEventHandler<T>): IHandle
on(type: "before-add", listener: CollectionBeforeAddEventHandler<T>): IHandle
on(type: "before-changes", listener: CollectionBeforeChangesEventHandler<T>): IHandle
on(type: "before-remove", listener: CollectionBeforeRemoveEventHandler<T>): IHandle
on(type: "change", listener: CollectionChangeEventHandler<T>): IHandle
on(type: string, listener: (event: any) => void): IHandle

Overrides Evented.on
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:90
Registers an event handler on the instance.

Read more...

Parameters
- type: "after-add"
- listener: CollectionAfterAddEventHandler<T>
Returns IHandle
Overrides Evented.on
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:91
Parameters
- type: "after-changes"
- listener: CollectionAfterChangesEventHandler<T>
Returns IHandle
Overrides Evented.on
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:92
Parameters
- type: "after-remove"
- listener: CollectionAfterRemoveEventHandler<T>
Returns IHandle
Overrides Evented.on
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:93
Parameters
- type: "before-add"
- listener: CollectionBeforeAddEventHandler<T>
Returns IHandle
Overrides Evented.on
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:94
Parameters
- type: "before-changes"
- listener: CollectionBeforeChangesEventHandler<T>
Returns IHandle
Overrides Evented.on
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:95
Parameters
- type: "before-remove"
- listener: CollectionBeforeRemoveEventHandler<T>
Returns IHandle
Overrides Evented.on
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:96
Parameters
- type: "change"
- listener: CollectionChangeEventHandler<T>
Returns IHandle
Overrides Evented.on
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:97
Parameters
- type: string
- listener: (event: any) => void
  - - (event: any): void
    - Parameters
      - event: any
      Returns void
Returns IHandle

pop

pop(): T

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:131
Returns T

push

push(item: T): number

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:132
Parameters
- item: T
Returns number

reduce

reduce<R>(callback: ItemReduceCallback<T, R>, initialValue?: R): R

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:133
Type parameters
- R = T
Parameters
- callback: ItemReduceCallback<T, R>
- Optional initialValue: R
Returns R

reduceRight

reduceRight<R>(callback: ItemReduceCallback<T, R>, initialValue?: R): R

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:134
Type parameters
- R = T
Parameters
- callback: ItemReduceCallback<T, R>
- Optional initialValue: R
Returns R

remove

remove(item: T): void

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:135
Parameters
- item: T
Returns void

removeAll

removeAll(): void

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:136
Returns void

removeAt

removeAt(index: number): any

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:137
Parameters
- index: number
Returns any

removeMany

removeMany(items: Collection<T> | T[]): T[]

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:138
Parameters
- items: Collection<T> | T[]
Returns T[]

reorder

reorder(item: T, index: number): T

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:139
Parameters
- item: T
- index: number
Returns T

reverse

reverse(): Collection<T>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:140
Returns Collection<T>

set

set<T>(propertyName: string, value: T): Collection<T>
set(props: HashMap<any>): Collection<T>

Inherited from Accessor.set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:30
Type parameters
- T
Parameters
- propertyName: string
- value: T
Returns Collection<T>
Inherited from Accessor.set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:31
Parameters
- props: HashMap<any>
Returns Collection<T>

shift

shift(): T

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:141
Returns T

slice

slice(begin?: number, end?: number): Collection<T>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:142
Parameters
- Optional begin: number
- Optional end: number
Returns Collection<T>

some

some(callback: ItemCallback<T>): boolean

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:143
Parameters
- callback: ItemCallback<T>
Returns boolean

sort

sort(compareFunction?: ItemCompareCallback<T>): void

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:144
Parameters
- Optional compareFunction: ItemCompareCallback<T>
Returns void

splice

splice(start: number, deleteCount: number, ...items: T[]): T[]

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:145
Parameters
- start: number
- deleteCount: number
- Rest ...items: T[]
Returns T[]

toArray

toArray(): T[]

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:146
Returns T[]

unshift

unshift(...items: T[]): number

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:147
Parameters
- Rest ...items: T[]
Returns number

watch

watch(path: string | string[], callback: WatchCallback, sync?: boolean): WatchHandle

Inherited from Accessor.watch
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:32
Parameters
- path: string | string[]
- callback: WatchCallback
- Optional sync: boolean
Returns WatchHandle

Static isCollection

isCollection<T>(value: any): value is Collection<T>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:149
Type parameters
- T = any
Parameters
- value: any
Returns value is Collection<T>

Static ofType

ofType<T, Base>(type: Constructor<T> | Types<T, Base>): new (items?: T[] | Collection<T> | { items?: T[] | Collection<T> }) => Collection<T>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:151
Type parameters
- T
- Base = T
Parameters
- type: Constructor<T> | Types<T, Base>
Returns new (items?: T[] | Collection<T> | { items?: T[] | Collection<T> }) => Collection<T>
- - new (items?: T[] | Collection<T> | { items?: T[] | Collection<T> }): Collection<T>
 - Parameters
 - Optional items: T[] | Collection<T> | { items?: T[] | Collection<T> }
 Returns Collection<T>

Type parameters

T = any

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

T = any

Parameters

Optional values: any[] | Collection<any> | CollectionPropertiesBase<any>

Returns Collection<T>

Properties

declaredClass

destroyed

initialized

Readonly length

Methods

[iterator]

Returns IterableIterator<T>

Protected _get

Parameters

propertyName: string

Returns any

Type parameters

T

Parameters

propertyName: string

Returns T

Protected _set

Type parameters

T

Parameters

propertyName: string

value: T

Returns Collection<T>

add

Parameters

item: T

Optional index: number

Returns void

addMany

Parameters

items: Collection<T> | T[]

Optional index: number

Returns void

clone

Returns Collection<T>

concat

Parameters

value: Collection<T> | T[]

Returns Collection<T>

destroy

Returns void

emit

Parameters

type: string

Optional event: any

Returns boolean

every

Parameters

callback: ItemTestCallback<T>

Returns boolean

filter

Parameters

callback: ItemTestCallback<T>

Returns Collection<T>

Type parameters

S

Parameters

callback: (item: T, index: number) => item is S

Parameters

item: T

index: number

Returns item is S

Returns Collection<S>

find

Parameters