Class Collection

Hierarchy

Collection<Dataset>
- Collection

Index

Constructors

Accessors

Methods

add contains move remove toggle

Constructors

constructor

new Collection(array?: Dataset[], options?: Options): Collection
Parameters
- Optional array: Dataset[]
  
  Array.
- Optional options: Options
  
  Collection options.
Returns Collection
Inherited from OlCollection<Dataset>.constructor
- Defined in node_modules/ol/Collection.d.ts:72

Accessors

length

get length(): number
The length of the collection. Shorthand for getLength

Returns number
- Defined in src/collection.ts:57
set length(length: number): void
Change the length of the collection
Parameters
- length: number
Returns void
- Defined in src/collection.ts:64

Methods

add

add(dataset: Dataset, index?: undefined | number): number
Add a Dataset to the collection

Returns
New length of the collection.
Parameters
- dataset: Dataset
  
  to add
- index: undefined | number = ...
  
  the Dataset will be added to.
Returns number
- Defined in src/collection.ts:11

contains

contains(item: Dataset): boolean
Is dataset in collection
Parameters
- item: Dataset
Returns boolean
- Defined in src/collection.ts:27

move

move(from: number, to: number): void
Move a Dataset in the collection to at specific postion
Parameters
- from: number
  
  Index of the Dataset to move
- to: number
  
  The index the Dataset will be moved to
Returns void
- Defined in src/collection.ts:47

remove

remove(dataset: Dataset): undefined | Dataset
Remove a Dataset from the collection

Returns
The removed Dataset or undefined if none found.
Parameters
- dataset: Dataset
Returns undefined | Dataset
Overrides OlCollection.remove
- Defined in src/collection.ts:20

toggle

toggle(item: Dataset): void
Toggle a Dataset in the collection
Parameters
- item: Dataset
Returns void
- Defined in src/collection.ts:34

Generated using TypeDoc