Class: Mapviewer

Members

---

bufferNullExtent :number

Gestion d'un buffer sur le zoom d'une extent sans taille

.

Gestion d'un buffer sur le zoom d'une extent sans taille

Type:

• number

Source:

• core/core.js, line 156

---

featureSnapper :FeatureSnapper

Type:

• FeatureSnapper

Source:

• core/core.js, line 281

---

hitTolerance :number

tolerance au clic pour les outils de sélection

.

tolerance au clic pour les outils de sélection

Type:

• number

Source:

• core/core.js, line 144

---

hitTolerance

Paramètres a garder en mémoire

.

Paramètres a garder en mémoire

Source:

• core/core.js, line 196

---

horizontalToolbar :ControlBar

Type:

• ControlBar

Source:

• core/core.js, line 223

---

isDesktop :boolean

mode desktop du viewer

.

mode desktop du viewer

Type:

• boolean

Source:

• core/core.js, line 160

---

layerFilterInteraction

Source:

• core/core.js, line 286

---

Map :ol.Map

Type:

• ol.Map

Source:

• core/core.js, line 164

---

padding :Array.<number>

gestion du padding au niveau applicatif entier (permet a l'application de se "décentrer")

.

gestion du padding au niveau applicatif entier (permet a l'application de se "décentrer")

Type:

• Array.<number>

Source:

• core/core.js, line 148

---

printControl :CustomPrint

Type:

• CustomPrint

Source:

• core/core.js, line 232

---

tokenManagerPool :TokenManagerPool

Type:

• TokenManagerPool

Source:

• core/core.js, line 138

---

verticalToolbar :ControlBar

Type:

• ControlBar

Source:

• core/core.js, line 213

---

zoomIn

Zoom d'un niveau

.

Zoom d'un niveau

Source:

• core/core.js, line 382

---

zoomOrigin :function|ol.Coordinate

Extent de l'origine de la carte (peut-être une fonction), utilisé dans ControlBar

.

Extent de l'origine de la carte (peut-être une fonction), utilisé dans ControlBar

Type:

• function | ol.Coordinate

Source:

• core/core.js, line 152

---

zoomOut

Dezoom d'un niveau

.

Dezoom d'un niveau

Source:

• core/core.js, line 387

Methods

---

addSearchControl(options)

Parameters:

Name	Type	Description
options	Object	Options de création du contrôle de recherche Properties Name Type Argument Default Description provider 'ban' | 'photon' | 'wfs' <optional> ban Nom du fournisseur pour la recherche reverse boolean <optional> false Affiche un outil de géocodage inverse d'adresse reverseTitle string <optional> Cliquer sur la carte... Titre à afficher sur le tooltip du bouton de géocodage inverse position boolean <optional> true Priorise les résultats près du centre de la carte affichée label string <optional> Rechercher Libellé affiché pour la zone de recherche placeholder string <optional> Rechercher une adresse Placeholder de la zone de recherche maxItems integer <optional> 10 Nombre de résultats affichés classés par score limit integer <optional> 10 Nombre de résultats recherchés (utile lorsque l'on va appliquer un filtre) typing number <optional> 500 le délais en ms pour lancer la recherche après une saisie utilisateur minLength integer <optional> 3 la longueur de la chaine de recherche à partir de laquelle lancer la recherche resultZoom integer <optional> 16 Zoom minimal à appliquer lors de la localisation sur la carte d'un résultat citycodes Array.<string> <optional> [] Liste de code insee sur lesquels on va lancer la recherche (attention, une requête sera réalisée par code insee) postfilters Array.<PostFilter> <optional> [] Liste des filtres à appliquer sur les résultats (attention, il est possible qu'aucun résultat ne s'affiche) wfsSources Array.<WfsSource> <optional> [] Options de recherche pour le type wfs en cascade (dans l'ordre du tableau)

Properties:

