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.
class SearchChMap
C'est la classe principale de la carte et doit être instanciée dans votre page HTML.
Konstruktor
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. |
| type | String | oui | aerial | Type de carte photo ou carte |
| zoom | Number | oui | auto | Niveau de zoom. Valeurs possibles: 512,128,32,8,4,2,1,0.5,0.25
Correspon au nombre de mètres par pixel, est aroundi au niveau le plus proche si necessaire. |
| controls | String | oui | default | Elemnts de contrôle et visualisation dans la carte (en tant que chaîne de caractères séparés par virgule):
default: Sélection de préréglage pour les éléments de contrôle.
zoom: Contrôle de zoom
type: Commutateur pour type de carte (photo, carte)
pan: Flèches de décalage de la carte
ruler: Echelle en bas à droite
ou chaîne de caractères "all" |
| enable | String | oui | dragging,clickzoom,pois | Modes de contrôle pour la carte interactive par chaîne de caractères (séparés par virgule):
dragging: Déplacer la carte avec la souris
clickzoom: Zoom avant par clic avec la souris de gauche, zoom arrière avec la souris de droite
mousewheel: Déplacer la carte avec la molette de la souris
keyboard: Contrôle par clavier avec les touches de flèches et +/-
pois: Afficher l'info quand la souris passe au-dessus d'un POI
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". |
| circle | Boolean | oui | auto | Contrôle afin d'afficher le centre de la carte avec un cercle rouge (si l'adresse est suffisamment précise). |
| autoload | Boolean | oui | true | Sie True la carte démarre automatiquement dès que la page est chargée (onload). Si le paramètre est mis sur False, la carte doit être initialisée manuellement avec init(). |
| autoresize | Boolean | oui | true | Détecte un changement de la grandeur du conteneur automatiquement. Si le paramètre est mis sur False, des changements doivent être transmis à l'objet de la carte avec la fonction resized(). |
Méthodes d'objet
| 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) ou d'une value défini (dx/dy). L'argument est un objet avec les paramètres suivants:
center: Référence géografique du nouveau centre
zoom: Nouveau niveau de zoom (optionnel). Voir les paramètres du constructeur pour les valeurs valables.
dx: Déplacement horizontal et relatif (en pixel)
dy: Déplacement vertical et relatif (en pixel)
circle: Contrôle afin d'afficher le centre de la carte avec un cercle rouge (Boolean)
Pour les paramètres dx und dy des valeurs négatives sont possibles. Des valeurs entre 0 et 1 sont interprétées comme fraction de la hauteur/largeur actuelle de la carte.
|
| 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. |
| enable(String what) | void | Activer un mode de contrôle. Une liste avec des valeurs séparées par virgule est utilisée comme argument. Voir paramètre enable du constructeur. |
| disable(String what) | void | Déactiver un mode de contrôle. Argument comme enable(). |
| 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 d'envoi par e-mail ("email") peuvent être générés. |
addEventListener(
String event, mixed func[, Object obj]) | void | Associé un gestionnaire d'événement.
event: Nom de l'événement. Voir list suivante.
func: Référence d'une fonction globale ou d'une chaîne de caractères avec le nom de la méthode de l'obj.
obj: Object dont la méthode func est executée en tant que gestionnaire d'événement.
|
removeEventListener(
String event, mixed func[, Object obj]) | 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. |
| init() | void | Initialisation manuelle de la carte. Doit être executé si autoload est False. |
Events
| 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. |
| panstart | Lancé dès que la carte se déplace, p.ex. en utilisant les flèches de déplacement ou le clavier, mais pas en tirant la carte avec la souris. |
| panend | Lancé lorsque le déplacement de la carte est terminé. |
| 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. |
| geoposition | Fournit des informations sur la précision du centre de la carte. Argument contient les propriétés suivantes:type: type/précision de la référence géographique; valeurs possibles: point,street,city,place,area
score: évaluation du résultat
100: unique
90: interpolé
80: plusieurs résultats
70: plus de 8 résultats
6x: donnée corrigée
50: numéro de maison ignoré
40: seulement localité
0: aucun résultat
error: Message d'erreur (optionnel) |
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
Map.addEventListener("change", "mapchanged", MyObj);
Map.removeEventListener("change", "mapchanged", MyObj);
Catégories et groupement POI
default: Sélection des catégories POI selon le niveau de zoom
| verkehr: |
Trafic |
| bergbahn |
Télécabine |
| parkhaus |
Parking couvert |
| haltestelle |
Tram/bus |
| zug |
Train |
| viasuisse |
Inforoute |
| gastro: |
Gastronomie |
| bar |
Bar |
| cafe |
Café |
| hotel |
Hôtel |
| restaurant |
Restaurant |
| kultur: |
Culture/loisir |
| kino |
Cinéma |
| museum |
Musée |
| theater |
Théâtre |
| tour |
Excursions |
| feuerstelle |
Foyer |
| spielplatz |
Parc de jeux |
| bad |
Piscine |
| gebaeude: |
Bâtiments publics |
| kirche |
Église |
| polizei |
Police |
| schule |
École, uni |
| spital |
Hôpital |
| verwaltung |
Administration |
| service: |
Shopping/service |
| apotheke |
Pharmacie |
| geldautomat |
Billetterie |
| post |
Poste |
| shop |
Magasin |
| tankstelle |
Station-service |
| geo: |
Geo/Météo |
| berg |
Montagnes |
| pass |
Cols |
| wasserfall |
Cascades |
| webcam |
Webcam |
| meteoradar |
Radar météo |
| wikipedia |
Wikipedia |
Les catégories POI sont activées/déactivées comme suivant:
Map.showPOIGroup("verkehr,bar,cafe,theater");
Map.hidePOIGroup("mobility");
class SearchChPOI
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.
Constructeur
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 |
Méthodes de l'objet
| 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, mixed func[, Object obj]) | void | Active un gestionnaire d'événements.
event: Nom de l'événement. Voir la liste ci-dessous.
func: Référence d'une fonction globale ou d'une chaîne de caractères avec le nom de la méthode obj.
obj: Objet dont la méthode func est activée en tant que gestionnaire d'événements.
|
removeEventListener(
String event, mixed func[, Object obj]) | void | Déactive un gestionnaire d'événements. Les arguments identiques doivent être utilisés que lors de l'activation. |
Evénements
| 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. |
| geoposition | Fournit des informations sur la précision de la position POI.
Les propriétés de l'événement sont les mêmes que chez geoposition de SearchChMap |
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", MyObj);
Poi.removeEventListener("popupopen", "poiPopup", MyObj);
Avez-vous plus de questions?
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.
|
Partager sur Facebook | Plus: Immobilier Cinéma Guide TV ... | Conditions | Publicité | Contact