Karteis Mapviewer

Class: BackgroundLayer

backgroundLayer~ BackgroundLayer

Service gérant les couches de fonds de plan

new BackgroundLayer()

Source:

Members

clipInteraction

interraction clip (masque)

.

interraction clip (masque)

Source:

commonLayer

Fonction commonLayer

.

Fonction commonLayer

Source:

ctx :module:core~default

instance du viewer

.

instance du viewer

Type:
  • module:core~default
Source:

ctx :Mapviewer

instance du viewer

.

instance du viewer

Type:
Source:

viewer :Mapviewer

instance du viewer

.

instance du viewer

Type:
Source:

Methods

addArcGis(options, options, resolve)

Créé un layer avec une source ArcGIS

.

Créé un layer avec une source ArcGIS

Parameters:
Name Type Description
options string

Id du layer
options Object

Tile ArcGIS Rest options

Properties
Name Type Argument Default Description
url string | undefined

Url du service ArcGIS MapServer

  • exemple : 'http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StateCityHighway_USA/MapServer'
urls array.<string> | undefined

Urls du service ArcGIS Rest. A utiliser à la place de url si le service support les urls multiples pour les requêtes d'export
useLegacy boolean | undefined

Force l'utilisation de TileArcGISRest (si le calque n'est pas compatible tuiles)
attributions array.<Attribution>

Attributions
crossOrigin null | string | undefined

L'attribut crossOrigin pour charger les images
params Object.<string, *> | undefined

Paramètres ArcGIS pouvant être utilisés mais non spécifiés

  • Exemple : params= {token:'12345'}
  • Exemple : params= {token: {type:'localStorage','path':'KARTEIS_ARCGIS_TOKEN'}} // recherche le token dans le localStorage[KARTEIS_ARCGIS_TOKEN]
tileGrid TileGrid | undefined

Grille de tuilles
projection ol.proj.ProjectionLike

Projection
tileLoadFunction ol.TileLoadFunctionType | undefined

Fonction optionnelle pour charger une tuille d'une Url donnée
wrapX boolean | undefined

Sépare le monde horizontalement. Par défaut "true"
forceCanvas Boolean <optional>
<nullable>
 false

force l'utilisation du moteur canvas plutot que webgl pour le rendu des tuiles
resolve function

Résolution de promesse a executer
Source:

addAzureMap(idLayer, options)

Créer un layer avec comme source Azure Map

.

Créer un layer avec comme source Azure Map

Parameters:
Name Type Description
idLayer string

Id du layer
options Object

Options pour Azure Map

Properties
Name Type Argument Default Description
language string <nullable>

Code de la culture. Par defaut, "fr-FR" Microsoft liste des language
apiKey string

subscriptionKey de Azure Maps Microsoft créer compte
tilesetId string <optional>
<nullable>
 microsoft.imagery

Type de l'imagerie a afficher Microsoft liste des tileset
apiVersion string <optional>
<nullable>
 2.0

Version de l'api azure
forceCanvas Boolean <optional>
<nullable>
 false

force l'utilisation du moteur canvas plutot que webgl pour le rendu des tuiles
Source:

addBackgroundLayer(idLayer, type, options)

Ajoute un fond de plan a la carte

.

Ajoute un fond de plan a la carte

Parameters:
Name Type Description
idLayer string

Id du layer
type 'osm' | 'bingmaps' | 'arcgis' | 'stamen' | 'stadiaMaps' | 'mapquest' | 'here' | 'mapguidetiled' | 'mapguideuntiled' | 'wmstiled' | 'wmsuntiled' | 'layerXYZ' | 'wmts' | 'vectorTile' | 'ign' | 'kml' | 'vector'

Type du fond de plan
options Object

