Class VcsMap<V>

active

• get active(): boolean

  Whether the map is active or not

  Returns boolean

layerCollection

• get layerCollection(): LayerCollection

  The layer collection of this map. LayerCollections can be shared among maps. When adding the map to a , the layer collection of the will be set. When setting the layer collection, the destroyLayerCollection flag is automatically set to false.

  Returns LayerCollection

• set layerCollection(layerCollection: LayerCollection): void

  Parameters

  • layerCollection: LayerCollection

  Returns void

layerTypes

• get layerTypes(): string[]

  Returns string[]

• set layerTypes(types: string[]): void

  The types of layers to display on this map. An empty array means all types.

  Parameters

  • types: string[]

  Returns void

loading

• get loading(): boolean

  Whether the map is loading or not

  Returns boolean

movementApiCallsDisabled

• get movementApiCallsDisabled(): boolean

  Whether api calls like gotoViewpoint & setting of oblique images are disabled

  Returns boolean

movementDisabled

• get movementDisabled(): boolean

  Returns boolean

  Deprecated

  use disableMovement() for setting and movementApiCallsDisabled, movementKeyEventsDisabled and movementPointerEventsDisabled getter

• set movementDisabled(prevent: boolean): void

  Parameters

  • prevent: boolean

  Returns void

movementKeyEventsDisabled

• get movementKeyEventsDisabled(): boolean

  Whether movement related key events like the arrow keys for navigating in map are disabled.

  Returns boolean

movementPointerEventsDisabled

• get movementPointerEventsDisabled(): boolean

  Whether movement related pointer events for navigating in map are disabled.

  Returns boolean

postRender

• get postRender(): VcsEvent<VcsMapRenderEvent<V>>

  An event raised on the maps post render

  Returns VcsEvent<VcsMapRenderEvent<V>>

splitPosition

• get splitPosition(): number

  Returns number

• set splitPosition(position: number): void

  The splitPosition should always be aligned with the mapCollection's splitPosition. Use mapCollection to change splitPosition.

  Parameters

  • position: number

  Returns void

target

• get target(): HTMLElement | null

  The currently set HTML element in which to render the map

  Returns HTMLElement | null

StaticclassName

• get className(): string

  Returns string

constructor

• new VcsMap<V extends VisualisationType = VisualisationType>(
      options: VcsMapOptions,
  ): VcsMap<V>

  Type Parameters

  • V extends VisualisationType = VisualisationType

  Parameters

  • options: VcsMapOptions

  Returns VcsMap<V>

activate

• activate(): Promise<void>

  activates the map, if necessary initializes the map. Once the promise resolves, the map can still be inactive, if deactivate was called while the map was activating.

  Returns Promise<void>

addVisualization

• addVisualization(item: V & { "[vectorClusterGroupName]"?: string }): void

  Adds a visualization to the visualizations map for its layer. The visualization must be valid, use validateVisualization first

  Parameters

  • item: V & { "[vectorClusterGroupName]"?: string }

  Returns void

canShowViewpoint

• canShowViewpoint(_viewpoint: Viewpoint): Promise<boolean>

  Determines whether this map can show this viewpoint. Returns true in any other map then ObliqueMap

  Parameters

  • _viewpoint: Viewpoint

  Returns Promise<boolean>

deactivate

• deactivate(): void

  deactivates the map

  Returns void

destroy

• destroy(): void

  disposes the map

  Returns void

disableMovement

• disableMovement(prevent: boolean | DisableMapControlOptions): void

  prevent all movement, including api calls (gotoViewpoint, setting oblique images), key and pointer events.

  Parameters

  • prevent: boolean | DisableMapControlOptions

  Returns void

getCurrentResolution

• getCurrentResolution(_coordinate: Coordinate): number

  Resolution in meters per pixe

  Parameters

  • _coordinate: Coordinate

    coordinate in mercator for which to determine resolution. only required in 3D

  Returns number

getViewpoint

• getViewpoint(): Promise<Viewpoint | null>

  Returns the most precise viewpoint possible in ObliqueMap.

  Returns Promise<Viewpoint | null>

getViewpointSync

• getViewpointSync(): Viewpoint | null

  Returns an approximate viewpoint in ObliqueMap, not requesting terrain.

  Returns Viewpoint | null

getVisualizations

• getVisualizations(): V[]

  Get all visualizations added to this map.

  Returns V[]

getVisualizationsForLayer

• getVisualizationsForLayer(layer: Layer): Set<V> | undefined

  Gets the visualizations for a specific layer

  Parameters

  • layer: Layer

  Returns Set<V> | undefined

getVisualizationsForVectorClusterGroup

• getVisualizationsForVectorClusterGroup(
      group: VectorClusterGroup,
  ): Set<V> | undefined

  Gets the visualizations of a vector cluster group

  Parameters

  • group: VectorClusterGroup

  Returns Set<V> | undefined

gotoViewpoint

• gotoViewpoint(_viewpoint: Viewpoint, _optMaximumHeight?: number): Promise<void>

  sets the view to the given viewpoint

  Parameters

  • _viewpoint: Viewpoint
  • Optional_optMaximumHeight: number

    during animation (can be used to get rid of the bunny hop) gotoViewpoint

  Returns Promise<void>

indexChanged

• indexChanged(_layer: Layer): void

  is called if a layer changes its position in the layerCollection.

  Parameters

  • _layer: Layer

  Returns void

initialize

• initialize(): Promise<void>

  Returns Promise<void>

pointIsVisible

• pointIsVisible(_coords: Coordinate): boolean

  Parameters

  • _coords: Coordinate

  Returns boolean

removeVisualization

• removeVisualization(item: V & { "[vectorClusterGroupName]"?: string }): void

  Removes a visualization

  Parameters

  • item: V & { "[vectorClusterGroupName]"?: string }

  Returns void

requestRender

• requestRender(): void

  Requests this map to render when possible

  Returns void

setTarget

• setTarget(target: string | HTMLElement | null): void

  Sets the map target.

  Parameters

  • target: string | HTMLElement | null

  Returns void

toJSON

• toJSON(defaultOptions?: VcsMapOptions): VcsMapOptions

  Parameters

  • defaultOptions: VcsMapOptions = ...

  Returns VcsMapOptions

validateVisualization

• validateVisualization(
      item: V,
  ): item is V & {
      "[vcsLayerName]"?: string;
      "[vectorClusterGroupName]"?: string;
  }

  Validates a visualization. A visualization must have the vcsLayeName symbol set and a layer with said name must be part of the maps layerCollection.

  Parameters

  • item: V

  Returns item is V & { "[vcsLayerName]"?: string; "[vectorClusterGroupName]"?: string }

StaticgetDefaultOptions

• getDefaultOptions(): VcsMapOptions

  Returns VcsMapOptions

destroyLayerCollection

fallbackMap

fallbackToCurrentMap

initialized

ReadonlylayerTypesChanged

mapElement

movementDisabledChanged

pointerInteractionEvent

stateChanged

visualizationAdded

visualizationRemoved