ym.modules.autoComplete V5

Initialisierung

Codebeispiel: Initialisierung Autocomplete

// Pass version of AutoComplete
ym.ready({ autocomplete: 5 }, function (modules) {
    var autocomplete1 = new ym.modules.AutoComplete('#autocomplete1', {
        onSelected: function (geoJson) {
            geocoder.geocode(geoJson.properties.location);
        }
    });

    // Use the factory method to create the instance.
    var autocomplete2 = ym.modules.autoComplete('#autocomplete2', {
        onSelected: function (geoJson) {
            geocoder.geocode(geoJson.properties.location);
        }
    });
});

Constructor(selector, settings)

• Parameter: selector
  Im Parameter selector kann ein CSS3-Selector übergeben werden, der dem Eingabefeld des Autocomplete hinzugefügt wird.

• Parameter: settings
  Die übergebenen Parameter können nachträglich angepasst werden, indem auf die Variable options des Autocomplete-Objekts zugegriffen und die einzelnen Variablen geändert werden. Die nächste Suche verwendet dann die geänderten Parameter.

Methoden

• update()
  Löst eine neue Suchanfrage aus und öffnet anschließend die Ergebnisliste.

• updateMap()
  Aktualisiert die Bounding Box der Karte und erzwingt die Neuberechnung von Mittelpunkt und Radius.

• fetch(query: string)
  Ruft die Ergebnisliste ab und gibt sie als GeoJSON zurück.

• open()
  Wenn Vorschläge vorhanden sind, wird die Ergebnisliste sofort geöffnet.

• close()
  Schließt die Vorschlagsliste sofort.

• setMap(map: ym.Map)
  Registriert eine Karte für die Autocomplete-Suche. Ist die Karte im Autocomplete registriert, wird das Rechteck des Kartenausschnitts automatisch als Suchbereich für die Suche verwendet.

• removeMap()
  Entfernt die registrierte Karte aus der Autocomplete-Suche. Durch das Entfernen der Karte entfällt die lokale Einschränkung.

• setCenter(latlng: ym.LatLng, radius?: number)
  Definiert anhand des in den options gesetzten Radius einen Suchbereich, in dem die Suchanfrage ausgeführt werden soll.

• getCenter()
  Sofern vorhanden, wird ein LatLng-Objekt zurückgegeben, das den Mittelpunkt des Suchrechtecks definiert. Ist kein Suchrechteck definiert, wird undefined zurückgegeben.

• setBounds(latlngBounds: ym.LatLngBounds)
  Definiert einen Suchbereich anhand eines Suchrechtecks.

• getBounds()
  Sofern vorhanden, wird ein LatLngBounds-Objekt zurückgegeben, das das Suchrechteck definiert. Ist kein Suchrechteck definiert, wird undefined zurückgegeben.

• whenReady()
  Argument: onReady: (error?: Error) => void Führt einen onReady-Callback aus, nachdem die Autocomplete-Komponente bereit ist.
  Rückgabe: Promise Gibt ein Promise zurück, nachdem die Autocomplete-Komponente bereit ist.

Events

CSS-Variablen

Das Design von Autocomplete kann über CSS-Variablen konfiguriert werden. Dazu müssen sie in der :root-Pseudoklasse definiert werden. Vom Internet Explorer nicht unterstützt.