Options pour la création du layer (voir les options des différents type de calque dans l'api)

Properties
Name Type Description
sdcardId string

Si cette option est set, vérifi qu'on a une sdcard via cordova et basculer sur un layer XYZ utilisant la sdcard
Source:

addBingMaps(idLayer, options)

Créer un layer avec comme source Bing Maps

.

Créer un layer avec comme source Bing Maps

Parameters:
Name Type Description
idLayer string

Id du layer
options Object

Options pour Bing Maps

Properties
Name Type Argument Default Description
culture string | undefined

Code de la culture. Par defaut, "en-us"
key string

API Key de Bing Maps
imagerySet string

Type de l'imagerie
maxZoom number | undefined

Niveau de zoom max. Par défaut niveau annocé par le service BingMaps (21)
wrapX boolean | undefined

Séparer le monde horizontalement. Par défaut true
forceCanvas Boolean <optional>
<nullable>
 false

force l'utilisation du moteur canvas plutot que webgl pour le rendu des tuiles
Source:

addHere( [idLayer], options)

Créé un layer avec une source Here documentation officielle : @link https://developer.here.com/documentation/raster-tile-api/api-reference.html Attention erreur HTTP 429 fréquente si on a pas un plan payant Si on détecte un ancien mode de connexion on utilise addHereLegacy

.

Créé un layer avec une source Here documentation officielle : @link https://developer.here.com/documentation/raster-tile-api/api-reference.html Attention erreur HTTP 429 fréquente si on a pas un plan payant Si on détecte un ancien mode de connexion on utilise addHereLegacy

Parameters:
Name Type Argument Description
idLayer string <optional>

Id du layer
options Object
Properties
Name Type Argument Default Description
apiKey String

jeton d'api
version String <optional>
 3

version de l'api Here (non utilisé, pour de futur mmaj)
baseUrl String <optional>
 https://maps.hereapi.com/v3

Url d'appel au service
resource 'base' | 'background' | 'blank' | 'label' <optional>
 base

Resource (base = background + label)
projection String <optional>
 mc

projection (mc - Mercator Projection)
format 'jpeg' | 'png' | 'png8' <optional>
 png

format d'image
style 'explore.day' | 'explore.night' | 'explore.satellite.day' | 'satellite.day' <optional>
 explore.day

Style de la carte
queryParams Object <optional>

Paramètres optionnels d'url, voir documentation officielle, exemple: { pview:IN, mv=in123jp45, lang:en,lang2:en }
forceCanvas Boolean <optional>
<nullable>
 false

force l'utilisation du moteur canvas plutot que webgl pour le rendu des tuiles
Source:
Returns:

Le fond de plan HERE

Type
Object

addHereLegacy(idLayer, options)

Créé un layer avec une source Here Pour utiliser le service renseigner au choix : app_key ou le couple app_id/app_code (ancien mode d'authenfication)

.

Créé un layer avec une source Here Pour utiliser le service renseigner au choix : app_key ou le couple app_id/app_code (ancien mode d'authenfication)

Parameters:
Name Type Description
idLayer string

Id du layer
options Object

Options pour l'affichage du fond de plan

Properties
Name Type Argument Default Description
app_key string

Key de l'appication pour la connexion (nouveau mode d'authentification)
app_id string

Id de l'appication pour la connexion (ancien mode d'authenfication)
app_code string

Code de l'application pour la connexion (ancien mode d'authenfication)
baseUrl string

Url d'appel au service. Par défaut https://{1-4}.base.maps.cit.api.here.com/maptile/2.1/maptile/newest/normal.day
forceCanvas Boolean <optional>
<nullable>
 false

force l'utilisation du moteur canvas plutot que webgl pour le rendu des tuiles
Source:

addHighlight(coordinate, radius)

Permet d'ajouter un highlight à une position et pour une taille

.

Permet d'ajouter un highlight à une position et pour une taille

Parameters:
Name Type Description
coordinate Array.<number>

Coordonées du centre du highlight
radius number

Rayon du highlight en taille de la projection de la carte
Source:

addIGN(idLayer, options)

Créé un layer avec une source IGN WMTS

.

Créé un layer avec une source IGN WMTS

Parameters:
Name Type Description
idLayer string

Id du layer
options Object

Options pour l'affichage du fond de plan

Properties
Name Type Argument Default Description
url string