Name	Type	Argument	Description
type	'citycode' | 'postalcode' | 'city' | 'context'		type de filtre (seul les types 'citycode' et 'postalcode' sont pris en charge)
values	Array.<(string|number)>		liste des valeurs que l'on accepte Paramètre de recherche WfsSource
name	String		type de filtre
wfs	Object		Paramère générale de la source Properties Name Type Argument Default Description url string Url du service version string <optional> <nullable> 1.0.0 version du service
featureNS	string		Namespace (a retrouver avec getCapabilities)
featurePrefix	string		prefix de la source a interroger
featureTypes	Array.<string>		// liste des couches a interroger
searchIn	Array.<string>		// recherche ce que l'utilisateur va taper dans ces champs
prefilter	Object		préfiltrage sur une des propriétée Properties Name Type Description key string | Array Nom du champ que l'on préfiltre, on peut utiliser une valeur, une liste de valeur ou un mot clé pour utiliser un résultat précédent (code_dep: "94" ou code_insee: ['94041','94081','94046','94002'] ou code_dep: 'PREVIOUS_RESULT.commune.code_dep' ou code_com: 'PREVIOUS_RESULT.commune.<%= code_insee.slice(2) %>')
value	string | Array		nom du champ ou des champs a retourner (pour utiliser dans la cascade)
display	string		libellé a afficher dans la liste
placeholder	string	<nullable>	surcharge du placeholder de la zone de recherche pour cette étape
geometryName	string	<nullable>	nom de la propriété géométrie (utilisé pour filtre bbox ou lors du zoom vers une feature)
useBbox	boolean	<nullable>	tente d'utiliser la bbox du résultat fin le plus proche comme filtre, geometryName est nécessaire
minLength	number	<nullable>	surcharge du nombre de caractère minimum a taper pour cette étape Permet d'ajouter un contrôle de recherche

Source:

• core/core.js, line 622

---

addSourceToFeatureSnapper(snapSource)

Parameters:

Name	Type	Description
snapSource	Object	paramétrage d'une snapSource Properties Name Type Argument Description groups Array.<snapGroup> <optional> groupes auquels appartientla source source ol.source.Vector <optional> Source openlayer, attention a ne pas ajouter des sources composée des même features...

Properties:

Name	Type	Description
name	String	nom du groupe auquel appartient la source
edge	Boolean	accrochage aux ligne
vertex	Boolean	accrochage au extremités Ajoute une source vecteur a surveiller

Source:

• core/core.js, line 689

---

<async> addTokenSource(tokenOptions)

Ajoute une source de token

.

Ajoute une source de token

Parameters:

Name	Type	Description
tokenOptions	tokenOptions | String	options de gestion du token ou token en clair (historique)

Source:

• core/core.js, line 967

Returns:

Type

TokenManager

---

clearFeatureSnapper()

Supprime toutes les sources du featureSnapper

.

Supprime toutes les sources du featureSnapper

Source:

• core/core.js, line 673

---

<async> copyMap(options)

Copie la carte dans le presse papier

.

Copie la carte dans le presse papier

Parameters:

Name	Type	Description
options	Object	Properties Name Type Default Description imageType string Format d'image, default image/png quality number Number between 0 and 1 indicating the image quality to use for image formats that use lossy compression such as image/jpeg and image/webp orientation string Orientation (paysage/portrait), default "devine le meilleur" immediate boolean false force l'impression même si la carte n'a pas finie de charger, default false

Source:

• core/core.js, line 768

---

dispatchEvent(type, data)

Permet de lever un event

.

Permet de lever un event

Parameters:

Name	Type	Description
type	String	Type d'event à lever
data	*	Données à transmettre

Source:

• core/core.js, line 1006

---

flyToExtent(extent, options)

Permet de zoomer sur une extent avec une animaion (1 seconde)

.

Permet de zoomer sur une extent avec une animaion (1 seconde)

Parameters:

Name	Type	Description
extent	ol.Extent	The destination extent
options	Object	Voir ol.View.fit

Source:

• core/core.js, line 426

---

getCenter(options)

Permet de récupérer le centre de la vue.

Permet de récupérer le centre de la vue. Possibilité de prendre en compte un padding.

Parameters:

Name	Type	Description
options	Object	Options pour récupérer le centre de la carte Properties Name Type Description padding Array.<number> [right, top, bottom, left] Padding à appliquer si l'ensemble de la vue n'est pas visible par l'utilisateur

Source:

• core/core.js, line 490

Returns:

Coordonnées du centre de la carte

Type

Array.<Number>

---

getExtent()

Permet de récupérer l'extent de la vue courrante

.

Permet de récupérer l'extent de la vue courrante

Source:

• core/core.js, line 478

---

getFeatureSnapper()

Renvoit le featureSnapper

.

Renvoit le featureSnapper

Source:

• core/core.js, line 696

Returns:

Type

FeatureSnapper

---

getFlatLayers(layers)

renvoi les calques et ceux dans les groupe (un groupe est considéré par un layer par Map.getLayers)

.

renvoi les calques et ceux dans les groupe (un groupe est considéré par un layer par Map.getLayers)

