API Business Geografic

Map

Objet permettant d'afficher une carte dans une page Web.

Des options peuvent être passées en paramètre pour configurer la carte à son lancement.

Author:
  • Fabien Nicollet
See:

Exemple

map = new bg.api.Map("myMap", "http://carto.haute-garonne.fr/", {
		getImageCallback:"onGetImage",
		getResultsCallback:"onGetResults"
      });

Methods

activateMouseWheel()

Active la navigation par la molette de la souris

activateTool(Number)

Active un des outils de sélection. Par exemple activateTool(1) active l'outil de sélection par rectangle. Sont disponibles les outils de sélection par : Rectangle (0), Point (1), Polygone (2), Ligne (3). L'utilisateur des modifiers (touche Ctrl) pour la multi-sélection est automatique. Si aucun outil passé, l'outil de déplacement est activé

Parameters:
Name Type Description
Number

toolId Index de l'outil à sélectionner Rectangle (0), Point (1), Polygone (2), Ligne (3). Retour à l'outil de déplacement en utilisant (-1)
Exemple
     activateTool(1);

addMarker(options)

Ajoute un Marker sur la carte non-lié à Aigle à une position donnée

Parameters:
Name Type Description
options bg.api.MarkerOptions
Exemple
     map.addMarker({
			x:507887.9286312493, 
			y:6217785.891499998,
			id:"1",
			title:"Titre info-bulle",
			content:'<p><font size="12" face="Arial"><img src="http://laroutesansfin.files.wordpress.com/2009/09/place-des-terreaux-lyon.jpg" width="188" height="141" align="left" hspace="5" vspace="5">Place des terreaux à Lyon (centre)<br /><a href="http://www.lpa.fr" target="_blank">http://www.lpa.fr</a><br />86 affiches spectaculaires sont exposées au Musée de l Imprimerie. Elles ont orné avec éclat, entre 1913 et 1970, le métro et les <b>gares ferroviaires britanniques</b>. Créées par les plus grands artistes de l époque, ces affiches ...</font></p>',
			footer:'<font size="12" face="Arial"><a href="http//www.haute-garonne.fr/" target="_blank">Site du CG31</a></font>',
			imageUrl:"http://www.lcoberschaeffolsheim.org/public/images/marker.png",
			toolTip:"Marker API JS",
			openInfoBubble:true,
			infoWidth:450,
			markerWidth:20,
			markerHeight:34
		});

callFunction(functionName, args)

Uniquement disponible pour GEO Permet d'appeler une fonction JavaScript définie dans l'application GEO

Le premier argument est le nom de la fonction. Le second argument est un tableau de paramètre à passer à la fonction appelée

Parameters:
Name Type Description
functionName

String Nom de la fonction à appeler
args

Array Tableau contenant les paramètres à passer à la fonction appelée
Exemple
Si on a définit une fonction
window.testFunction = function (message){
     alert(message);
}
On pourra l'appeler avec:
map.callFunction("testFunction", ["test message"]);

Pour récupérer le résultat de la fonction appelée, utiliser:
map.callFunction("testFunction", ["test message"]).then(function(resultat){
    alert(resultat);
});

deactivateMouseWheel()

Désactive la navigation par la molette de la souris

fitAll()

Retour à l'emprise initiale définie dans Aigle

getExtent() → {String}

Renvoie les coordonnées de l'emprise courante Note: Pour une application GEO, utiliser la notation suivante: map.getExtent().then(function(extent){ // l'emprise est disponible dans la variable "extent" });

Returns:

Emprise courante, west, south, east, north, en mètres

Type
String

getImage()

Fait une demande d'image pour une impression.

L'URL de l'image sera ensuite transmise à la méthode bg.api.MapOptions#getImageCallback lorsqu'elle est prête (traitement asyncrone) Les résultats courants affichés sur la carte seront, eux, transmis à la méthode bg.api.MapOptions#getResultsCallback

See:

getLatLng(x, y)

écupère des coordonnées dans le format WGS84, à partir de X/Y

Parameters:
Name Type Description
x
y

getProjected(lat, lng)

Récupère des coordonnées dans le format du système de projection de la carte, à partir de latitude/longitude

Parameters:
Name Type Description
lat
lng

getScale()

Récupérer l'echelle courante Note: Pour une application GEO, utiliser la notation suivante: map.getScale().then(function(scale){ // l'échelle est disponible dans la variable "scale" });

Returns:

Number

panDown()

Déplacement vers le bas

panLeft()

Déplacement vers la gauche

panRight()

Déplacement vers la droite

panUp()

Déplacement vers le haut

removeMarker(markerId)

Supprimer un Marker ajouté par addMarker

Parameters:
Name Type Description
markerId String

Identifiant unique utilisé lors de l'appel à addMarker

Lance une recherche Aigle avec filtres (optionnels).

Un Marker sera automatiquement affiché sur la carte avec une fiche d'informations si celle-ci est définie dans Aigle sur la recherche

Parameters:
Name Type Description
String

name Nom de la recherche Aigle à lancer
filters String[]

Tableau de filtres comme pour la propriété "filters" de MapOption
See:
  • bg.api.MapTypeOption#filters

setActiveLayer(String)

Permet de spécifier une couche de travail. Le paramètre à passer est le nom de la couche définie dans Aigle. Cette couche de travail sera utilisée pour les sélections

Parameters:
Name Type Description
String

name Nom de la couche Aigle définie comme couche de travail. Une valeur vide ("") annule ce paramètre.
Exemple
     setActiveLayer("Communes");

setCenter(center)

Centrer la carte sur un point donnée

Les coordonnées du centre doivent être définies en mètres.

Parameters:
Name Type Description
center String
Exemple
 map.setCenter("507887.9286312493, 6217785.891499998");

setExtent(extent)

Donner une emprise à la carte

Définie sous la forme Nord, Sud, Est, Ouest

Les coordonnées de l'emprise doivent être définies en mètres.

Parameters:
Name Type Description
extent String
Exemple
 map.setExtent("6230310.994135345, 6213404.647885345, 545652.4266024437, 525102.105972744")

setLegend(legend)

Modifie la visibilité des couches de l'application

Parameters:
Name Type Description
legend String[]

Tableau de visibilités comme pour la propriété "legend" de MapOptions
See:
  • bg.api.MapTypeOption#legend
Exemple
     map.setLegend(["Communes=1"]);

setProxSearches(proxSearches)

Définit la visibilité des recherches à promimité à la volée

Parameters:
Name Type Description
proxSearches String[]
Exemple
 map.setProxSearches(["Collèges=1", "Centres de secours=0"]);

setSelectionSearchName(String)

Nom de la recherche à lancer sur la sélection courante. La recherche sera automatiquement lancée lorsque l'utilisateur a terminé sa sélection (au clic ou à la fin d'une séquence de multi-sélection avec Ctrl). Ce nom de recherche est défini dans Aigle.

Parameters:
Name Type Description
String

name Nom de la recherche Aigle à lancer
Exemple
     setSelectionSearchName("Recherche de communes");

zoomIn()

Zoom avant

zoomOut()

Zoom Arrière

zoomToScale(scale)

Zoomer à une échelle précise. Si on a une couche TMS de définie, l'application va automatiquement se fixer au bon niveau

Parameters:
Name Type Description
scale Number

Echelle sur laquelle on souhaite se fixer
Exemple
 map.zoomToScale(25000);