Class BaseOLMap

Hierarchy (view full)

VcsMap<OLLayer>
- BaseOLMap
  - ObliqueMap
  - OpenlayersMap

Accessors

active

get active(): boolean
Whether the map is active or not

Returns boolean
Inherited from VcsMap.active
- Defined in src/map/vcsMap.ts:181

className

get className(): string
Returns string
Inherited from VcsMap.className
- Defined in src/vcsObject.ts:45

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
Inherited from VcsMap.layerCollection
- Defined in src/map/vcsMap.ts:242
set layerCollection(layerCollection): void
Parameters
- layerCollection: LayerCollection
Returns void
Inherited from VcsMap.layerCollection
- Defined in src/map/vcsMap.ts:249

loading

get loading(): boolean
Whether the map is loading or not

Returns boolean
Inherited from VcsMap.loading
- Defined in src/map/vcsMap.ts:188

movementApiCallsDisabled

get movementApiCallsDisabled(): boolean
Whether api calls like gotoViewpoint & setting of oblique images are disabled

Returns boolean
Inherited from VcsMap.movementApiCallsDisabled
- Defined in src/map/vcsMap.ts:223

movementDisabled

get movementDisabled(): boolean
Returns boolean
Deprecated
use disableMovement() for setting and movementApiCallsDisabled, movementKeyEventsDisabled and movementPointerEventsDisabled getter
Inherited from VcsMap.movementDisabled
- Defined in src/map/vcsMap.ts:210
set movementDisabled(prevent): void
Parameters
- prevent: boolean
Returns void
Inherited from VcsMap.movementDisabled
- Defined in src/map/vcsMap.ts:199

movementKeyEventsDisabled

get movementKeyEventsDisabled(): boolean
Whether movement related key events like the arrow keys for navigating in map are disabled.

Returns boolean
Inherited from VcsMap.movementKeyEventsDisabled
- Defined in src/map/vcsMap.ts:228

movementPointerEventsDisabled

get movementPointerEventsDisabled(): boolean
Whether movement related pointer events for navigating in map are disabled.

Returns boolean
Inherited from VcsMap.movementPointerEventsDisabled
- Defined in src/map/vcsMap.ts:233

olMap

get olMap(): null | Map
Returns null | Map
- Defined in src/map/baseOLMap.ts:74

postRender

get postRender(): VcsEvent<VcsMapRenderEvent<V>>
An event raised on the maps post render

Returns VcsEvent<VcsMapRenderEvent<V>>
Inherited from VcsMap.postRender
- Defined in src/map/vcsMap.ts:299

splitPosition

get splitPosition(): number
The splitPosition should always be aligned with the mapCollection's splitPosition. Use mapCollection to change splitPosition.

Returns number
Overrides VcsMap.splitPosition
- Defined in src/map/baseOLMap.ts:65
set splitPosition(position): void
The splitPosition should always be aligned with the mapCollection's splitPosition. Use mapCollection to change splitPosition.
Parameters
- position: number
Returns void
Overrides VcsMap.splitPosition
- Defined in src/map/baseOLMap.ts:69

target

get target(): null | HTMLElement
The currently set HTML element in which to render the map

Returns null | HTMLElement
Inherited from VcsMap.target
- Defined in src/map/vcsMap.ts:195

`Static`className

get className(): string
Returns string
Overrides VcsMap.className
- Defined in src/map/baseOLMap.ts:57

Constructors

constructor

new BaseOLMap(options): BaseOLMap
Parameters
- options: VcsMapOptions
Returns BaseOLMap
Inherited from VcsMap.constructor
- Defined in src/map/vcsMap.ts:137

Methods

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>
Overrides VcsMap.activate
- Defined in src/map/baseOLMap.ts:172

addOLLayer

addOLLayer(olLayer): void
Parameters
- olLayer: Layer<Source, LayerRenderer<any>>
Returns void
- Defined in src/map/baseOLMap.ts:194

addVisualization

addVisualization(item): void
Adds a visualization to the visualizations map for its layer. The visualization must be valid, use validateVisualization first
Parameters
- item: Layer<Source, LayerRenderer<any>> & {
  [vectorClusterGroupName]?: string;
  }
