Topin Map API Klassenreferenz

Die Klassenrefenz beschreibt die öffentlichen Klassen der API und deren Methoden, die benötigt werden, um die Inhalte der Topin-Map einzubinden und zu steuern.

class TopinMap

Dies ist die Hauptklasse der API, von der Sie eine Instanz erzeugen müssen.

Constructor

Constructor Beschreibung
TopinMap(Mixed map, TopinMapOptions options?) map ist die ID eines HTML-Containers, der HTML-Container selbst oder eine Instanz eines google.maps.Map-Objects. options ist optional, siehe class TopinMapOptions. Wenn map eine Instanz eines google.maps.Map-Objects ist, werden alle Angaben in options ignoriert und alle Einstellungen der Instanz unverändert übernommen.

Methoden

Methode Return Beschreibung
enableDoubleClickZoom() none Entspricht Map.setOptions({disableDoubleClickZoom: false})
disableDoubleClickZoom() none Entspricht Map.setOptions({disableDoubleClickZoom: true})
doubleClickZoomEnabled() Boolean Entspricht Map.get('disableDoubleClickZoom')
enableScrollWheelZoom() none Entspricht Map.setOptions({scrollWheel: true})
disableScrollWheelZoom() none Entspricht Map.setOptions({scrollWheel: false})
scrollWheelZoomEnabled() Boolean Entspricht Map.get('scrollWheel')
setZoom(Number level) none Entspricht Map.setZoom(level)
getZoom() Number Entspricht Map.getZoom()
zoomIn() none Erhöht die Zoomstufe um 1.
zoomOut() none Verringert die Zoomstufe um 1.
checkResize() none Ist aufzurufen, wenn sich die Grösse des Containers geändert hat.
unload() none Gibt den von der Topin Map API verwendeten Speicher wieder frei.
enableControls(Array controls) none Lädt die im controls aufgelisteten Controls. Ein Liste der Controls und der Beschreibung finden Sie unter TopinMapOptions.
disableControls(Array controls) none Entfernt die in controls aufgelisteten Controls. Ein Liste der Controls und der Beschreibung finden Sie unter TopinMapOptions.
activateControl(String control) none Aktiviert das Control control. Ein Liste der Controls und der Beschreibung finden Sie unter TopinMapOptions.
deactivateControl(String control) none Deaktiviert das Control control. Ein Liste der Controls und der Beschreibung finden Sie unter TopinMapOptions.
setCenter(GLatLng center, Number zoom) none Entspricht Map.setCenter() gefolgt von Map.setZoom()
getCenter() LatLng Entspricht Map.getCenter()
setBounds(LatLngBounds bounds) none Stellt die Karte so ein, dass die gegebenen Bounds vollständig und so gross wie möglich in der Karte dargestellt werden.
getBounds() LatLngBounds Gibt die aktuellen Bounds der Karte zurück.
setMapType(String type) none Legt den aktuellen Kartentyp fest. Ein Liste der Verfügbaren Kartentypen finden Sie unter TopinMapOptions.
getMapType() String Gibt den aktuellen Kartentyp zurück.
selectPlatform(String platform, Function callback, Mixed params) none Lädt die Plattform platform. Wenn bereits eine andere Platform geladen ist, wird diese zuerst abgewählt. Sobald die Plattform geladen ist, wird callback aufgerufen. Die Signatur von callback ist function(Boolean res, Mixed params). res ist true wenn die Platform erfolgreich geladen wurde, false andernfalls. params wird unverändert durchgereicht. Wenn eine Plattform geladen wurde, kann die Sichtbarkeit der POIs mit showCategories und hideCategories gesteuert werden. Eine Liste der verfügbaren Plattformen finden Sie unter Plattformen und Kategorien.
unselectPlatform() String Wählt die aktuell geladene Plattform ab. Wenn noch POIs dieser Plattform auf der Karte angezeigt werden, werden diese entfernt. Gibt den Namen der abgewählten Plattform zurück.
getPlatform() String Gibt die aktuell ausgewählte Plattform zurück. Wenn aktuell keine Plattform ausgewählt ist, wird ein String der Länge 0 zurückgegeben.
showCategories(Array categories?) none Zeigt die POIs der aktuell geladenen Plattform an. Wird categories weggelassen, werden die POIs aller Kategorien angezeigt. Um nur bestimmte Kategorien anzuzeigen, geben Sie deren IDs in einem Array an. Eine Liste der verfügbaren Kategorien finden Sie unter Plattformen und Kategorien.
hideCategories(Array categories?) none Blendet die POIs der aktuell geladenen Plattform aus. Wird categories weggelassen, werden die POIs aller Kategorien ausgeblendet. Um nur bestimmte Kategorien auszublenden, geben Sie deren IDs in einem Array an. Eine Liste der verfügbaren Kategorien finden Sie unter Plattformen und Kategorien.
selectPoi(String poiid) GLatLng Sucht den POI mit der gegebenen ID in der aktuell geladenen Plattform, zeichnet einen roten Kreis um diesen und gibt dessen Koordinaten zurück. Ist bereits ein POI ausgewählt, wird dieser zuerst abgewählt. Wurde der POI mit der gegebenen ID nicht gefunden, wird null zurückgegeben.
unselectPoi() none Entfernt den roten Kreis um einen ausgewählten POI. Ist kein POI ausgewählt, passiert nichts.
getPermanentLink() String Gibt die URL auf http://map.topin.travel/ zurück, die dem aktuellen Zustand der Karte entspricht.
getMap() Map Gibt das verwendete Map-Object zurück.
addListener(String event, Function callback) Handle Interface zu google.maps.event.addListener und unterstützt die Events von Map.
removeListener(Handle handle) none Interface zu google.maps.event.removeListener.

