Class VcsApp

categories

• get categories(): CategoryCollection

• Returns CategoryCollection

categoryClassRegistry

• get categoryClassRegistry(): OverrideClassRegistry<typeof Category>

• Returns OverrideClassRegistry<typeof Category>

categoryItemClassRegistry

• get categoryItemClassRegistry(): OverrideClassRegistry<AbstractCtor>

• Returns OverrideClassRegistry<AbstractCtor>

destroyed

• get destroyed(): VcsEvent<void>

• Returns VcsEvent<void>

displayQuality

• get displayQuality(): DisplayQuality

• Returns DisplayQuality

dynamicModuleId

• get dynamicModuleId(): string

• Returns string

dynamicModuleIdChanged

• get dynamicModuleIdChanged(): VcsEvent<string>

• Returns VcsEvent<string>

featureProviderClassRegistry

• get featureProviderClassRegistry(): OverrideClassRegistry<typeof AbstractFeatureProvider>

• Returns OverrideClassRegistry<typeof AbstractFeatureProvider>

flights

• get flights(): OverrideCollection<FlightInstance, FlightCollection>

• Returns OverrideCollection<FlightInstance, FlightCollection>

hiddenObject

• get hiddenObject(): OverrideCollection<HiddenObject>

• Returns OverrideCollection<HiddenObject>

id

• get id(): string

• Returns string

layerClassRegistry

• get layerClassRegistry(): OverrideClassRegistry<typeof Layer>

• Returns OverrideClassRegistry<typeof Layer>

layers

• get layers(): OverrideCollection<Layer<LayerImplementation<VcsMap<VisualisationType>>>, LayerCollection>

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

locale

• get locale(): string

• Returns string

• 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

localeChanged

• get localeChanged(): VcsEvent<string>

• Returns VcsEvent<string>

mapClassRegistry

• get mapClassRegistry(): OverrideClassRegistry<typeof VcsMap>

• Returns OverrideClassRegistry<typeof VcsMap>

maps

• get maps(): OverrideCollection<VcsMap<VisualisationType>, MapCollection>

• Returns OverrideCollection<VcsMap<VisualisationType>, MapCollection>

moduleAdded

• get moduleAdded(): VcsEvent<VcsModule>

• Returns VcsEvent<VcsModule>

moduleRemoved

• get moduleRemoved(): VcsEvent<VcsModule>

• Returns VcsEvent<VcsModule>

modules

• get modules(): VcsModule[]

• Returns VcsModule[]

obliqueCollections

• get obliqueCollections(): OverrideCollection<ObliqueCollection>

• Returns OverrideCollection<ObliqueCollection>

styleClassRegistry

• get styleClassRegistry(): OverrideClassRegistry<typeof StyleItem>

• Returns OverrideClassRegistry<typeof StyleItem>

styles

• get styles(): OverrideCollection<StyleItem>

• Returns OverrideCollection<StyleItem>

tileProviderClassRegistry

• get tileProviderClassRegistry(): OverrideClassRegistry<typeof TileProvider>

• Returns OverrideClassRegistry<typeof TileProvider>

viewpoints

• get viewpoints(): OverrideCollection<Viewpoint>

• Returns OverrideCollection<Viewpoint>

constructor

• new VcsApp(options?): VcsApp

• Parameters

  • options: VcsAppOptions = {}

  Returns VcsApp

_startModuleMutationChain

• _startModuleMutationChain(): void

• Returns void

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>

destroy

• destroy(): void

• Destroys the app and all its collections, their content and ui managers.

  Returns void

getModuleById

• getModuleById(id): undefined | VcsModule

• Parameters

  • id: string

  Returns undefined | VcsModule

removeModule

• removeModule(moduleId): Promise<void>

• Parameters

  • moduleId: string

  Returns Promise<void>

resetDynamicModule

• resetDynamicModule(): void

• resets the dynamic VcsModule to the "defaultDynamicModule"

  Returns void

serializeModule

• serializeModule(moduleId): VcsModuleConfig

• Parameters

  • moduleId: string

  Returns VcsModuleConfig

setDynamicModule

• setDynamicModule(module): void

• sets the given module as the dynamic

  Parameters

  • module: VcsModule

  Returns void

description

name

properties