Class BaseOLMap

Hierarchy

Accessors

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

    Returns boolean

  • get className(): string
  • Returns string

  • 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): void
  • Parameters

    Returns void

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

    Returns boolean

  • get splitPosition(): number
  • Returns number

  • 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

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

    Returns null | HTMLElement

Constructors

Methods

  • 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>

  • Parameters

    • olLayer: Layer<Source, LayerRenderer<any>>

    Returns 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>>

    Returns void

  • prevent all movement, including navigation controls, gotoViewpoint & setting of oblique images

    Parameters

    • prevent: boolean

    Returns void

  • Resolution in meters per pixe

    Parameters

    • _coordinate: Coordinate

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

    Returns number

  • 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>

  • Internal API for deregistering representations.

    Parameters

    • olLayer: Layer<Source, LayerRenderer<any>>

    Returns void

  • 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;
    }

Properties

[moduleIdSymbol]?: string
_olListeners: EventsKey[] = []
_olMap: null | Map = null
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: null | string

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

initialized: boolean
isDestroyed: boolean
mapElement: HTMLElement
movementDisabled: boolean

if true, no movements should occur

name: string

unique Name

pointerInteractionEvent: VcsEvent<MapEvent>

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

properties: Record<string, unknown>
stateChanged: VcsEvent<MapState>

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

Generated using TypeDoc