Class OverlayMutableCollection

Mutable Overlay Collection class

This class should not be instantiated directly.

Hierarchy

OverlayCollection
- OverlayMutableCollection

Index

Properties

Accessors

overlayInfos pointerId size

Methods

add addCategory clear contains containsCategory getOverlayAt getOverlayByUId remove removeCategory init

Properties

`Protected`_pointerId

_pointerId: number

Accessors

overlayInfos

get overlayInfos(): OverlayInfo[]
Get all overlay infos in the collection

Returns OverlayInfo[]
List of overlay infos

Throws
An exception if it fails
Inherited from OverlayCollection.overlayInfos
- Defined in core/overlays.ts:393

pointerId

get pointerId(): number
Returns number
Inherited from OverlayCollection.pointerId
- Defined in core/overlays.ts:300

size

get size(): number
Get the number of overlays in the collection

Returns number
The number of overlays

Throws
An exception if it fails
Inherited from OverlayCollection.size
- Defined in core/overlays.ts:310

Methods

add

add(overlayId: number): void
Add an overlay to the collection
Parameters
- overlayId: number
  The overlay ID to add
Returns void
Throws
An exception if it fails
- Defined in core/overlays.ts:425

addCategory

addCategory(overlayId: number, categoryId: number): void
Add a specific category of an overlay to the collection
Parameters
- overlayId: number
  The overlay ID
- categoryId: number
  The category ID to add
Returns void
Throws
An exception if it fails
- Defined in core/overlays.ts:436

clear

clear(): void
Clear all overlays from the collection

Returns void
Throws
An exception if it fails
- Defined in core/overlays.ts:448

contains

contains(overlayId: number): boolean
Check if the collection contains an overlay
Parameters
- overlayId: number
  The overlay ID
Returns boolean
True if the overlay is in the collection, false otherwise

Throws
An exception if it fails
Inherited from OverlayCollection.contains
- Defined in core/overlays.ts:364

containsCategory

containsCategory(overlayId: number, categoryId: number): boolean
Check if the collection contains a specific category of an overlay
Parameters
- overlayId: number
  The overlay ID
- categoryId: number
  The category ID
Returns boolean
True if the category is in the collection, false otherwise

Throws
An exception if it fails
Inherited from OverlayCollection.containsCategory
- Defined in core/overlays.ts:378

getOverlayAt

getOverlayAt(index: number): OverlayInfo | null
Get an overlay by index
Parameters
- index: number
  The index of the overlay
Returns OverlayInfo | null
The overlay if found, null otherwise

Throws
An exception if it fails
Inherited from OverlayCollection.getOverlayAt
- Defined in core/overlays.ts:323

getOverlayByUId

getOverlayByUId(overlayUid: number): OverlayInfo | null
Get an overlay by UID
Parameters
- overlayUid: number
  The overlay UID
Returns OverlayInfo | null
The overlay if found, null otherwise

Throws
An exception if it fails
Inherited from OverlayCollection.getOverlayByUId
- Defined in core/overlays.ts:341

remove

remove(overlayId: number): GemError
Remove an overlay from the collection
Parameters
- overlayId: number
  The overlay ID to remove
Returns GemError
GemError indicating success or failure

Throws
An exception if it fails
- Defined in core/overlays.ts:459

removeCategory

removeCategory(overlayId: number, categoryId: number): GemError
Remove a specific category of an overlay from the collection
Parameters
- overlayId: number
  The overlay ID
- categoryId: number
  The category ID to remove
Returns GemError
GemError indicating success or failure

Throws
An exception if it fails
- Defined in core/overlays.ts:473

`Static`init

init(id: number): OverlayMutableCollection
Internal
Parameters
- id: number
Returns OverlayMutableCollection
Overrides OverlayCollection.init
- Defined in core/overlays.ts:415