Class VcsApp

Hierarchy

VcsApp

Index

Constructors

Methods

_parseModule _removeModule _setModuleState _startModuleMutationChain addModule destroy getModuleById removeModule resetDynamicModule serializeModule setDynamicModule

Accessors

categoryClassRegistry

get categoryClassRegistry(): OverrideClassRegistry<typeof Category>
Returns OverrideClassRegistry<typeof Category>
- Defined in src/vcsApp.ts:350

categoryItemClassRegistry

get categoryItemClassRegistry(): OverrideClassRegistry<Ctor<any>>
Returns OverrideClassRegistry<Ctor<any>>
- Defined in src/vcsApp.ts:354

destroyed

get destroyed(): VcsEvent<void>
Returns VcsEvent<void>
- Defined in src/vcsApp.ts:314

displayQuality

get displayQuality(): DisplayQuality
Returns DisplayQuality
- Defined in src/vcsApp.ts:310

dynamicModuleId

get dynamicModuleId(): string
Returns string
- Defined in src/vcsApp.ts:330

dynamicModuleIdChanged

get dynamicModuleIdChanged(): VcsEvent<string>
Returns VcsEvent<string>
- Defined in src/vcsApp.ts:334

id

get id(): string
Returns string
- Defined in src/vcsApp.ts:245

layerClassRegistry

get layerClassRegistry(): OverrideClassRegistry<typeof Layer>
Returns OverrideClassRegistry<typeof Layer>
- Defined in src/vcsApp.ts:342

layers

get layers(): OverrideCollection<Layer<LayerImplementation<VcsMap<VisualisationType>>>, LayerCollection>
Returns OverrideCollection<Layer<LayerImplementation<VcsMap<VisualisationType>>>, LayerCollection>
- Defined in src/vcsApp.ts:282

locale

get locale(): string
Returns string
- Defined in src/vcsApp.ts:249
set locale(value): void
sets the locale of the vcsApp and the linked layerCollection. This will trigger the localeChanged Event.
Parameters
- value: string
  
  new locale with 2 letters
Returns void
- Defined in src/vcsApp.ts:258

localeChanged

get localeChanged(): VcsEvent<string>
Returns VcsEvent<string>
- Defined in src/vcsApp.ts:274

mapClassRegistry

get mapClassRegistry(): OverrideClassRegistry<typeof VcsMap>
Returns OverrideClassRegistry<typeof VcsMap>
- Defined in src/vcsApp.ts:338

maps

get maps(): OverrideCollection<VcsMap<VisualisationType>, MapCollection>
Returns OverrideCollection<VcsMap<VisualisationType>, MapCollection>
- Defined in src/vcsApp.ts:278

moduleAdded

get moduleAdded(): VcsEvent<VcsModule>
Returns VcsEvent<VcsModule>
- Defined in src/vcsApp.ts:322

moduleRemoved

get moduleRemoved(): VcsEvent<VcsModule>
Returns VcsEvent<VcsModule>
- Defined in src/vcsApp.ts:326

modules

get modules(): VcsModule[]
Returns VcsModule[]
- Defined in src/vcsApp.ts:318

obliqueCollections

get obliqueCollections(): OverrideCollection<ObliqueCollection>
Returns OverrideCollection<ObliqueCollection>
- Defined in src/vcsApp.ts:286

styleClassRegistry

get styleClassRegistry(): OverrideClassRegistry<typeof StyleItem>
Returns OverrideClassRegistry<typeof StyleItem>
- Defined in src/vcsApp.ts:346

styles

get styles(): OverrideCollection<StyleItem>
Returns OverrideCollection<StyleItem>
- Defined in src/vcsApp.ts:294

tileProviderClassRegistry

get tileProviderClassRegistry(): OverrideClassRegistry<typeof TileProvider>
Returns OverrideClassRegistry<typeof TileProvider>
- Defined in src/vcsApp.ts:358

viewpoints

get viewpoints(): OverrideCollection<Viewpoint>
Returns OverrideCollection<Viewpoint>
- Defined in src/vcsApp.ts:290