Returns void
Inherited from VcsMap.addVisualization
- Defined in src/map/vcsMap.ts:395

canShowViewpoint

canShowViewpoint(_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>
Inherited from VcsMap.canShowViewpoint
- Defined in src/map/vcsMap.ts:337

deactivate

deactivate(): void
deactivates the map

Returns void
Inherited from VcsMap.deactivate
- Defined in src/map/vcsMap.ts:498

destroy

destroy(): void
disposes the map

Returns void
Overrides VcsMap.destroy
- Defined in src/map/baseOLMap.ts:239

disableMovement

disableMovement(prevent): void
prevent all movement, including api calls (gotoViewpoint, setting oblique images), key and pointer events.
Parameters
- prevent: boolean | DisableMapControlOptions
Returns void
Overrides VcsMap.disableMovement
- Defined in src/map/baseOLMap.ts:215

getCurrentResolution

getCurrentResolution(_coordinate): number
Resolution in meters per pixe
Parameters
- _coordinate: Coordinate
  coordinate in mercator for which to determine resolution. only required in 3D
Returns number
Overrides VcsMap.getCurrentResolution
- Defined in src/map/baseOLMap.ts:225

getLogger

getLogger(): Logger
Returns Logger
Inherited from VcsMap.getLogger
- Defined in src/vcsObject.ts:49

getViewpoint

getViewpoint(): Promise<null | Viewpoint>
Returns the most precise viewpoint possible in ObliqueMap.

Returns Promise<null | Viewpoint>
Inherited from VcsMap.getViewpoint
- Defined in src/map/vcsMap.ts:549

getViewpointSync

getViewpointSync(): null | Viewpoint
Returns an approximate viewpoint in ObliqueMap, not requesting terrain.

Returns null | Viewpoint
Inherited from VcsMap.getViewpointSync
- Defined in src/map/vcsMap.ts:557

getVisualizations

getVisualizations(): Layer<Source, LayerRenderer<any>>[]
Get all visualizations added to this map.

Returns Layer<Source, LayerRenderer<any>>[]
Inherited from VcsMap.getVisualizations
- Defined in src/map/vcsMap.ts:459

getVisualizationsForLayer

getVisualizationsForLayer(layer): undefined | Set<Layer<Source, LayerRenderer<any>>>
Gets the visualizations for a specific layer
Parameters
- layer: Layer<LayerImplementation<VcsMap<VisualisationType>>>
Returns undefined | Set<Layer<Source, LayerRenderer<any>>>
Inherited from VcsMap.getVisualizationsForLayer
- Defined in src/map/vcsMap.ts:443

getVisualizationsForVectorClusterGroup

getVisualizationsForVectorClusterGroup(group): undefined | Set<Layer<Source, LayerRenderer<any>>>
Gets the visualizations of a vector cluster group
Parameters
- group: VectorClusterGroup
Returns undefined | Set<Layer<Source, LayerRenderer<any>>>
Inherited from VcsMap.getVisualizationsForVectorClusterGroup
- Defined in src/map/vcsMap.ts:450

gotoViewpoint

gotoViewpoint(_viewpoint, _optMaximumHeight?): 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>
Inherited from VcsMap.gotoViewpoint
- Defined in src/map/vcsMap.ts:538

indexChanged

indexChanged(layer): void
is called if a layer changes its position in the layerCollection.
Parameters
- layer: Layer<LayerImplementation<VcsMap<VisualisationType>>>
Returns void
Overrides VcsMap.indexChanged
- Defined in src/map/baseOLMap.ts:179

initialize

initialize(): Promise<void>
Returns Promise<void>
Overrides VcsMap.initialize
- Defined in src/map/baseOLMap.ts:116

pointIsVisible

pointIsVisible(_coords): boolean
Parameters
- _coords: Coordinate
Returns boolean
Inherited from VcsMap.pointIsVisible
- Defined in src/map/vcsMap.ts:571

removeOLLayer

removeOLLayer(olLayer): void
Internal API for deregistering representations.
Parameters
- olLayer: Layer<Source, LayerRenderer<any>>
Returns void
- Defined in src/map/baseOLMap.ts:208

removeVisualization

removeVisualization(item): void
Removes a visualization
Parameters
- item: Layer<Source, LayerRenderer<any>> & {
  [vectorClusterGroupName]?: string;
  }
Returns void
Inherited from VcsMap.removeVisualization
- Defined in src/map/vcsMap.ts:420

requestRender

requestRender(): void
Requests this map to render when possible

Returns void
Overrides VcsMap.requestRender
- Defined in src/map/baseOLMap.ts:233

setTarget

setTarget(target): void
Sets the map target.
Parameters
- target: null | string | HTMLElement
Returns void
Overrides VcsMap.setTarget
- Defined in src/map/baseOLMap.ts:109

toJSON

toJSON(): VcsMapOptions
Returns VcsMapOptions
Inherited from VcsMap.toJSON
- Defined in src/map/vcsMap.ts:581

validateVisualization

validateVisualization(item): item is Layer<Source, LayerRenderer<any>> & {
[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: Layer<Source, LayerRenderer<any>>
Returns item is Layer<Source, LayerRenderer<any>> & {
[vcsLayerName]?: string;
[vectorClusterGroupName]?: string;
}
Inherited from VcsMap.validateVisualization
- Defined in src/map/vcsMap.ts:373

`Static`getDefaultOptions

getDefaultOptions(): VcsMapOptions
Returns VcsMapOptions
Inherited from VcsMap.getDefaultOptions
- Defined in src/map/vcsMap.ts:65

Properties

`Optional`[moduleIdSymbol]

[moduleIdSymbol]?: string

destroyLayerCollection

destroyLayerCollection: boolean

Whether to destroy the layerCollection when destroying the map. Defaults to false if passing in a LayerCollection and true if a LayerCollection is created. Is set to false, when setting a different LayerCollection.

fallbackMap

fallbackMap: null | string

The name of a map to fall back on, if this map cant show a viewpoint

fallbackToCurrentMap

fallbackToCurrentMap: boolean

instead of using a fallback map, this map will fail to activate if another map is active and the current viewpoint cannot be shown

initialized

initialized: boolean

isDestroyed

isDestroyed: boolean

mapElement

mapElement: HTMLElement

movementDisabledChanged

movementDisabledChanged: VcsEvent<DisableMapControlOptions>

`Readonly`name

name: string

unique Name

pointerInteractionEvent

pointerInteractionEvent: VcsEvent<MapEvent>

Event raised then the map has a pointer interaction. Raises MapEvent.

properties

properties: Record<string, unknown>

stateChanged

stateChanged: VcsEvent<MapState>

Event raised when the maps state changes. Is passed the MapState as its only argument.

Class BaseOLMap

Hierarchy (view full)

Index

Accessors

Constructors

Methods

Properties

Accessors

active

Returns boolean

className

Returns string

layerCollection

Returns LayerCollection

Parameters

Returns void

loading

Returns boolean

movementApiCallsDisabled

Returns boolean

movementDisabled

Returns boolean

Deprecated

Parameters

Returns void

movementKeyEventsDisabled

Returns boolean

movementPointerEventsDisabled

Returns boolean

olMap

Returns null | Map

postRender

Returns VcsEvent<VcsMapRenderEvent<V>>

splitPosition

Returns number

Parameters

Returns void

target

Returns null | HTMLElement

StaticclassName

Returns string

Constructors

constructor

Parameters

Returns BaseOLMap

Methods

activate

Returns Promise<void>

addOLLayer

Parameters

Returns void

addVisualization

Parameters

Returns void

canShowViewpoint

Parameters

Returns Promise<boolean>

deactivate

Returns void

destroy

Returns void

disableMovement

Parameters

Returns void

getCurrentResolution

Parameters

Returns number

getLogger

Returns Logger

getViewpoint

Returns Promise<null | Viewpoint>

getViewpointSync

Returns null | Viewpoint

getVisualizations

Returns Layer<Source, LayerRenderer<any>>[]

getVisualizationsForLayer

Parameters

Returns undefined | Set<Layer<Source, LayerRenderer<any>>>

getVisualizationsForVectorClusterGroup

Parameters

`Static`className

Returns item is Layer<Source, LayerRenderer<any>> & {
[vcsLayerName]?: string;
[vectorClusterGroupName]?: string;
}

`Static`getDefaultOptions

`Optional`[moduleIdSymbol]

`Readonly`name