SearchInsideGeometryOptions interface
Opcje wyszukiwania wewnątrz geometrii
- Rozszerzenie
Właściwości
| extended |
Indeksy, dla których należy uwzględnić rozszerzone kody pocztowe w wynikach |
| index |
Rozdzielona przecinkami lista indeksów, które powinny być używane do wyszukiwania. Kolejność elementów nie ma znaczenia. Dostępne indeksy to:
|
| language | Język, w którym powinny być zwracane wyniki wyszukiwania. |
Właściwości dziedziczone
| abort |
Sygnał, który może służyć do przerwania żądań. |
| category |
Rozdzielona przecinkami lista identyfikatorów zestawów kategorii, których można użyć do ograniczenia wyniku do określonych kategorii Punktów orientacyjnych. Kolejność identyfikatorów nie ma znaczenia. Po podaniu wielu identyfikatorów kategorii zostaną zwrócone tylko elementy POI należące do (co najmniej) jednej z kategorii z podanej listy. Listę obsługiwanych kategorii można znaleźć za pomocą interfejsu API kategorii POI. Przykłady użycia: |
| localized |
Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie poprawnych map dla określonego kraju/regionu dla regionów spornych geopolitycznie. |
| on |
Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy. |
| operating |
Godziny operacji dla weryfikacji koncepcji (punkty orientacyjne). |
| request |
Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji. |
| serializer |
Opcje zastępowania zachowania serializacji/deseralizacji. |
| top | Maksymalna liczba odpowiedzi, które zostaną zwrócone. Ustawienie domyślne: 10, minimum: 1 i maksimum: 100 |
| tracing |
Opcje używane podczas śledzenia są włączone. |
Szczegóły właściwości
extendedPostalCodesFor
Indeksy, dla których należy uwzględnić rozszerzone kody pocztowe w wynikach
extendedPostalCodesFor?: string[]
Wartość właściwości
string[]
indexFilter
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 = Geografie, PAD = Adresy punktów,
- POI = punkty orientacyjne, Str = Streets,
- Xstr = Cross Streets (skrzyżowania)
indexFilter?: string[]
Wartość właściwości
string[]
language
Język, w którym powinny być zwracane wyniki wyszukiwania.
language?: 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
dziedziczone z OperationOptions.abortSignal
categoryFilter
Rozdzielona przecinkami lista identyfikatorów zestawów kategorii, których można użyć do ograniczenia wyniku do określonych kategorii Punktów orientacyjnych. Kolejność identyfikatorów nie ma znaczenia. Po podaniu wielu identyfikatorów kategorii zostaną zwrócone tylko elementy POI należące do (co najmniej) jednej z kategorii z podanej listy. Listę obsługiwanych kategorii można znaleźć za pomocą interfejsu API kategorii POI.
Przykłady użycia: categorySet=7315(Szukaj użytecznych miejsc w kategorii Restauracja) categorySet=7315025,7315017(Szukaj użytecznych miejsc w kategorii Restauracja włoska lub francuska)
categoryFilter?: number[]
Wartość właściwości
number[]
Odziedziczone poSearchGeometryBaseOptions.categoryFilter
localizedMapView
Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie poprawnych map dla określonego kraju/regionu dla regionów spornych geopolitycznie.
localizedMapView?: string
Wartość właściwości
string
Odziedziczone poSearchGeometryBaseOptions.localizedMapView
onResponse
Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.
onResponse?: RawResponseCallback
Wartość właściwości
dziedziczone z OperationOptions.onResponse
operatingHours
Godziny operacji dla weryfikacji koncepcji (punkty orientacyjne).
operatingHours?: string
Wartość właściwości
string
Odziedziczone poSearchGeometryBaseOptions.operatingHours
requestOptions
Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.
requestOptions?: OperationRequestOptions
Wartość właściwości
dziedziczone z OperationOptions.requestOptions
serializerOptions
Opcje zastępowania zachowania serializacji/deseralizacji.
serializerOptions?: SerializerOptions
Wartość właściwości
dziedziczone z OperationOptions.serializerOptions
top
Maksymalna liczba odpowiedzi, które zostaną zwrócone. Ustawienie domyślne: 10, minimum: 1 i maksimum: 100
top?: number
Wartość właściwości
number
Odziedziczone poSearchGeometryBaseOptions.top
tracingOptions
Opcje używane podczas śledzenia są włączone.
tracingOptions?: OperationTracingOptions
Wartość właściwości
dziedziczone z OperationOptions.tracingOptions