Třída SMap.SuggestProvider
Data pro našeptávač
Atributy konstruktoru | Název a popis kontruktoru |
---|---|
SMap.SuggestProvider(options)
|
Atributy metody | Jméno a popis metody |
---|---|
suggestSet(suggestOpts)
Nastaveni ze suggestu pro zpetnou kombalitu.
|
|
get(phrase)
Funkce vrací promise s daty pro našeptávač.
|
|
abort()
Zrušení requestu.
|
|
getLimit()
Získání limitu - počtu položek našeptávače pro zobrazení/stažení
|
|
urlParams(data)
Pomocna funkce pro nastaveni dat ze suggestu.
|
|
updateParams(cb)
Vlastní funkce pro obohacení parametrů pro request našeptávače
|
|
dataParams(data)
Pomocna funkce pro nastaveni dat ze suggestu.
|
Konstruktor - detail
SMap.SuggestProvider(options)
Vytvoření provideru pro zajištění dat našeptávače.
- Parametry:
- {Object} options volitelný
- {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
- {Number} options.limit volitelný, výchozí: 5
- Kolik položek se bude stahovat/zobrazovat
- {function} options.updateParams volitelný
- Vlastní funkce pro obohacení parametrů pro request našeptávače
- {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ě
suggestSet(suggestOpts)
Nastaveni ze suggestu pro zpetnou kombalitu.
- Parametry:
- {Object} suggestOpts
- Nastaveni
{JAK.Promise}
get(phrase)
Funkce vrací promise s daty pro našeptávač.
- Parametry:
- {String} phrase
- Hledaná fráze
- Vrací:
- {JAK.Promise}
abort()
Zrušení requestu.
{Number}
getLimit()
Získání limitu - počtu položek našeptávače pro zobrazení/stažení
- Vrací:
- {Number}
urlParams(data)
Pomocna funkce pro nastaveni dat ze suggestu.
- Parametry:
- {Object} data
- Nove hodnoty pro upravu url.
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
dataParams(data)
Pomocna funkce pro nastaveni dat ze suggestu.
- Parametry:
- {Object} data
- Nove hodnoty pro upravu url.