Parameters:

Name	Type	Description
layers	Array	mets a place cette liste, part de map.getLayers() si vide

Source:

• core/core.js, line 462

Returns:

la liste des calques à plat

---

getMap()

Renvoi la carte

.

Renvoi la carte

Source:

• core/core.js, line 876

Returns:

Type

ol.Map

---

<async> getMapSnapshot(options)

Renvoit une promesse avec le screenshot de la carte

.

Renvoit une promesse avec le screenshot de la carte

Parameters:

Name	Type	Description
options	Object	Properties Name Type Default Description imageType string Format d'image, default image/png quality number Number between 0 and 1 indicating the image quality to use for image formats that use lossy compression such as image/jpeg and image/webp orientation string Orientation (paysage/portrait), default "devine le meilleur" immediate boolean false force l'impression même si la carte n'a pas finie de charger, default false toDataUrl boolean false retour sous forme de "data url", default false

Source:

• core/core.js, line 710

Returns:

Blob ou dataUrl de l'image de la carte

Type

Promise.<Blob> | Promise.<string>

---

getResolution()

Permet de récupérer la résolution actuelle de la carte

.

Permet de récupérer la résolution actuelle de la carte

Source:

• core/core.js, line 554

Returns:

Résolution de la carte

Type

Number

---

getRotation()

Permet de récupérer la rotation en radian de la carte

.

Permet de récupérer la rotation en radian de la carte

Source:

• core/core.js, line 528

Returns:

Rotation de la carte en radian

Type

Number

---

getScale( [round])

renvoi l'échelle d'affichage courante

.

renvoi l'échelle d'affichage courante

Parameters:

Name	Type	Argument	Default	Description
round	boolean	<optional> <nullable>	false	arrondir?

Source:

• core/core.js, line 941

Returns:

Number

---

getViewProjection()

Renvoi le code de projection actuel de la carte

.

Renvoi le code de projection actuel de la carte

Source:

• core/core.js, line 932

Returns:

Code de projection

Type

string

---

getZoom()

Récupère le niveau de zoom actuel

.

Récupère le niveau de zoom actuel

Source:

• core/core.js, line 392

---

isFeatureInMapExtent(feature)

Permet de savoir si une feature est visible dans la vue courrante

.

Permet de savoir si une feature est visible dans la vue courrante

Parameters:

Name	Type	Description
feature	ol.Feature	Feature à tester

Source:

• core/core.js, line 571

---

on(type, listener, context)

Permet d'ecouter un event

.

Permet d'ecouter un event

Parameters:

Name	Type	Description
type	String	Type d'event à écouter
listener	function	Callback losque l'event survient
context	Object	Context d'appel du callback

Source:

• core/core.js, line 1016

---

once(type, listener, context)

Permet d'ecouter un event une seule fois

.

Permet d'ecouter un event une seule fois

Parameters:

Name	Type	Description
type	String	Type d'event à écouter
listener	function	Callback losque l'event survient
context	Object	Context d'appel du callback

Source:

• core/core.js, line 1029

---

<async> print(options)

télécharge une copie de la carte

.

télécharge une copie de la carte

Parameters:

Name	Type	Description
options	Object	Properties Name Type Default Description imageType string Format d'image, default image/png quality number Number between 0 and 1 indicating the image quality to use for image formats that use lossy compression such as image/jpeg and image/webp orientation string Orientation (paysage/portrait), default "devine le meilleur" immediate boolean false force l'impression même si la carte n'a pas finie de charger, default false filename string Nom de fichier

Source:

• core/core.js, line 742

Returns:

Blob de l'image de la carte

Type

Promise.<Blob>

---

refreshMap()

Permet de recalculer l'ensemble des layers

.

Permet de recalculer l'ensemble des layers

Source:

• core/core.js, line 433

---

removeSourceToken(tokenOptions)

Supprime une source de token

.

Supprime une source de token

Parameters:

Name	Type	Description
tokenOptions	tokenOptions | String	options de gestion du token ou token en clair (historique)

Source:

• core/core.js, line 976

Returns:

true si le token a été supprimé

Type

Boolean

---

setCenter(center, options)

Permet de changer le centre de la vue.

Permet de changer le centre de la vue. Possibilité de prendre en compte un padding.

Parameters:

Name	Type	Description
center	Array.<Number>	Nouveau centre de la carte à appliquer
options	Object	Options pour modifier le centre de la carte Properties Name Type Description padding Array.<number> [top, right, bottom, left] Padding à appliquer si l'ensemble de la vue n'est pas visible par l'utilisateur

