SearchGetSearchAddressOptionalParams interface

Balíček:

azure-maps-rest

Volitelné parametry.

Extends

RequestOptionsBase

Vlastnosti

btmRight	Umístění pravého dolního ohraničujícího rámečku Např. 37,553,-122,453
countrySet	Řetězec kódů zemí oddělený čárkami, např. FR, ES. Tím se hledání omezí na zadané země.
extendedPostalCodesFor	Indexy, jejichž rozšířená POŠTOVNÍ SMĚROVACÍ ČÍSLA by měla být zahrnuta do výsledků. Dostupné indexy jsou: Addr = Rozsahy adres Geografická oblast = zeměpisné oblasti PAD = Point Addresses POI = body zájmu Str = Ulice XStr = křížení ulic (křižovatky) Hodnota by měla být čárkami oddělený seznam typů indexů (v libovolném pořadí) nebo žádný pro žádné indexy. Ve výchozím nastavení jsou rozšířená PSČ zahrnuta pro všechny indexy s výjimkou geografické oblasti. Rozšířené seznamy PSČ pro geografické oblasti můžou být poměrně dlouhé, takže je potřeba je explicitně vyžádat, když je to potřeba. Příklady použití: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Rozšířené PSČ se vrátí jako vlastnost extendedPostalCode adresy. Dostupnost závisí na oblasti.
language	Jazyk, ve kterém se mají vrátit výsledky hledání. Měl by být jednou z podporovaných značek jazyka IETF, nerozlišují se malá a velká písmena. Pokud data v zadaném jazyce nejsou pro konkrétní pole k dispozici, použije se výchozí jazyk. Podrobnosti najdete v části Podporované jazyky .
lat	Zeměpisná šířka, kde by výsledky měly být zkreslené. Např. 37,337
limit	Maximální počet odpovědí, které budou vráceny. Výchozí hodnota: 10, minimum: 1 a maximum: 100
lon	Zeměpisná délka, kde by výsledky měly být zkreslené. Například -121,89
ofs	Počáteční posun vrácených výsledků v rámci celé sady výsledků.
radius	Poloměr v metrech k pro výsledky, které mají být omezeny na definovanou oblast
topLeft	Levá horní pozice ohraničujícího rámečku. Např. 37,553,-122,453
typeahead	Boolean. Pokud je nastaven příznak hlavičky typeahead, dotaz se interpretuje jako částečný vstup a hledání přejde do prediktivního režimu.
view	Parametr View určuje, která sada geopoliticky sporného obsahu se vrátí prostřednictvím Azure Maps služeb, včetně ohraničení a popisků zobrazených na mapě. Parametr View (označovaný také jako parametr oblasti uživatele) zobrazí správné mapy pro danou zemi nebo oblast. Ve výchozím nastavení je parametr View nastavený na "Unified" i v případě, že jste ho v požadavku nedefinovali. Je na vás, abyste určili umístění uživatelů a pak pro toto umístění správně nastavili parametr View. Alternativně můžete nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazit v Azure Maps musí být použit v souladu s platnými zákony, včetně těch týkajících se mapování, země, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps. Příklad: view=IN. Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení.

Zděděné vlastnosti

abortSignal	Signál, který lze použít k přerušení požadavků.
customHeaders	{object} [customHeaders] Vlastní hlavičky požadavků definované uživatelem, které se použijí před odesláním požadavku.
onDownloadProgress	Zpětné volání, které se aktivuje při stahování.
onUploadProgress	Zpětné volání, které se aktivuje při průběhu nahrávání.
timeout	Počet milisekund, které může požadavek trvat, než se automaticky ukončí.

Podrobnosti vlastnosti

btmRight

Umístění pravého dolního ohraničujícího rámečku Např. 37,553,-122,453

btmRight?: string

Hodnota vlastnosti

string

countrySet

Řetězec kódů zemí oddělený čárkami, např. FR, ES. Tím se hledání omezí na zadané země.

countrySet?: string[]

Hodnota vlastnosti

string[]

extendedPostalCodesFor