Constructors

constructor

new VcsApp(options?): VcsApp
Parameters
- options: VcsAppOptions = {}
Returns VcsApp
- Defined in src/vcsApp.ts:151

Methods

`Protected` _parseModule

_parseModule(module): Promise<void>
Parameters
- module: VcsModule
Returns Promise<void>
- Defined in src/vcsApp.ts:372

`Protected` _removeModule

_removeModule(moduleId): Promise<void>
Parameters
- moduleId: string
Returns Promise<void>
- Defined in src/vcsApp.ts:552

`Protected` _setModuleState

_setModuleState(module): Promise<void>
Parameters
- module: VcsModule
Returns Promise<void>
- Defined in src/vcsApp.ts:401

_startModuleMutationChain

_startModuleMutationChain(): void
Returns void
- Defined in src/vcsApp.ts:481

addModule

addModule(module): Promise<void>
When adding multiple modules, adding of previous modules are awaited. If an invalid module is added an error is thrown and already added items of invalid module are removed.
Parameters
- module: VcsModule
Returns Promise<void>
- Defined in src/vcsApp.ts:452

destroy

destroy(): void
Destroys the app and all its collections, their content and ui managers.

Returns void
- Defined in src/vcsApp.ts:588

getModuleById

getModuleById(id): undefined | VcsModule
Parameters
- id: string
Returns undefined | VcsModule
- Defined in src/vcsApp.ts:368

removeModule

removeModule(moduleId): Promise<void>
Parameters
- moduleId: string
Returns Promise<void>
- Defined in src/vcsApp.ts:564

resetDynamicModule

resetDynamicModule(): void
resets the dynamic VcsModule to the "defaultDynamicModule"

Returns void
- Defined in src/vcsApp.ts:548

serializeModule

serializeModule(moduleId): VcsModuleConfig
Parameters
- moduleId: string
Returns VcsModuleConfig
- Defined in src/vcsApp.ts:504

setDynamicModule

setDynamicModule(module): void
sets the given module as the dynamic
Parameters
- module: VcsModule
Returns void
- Defined in src/vcsApp.ts:533

Properties

`Private` _categories

_categories: CategoryCollection

`Private` _categoryClassRegistry

_categoryClassRegistry: OverrideClassRegistry<typeof Category>

`Private` _categoryItemClassRegistry

_categoryItemClassRegistry: OverrideClassRegistry<Ctor<any>>

`Private` _defaultDynamicModule

_defaultDynamicModule: VcsModule

`Private` _destroyed

_destroyed: VcsEvent<void>

`Private` _displayQuality

_displayQuality: DisplayQuality

`Private` _dynamicModule

_dynamicModule: VcsModule

`Private` _dynamicModuleIdChanged

_dynamicModuleIdChanged: VcsEvent<string>

`Private` _featureProviderClassRegistry

_featureProviderClassRegistry: OverrideClassRegistry<typeof AbstractFeatureProvider>

`Private` _flights

_flights: OverrideCollection<FlightInstance, FlightCollection>

`Private` _hiddenObjects

_hiddenObjects: OverrideCollection<HiddenObject>

`Private` _id

_id: string

`Private` _layerClassRegistry

_layerClassRegistry: OverrideClassRegistry<typeof Layer>

`Private` _layers

_layers: OverrideCollection<Layer<LayerImplementation<VcsMap<VisualisationType>>>, LayerCollection>

`Private` _locale

_locale: string

represents the current Locale.

`Private` _localeChanged

_localeChanged: VcsEvent<string>

fires if the current Locale changes.

`Private` _mapClassRegistry

_mapClassRegistry: OverrideClassRegistry<typeof VcsMap>

`Private` _maps

_maps: OverrideCollection<VcsMap<VisualisationType>, MapCollection>

`Private` _moduleMutationChain

_moduleMutationChain: {
    items: {
        moduleId: string;
        mutation: (() => Promise<void>);
        reject: ((reason?) => void);
        resolve: (() => void);
    }[];
    running: boolean;
}