Source:

• core/core.js, line 509

---

setFeatureHover(options)

Démarre ou remplace le service de survol des features

.

Démarre ou remplace le service de survol des features

Parameters:

Name	Type	Description
options	Object

Source:

• core/core.js, line 841

---

setFeatureHoverActive(active)

Met en pause ou active le service survol des features

.

Met en pause ou active le service survol des features

Parameters:

Name	Type	Description
active	Boolean

Source:

• core/core.js, line 861

---

setLimitExtent(extent, center, buffer)

Permet de définir un extent comme limite de déplacement sur la carte

.

Permet de définir un extent comme limite de déplacement sur la carte

Parameters:

Name	Type	Description
extent	ol.extent	Extent à appliquer (dans l'epsg de la carte)
center	Boolean	Place la carte au centre de l'extent. Par défaut false
buffer	number	Ratio du buffer à appliquer à l'extent. Par défaut 1 (extent original)

Source:

• core/core.js, line 633

---

setResolution(resolution)

Permet de modifier la résolution actuelle de la carte

.

Permet de modifier la résolution actuelle de la carte

Parameters:

Name	Type	Description
resolution	Number	Résolution de la carte

Source:

• core/core.js, line 563

---

setRotation(rotation, options)

Permet de modifier la rotation de la carte

.

Permet de modifier la rotation de la carte

Parameters:

Name	Type	Description
rotation	Number	Rotation de la carte en radian
options	Object	Options pour la rotation de la carte Properties Name Type Description padding Array.<Number> Padding à prendre en compte pour la rotation [top, right, bottom, left]

Source:

• core/core.js, line 539

---

setScale(scale, animate)

Met la carte a l'echelle demandée

.

Met la carte a l'echelle demandée

Parameters:

Name	Type	Description
scale	Number	echelle a atteindre
animate	boolean | object | null	Animer la mise a l'echelle (true: animation prédéfinie, object: options compatible https://openlayers.org/en/latest/apidoc/module-ol_View-View.html#animate)

Source:

• core/core.js, line 950

---

setViewProjection(toProjection)

Verifi que la vue est dans la même projection que celle demandée et switch la projection

.

Verifi que la vue est dans la même projection que celle demandée et switch la projection

Parameters:

Name	Type	Description
toProjection	String

Source:

• core/core.js, line 885

Returns:

projection changed

Type

Boolean

---

setZoom(zoom)

set le niveau de zoom actuel

.

set le niveau de zoom actuel

Parameters:

Name	Type	Description
zoom	Number	niveau de zoom, plus c'est élevè, plus on se rapproche

Source:

• core/core.js, line 400

---

<async> startMeasure(measureType)

Lance le mode mesure

.

Lance le mode mesure

Parameters:

Name	Type	Description
measureType	'distance' | 'area'	type de mesure a effectuer

Source:

• core/core.js, line 777

Returns:

MapMeasureEvent

---

startRecordingTrace(options)

Démarre l'enregistrement

.

Démarre l'enregistrement

Parameters:

Name	Type	Description
options	Object	Properties Name Type Description interval Boolean interval d'enregistrement des points precision Number Nombre de chiffres après la virgule horodatage Number interval d'enregistrement des points

Source:

• core/core.js, line 806

---

stopRecordingTrace()

Annule l'enregistrement de trace

.

Annule l'enregistrement de trace

Source:

• core/core.js, line 830

---

un(type, listener, context)

Permet de ne plus ecouter un event

.

Permet de ne plus ecouter un event

Parameters:

Name	Type	Description
type	String	Type d'event à écouter
listener	function	Callback losque l'event survient
context	Object	Context d'appel du callback

Source:

• core/core.js, line 1042

---

validateRecordingTrace(options)

Validation, lance l'event, renvoit le résultat et retirer le controle

.

Validation, lance l'event, renvoit le résultat et retirer le controle

Parameters:

Name	Type	Description
options	Object	Properties Name Type Description silent Boolean ne lance pas l'event

Source:

• core/core.js, line 820

Returns:

{positions, feature}

Type

object

---

zoomToExtent(extent, options)

Permet de zoomer sur une extent

.

Permet de zoomer sur une extent

Parameters:

Name	Type	Description
extent	ol.Extent	Extent sur laquelle zoomer
options	Object	Voir ol.View.fit

Source:

• core/core.js, line 410