Indexy, jejichž rozšířená POŠTOVNÍ SMĚROVACÍ ČÍSLA by měla být zahrnuta do výsledků. Dostupné indexy jsou:

Addr = Rozsahy adres

Geografická oblast = zeměpisné oblasti

PAD = Point Addresses

POI = body zájmu

Str = Ulice

XStr = křížení ulic (křižovatky)

Hodnota by měla být čárkami oddělený seznam typů indexů (v libovolném pořadí) nebo žádný pro žádné indexy.

Ve výchozím nastavení jsou rozšířená PSČ zahrnuta pro všechny indexy s výjimkou geografické oblasti. Rozšířené seznamy PSČ pro geografické oblasti můžou být poměrně dlouhé, takže je potřeba je explicitně vyžádat, když je to potřeba.

Příklady použití:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Rozšířené PSČ se vrátí jako vlastnost extendedPostalCode adresy. Dostupnost závisí na oblasti.

extendedPostalCodesFor?: string

Hodnota vlastnosti

string

language

Jazyk, ve kterém se mají vrátit výsledky hledání. Měl by být jednou z podporovaných značek jazyka IETF, nerozlišují se malá a velká písmena. Pokud data v zadaném jazyce nejsou pro konkrétní pole k dispozici, použije se výchozí jazyk. Podrobnosti najdete v části Podporované jazyky .

language?: string

Hodnota vlastnosti

string

lat

Zeměpisná šířka, kde by výsledky měly být zkreslené. Např. 37,337

lat?: number

Hodnota vlastnosti

number

limit

Maximální počet odpovědí, které budou vráceny. Výchozí hodnota: 10, minimum: 1 a maximum: 100

limit?: number

Hodnota vlastnosti

number

lon

Zeměpisná délka, kde by výsledky měly být zkreslené. Například -121,89

lon?: number

Hodnota vlastnosti

number

ofs

Počáteční posun vrácených výsledků v rámci celé sady výsledků.

ofs?: number

Hodnota vlastnosti

number

radius

Poloměr v metrech k pro výsledky, které mají být omezeny na definovanou oblast

radius?: number

Hodnota vlastnosti

number

topLeft

Levá horní pozice ohraničujícího rámečku. Např. 37,553,-122,453

topLeft?: string

Hodnota vlastnosti

string

typeahead

Boolean. Pokud je nastaven příznak hlavičky typeahead, dotaz se interpretuje jako částečný vstup a hledání přejde do prediktivního režimu.

typeahead?: boolean

Hodnota vlastnosti

boolean

view

Parametr View určuje, která sada geopoliticky sporného obsahu se vrátí prostřednictvím Azure Maps služeb, včetně ohraničení a popisků zobrazených na mapě. Parametr View (označovaný také jako parametr oblasti uživatele) zobrazí správné mapy pro danou zemi nebo oblast. Ve výchozím nastavení je parametr View nastavený na "Unified" i v případě, že jste ho v požadavku nedefinovali. Je na vás, abyste určili umístění uživatelů a pak pro toto umístění správně nastavili parametr View. Alternativně můžete nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazit v Azure Maps musí být použit v souladu s platnými zákony, včetně těch týkajících se mapování, země, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps. Příklad: view=IN. Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení.

view?: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

abortSignal

Signál, který lze použít k přerušení požadavků.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

Zděděno z RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Vlastní hlavičky požadavků definované uživatelem, které se použijí před odesláním požadavku.

customHeaders?: [key: string]: string

Hodnota vlastnosti

[key: string]: string

Zděděno z RequestOptionsBase.customHeaders

onDownloadProgress

Zpětné volání, které se aktivuje při stahování.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

Zděděno z RequestOptionsBase.onDownloadProgress

onUploadProgress

Zpětné volání, které se aktivuje při průběhu nahrávání.

onUploadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

Zděděno z RequestOptionsBase.onUploadProgress

timeout

Počet milisekund, které může požadavek trvat, než se automaticky ukončí.

timeout?: number

Hodnota vlastnosti

number

Zděděno z RequestOptionsBase.timeout