StacGetItemCollectionOptionalParams interface
Parametry opcjonalne.
- Rozszerzenie
Właściwości
| bounding |
Zaznaczone są tylko funkcje, które mają geometrię przecinającą pole ograniczenia. Ramka ograniczenia jest podawana jako cztery lub sześć liczb, w zależności od tego, czy układ odniesienia współrzędnych zawiera oś pionową (wysokość czy głębokość):
Układem współrzędnych odniesienia wartości jest WGS 84 długość/szerokość geograficzna (http://www.opengis.net/def/crs/OGC/1.3/CRS84). W przypadku WGS 84 długości geograficznej/szerokości geograficznej wartości są w większości przypadków sekwencją minimalnej długości geograficznej, minimalnej szerokości geograficznej, maksymalnej długości geograficznej i maksymalnej szerokości geograficznej. Jednak w przypadkach, gdy pole obejmuje antymerydian pierwszą wartość (zachodnio-najbardziej box edge) jest większa niż trzecia wartość (krawędź najbardziej wschodnia). Jeśli uwzględniona jest oś pionowa, trzecia i szósta liczba są dolną i górną krawędzią 3-wymiarowej obwiedni. Jeśli obiekt ma wiele właściwości geometrii przestrzennej, to serwer decyduje, czy do określenia zakresu zostanie użyta tylko jedna właściwość geometrii przestrzennej, czy wszystkie odpowiednie geometrie. |
| datetime | Data i godzina lub interwał, otwarty lub zamknięty. Wyrażenia daty i godziny są zgodne ze specyfikacją RFC 3339. Interwały otwarte są wyrażane za pomocą podwójnych kropek. Examples:
Wybierane są tylko te elementy, które mają właściwość czasową, która przecina wartość parametru Jeśli obiekt ma wiele właściwości czasowych, to serwer decyduje, czy do określenia zakresu zostanie użyta tylko jedna właściwość czasowa, czy wszystkie istotne właściwości czasowe. |
| duration |
Czas podpisu URL w minutach. |
| limit | Opcjonalny parametr limit zaleca liczbę elementów, które powinny być obecne w dokumencie odpowiedzi. Jeśli wartość parametru limit jest większa niż anonsowana wartość maksymalna limitu, serwer musi zwrócić maksymalną możliwą liczbę elementów, a nie odpowiadać błędem. Zliczane są tylko te elementy, które znajdują się na pierwszym poziomie kolekcji w dokumencie odpowiedzi. Zagnieżdżone obiekty zawarte w jawnie żądanych elementach nie mogą być zliczane. Minimum = 1. Maksimum = 10000. Wartość domyślna = 10. |
| sign | Czy podpisywać adresy URL zasobów w odpowiedzi. |
| token | Token paginacji do pobierania kolejnego zestawu wyników. |
Właściwości dziedziczone
| abort |
Sygnał, który może służyć do przerwania żądań. |
| 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. |
| request |
Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji. |
| tracing |
Opcje używane podczas śledzenia są włączone. |
Szczegóły właściwości
boundingBox
Zaznaczone są tylko funkcje, które mają geometrię przecinającą pole ograniczenia. Ramka ograniczenia jest podawana jako cztery lub sześć liczb, w zależności od tego, czy układ odniesienia współrzędnych zawiera oś pionową (wysokość czy głębokość):
- Lewy dolny róg, oś współrzędnych 1
- Lewy dolny róg, oś współrzędnych 2
- Wartość minimalna, oś współrzędnych 3 (opcjonalnie)
- Prawy górny róg, oś współrzędnych 1
- Prawy górny róg, oś współrzędnych 2
- Wartość maksymalna, oś współrzędnych 3 (opcjonalnie)
Układem współrzędnych odniesienia wartości jest WGS 84 długość/szerokość geograficzna (http://www.opengis.net/def/crs/OGC/1.3/CRS84).
W przypadku WGS 84 długości geograficznej/szerokości geograficznej wartości są w większości przypadków sekwencją minimalnej długości geograficznej, minimalnej szerokości geograficznej, maksymalnej długości geograficznej i maksymalnej szerokości geograficznej. Jednak w przypadkach, gdy pole obejmuje antymerydian pierwszą wartość (zachodnio-najbardziej box edge) jest większa niż trzecia wartość (krawędź najbardziej wschodnia).
Jeśli uwzględniona jest oś pionowa, trzecia i szósta liczba są dolną i górną krawędzią 3-wymiarowej obwiedni.
Jeśli obiekt ma wiele właściwości geometrii przestrzennej, to serwer decyduje, czy do określenia zakresu zostanie użyta tylko jedna właściwość geometrii przestrzennej, czy wszystkie odpowiednie geometrie.
boundingBox?: string[]
Wartość właściwości
string[]
datetime
Data i godzina lub interwał, otwarty lub zamknięty. Wyrażenia daty i godziny są zgodne ze specyfikacją RFC 3339. Interwały otwarte są wyrażane za pomocą podwójnych kropek.
Examples:
- Data-godzina: "2018-02-12T23:20:50Z"
- Zamknięty interwał: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
- Interwały otwarcia: "2018-02-12T00:00:00Z/.." lub ".. /2018-03-18T12:31:12Z"
Wybierane są tylko te elementy, które mają właściwość czasową, która przecina wartość parametru datetime .
Jeśli obiekt ma wiele właściwości czasowych, to serwer decyduje, czy do określenia zakresu zostanie użyta tylko jedna właściwość czasowa, czy wszystkie istotne właściwości czasowe.
datetime?: string
Wartość właściwości
string
durationInMinutes
Czas podpisu URL w minutach.
durationInMinutes?: number
Wartość właściwości
number
limit
Opcjonalny parametr limit zaleca liczbę elementów, które powinny być obecne w dokumencie odpowiedzi.
Jeśli wartość parametru limit jest większa niż anonsowana wartość maksymalna limitu, serwer musi zwrócić maksymalną możliwą liczbę elementów, a nie odpowiadać błędem.
Zliczane są tylko te elementy, które znajdują się na pierwszym poziomie kolekcji w dokumencie odpowiedzi. Zagnieżdżone obiekty zawarte w jawnie żądanych elementach nie mogą być zliczane.
Minimum = 1. Maksimum = 10000. Wartość domyślna = 10.
limit?: number
Wartość właściwości
number
sign
Czy podpisywać adresy URL zasobów w odpowiedzi.
sign?: string
Wartość właściwości
string
token
Token paginacji do pobierania kolejnego zestawu wyników.
token?: 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
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
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
tracingOptions
Opcje używane podczas śledzenia są włączone.
tracingOptions?: OperationTracingOptions
Wartość właściwości
dziedziczone z OperationOptions.tracingOptions