@vcmap/core
    Preparing search index...

    Class BaseOLMap

    Hierarchy (View Summary)

    Index

    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: LayerCollection): void

      Parameters

      Returns void

    • 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

    • get loading(): boolean

      Whether the map is loading or not

      Returns boolean

    • get movementApiCallsDisabled(): boolean

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

      Returns boolean

    • get movementDisabled(): boolean

      Returns boolean

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

    • set movementDisabled(prevent: boolean): void

      Parameters

      • prevent: boolean

      Returns void

    • get movementKeyEventsDisabled(): boolean

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

      Returns boolean

    • get movementPointerEventsDisabled(): boolean

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

      Returns boolean

    • get splitPosition(): number

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

      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

    • get target(): HTMLElement | null

      The currently set HTML element in which to render the map

      Returns HTMLElement | null

    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>

    • Internal API for registering representations.

      Parameters

      • olLayer: OLLayerLike

      Returns void

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

      Parameters

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

      Returns void

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

      Parameters

      • prevent: boolean | DisableMapControlOptions

      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: OLLayerLike

      Returns void

    • Removes a visualization

      Parameters

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

      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: OLLayerLike

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

    Properties

    "[moduleIdSymbol]"?: string
    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: string | null

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

    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: boolean
    isDestroyed: boolean
    layerTypesChanged: VcsEvent<string[]> = ...
    mapElement: HTMLElement
    movementDisabledChanged: VcsEvent<DisableMapControlOptions>
    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.

    visualizationAdded: VcsEvent<VisualisationType>

    Event raised when a visualization is added to the map

    visualizationRemoved: VcsEvent<VisualisationType>

    Event raised when a visualization is removed from the map