geoview-core
    Preparing search index...

    Class BasemapApi

    A class to get a Basemap for a define projection and language. For the moment, a list maps are available and can be filtered by projection (currently only WM and LCC projections are listed, in case other projections needed, they need to be added to the list)

    Basemap

    Index

    Constructors

    • Initialize basemap api

      Parameters

      • mapViewer: MapViewer

        The map viewer.

      • basemapOptions: TypeBasemapOptions

        Optional basemap option properties, passed in from map config.

      Returns BasemapApi

    Properties

    activeBasemap?: TypeBasemapProps
    basemapOptions: TypeBasemapOptions
    basemapsList: BasemapCreationList = ...

    Basemap list

    created: boolean = false

    Indicates if the basemap has been created successfully

    defaultExtent?: Extent
    defaultOrigin?: number[]
    defaultResolutions?: number[]
    mapViewer: MapViewer
    overviewMap?: TypeBasemapProps
    overviewMapCtrl?: OverviewMap
    DEFAULT_WAIT_PERIOD_BASEMAP_WARNING: number = ...

    The maximum delay to wait before we warn about the basemap taking a long time

    Methods

    • Clears the basemap layers from the map.

      Returns void

    • Create the core basemap and add the layers to it.

      Parameters

      • basemapOptions: TypeBasemapOptions

        Basemap options.

      • Optionalprojection: TypeValidMapProjectionCodes

        Optional projection code.

      • Optionallanguage: TypeDisplayLanguage

        Optional language.

      Returns Promise<TypeBasemapProps>

      The core basemap.

    • Returns BaseLayer[]

    • Parameters

      • olMap: Map
      • toggleButton: HTMLDivElement

      Returns OverviewMap

    • Load the default basemap that was passed in the map config.

      Parameters

      • Optionalprojection: TypeValidMapProjectionCodes

        Optional projection code.

      • Optionallanguage: TypeDisplayLanguage

        Optional language.

      Returns Promise<void>

    • Unregisters a basemap changed event callback.

      Parameters

      • callback: BasemapChangedDelegate

        The callback to stop being called whenever the event is emitted

      Returns void

    • Unregisters a basemap error event callback.

      Parameters

      • callback: BasemapErrorDelegate

        The callback to stop being called whenever the event is emitted

      Returns void

    • Registers a basemap changed event callback.

      Parameters

      • callback: BasemapChangedDelegate

        The callback to be executed whenever the event is emitted

      Returns void

    • Registers a basemap error event callback.

      Parameters

      • callback: BasemapErrorDelegate

        The callback to be executed whenever the event is emitted

      Returns void

    • Refreshes the basemap layers

      Returns void

    • Set the current basemap and update the basemap layers on the map.

      Parameters

      Returns void

    • Returns Promise<void>

    • Parameters

      • olMap: Map
      • visible: boolean

      Returns void