Třída SMap.Suggest
Našeptávač pro Mapy.
Posílá tyto signály:
- open - - otevření našeptávače
- close - - zavření našeptávače
- request - - byl poslán request s aktuální frází
- request-items - (Array[]) - vrací pole s aktuálními daty pro našeptávač
- enter - ({ event, phrase }) - v inputu byl zmáčknut enter, nebyla vybrána položka z našeptávače
- suggest - ({ phrase, prevPhrase, data, position, limit }) - byla vybrána položka z našeptávače
Atributy konstruktoru | Název a popis kontruktoru |
---|---|
SMap.Suggest(input, options)
|
Atributy metody | Jméno a popis metody |
---|---|
urlParams(data)
Funkce pro upravu url parametru.
|
|
updateParams(cb)
Vlastní funkce pro obohacení parametrů pro request našeptávače
|
|
dataParams(data)
Pomocna funkce pro nastaveni dat ze suggestu.
|
|
map(map)
Nastaveni - bind mapy.
|
|
abort()
Zrušení requestu.
|
|
addListener(name, cb, scope)
Přidání posluchače signálu.
|
|
removeListener(name, cb, scope)
Odstranění posluchače signálu.
|
|
destroy()
Odstranění našeptávače.
|
|
open()
Zobrazení našeptávače.
|
|
close()
Zavření našeptávače.
|
|
Odstranění všech položek našeptávače.
|
|
send()
Zobrazení našeptávače pro danou frázi ve vstupním inputu.
|
|
Získání fráze ze vstupního inputu.
|
|
Získání provideru.
|
|
isActive()
Je našeptávač aktivní (otevřený)
|
Konstruktor - detail
SMap.Suggest(input, options)
Vytvoření našeptávače - je potřeba zadat vstupní input a volitelné parametry.
- Parametry:
- {Element} input
- Input type text
- {Object} options volitelný
- {function} options.factory volitelný
- Vlastní funkce, která bude naplňovat položky našeptávače (data, pos)
- {function} options.provider volitelný, výchozí: null
- OBSOLETE: Vlastní provider, který bude získávat data pro našeptávač
- {Number} options.delay volitelný, výchozí: 400
- Spoždění pro zobrazení našeptávače
- {Boolean} options.infinite volitelný, výchozí: true
- Procházet položky našeptávače cyklicky
- {String} options.url volitelný
- Url pro stažení dat našeptávače
- {String} options.poiaggUrl volitelný
- Url pro stažení ikonek do našeptávače
- {SMap} options.map volitelný
- Bind mapy, takže se pro každé volání suggestu pak spočítají bounds a zoom podle viewportu
- {function} options.updateParams volitelný
- Vlastní funkce pro obohacení parametrů pro request našeptávače (params)
- {function} options.dataParams volitelný
- Vlastní funkce pro obohacení parametrů pro data jedné položky našeptávače (data, requestItem)
- {String} options.abTest volitelný
- Název testu pro AB testování
Metody - detailně
urlParams(data)
Funkce pro upravu url parametru.
- Parametry:
- {Object} data
- objekt s definici hodnot pro url, viz. nize
- {Integer} data.limit volitelný, výchozí: 5
- maximalni pocet vysledku, default 5, max 100
- {Integer} data.count volitelný
- maximalni pocet vysledku, stejne jako limit
- {String} data.category volitelný
- id kategorii, ze kterych se naseptava, oddelene carkou, priklad "region_cz,district_cz", default jsou vsechny hodnoty; povolene hodnoty: address_cz, address_sk, area_cz(obsahuje sk i cz), area_osm, country_cz, country_sk, country_osm, district_cz, district_sk, district_osm, municipality_cz, municipality_sk, municipality_osm, quarter_cz, quarter_sk, region_cz, region_sk, region_osm, street_cz, street_sk, street_osm, ward_osm, ward_cz, ward_cz, traffic_cz(zastavky pouze cz), trafficpoi_cz(km dalnic, parkoviste, cz i sk), poi_cz, poi_sk, poi_osm, place_osm
- {String} data.type volitelný
- typy vysledku, ktere se maji naseptat, oddelene |, priklad "municipality|street"; povolene hodnoty: country - staty, municipality - mesta, street - ulice, address - adresni body, poi - body zajmu, pubt - zastavky a specialni: region (jen seznam DB, bez osm)
- {String} data.subtype volitelný
- pro planovac nema smysl naseptavat a hledat vsechny area typy, chceme nechat pouze ty z vyctu, priklad "small_area"
- {String} data.locality volitelný
- omezeni na mesta a zeme dle ISO kodu, priklad "Praha|cz"
- {String} data.pos volitelný
- pozice ke ktere vyhledavat, zadane jako string "lat,lon" kde lat i lon jsou desetinna cisla
- {String} data.lon, data.lat volitelný
- parametry k zadani pozice, ke ktere vyhledavat. Oba jsou float. Pozor, pri zadání bboxu (parametry fromLatitude,toLatitude,fromLongitude a toLongitude) se hodnoty parametru lat a lon ignoruji
- {Float} data.fromLatitude, data.toLatitude, data.fromLongitude, data.toLongitude volitelný
- parametry k zadani pozice, ke ktere vyhledavat. Vsechny jsou float. Maji prednost pred lat, lon
- {Integer} data.zoom volitelný
- preferovane priblizeni, povolene hodnoty v rozsahu 2 - 20. Vetsi priblizeni posiluje lokalni vysledky
- {String} data.bounds volitelný
- oblast, ze ktere preferujeme vysledky, skladani "SW LAT,LON|NE LAT,LON", priklad: "34.172684,-118.604794|34.236144,-118.500938"
- {Number} data.pubtBoost volitelný
- 1 zvetsi vahu zastavek, default vypnuto
- {Number} data.enableCategories volitelný
- 1 naseptava i kategorie, default 0
- {String} data.lang volitelný
- preferovane jazyky pro vysledky, povolene hodnoty en,cs,de,pl,sk,ru,es,fr, priklad "cs,en"
- {String} data.langFilter volitelný
- povolene jazyky pro vysledky, povolene hodnoty native,en,cs,de,pl,sk,ru,es,fr, priklad "native,cs"
updateParams(cb)
Vlastní funkce pro obohacení parametrů pro request našeptávače
- Parametry:
- {function} cb
- Funkce, kde prvním argumentem je objekt pro vytvoření URL (params)
dataParams(data)
Pomocna funkce pro nastaveni dat ze suggestu.
- Parametry:
- {Object} data
- Nove hodnoty pro upravu url.
map(map)
Nastaveni - bind mapy.
- Parametry:
- {SMap} map
- Instance mapy
abort()
Zrušení requestu.
addListener(name, cb, scope)
Přidání posluchače signálu.
- Parametry:
- {String} name
- Jméno signálu
- {function} cb
- Callback funkce
- {Object} scope volitelný
- Vlastní scope pro funkci
removeListener(name, cb, scope)
Odstranění posluchače signálu.
- Parametry:
- {String} name
- Jméno signálu
- {function} cb
- Callback funkce
- {Object} scope volitelný
- Vlastní scope pro funkci
destroy()
Odstranění našeptávače.
open()
Zobrazení našeptávače.
close()
Zavření našeptávače.
clearItems()
Odstranění všech položek našeptávače.
send()
Zobrazení našeptávače pro danou frázi ve vstupním inputu.
handleEvent()
{String}
getPhrase()
Získání fráze ze vstupního inputu.
- Vrací:
- {String}
{Object}
getProvider()
Získání provideru.
- Vrací:
- {Object}
{Boolean}
isActive()
Je našeptávač aktivní (otevřený)
- Vrací:
- {Boolean}