Class ObliqueMap

Hierarchy (view full)

Accessors

active className collection currentImage imageChanged layerCollection loading mapChangeEvent movementApiCallsDisabled movementDisabled movementKeyEventsDisabled movementPointerEventsDisabled olMap postRender splitPosition switchEnabled switchThreshold target className

Constructors

constructor

Methods

activate addOLLayer addVisualization canShowViewpoint deactivate destroy disableMovement getCurrentResolution getExtentOfCurrentImage getLogger getViewpoint getViewpointSync getVisualizations getVisualizationsForLayer getVisualizationsForVectorClusterGroup gotoViewpoint indexChanged initialize pointIsVisible removeOLLayer removeVisualization requestRender setCollection setImageByName setTarget toJSON validateVisualization getDefaultOptions

Properties

[moduleIdSymbol]? collectionChanged destroyLayerCollection failedToSetCollection fallbackMap fallbackToCurrentMap initialized initializedPromise isDestroyed maintainViewpointOnCollectionChange mapElement movementDisabledChanged name pointerInteractionEvent properties stateChanged

Accessors

active

  • get active(): boolean

  • Whether the map is active or not

    Returns boolean

className

  • get className(): string

  • Returns string

collection

currentImage

imageChanged

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

  • Parameters

    Returns void

loading

  • get loading(): boolean

  • Whether the map is loading or not

    Returns boolean

mapChangeEvent

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

olMap

postRender

splitPosition

  • get splitPosition(): number

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

    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

switchEnabled

  • get switchEnabled(): boolean

  • Whether the post render handler should switch on image edge. Setting this to false will suspend all post render handler switches.

    Returns boolean

  • set switchEnabled(switchEnabled): void

  • Parameters

    • switchEnabled: boolean

    Returns void

switchThreshold

  • get switchThreshold(): number

  • Threshold from 0 to 1 to define when to start switching to other images. Where 0 indicates to only switch, when the view center is outside of the image and 1 to always switch. 0.2 would start switching if the view center is within the outer 20% of the image.

    Returns number

  • set switchThreshold(threshold): void

  • Parameters

    • threshold: number

    Returns void

target

  • get target(): null | HTMLElement

  • The currently set HTML element in which to render the map

    Returns null | HTMLElement

StaticclassName

Constructors

constructor

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>

addOLLayer

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

canShowViewpoint

deactivate

destroy

disableMovement

  • disableMovement(prevent): void

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

    Parameters

    • prevent: boolean | DisableMapControlOptions

    Returns void

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

getExtentOfCurrentImage

getLogger

getViewpoint

getViewpointSync

getVisualizations

getVisualizationsForLayer

getVisualizationsForVectorClusterGroup

gotoViewpoint

indexChanged

initialize

pointIsVisible

removeOLLayer

removeVisualization

requestRender

setCollection

setImageByName

  • setImageByName(imageName, optCenter?): Promise<void>

  • Sets an image by its name on the map

    Parameters

    • imageName: string
    • OptionaloptCenter: Coordinate

    Returns Promise<void>

setTarget

toJSON

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

StaticgetDefaultOptions

Properties

Optional[moduleIdSymbol]

[moduleIdSymbol]?: string

collectionChanged

collectionChanged: VcsEvent<ObliqueCollection>

An event raise, when the collection changes. Is passed the collection as its only argument.

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.

failedToSetCollection

failedToSetCollection: VcsEvent<ObliqueCollection> = ...

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

initializedPromise

initializedPromise: null | Promise<void> = null

isDestroyed

isDestroyed: boolean

maintainViewpointOnCollectionChange

maintainViewpointOnCollectionChange: boolean

mapElement

mapElement: HTMLElement

movementDisabledChanged

movementDisabledChanged: VcsEvent<DisableMapControlOptions>

Readonlyname

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.

Settings

Member Visibility

On This Page

Accessors
Constructors
Methods
Properties