OverlayMutableCollection - @magiclane/maps-sdk API Reference

Home > @magiclane/maps-sdk > OverlayMutableCollection

OverlayMutableCollection class

Mutable Overlay Collection class

This class should not be instantiated directly.

Maps & 3D Scene

Signature:

export declare class OverlayMutableCollection extends OverlayCollection

Extends: OverlayCollection

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the OverlayMutableCollection class.

Methods

Method	Modifiers	Description
add(overlayId)		Add an overlay to the collection
addCategory(overlayId, categoryId)		Add a specific category of an overlay to the collection
clear()		Clear all overlays from the collection
remove(overlayId)		Remove an overlay from the collection
removeCategory(overlayId, categoryId)		Remove a specific category of an overlay from the collection