Module Basemap

Apply the basemap on the map.

throws

Error if basemap not found for the given id

example

// Activate the basemap "streets"
JMap.Map.Basemap.activateById("streets")

// Deactivate current basemap
JMap.Map.Basemap.deactivate()

Add a new basemap on the map.

You can find tile servers here : https://wiki.openstreetmap.org/wiki/Tile_servers

throws

if invalid parameters

example

// add an osm basemap
JMap.Map.Basemap.add({
  id: "osm",
  label: "Open Street Map",
  tileUrls: [
    "https://a.tile.openstreetmap.org/{z}/{x}/{y}.png",
    "https://b.tile.openstreetmap.org/{z}/{x}/{y}.png",
    "https://c.tile.openstreetmap.org/{z}/{x}/{y}.png"
  ],
  previewImageAsUrlOrBase64: "https://searchengineland.com/figz/wp-content/seloads/2013/11/Screen-Shot-2013-11-22-at-3.41.27-PM.png"
 }, true) // true = activate the new basemap

// Add a quadkey (not x/y/z) basemap
JMap.Map.Basemap.add(
 {
   id: "My custom map",
   label: "My map",
   tileUrls: [
     "https://t.ssl.ak.dynamic.tiles.virtualearth.net/comp/ch/{quadkey}?mkt=fr-CA&it=G,LC,BX,RL&shading=hill&n=z&og=1226&cstl=vb&src=o"
   ],
   previewImageAsUrlOrBase64: "http://www.toxel.com/wp-content/uploads/2008/08/creativelogos11.jpg"
 }, true) // true = activate the new basemap

Deactivate the current active basemap on the map.

Do nothing if no map is active.

example

// Deactivate current basemap
JMap.Map.Basemap.deactivate()

Returs true if basemap exist for the given id.

example

// returns true if "streets" basemap exist
JMap.Map.Basemap.existsById("streets")

Returns the active basemap id, undefined is no basemap is activated.

example

// returns the active basemap id, undefined is no basemap is activated
JMap.Map.Basemap.getActiveId()

Returns the available basemap ids that can be used with method activateById.

Mapbox values are : "mapbox-light", "mapbox-streets", "mapbox-satellite", "mapbox-satellite-streets", "mapbox-dark", or "mapbox-outdoors"

OSM value is : "osm-standard"

example

// returns an array of string containing all available basemap ids
JMap.Map.Basemap.getAllIds()

Returs the basemap descriptor for the given id.

throws

Error if basemap not found for the given id

example

// returns the "streets" basemap
JMap.Map.Basemap.getById("streets")

Returns true if a basemap is active on the map.

example

JMap.Map.Basemap.activateById("streets")

// returns true
JMap.Map.Basemap.isActive()

JMap.Map.Basemap.deactivate()

// returns false
JMap.Map.Basemap.isActive()

Returns true if basemaps are disabled.

Can be disabled with option disableBasemaps JCoreOptions in JS options, or with url param "ngDisableBasemaps=true".

example

JMap.Map.Basemap.isDisabled()

Returns true if the basemap id is a mapbox basemap.

example

// returns true
JMap.Map.Basemap.isMapboxId("mapbox-streets")

// returns false
JMap.Map.Basemap.isMapboxId("my-custom-basemap")

Returns true if the basemap id is an Open Street Map basemap.

example

// returns true
JMap.Map.Basemap.isOSMId("osm-standard")

// returns false
JMap.Map.Basemap.isOSMId("mapbox-streets")

Remove a basemap for a given id.

If id doesn't exist do nothing.

If the active basemap is removed, no basemap will be displayed anymore.

throws

if missing basemap parameter

example

// Remove the "streets" basemap
JMap.Map.Basemap.removeById("streets")

Remove basemaps for the given ids.

If an id doesn't exist it is ignored.

If the active basemap is removed, no basemap will be displayed anymore.

example

// Remove two basemaps
JMap.Map.Basemap.removeByIds([ "streets", "lights" ])