class TopinMapOptions

Diese Klasse muss nicht instanziiert werden, sondern ist nur ein Object.

Attribute

Attribut Typ Beschreibung
center LatLng Der Punkt, der in der Mitte der Karte angezeigt werden soll.
zoom Number Der Zoomlevel, der verwendet werden soll. Der Bereich geht von 0 aufwärts. 0 ist am weitesten weg.
bounds LatLngBounds Der Bereich, der in der Karte angezeigt werden soll. Ist dieses Attribut vorhanden, werden die Attribute center und zoom ignoriert. Sind weder center, zoom noch bounds angegeben, wird die Schweiz in der Karte angezeigt.
type String Die Art der Karte. Folgende Kartentypen stehen zur Auswahl:
  • sat: Satellitenbilder
  • hybrid: Satellitenbilder plus Strassenkarte
  • street: Strassenkarte
  • topo: Reliefdarstellung
Wird dieses Attribut nicht angegeben, wird der Kartentyp topo verwendet.
controls Array Ein Array von den Controls, die auf der Karte eingeblendet werden sollen. Folgende Controls stehen zur Verfügung:
  • zoom: entspricht zoomControl
  • type: entspricht mapTypeControl
  • scale: entspricht scaleControl
  • pan: entspricht panControl
  • overview: entspricht overviewMapControl
  • rotate: entspricht rotateControl
  • streetview: entspricht streetViewControl
  • crosshair: zeichnet ein kleines Fadenkreuz in der Mitte der Karte
  • coords: zeigt die aktuelle Position in der rechten oberen Ecke der Karte an
  • loading: zeigt eine Lade-Animation, während die POIs einer Platform geladen werden
  • platforms: listet alle verfügbaren Plattformen in einem Dropdown auf. Kann (de)aktivert werden. Default: deaktivert
  • categories: listet alle verfügbaren Kategorien von der ausgewählten Plattform in einem Dropdown auf. Kann (de)aktivert werden. Default: deaktivert
Es stehen auch spezielle Controls zur Verfügung, die mehrere von den oben genannten zusammenfassen:
  • default: beinhaltet: zoom, pan, type, loading und crosshair
  • all: beinhaltet alle oben genannten Controls
Wird dieses Attribut nicht angegeben, wird das Control default verwendet.

Plattformen und Kategorien

Diese Plattformen und Kategorien stehen mit der Topin Map API zur Verfügung.

Plattformen

Plattform Beschreibung
webcams Alle Webcams von Swisswebcams.ch.
ausflugsziele Alle Einträge von Topin Ausflüge und Ferien.
touren Alle Einträge von Topin Touren.
gastro Alle Einträge von Topin Gastro-Tipps.
groups Alle Einträge von Topin Gruppenunterkünfte.
feuerstellen Alle Feuerstellen der Schweizer Familie.
camping Alle Camping-Pl6Auml;tze von camping.ch.
events Alle anstehenden Veranstaltungen von myswitzerland.com.