Url de la ressource (ex: https://wxs.ign.fr/choisirgeoportail/geoportail/wmts)
layer string

Nom du layer à utiliser (ex: GEOGRAPHICALGRIDSYSTEMS.MAPS)
style string <optional>
 'normal'

Style d'affichage de la couche (ex: https://wxs.ign.fr/choisirgeoportail/geoportail/wmts)
format 'image/jpeg' | 'image/png' <optional>
 'image/jpeg'

format d'image
forceCanvas Boolean <optional>
<nullable>
 false

force l'utilisation du moteur canvas plutot que webgl pour le rendu des tuiles
Source:

addKml(nameLayer, options)

Créé un layer avec une source KML

.

Créé un layer avec une source KML

Parameters:
Name Type Description
nameLayer string

Nom du layer
options Object

Options pour l'affichage du fond de plan

Properties
Name Type Argument Default Description
url string

Url de la ressource (ex: https://wxs.ign.fr/choisirgeoportail/geoportail/wmts)
projection ol.proj.ProjectionLike <optional>
 'EPSG:4326'

Projection des données KML, utiliser 'XY' pour le pas reprojecter les données
Source:

addLayerFallbackXYZ(idLayer, options)

Créé un layer de fallback xyz

.

Créé un layer de fallback xyz

Parameters:
Name Type Description
idLayer string

Id du layer
options Object

Options pour la création du layer

Properties
Name Type Argument Default Description
forceCanvas Boolean <optional>
<nullable>
 false

force l'utilisation du moteur canvas plutot que webgl pour le rendu des tuiles
Source:

addLayerXYZ(idLayer, options)

Créé un layer tuilé pour une source web de tuile

.

Créé un layer tuilé pour une source web de tuile

Parameters:
Name Type Description
idLayer string

Id du layer
options Object

Options pour la création du layer

Properties
Name Type Argument Default Description
url string | undefined

Schema d'url du service de tuile XYZ (ex: 'http://wgs-users.s3.amazonaws.com/cus/fonds/ems_gris/{z}/{x}/{y}.png')
forceCanvas Boolean <optional>
<nullable>
 false

force l'utilisation du moteur canvas plutot que webgl pour le rendu des tuiles
Source:

addMapguideTiled(idLayer, options)

Créé un layer tuilé pour une source mapguide

.

Créé un layer tuilé pour une source mapguide

Parameters:
Name Type Argument Default Description
idLayer string

Id du layer
options Object

Options pour la création du layer

Properties
Name Type Description
MAPDEFINITION Object

Mpadefinition de la carte. Requis
USERNAME string

Utilisateur pour la connexion mapguide. Par défaut 'Anonymous'
Options.CLIENTAGENT string

Client agent mapguide. Par défaut 'MapGuide Developer'
options.DPI number

Nombre de dpi pour de l'image
options.useProxy boolean

Passage par un proxy mapagent-proxy.php
options.forceCanvas Boolean <optional>
<nullable>
 false

force l'utilisation du moteur canvas plutot que webgl pour le rendu des tuiles
Source:

addMapguideUnTiled(idLayer, options)

Créé un layer non tuilé pour une source mapguide

.

Créé un layer non tuilé pour une source mapguide

Parameters:
Name Type Description
idLayer string

Id du layer
options Object

Options pour la création du layer

Properties
Name Type Description
mapagent string

Url du mapAgent de mapguide
useOverlay boolean
meterPerUnit number

Nombre de mètres par unitée de mesure
params Object

Paramètres de connexion à mapguide

Properties
Name Type Description
MAPNAME string

Nom de la map
SESSION string

Identifiant de la session mapguide
CLIENTAGENT string

Clientgent de mapguide
Source:

addOSM(idLayer, options)

Créé un layer avec comme source Open Street Map

.

Créé un layer avec comme source Open Street Map

Parameters:
Name Type Description
idLayer string

Id du layer
options Object

Options pour Bing Maps

Properties
Name Type Argument Default Description
url string

Url personnalisée pour OSM
forceCanvas Boolean <optional>
<nullable>
 false

force l'utilisation du moteur canvas plutot que webgl pour le rendu des tuiles
Source:

addStadiaMaps(idLayer, options)

Créé un layer avec une source StadiaMaps

.

Créé un layer avec une source StadiaMaps

Parameters:
Name Type Description
idLayer string

Id du layer
options Object

Options pour StadiaMaps

Properties
Name Type Argument Default Description
layer string

Nom du layer sur StadiaMaps
apiKey string <nullable>

clé d'API
minZoom number | undefined

Zoom minimum
maxZoom number | undefined

Zoom maximum
tileLoadFunction ol.TileLoadFunctionType | undefined

Fonction optionnelle pour charger l'url donnée
url string | undefined

Template de l'url. Doit inclure {x}, {y} ou {-y}, et {z}
forceCanvas Boolean <optional>
<nullable>
 false

force l'utilisation du moteur canvas plutot que webgl pour le rendu des tuiles
Source:

addStamen(idLayer, options)

Créé un layer avec une source Stamen

.

Créé un layer avec une source Stamen

Parameters:
Name Type Description
idLayer string

Id du layer
options Object

Options pour Stamen

Properties
Name Type Description
layer string

Nom du layer sur Stamen
minZoom number | undefined

Zoom minimum
maxZoom number | undefined

Zoom maximum
tileLoadFunction ol.TileLoadFunctionType | undefined

Fonction optionnelle pour charger l'url donnée
url string | undefined

Template de l'url. Doit inclure {x}, {y} ou {-y}, et {z}
Source:

<async> addVector(nameLayer, options)

Créé un layer avec une source KML

.

Créé un layer avec une source KML

Parameters:
Name Type Description
nameLayer string

Nom du layer
options Object

Options pour l'affichage du fond de plan

Properties
Name Type Description
file Object
Properties
Name Type Argument Default Description
type 'wfs' | 'geojson' | 'shp'
projection string <optional>
 EPSG:3857

projection pour interroger le service
url string

Url de la ressource (ex: https://wxs.ign.fr/choisirgeoportail/geoportail/wmts)
wfs Object
Properties
Name Type Description
geometryName string

nom du champs geométrie du service
params Object

paramètre du service wfs
params Object

paramètre du service wfs

Properties
Name Type Description
typename string

Nom de la couche du service WFS à exploiter
* string

autres paramètres du service WFS
cqlFilter string

filtre cql
filters Object.<string, (string|Array)>

objet represant des filtres a générer (exemple {code_insee:[9420,8521]}). Ignoré si cqlFilter est défini
style Object
Properties
Name Type Description
url string

url du fichier de style
type 'qml' | 'mapbox' | 'sld' | 'ol'

format du fichier de style
Source:

<async> addVectorTile(idLayer, options)

Créer un calque vectoriel tuilé

.

Créer un calque vectoriel tuilé

Parameters:
Name Type Description
idLayer string
options Object
Properties
Name Type Argument Default Description
styleUrl String

Url du fichier de style compatible MapBox
tileLoadUrl String <optional>
 null

Url des fichier pbf pour surchager la fonction tileLoad, doit contenir {z}/{y}/{x}
params Object

paramètres

Properties
Name Type Argument Description
sourceOrLayers String | Array.<String>

source key or an array of layer ids from the Mapbox Style object. When a source key is provided, all layers for the specified source will be included in the style function. When layer ids are provided, they must be from layers that use the same source. When not provided or a falsey value, all layers using the first source specified in the glStyle will be rendered.
optionsOrPath String | Options <optional>

Options. Alternatively the path of the style file (only required when a relative path is used for the "sprite" property of the style). @link https://github.com/openlayers/ol-mapbox-style#interfacestypesoptionsmd
resolutions Array.<Number> <optional>

Resolutions for mapping resolution to zoom level. Only needed when working with non-standard tile grids or projections.
Source:

addWMSTiled(idLayer, options)

Créé un layer tuilé pour une source WMS

.

Créé un layer tuilé pour une source WMS

Parameters:
Name Type Description
idLayer string

Id du layer
options Object

Options pour la création du layer

Properties
Name Type Argument Default Description
attributions Array.<Attribution> | unefined

Attributions
params Object.<string, *>

Paramètre WMS Requis. Au minimum LAYERS est requis. Par défaut STYLE vaut '', VERSION vaut 1.3.0. WIDTH, HEIGHT, BBOX, CRS et SRS seront attribués dynamiquement
crossOrigin null | string | undefined

L'attribut crossOrigin pour charger les images
gutter number | undefined
hidpi boolean | undefined

Utilise ol.Map#pixelRation lors du chargement des images. True par défaut
tileGrid TileGrid | unedfined

Grille de tuilles
maxZoom number | undefined

Zoom Maximum
projection ol.proj.ProjectionLike

Projection
serverType ol.source.wms.ServerType | string | undefined

Type de serveur WMS (mapserver, geoserver ou qgis) nécessaire si hidpi true
imageLoadFunction ol.TileLoadFunctionType | undefined

Fonction optionnelle pour charger une image d'une URL donnée
url string | undefined

Url du service WMS
urls Array.<string> | undefined

Urls du service WMS. A utiliser à la place de url si le service WMS supporte plusieurs urls pour les requêtes GetMap
wrapX boolean | undefined

Séparer le monde horizontalement. Par défaut True
forceCanvas Boolean <optional>
<nullable>
 false

force l'utilisation du moteur canvas plutot que webgl pour le rendu des tuiles
Source:

addWMSUnTiled(idLayer, options)

Créé un layer non tuilé pour une source WMS

.

Créé un layer non tuilé pour une source WMS

Parameters:
Name Type Description
idLayer string

Id du layer
options Object

Options pour la création du layer

Properties
Name Type Description
attribution Array.<Attributions>

Attributions
params Object.<string, *>

Paramètre WMS requis. Au minimum LAYERS est requis. Par défaut STYLE vaut '', VERSION vaut 1.3.0. WIDTH, HEIGHT, BBOX, CRS et SRS seront attribués dynamiquement
crossOrigin null | string | undefined

L'attribut crossOrigin pour charger les images
hidpi boolean | undefined

Utilise ol.Map#pixelRation lors du chargement des images. True par défaut
projection ol.proj.ProjectionLike

Projection
serverType ol.source.wms.ServerType | string | undefined

Tyle de serveur WMS (mapserver, geoserver ou qgis) nécessaire si hidpi true
imageLoadFunction ol.TileLoadFunctionType | undefined

Fonction optionnnelle pour charger une image d'une URL donnée
url string | undefined

Urldu service WMS
ratio number | undefined

Ratio. Si 1 demande les images pour la taille de la carte, 2 demande les images pour le double de WIDTH et HEIGHT de la carte. Par défaut 1.5
resolution Array.<number> | undefined

Si spécifié, demande uniquement pour celle-ci
Source:

<async> addWMTS(idLayer, options)

Créer un calque tuilé suivant la norme WMTS

.

Créer un calque tuilé suivant la norme WMTS

Parameters:
Name Type Description
idLayer string
options object
Properties
Name Type Argument Default Description
url string

url du getCapabilities
params object | undefined <optional>
 null

paramètres optionnels

Properties
Name Type Argument Default Description
layer string | undefined <optional>
 null

nom du calque a utiliser dans la couche WMTS (sinon utilise le premier trouvé)
tileMatrixSet string | undefined <optional>
 null

Nom du Tile Matrix Set a utiliser dans la couche WMTS (sinon utilise le premier trouvé)
token string | undefined <optional>
 null

Token pour utilisé un serveur ARCGIS protégé
forceCanvas Boolean <optional>
<nullable>
 false

force l'utilisation du moteur canvas plutot que webgl pour le rendu des tuiles

  • Exemple : params= {token: 'supertoken'}
  • Exemple : params= {token: {type:'localStorage','path':'KARTEIS_ARCGIS_TOKEN'}} // recherche le token dans le localStorage[KARTEIS_ARCGIS_TOKEN]
Source:

allTileLoaded(idLayer)

Permet de savoir si un ou tous les fonds de plans ont chargés toutes leurs tuilles

.

Permet de savoir si un ou tous les fonds de plans ont chargés toutes leurs tuilles

Parameters:
Name Type Description
idLayer string | undefined

Id du layer à controler. Si undefined, verifie tous les layers
Source:
Returns:

True si toutes les tuilles chargées du ou de tous les layers

Type
boolean

clearCacheTiles()

Permet de vider le cache des tuiles

.

Permet de vider le cache des tuiles

Source:
Returns:

Promesse retournant true si le cache a été vidé

Type
Promise

clearHighlight()

Supprime tous les highlight persistés sur la carte

.

Supprime tous les highlight persistés sur la carte

Source:

downLayer(idLayer)

Permet de descendre le layer d'un nieau dans l'ordre d'affichage

.

Permet de descendre le layer d'un nieau dans l'ordre d'affichage

Parameters:
Name Type Description
idLayer string

Id du layer
Source:

extractToken()

Si le token n'est pas de type string, on l'inteprete

.

Si le token n'est pas de type string, on l'inteprete

Source:

getLayer(idLayer)

Permet de retourner un layer

.

Permet de retourner un layer

Parameters:
Name Type Description
idLayer string

Id du layer
Source:
Returns:

Layer recherché

Type
ol.layer.Base

getLayers()

Permet de retourner les couches de background

.

Permet de retourner les couches de background

Source:
Returns:

Liste des layers de background

Type
array.<ol.Layer>

getLayersId()

Permet de retourner la liste des couches de données

.

Permet de retourner la liste des couches de données

Source:
Returns:

Liste des ids de layer de fond de plan

Type
array.<string>

getLayerType()

Retourne la liste des types de fonds de plan géré par le service

.

Retourne la liste des types de fonds de plan géré par le service

Source:
Returns:

Liste des type de layer de fond de plan

Type
array.<string>

getTilesUrls(idLayer, extent, zooms)

Permet de récupérer toutes les urls des tuiles pour un extent données sur plusieurs niveaux de zoom

.

Permet de récupérer toutes les urls des tuiles pour un extent données sur plusieurs niveaux de zoom

Parameters:
Name Type Description
idLayer number | string

Identifiant du layer
extent Extent

Extent des urls à récupérer
zooms Array.<number>

Niveaux de zoom des tuiles à récupérer
Source:
Returns:

Tableau des urls des tuiles

Type
Array.<string>

hideLayer(idLayer)

Permet de masquer un layer de fond de plan

.

Permet de masquer un layer de fond de plan

Parameters:
Name Type Description
idLayer string

Id du layer à masquer
Source:

isSWReady()

Permet de savoir si le service worker de mise en cache de tuile est présent

.

Permet de savoir si le service worker de mise en cache de tuile est présent

Source:
Returns:

Promesse retournant true si le SW est prêt

Type
Promise

isVisible(id)

Permet de connaitre la visibilité d'un layer (en fonction de min/max zoom, propriété "visible" & group "visible")

.

Permet de connaitre la visibilité d'un layer (en fonction de min/max zoom, propriété "visible" & group "visible")

Parameters:
Name Type Description
id string

Identifiant du layer
Source:
Returns:

Visibilité

Type
boolean

layerExist(idLayer)

Permet de savoir si un layer existe

.

Permet de savoir si un layer existe

Parameters:
Name Type Description
idLayer string

Id du layer
Source:
Returns:

Si le layer existe

Type
boolean

manageVisibility(layer)

Gestion de ce qui se passe quand un background change de visibilitée

.

Gestion de ce qui se passe quand un background change de visibilitée

Parameters:
Name Type Description
layer ol.layer
Source:

onViewChange(layer, options)

Mets à jours les propriétés OpenLayer ou Karteis Mapviewer d'un calque

.

Mets à jours les propriétés OpenLayer ou Karteis Mapviewer d'un calque

Parameters:
Name Type Description
layer ol.layer

Calque OpenLayer
options Object

Options possibles pour les calques
Source:

precacheTiles(idLayer, extent, zooms, force)

Permet de mettre en cache des tuile d'un layer sur une extent et certains niveaux de zoom.

Permet de mettre en cache des tuile d'un layer sur une extent et certains niveaux de zoom. Attention, il n'y a pas de limite de nombre de tuiles possible en cache. Il est recommandé de ne pas mettre plus de 1000 tuiles en cache pour des layers détaillée ou 3000 pour des layers plus sobre (Stamen toner-lite)

Lors de la mise en cache, si des tuiles ne sont pas récupérer, on les ignores et le traitement se poursuit

Parameters:
Name Type Description
idLayer string | number

Identifiant du layer
extent Extent

Extent des tuiles à mettre en cache
zooms Array.<number>

Niveaux de zoom à mettre en cache
force boolean

Force la mise à jour si la tuile est déjà en cache
Source:
Returns:

Promesse qui retourne true une fois le traitement terminé (mais pas forcément complet)

Type
Promise

removeLastHighlight()

Supprime le dernier highlight créé sur la carte

.

Supprime le dernier highlight créé sur la carte

Source:

removeLayer(idLayer)

Permet de supprimer un layer

.

Permet de supprimer un layer

Parameters:
Name Type Description
idLayer string

Id du layer
Source:
Fires:
  • remove:[idLayer] Lancé avant la suppression du layer
  • removed:[idLayer] Lancé après la suppression du layer

sendToSW(message)

Permet de communiquer avec le service worker

.

Permet de communiquer avec le service worker

Parameters:
Name Type Description
message Object

Message envoyé au SW
Source:
Returns:

Promesse résolue lors de la réponse du SW

Type
Promise

setHighlight(idLayer, active, radius)

Permet d'utiliser un layer en tant que highlight Attention ne fonctionne pas avec des calques webgl, le calque doit avoir éété ajouter avec l'options forceCanvas = true

.

Permet d'utiliser un layer en tant que highlight Attention ne fonctionne pas avec des calques webgl, le calque doit avoir éété ajouter avec l'options forceCanvas = true

Parameters:
Name Type Default Description
idLayer string | number

Nom du layer
active boolean true

Permet de gérer l'état du highlight sur le layer
radius number 100

Rayon du highlight en pixel. Par défaut 100
Source:

showLayer(idLayer)

Permet d'afficher un layer de fond de plan

.

Permet d'afficher un layer de fond de plan

Parameters:
Name Type Description
idLayer string

Id du layer à afficher
Source:

upLayer(idLayer)

Permet de monter le layer d'un niveau dans l'ordre d'affichage

.

Permet de monter le layer d'un niveau dans l'ordre d'affichage

Parameters:
Name Type Description
idLayer string

Id du layer
Source: