La référence des classes décrit toutes les classes publiques et ses méthodes de l'API, qui peuvent être utiliser afin d'intégrer et de contrôler la carte interactive de la Suisse.
C'est la classe principale de la carte et doit être instanciée dans votre page HTML.
var map = new SearchChMap({ container:"mapcontainer" });
Le constructeur exige un objet avec les paramètres suivants:
| Paramètre | Type d'attribut | Optionnel | Préréglage | Description |
| container | Mixed | oui | mapcontainer | Objet du DOM ou ID du conteneur, dans lequel se trouve la carte. D'avantage un élément bloc comme <div> ou <p> est utilisé. |
| center | Mixed | oui | - | Centre de la carte. Chaîne de caractères avec adresse ou array avec coordonnées géografiques. Voir références géographiques pour plus de détails. |
| from | Mixed | oui | - | Point de départ d'un itinéraire. Vous ne pouvez saisir quelque chose comme center si vous saisissez aussi quelque chose dans le champ to. |
| to | Mixed | oui | - | Destination d'un itinéraire. Vous ne pouvez saisir quelque chose comme center si vous saisissez aussi quelque chose dans le champ from. |
| routemode | String | oui | car | Route mode. Values: car,bicycle,pedestrian,oev |
| type | String | oui | street | Type de carte aerial ou street |
| zoomlevel | Number | oui | auto | Niveau de zoom. Valeurs possibles: 6 - 19 |
| zoom | Number | oui | auto | Niveau de zoom (obsolète). Valeurs possibles: 1024,512,256,128,64,32,16,8,4,2,1,0.5,0.25,0.125Correspon au nombre de mètres par pixel, est aroundi au niveau le plus proche si necessaire. |
| controls | String | oui | default | Elements de contrôle et visualisation dans la carte (en tant que chaîne de caractères séparés par virgule):
ou chaîne de caractères "all" |
| poigroups | String | oui | default | Catégories de POI (en tant que chaîne de caractères séparés par virgule). Voir Catégories et Groupement de POI. |
| drawing | String | oui | - | Un dessin de map.search.ch crée par "Dessiner sur la carte", qui est affiché, p.ex. "mu4zdnjn2". |
| marker | Boolean | oui | auto | Contrôle afin d'afficher le centre de la carte avec un marquage rouge (si l'adresse est suffisamment précise). |
| gestureHandling | String | oui | auto |
Contrôle la façon dont l'API gère les gestes sur la carte. Valeurs autorisées:
|
| poiClick | Boolean | yes | true | enable/disable clicks on POIs and on the map itself |
| poiHover | Boolean | yes | true | enable/disable POI hover |
| Méthode | Valeur retournée | Description |
| set(Object p) | void | Mettre à jour/actualiser les réglages de la carte. Comme argument un objet avec le paramètres utilisés avec le constructeur sont nécessaire (exception container). |
| go(Object p) | void | Déplace la carte vers le centre donné (center). L'argument est un objet avec les paramètres suivants:
|
| get([String what]) | mixed | Getter pour les réglages de l'objet de la carte. Comme argument tous les noms peuvent être utilisés similaire à la fonction set(). Sans argument la méthode retourne un objet avec tous les paramètres..Example: map.get('zoom') ou aussi map.get().zoom livre le niveau du zoom actuel. |
| zoom(int dir) | void | Zoom avant/arrière de la carte. dir > 0: zoom avant, dir < 0: zoom arrière. |
| showPOIGroup(String groups) | void | Afficher un ou plusieurs groupes de POI. L'argument est une chaîne de caractères séparés par une virgules selon la définition. |
| hidePOIGroup(String groups) | void | Déactive un ou plusieurs groupes de POI. Argument selon showPOIGroup() |
| addPOI(SearchChPOI obj) | void | Affiche un POI spécifique sur la carte. L'argument est une instance de SearchChPOI. |
| removePOI(SearchChPOI obj) | void | Déactive un POI spécifique de la carte. Une référence de l'objet SearchChPOI à déactiver est necessaire comme argument. |
| removeAllPOIs() | void | Déactive tous les objets POI spécifiques de la carte. |
| getPermUrl(String mode) | String | Rend adresse URL absolue de map.search.ch avec la vue actuelle de la carte. A l'aide du paramètre optionel mode des liens pour la version imprimable ("print") ou la version itinéraire d'une route ("directions") peuvent être générés. |
| addEventListener( String event, function callback) | void | Associé un gestionnaire d'événement.
|
| removeEventListener( String event, function callback) | void | Déactiver un gestionnaire d'événement associé préalablement. Les mêmes arguments doivent être utilisés que lors de l'activation. |
| resize(int w, int h) | void | Agrandir ou réduire la carte integrée à la largeur/hauteur indiquée. |
| Evénement | Description |
| load | Lancé après la fin du chargement de la carte, c'est-à-dire que toutes les images visibles sont chargées et affichées. |
| change | Lancé lorsque l'extrait de la carte a changé, p.ex. quand l'utilisateur déplacé ou zoomé la carte. |
| maptypechanged | Lancé lorsque le type de la carte a changé (carte/photo). |
| dragstart | Lancé dès que l'utilisateur commence a tirer la carte avec la souris. |
| dragend | Lancé dès que l'utilisateur relache la souris après avoir tiré la carte. |
| mouseclick | Lancé lorsque l'utilisatuer clique dans sur carte. |
| zoomstart | Lancé lorsque le zoom est activé. |
| zoomend | Lancé lorsque l'animation du zoom de la carte est terminée. |
| mapmove | Lancé constamment pendant que la carte est déplacée. |
Les gestionnaires d'événements son activés/déactives avec les méthodes suivantes. Un gestionnaire peut être une fonction globale ou une méthode d'un objet et contient comme seul argument un objet avec des propriété spécifique pour l'événement.
// Register an event-handler function
map.addEventListener("load", function(e){ alert(e.event); });
// Add and remove an object method as event-listener
function mapchanged(e) { [..] }
map.addEventListener("change", mapchanged);
map.removeEventListener("change", mapchanged);
default: Sélection des catégories POI selon le niveau de zoom| verkehr: | Trafic |
| zug | Train |
| haltestelle | Tram/bus |
| bergbahn | Télécabine |
| parking | Parking |
| viasuisse | Inforoute |
| velo | Vélos/E-Scooters |
| mobility | Mobility |
| gastro: | Gastronomie |
| bar | Bar |
| cafe | Café |
| hotel | Hôtel |
| restaurant | Restaurant |
| kultur: | Culture/loisirs |
| kino | Cinéma |
| museum | Musée |
| theater | Théâtre |
| tour | Excursions |
| feuerstelle | Foyer |
| spielplatz | Parc de jeux |
| bad | Piscine |
| camping | Terrain de camping |
| gebaeude: | Bâtiments publics |
| kirche | Église |
| polizei | Police |
| schule | École, uni |
| spital | Hôpital |
| verwaltung | Administration |
| service: | Shopping/service |
| apotheke | Pharmacie |
| geldautomat | Bancomat |
| post | Poste |
| shop | Magasin |
| tankstelle | Station-service |
| ladestation | Station de recharge voiture électrique |
| geo: | Geo |
| pass | Cols |
| wasserfall | Cascades |
| webcam | Webcam |
| wikipedia | Wikipedia |
Les catégories POI sont activées/déactivées comme suivant:
map.showPOIGroup("verkehr,bar,cafe,theater");
map.hidePOIGroup("mobility");
La classe représente un POI spécifique pour la carte interactive. Des instances peuvent être ajouté à l'objet map par la méthode addPOI() et ainsi être affiché sur la carte.
var Poi = new SearchChPOI({ center:[600000,200000], html:"Sternwarte Bern" });
map.addPOI(Poi);
Le constructeur nécessite un objet avec le paramètres suivants:
| Paramètre | Typ | Optionnel | Description |
| center | Mixed | non | Position du symbole. Chaîne de caractères avec adresse ou array avec coordonnées géografiques. Voir références géografiques pour davantage de détails. |
| html | String | non | Content de la fenêtre popup du POI. Du code HTML est permis. |
| title | String | oui | Titre de la fenêtre popup du POI |
| icon | String | oui | Lien URL du fichier de l'image qui sera utilisé comme symbole du POI |
| width | Integer | oui | Largeur du symbole du POI en pixel |
| height | Integer | oui | Hauteur du symbole du POI en pixel |
| enabled | Boolean | oui | L'info est affichée quand la souris passe sur un POI si la valeur est True (préréglage) |
| minzoom | Number | oui | Le POI n'est qu'affiché à partir du niveau de zoom défini (voir paramètre zoom de SearchChMap) |
| maxzoom | Number | oui | Le POI n'est au'affiché jusqu'au niveau de zoom défini |
| Methode | Valeur retournée | Description |
| set(Object p) | void | Met à jour les propriétés du symbole du POI. L'argument est un objet avec les paramètres identique au constructeur. |
| open() | void | Affiche la fenêtre popup avec le titre et le contenu HTML. Au cas où le POI ne se trouve pas dans l'extrait de la carte actuel, la carte est déplacée jusqu'à l'apparence du POI. |
| close() | void | Masque la fenêtre popup du POI |
| show() | void | Réaffiche le symbole du POI |
| hide() | void | Masque le symbole du POI sur la carte |
| destroy() | void | Enlève le POI de la carte et efface toutes références internes de l'objet |
| isVisible() | boolean | |
| addEventListener( String event, function callback) | void | Active un gestionnaire d'événements.
|
| removeEventListener( String event, function callback) | void | Déactive un gestionnaire d'événements. Les arguments identiques doivent être utilisés que lors de l'activation. |
| Evénement | Description |
| mouseover | Lancé dès que la souris passe sur un le symbole du POI. |
| mouseout | Lancé dès que la souris quitte à nouveau le symbole du POI. |
| mouseclick | Lancé dès que l'utilisateur clique sur un symbole du POI. |
| popupopen | Lancé quand la fenêtre popup est affichée. |
| popupclose | Lancé quand la fenêtre popup est masquée. |
Les gestionnaires d'événements sont activés/déactivés par l'objet avec les méthodes suivantes. Un gestionnaire peut être une fonction globale ou une méthode d'un objet. L'argument comporte un objet avec les caractères spécifique de l'événement.
Poi.addEventListener("popupopen", poiPopup);
Poi.removeEventListener("popupopen", poiPopup);
Au cas où l'API ne fonctionne pas selon vos besoins ou il vous manque des fonctionalités indispensables, n'hésitez pas à nous contacter.