editor › Globals › LocalMosaicElementLoader
Class: LocalMosaicElementLoader
We load the MosaicElementContainers by defining them in the code in this class. Look at documentation for {@see MosaicElementContainer} and {@see MosaicElementCutout}.
Hierarchy
↳ LocalMosaicElementLoader
Index
Properties
Methods
Properties
Static Protected gridMap
▪ gridMap: Map‹string, MosaicElementContainer› = new Map()
Inherited from MosaicElementLoader.gridMap
Defined in src/modules/kyub.core.plateOrnaments/src/MosaicElementOrnaments/MosaicElementLoader.ts:11
Static Protected nullMosaicElementContainerId
▪ nullMosaicElementContainerId: string = "null_grid"
Inherited from MosaicElementLoader.nullMosaicElementContainerId
Defined in src/modules/kyub.core.plateOrnaments/src/MosaicElementOrnaments/MosaicElementLoader.ts:8
Methods
Static Protected _loadMosaicElementContainer
▸ _loadMosaicElementContainer(id: string): Promise‹void›
Overrides MosaicElementLoader._loadMosaicElementContainer
Defined in src/modules/kyub.core.plateOrnaments/src/MosaicElementOrnaments/LocalMosaicElementLoader.ts:13
When any grid type is requested for the first time we initialize the entire map.
Parameters:
| Name | Type |
|---|---|
id |
string |
Returns: Promise‹void›
Static getMosaicElementContainer
▸ getMosaicElementContainer(id: string): Promise‹MosaicElementContainer›
Inherited from MosaicElementLoader.getMosaicElementContainer
Defined in src/modules/kyub.core.plateOrnaments/src/MosaicElementOrnaments/MosaicElementLoader.ts:17
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | id of the mosaicElementContainer |
Returns: Promise‹MosaicElementContainer›
a promise of a MosaicElementContainer
Static getNullMosaicElementContainer
▸ getNullMosaicElementContainer(): MosaicElementContainer
Inherited from MosaicElementLoader.getNullMosaicElementContainer
Defined in src/modules/kyub.core.plateOrnaments/src/MosaicElementOrnaments/MosaicElementLoader.ts:32
Returns: MosaicElementContainer
a NullMosaicElementContainer providing the same interface as a MosaicElementContainer but adding no functionality. This means that we can use it as a default value in case no real MosaicElementContainer has been set.