SearchPostSearchInsideGeometryOptionalParams interface

Pakiet:

azure-maps-rest

Parametry opcjonalne.

Extends

RequestOptionsBase

Właściwości

extendedPostalCodesFor	Indeksy, dla których należy uwzględnić rozszerzone kody pocztowe w wynikach. Dostępne indeksy to: Addr = zakresy adresów Geo = Geografie PAD = adresy punktów POI = punkty orientacyjne Str = ulice XStr = Cross Streets (skrzyżowania) Wartość powinna być rozdzielaną przecinkami listą typów indeksów (w dowolnej kolejności) lub Brak dla żadnych indeksów. Domyślnie rozszerzone kody pocztowe są uwzględniane dla wszystkich indeksów z wyjątkiem geo. Rozszerzone listy kodów pocztowych dla lokalizacji geograficznych mogą być dość długie, więc w razie potrzeby muszą być jawnie żądane. Przykłady użycia: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Rozszerzony kod pocztowy jest zwracany jako właściwość extendedPostalCode adresu. Dostępność jest zależna od regionu.
idxSet	Rozdzielona przecinkami lista indeksów, które powinny być używane do wyszukiwania. Kolejność elementów nie ma znaczenia. Dostępne indeksy to: Addr = Interpolacja zakresu adresów, Geo = Geographies, PAD = Point Address, POI = Punkty orientacyjne, Str = Streets, Xstr = Cross Streets (skrzyżowania)
language	Język, w którym powinny być zwracane wyniki wyszukiwania. Powinien być jednym z obsługiwanych tagów języka IETF, bez uwzględniania wielkości liter. Gdy dane w określonym języku nie są dostępne dla określonego pola, używany jest język domyślny. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane języki .
limit	Maksymalna liczba odpowiedzi, które zostaną zwrócone. Wartość domyślna: 10, minimalna: 1 i maksymalna: 100
openingHours	Godziny otwarcia punktu zakupu (punkty orientacyjne). Dostępność godzin otwarcia zależy od dostępnych danych. Możliwe wartości to: "nextSevenDays"
view	Parametr Widok określa, który zestaw geopolitycznie spornej zawartości jest zwracany za pośrednictwem usług Azure Maps, w tym obramowań i etykiet wyświetlanych na mapie. Parametr View (nazywany również "parametrem regionu użytkownika") pokaże poprawne mapy dla tego kraju/regionu. Domyślnie parametr Widok jest ustawiony na "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru View dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z tymi dotyczącymi mapowania, kraju, w którym są udostępniane mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem Azure Maps. Przykład: view=IN. Aby uzyskać szczegółowe informacje, zapoznaj się z tematem Obsługiwane widoki i zobacz dostępne widoki.

Właściwości dziedziczone

abortSignal	Sygnał, który może służyć do przerwania żądań.
customHeaders	{object} [customHeaders] Niestandardowe nagłówki żądań zdefiniowane przez użytkownika, które będą stosowane przed wysłaniem żądania.
onDownloadProgress	Wywołanie zwrotne uruchamiane po postępie pobierania.
onUploadProgress	Wywołanie zwrotne uruchamiane po postępie przekazywania.
timeout	Liczba milisekund, które żądanie może potrwać przed automatycznym zakończeniem.

Szczegóły właściwości

extendedPostalCodesFor

Indeksy, dla których należy uwzględnić rozszerzone kody pocztowe w wynikach. Dostępne indeksy to:

Addr = zakresy adresów

Geo = Geografie

PAD = adresy punktów

POI = punkty orientacyjne

Str = ulice

XStr = Cross Streets (skrzyżowania)

Wartość powinna być rozdzielaną przecinkami listą typów indeksów (w dowolnej kolejności) lub Brak dla żadnych indeksów.

Domyślnie rozszerzone kody pocztowe są uwzględniane dla wszystkich indeksów z wyjątkiem geo. Rozszerzone listy kodów pocztowych dla lokalizacji geograficznych mogą być dość długie, więc w razie potrzeby muszą być jawnie żądane.

Przykłady użycia:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Rozszerzony kod pocztowy jest zwracany jako właściwość extendedPostalCode adresu. Dostępność jest zależna od regionu.

extendedPostalCodesFor?: string

Wartość właściwości

string

idxSet

Rozdzielona przecinkami lista indeksów, które powinny być używane do wyszukiwania. Kolejność elementów nie ma znaczenia. Dostępne indeksy to: Addr = Interpolacja zakresu adresów, Geo = Geographies, PAD = Point Address, POI = Punkty orientacyjne, Str = Streets, Xstr = Cross Streets (skrzyżowania)

idxSet?: SearchIndexSet[]

Wartość właściwości

SearchIndexSet[]

language

Język, w którym powinny być zwracane wyniki wyszukiwania. Powinien być jednym z obsługiwanych tagów języka IETF, bez uwzględniania wielkości liter. Gdy dane w określonym języku nie są dostępne dla określonego pola, używany jest język domyślny. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane języki .

language?: string

Wartość właściwości

string

limit

Maksymalna liczba odpowiedzi, które zostaną zwrócone. Wartość domyślna: 10, minimalna: 1 i maksymalna: 100

limit?: number

Wartość właściwości

number

openingHours

Godziny otwarcia punktu zakupu (punkty orientacyjne). Dostępność godzin otwarcia zależy od dostępnych danych. Możliwe wartości to: "nextSevenDays"

openingHours?: OpeningHours

Wartość właściwości

OpeningHours

view

Parametr Widok określa, który zestaw geopolitycznie spornej zawartości jest zwracany za pośrednictwem usług Azure Maps, w tym obramowań i etykiet wyświetlanych na mapie. Parametr View (nazywany również "parametrem regionu użytkownika") pokaże poprawne mapy dla tego kraju/regionu. Domyślnie parametr Widok jest ustawiony na "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru View dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z tymi dotyczącymi mapowania, kraju, w którym są udostępniane mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem Azure Maps. Przykład: view=IN. Aby uzyskać szczegółowe informacje, zapoznaj się z tematem Obsługiwane widoki i zobacz dostępne widoki.

view?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

abortSignal

Sygnał, który może służyć do przerwania żądań.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

Dziedziczone z RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Niestandardowe nagłówki żądań zdefiniowane przez użytkownika, które będą stosowane przed wysłaniem żądania.

customHeaders?: [key: string]: string

Wartość właściwości

[key: string]: string

Dziedziczone z RequestOptionsBase.customHeaders

onDownloadProgress

Wywołanie zwrotne uruchamiane po postępie pobierania.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

Dziedziczone z RequestOptionsBase.onDownloadProgress

onUploadProgress

Wywołanie zwrotne uruchamiane po postępie przekazywania.

onUploadProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

Dziedziczone z RequestOptionsBase.onUploadProgress

timeout

Liczba milisekund, które żądanie może potrwać przed automatycznym zakończeniem.

timeout?: number

Wartość właściwości

number

Dziedziczone z RequestOptionsBase.timeout