geoview-core - v2.2.0
    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).

    Index

    Constructors

    Properties

    activeBasemap?: TypeBasemapProps

    The active basemap

    basemapOptions: TypeBasemapOptions

    The basemap options passed from the map config

    basemapsList: BasemapCreationList = ...

    The basemap creation configuration list

    created: boolean = false

    Indicates if the basemap has been created successfully

    defaultExtent?: Extent

    The default extent

    defaultOrigin?: number[]

    The default origin

    defaultResolutions?: number[]

    The default resolutions

    overviewMap?: TypeBasemapProps

    The overview map basemap

    overviewMapCtrl?: OverviewMap

    The overview map control

    DEFAULT_WAIT_PERIOD_BASEMAP_WARNING: number = ...

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

    Methods

    • Creates the core basemap and adds the layers to it.

      Parameters

      • basemapOptions: TypeBasemapOptions

        The basemap options

      • Optionalprojection: TypeValidMapProjectionCodes

        Optional projection code

      • Optionallanguage: TypeDisplayLanguage

        Optional display language

      Returns Promise<TypeBasemapProps>

      A promise that resolves with the core basemap

      When no basemap layers are created and the basemap is not 'nogeom'

    • Gets or creates the overview map control.

      Parameters

      • olMap: Map

        The OpenLayers map instance

      • toggleButton: HTMLDivElement

        The toggle button element for the overview map

      Returns OverviewMap

      The overview map control

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

      Parameters

      • Optionalprojection: TypeValidMapProjectionCodes

        Optional projection code

      • Optionallanguage: TypeDisplayLanguage

        Optional display 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

    • Sets the visibility of the overview map control.

      Parameters

      • olMap: Map

        The OpenLayers map instance

      • visible: boolean

        Whether the overview map control should be visible

      Returns void