Les fonctions publiques de mviewer

Pour accéder à ces fonctions publiques, il faut simplement utiliser l’objet mviewer et accéder à une fonction (mviewer.nomDeLaFonction()).

Il existe déjà les fonctions suivantes :

mviewer
getActiveBaseLayer()
Renvoie:

L’id du baselayer (couche de fond visible).

setBaseLayer(id)
Paramètres:

id (string) – Id du layer

Renvoie:

Affiche le baselayer correspondant à l’id.

getLayer(layerid)
Paramètres:

layerid (string) – Id du layer

Renvoie:

La configuration du layer.

getLayer(layerid).layer
Renvoie:

Le layer (ol.Layer) du layerid.

getMap()
Renvoie:

La map (ol.Map).

toggleLayer(layerid)
Paramètres:

layerid (string) – Id du layer

Renvoie:

Affiche/masque le layer correspondant au layerid.

removeAllLayers()
Renvoie:

Masque toutes les couches.

showLocation(projection, x, y)
Paramètres:

  • projection (string) – Projection de la carte

  • x (float) – Coordonnée y

  • y (float) – Coordonnée y

Renvoie:

Affiche une punaise sur les coordonnées entrées.

tr()
Renvoie:

Traduit dans la langue courante de mviewer une valeur de type machaine.a.traduire (cf Configurer - Traduction) .

zoomToLocation(x, y, zoom, querymap)
Paramètres:

  • x (float) – Coordonnée y

  • y (float) – Coordonnée y

  • zoom (int) – Zoom de la carte

  • querymap (boolean) – Interrogation de la carte

Renvoie:

Zoom aux coordonnées indiquées et en option interroge la carte à ces coordonnées.

getLayersAttribute(attribute)
Paramètres:

attribute (string) – Attribut recherché dans les couches Mviewer

Renvoie:

Un objet contenant les couches et la valeur de l’attribut recherchée du type {id1: value, id2: null}.

orderLegendByMap()
Renvoie:

Réordonne la légende selon l’affichage des couches sur la carte.

orderLegendByMap()
Renvoie:

Réordonne la légende en respectant l’affichage des couches sur la carte.

reorderLayer(layer, index)
Paramètres:

  • layer (Object) – Couche OpenLayers depuis la carte (e.g depuis mviewer.getLayer(id)).

  • index (int) – Nouvel index de la couche sur la carte.

Renvoie:

Permet de changer l’affichage d’une couche sur la carte (voir openLayers zindex).

showLayersByAttrOrder(layers, reverse)
Paramètres:

  • layer (Object) – Dictionnaire des couches avec le zindex pour chacune (ex. {id1:1, id2:2,,,})

  • reverse (boolean) – reverse == true pour lire les couches dans le sens inverse de l’ordre de l’objet.

Renvoie:

Permet de modifier l’ordre complet des couches de la carte, réordonnera les topLayer et la légende ensuite.

setLegendLayerPos(id, position)
Paramètres:

  • id (string) – Identifiant de la couche. Correspond à l’attribut data-layerid d’un élement de la légende.

  • position (int) – Nouvelle position de l’élément de légende ciblé dans la légende.

Renvoie:

Permet de modifier l’ordre d’affichage d’un élément de la légende sans impacter l’ordre d’affichage sur la carte.

orderLayerByIndex()
Renvoie:

Ordonne les éléments en respectant le paramètre index. Les couches sans index seront listées dans l’ordre d’écriture dans le XML. Cela n’impacte pas l’affichage dans la légende.

orderTopLayer()
Renvoie:

Ordonne les/la couches avec le paramètre toplayer. Cela n’impacte pas l’affichage dans la légende.

clickedCoordinates()
Renvoie:

Les coordonnées latitude / longitude du point cliqué sur la carte.