YMapCollection

YMapCollection is a class that can combine multiple objects in a collection. It enables you to add objects to a subtree and remove them from it.

Creating a collectionCreating a collection

Example of creating a collection of markers.

const collection = new YMapCollection({});
const markerElement = document.createElement('div');
markerElement.className = 'marker';

for (let i = 0; i < 10_000; i++) {
 collection.addChild(new YMapMarker({
   coordinates: [Math.random() * 180, Math.random() * 180]
 }, markerElement.cloneNode(true)));
}

map.addChild(collection); // add a collection to the map
map.removeChild(collection); // remove all markers from the map

Detailed example.

ConstructorConstructor

new YMapCollection(props, options?)

Constructor parametersConstructor parameters

Inherited fromInherited from

YMapGroupEntity.constructor

new YMapCollection(props, children?, options?)

Constructor parametersConstructor parameters

Inherited fromInherited from

YMapGroupEntity.constructor

PropsProps

readonly children: readonly [YMapEntity](YMapEntity.md)<unknown, {}>[]

Inherited fromInherited from

YMapGroupEntity.children

MethodsMethods

addChildaddChild

addChild(child, index?): YMapCollection

ParametersParameters

ReturnsReturns

YMapCollection

Inherited fromInherited from

YMapGroupEntity.addChild

removeChildremoveChild

removeChild(child): YMapCollection

ParametersParameters

ReturnsReturns

YMapCollection

Inherited fromInherited from

YMapGroupEntity.removeChild

updateupdate

update(changedProps): void

ParametersParameters

ReturnsReturns

void

Inherited fromInherited from

YMapGroupEntity.update