Type declaration

items: {
    moduleId: string;
    mutation: (() => Promise<void>);
    reject: ((reason?) => void);
    resolve: (() => void);
}[]
running: boolean

`Private` _modules

_modules: IndexedCollection<VcsModule>

`Private` _obliqueCollections

_obliqueCollections: OverrideCollection<ObliqueCollection>

`Private` _styleClassRegistry

_styleClassRegistry: OverrideClassRegistry<typeof StyleItem>

`Private` _styles

_styles: OverrideCollection<StyleItem>

`Private` _tileProviderClassRegistry

_tileProviderClassRegistry: OverrideClassRegistry<typeof TileProvider>

`Private` _viewpoints

_viewpoints: OverrideCollection<Viewpoint>

description

description: undefined | string

name

name: undefined | string

properties

properties: undefined | Record<string, unknown>

Class VcsApp

Hierarchy

Index

Accessors

Constructors

Methods

Properties

Accessors

categories

Returns CategoryCollection

categoryClassRegistry

Returns OverrideClassRegistry<typeof Category>

categoryItemClassRegistry

Returns OverrideClassRegistry<Ctor<any>>

destroyed

Returns VcsEvent<void>

displayQuality

Returns DisplayQuality

dynamicModuleId

Returns string

dynamicModuleIdChanged

Returns VcsEvent<string>

featureProviderClassRegistry

Returns OverrideClassRegistry<typeof AbstractFeatureProvider>

flights

Returns OverrideCollection<FlightInstance, FlightCollection>

hiddenObject

Returns OverrideCollection<HiddenObject>

id

Returns string

layerClassRegistry

Returns OverrideClassRegistry<typeof Layer>

layers

Returns OverrideCollection<Layer<LayerImplementation<VcsMap<VisualisationType>>>, LayerCollection>

locale

Returns string

Parameters

value: string

Returns void

localeChanged

Returns VcsEvent<string>

mapClassRegistry

Returns OverrideClassRegistry<typeof VcsMap>

maps

Returns OverrideCollection<VcsMap<VisualisationType>, MapCollection>

moduleAdded

Returns VcsEvent<VcsModule>

moduleRemoved

Returns VcsEvent<VcsModule>

modules

Returns VcsModule[]

obliqueCollections

Returns OverrideCollection<ObliqueCollection>

styleClassRegistry

Returns OverrideClassRegistry<typeof StyleItem>

styles

Returns OverrideCollection<StyleItem>

tileProviderClassRegistry

Returns OverrideClassRegistry<typeof TileProvider>

viewpoints

Returns OverrideCollection<Viewpoint>

Constructors

constructor

Parameters

options: VcsAppOptions = {}

Returns VcsApp

Methods

Protected _parseModule

Parameters

module: VcsModule

Returns Promise<void>

Protected _removeModule

Parameters

moduleId: string

Returns Promise<void>

Protected _setModuleState

Parameters

module: VcsModule

Returns Promise<void>

_startModuleMutationChain

`Protected` _parseModule

`Protected` _removeModule

`Protected` _setModuleState

`Private` _categories

`Private` _categoryClassRegistry

`Private` _categoryItemClassRegistry

`Private` _defaultDynamicModule

`Private` _destroyed

`Private` _displayQuality

`Private` _dynamicModule

`Private` _dynamicModuleIdChanged

`Private` _featureProviderClassRegistry

`Private` _flights

`Private` _hiddenObjects

`Private` _id

`Private` _layerClassRegistry

`Private` _layers

`Private` _locale

`Private` _localeChanged

`Private` _mapClassRegistry

`Private` _maps

`Private` _moduleMutationChain

items: {
moduleId: string;
mutation: (() => Promise<void>);
reject: ((reason?) => void);
resolve: (() => void);
}[]

`Private` _modules

`Private` _obliqueCollections

`Private` _styleClassRegistry

`Private` _styles

`Private` _tileProviderClassRegistry

`Private` _viewpoints