Anleitung

Migrationsanleitung Autocomplete 5

Die Migrationsanleitung zeigt die Änderungen des Autocompletes auf und zeigt, was für die neue Version angepasst werden muss.

Loader

Dem serverseitigen Loader muss angeben werden, dass er das Autocomplete Modul in Version 5 lädt. Das geschieht, indem man beim Parameter libraries zusätzlich autocomplete-5 ergänzt.

https://www.yellowmap.de/api_rst/api/loader?libraries=free-3,autocomplete-5&apiKey={{API_KEY}}

Ready

Im Javascriptcode muss bei der ready-Funktion der Parameter { autocomplete: 5 } übergeben werden.

ym.ready({ autocomplete: 5 }, function (modules) {

Geänderte Parameter

Für das neue Autocomplete wurden diese Parameter umbenannt. Eine Übersicht über alle Parameter finden Sie unter Referenzen.

Alter Parameter	Geändert zu Parameter	Beschreibung
`locales`	`isoCountries`	Die Länder, in denen gesucht werden soll: Es wird ein Array mit beliebig vielen Ländercodes nach ISO-3166-2 übergeben. Wird der Parameter nicht übergeben, wird in allen unterstützten Ländern gesucht.
`onlyInGeoRect`	`inBoundingBox`	Zeigt nur Ergebnisse, die in dem Rechteck liegen, die beim Parameter boundingBoxBoost festgelegt wurden.

Rückgabetypen

Beim neuen Autocomplete gibt es die Rückgabentypen GeoJSON und JSON. Der Datentyp protobuf wurde eingestellt.

Das Autocomplete benutzt nicht mehr das Objekt location um die Daten der Adresse auszuliefern, sondern liefert Sie direkt in den properties.

Rückgabetyp: JSON vs GeoJSON

Alter Rückgabetyp: JSON Neuer Rückgabetyp: GeoJSON

Alter Rückgabetyp: JSON	Neuer Rückgabetyp: GeoJSON
`{ "properties": { "type": "yellowmaps", "displayValue": "Berlin, DE", "location": { "country": "DE", "district": "", "zip": "", "city": "Berlin", "cityAddOn": "", "cityPart": "", "street": "", "houseNo": "", "singleSlot": "" }, "searchData": { "location": { "singleSlot": "Berlin, DE" } } } }`	{ "type": "Feature", "geometry": { "type": "Point", "coordinates": [ 13.3888599, 52.5170365 ] }, "properties": { "Locale": null, "GeoEntityType": "CITY", "country": "Deutschland", "state": "Berlin", "neighbourhood": null, "district": null, "county": null, "city": "Berlin", "cityPart": null, "zip": null, "street": null, "village": null, "houseNo": null, "Geometry": { "Type": "Point", "Coordinates": [ 13.3888599, 52.5170365 ] }, "poi": null, "RepositoryScore": 1.3475391, "DisplayValue": "Berlin" } }


{








  "properties": {
    "type": "yellowmaps",
    "displayValue": "Berlin, DE",
    "location": {
      "country": "DE",
      "district": "",
      "zip": "",
      "city": "Berlin",
      "cityAddOn": "",
      "cityPart": "",
      "street": "",
      "houseNo": "",
      "singleSlot": ""
    },





    "searchData": {
      "location": {
        "singleSlot": "Berlin, DE"
      }
    }
  }
}


{
  "type": "Feature",
  "geometry": {
    "type": "Point",
    "coordinates": [
      13.3888599,
      52.5170365
    ]
  },
  "properties": {
    "Locale": null,
    "GeoEntityType": "CITY",
    "country": "Deutschland",
    "state": "Berlin",
    "neighbourhood": null,
    "district": null,
    "county": null,
    "city": "Berlin",
    "cityPart": null,
    "zip": null,
    "street": null,
    "village": null,
    "houseNo": null,
    "Geometry": {
      "Type": "Point",
      "Coordinates": [
        13.3888599,
        52.5170365
      ]
    },
    "poi": null,
    "RepositoryScore": 1.3475391,
    "DisplayValue": "Berlin"
  }
}