StacGetItemCollectionOptionalParams interface
Optionale Parameter.
- Extends
Eigenschaften
| bounding |
Nur Features mit einer Geometrie, die das umgebende Feld überschneidet, werden ausgewählt. Der Begrenzungsrahmen wird als vier oder sechs Zahlen bereitgestellt, je nachdem, ob das Koordinatenreferenzsystem eine vertikale Achse (Höhe oder Tiefe) enthält:
Das Koordinatenbezugssystem der Werte ist WGS 84 Längen-/Breitengrad (http://www.opengis.net/def/crs/OGC/1.3/CRS84). Für WGS 84 Längen-/Breitengrad sind die Werte in den meisten Fällen die Abfolge von minimalem Längengrad, minimalem Breitengrad, maximalem Längengrad und maximalem Breitengrad. In Fällen, in denen das Feld jedoch den Antimeridian überspannt, ist der erste Wert (west-most box edge) größer als der dritte Wert (ost-most box edge). Wenn die vertikale Achse eingeschlossen ist, sind die dritte und die sechste Zahl der untere und der obere Rand des 3-dimensionalen Begrenzungsrahmens. Wenn ein Feature über mehrere räumliche Geometrieeigenschaften verfügt, entscheidet der Server, ob nur eine einzelne räumliche Geometrieeigenschaft oder alle relevanten Geometrien zum Bestimmen der Ausdehnung verwendet werden. |
| datetime | Entweder ein Datum/eine Uhrzeit oder ein Intervall, offen oder geschlossen. Datums- und Uhrzeitausdrücke entsprechen RFC 3339. Offene Intervalle werden mit Doppelpunkten ausgedrückt. Beispiele:
Es werden nur Features ausgewählt, die über eine temporale Eigenschaft verfügen, die den Wert von Wenn ein Feature über mehrere zeitliche Eigenschaften verfügt, ist es die Entscheidung des Servers, ob nur eine einzelne temporale Eigenschaft zum Bestimmen der Ausdehnung oder alle relevanten temporalen Eigenschaften verwendet wird. |
| duration |
Dauer der URL-Signatur beträgt Minuten. |
| limit | Der optionale limit-Parameter empfiehlt die Anzahl der Elemente, die im Antwortdokument vorhanden sein sollten. Wenn der Wert des Grenzwertparameters größer als der angegebene Grenzwert ist, muss der Server die maximal mögliche Anzahl von Elementen zurückgeben, anstatt mit einem Fehler zu antworten. Es werden nur Elemente gezählt, die sich auf der ersten Ebene der Sammlung im Antwortdokument befinden. Verschachtelte Objekte, die in den explizit angeforderten Elementen enthalten sind, dürfen nicht gezählt werden. Minimum = 1. Höchstwert = 10000. Standardwert = 10. |
| sign | Ob man Asset-URLs in der Antwort signieren soll. |
| token | Paginierungstoken zum Abrufen der nächsten Ergebnismenge. |
Geerbte Eigenschaften
| abort |
Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann. |
| on |
Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden. |
| request |
Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden. |
| tracing |
Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist. |
Details zur Eigenschaft
boundingBox
Nur Features mit einer Geometrie, die das umgebende Feld überschneidet, werden ausgewählt. Der Begrenzungsrahmen wird als vier oder sechs Zahlen bereitgestellt, je nachdem, ob das Koordinatenreferenzsystem eine vertikale Achse (Höhe oder Tiefe) enthält:
- Linke untere Ecke, Koordinatenachse 1
- Linke untere Ecke, Koordinatenachse 2
- Minimalwert, Koordinatenachse 3 (optional)
- Rechte obere Ecke, Koordinatenachse 1
- Obere rechte Ecke, Koordinatenachse 2
- Maximalwert, Koordinatenachse 3 (optional)
Das Koordinatenbezugssystem der Werte ist WGS 84 Längen-/Breitengrad (http://www.opengis.net/def/crs/OGC/1.3/CRS84).
Für WGS 84 Längen-/Breitengrad sind die Werte in den meisten Fällen die Abfolge von minimalem Längengrad, minimalem Breitengrad, maximalem Längengrad und maximalem Breitengrad. In Fällen, in denen das Feld jedoch den Antimeridian überspannt, ist der erste Wert (west-most box edge) größer als der dritte Wert (ost-most box edge).
Wenn die vertikale Achse eingeschlossen ist, sind die dritte und die sechste Zahl der untere und der obere Rand des 3-dimensionalen Begrenzungsrahmens.
Wenn ein Feature über mehrere räumliche Geometrieeigenschaften verfügt, entscheidet der Server, ob nur eine einzelne räumliche Geometrieeigenschaft oder alle relevanten Geometrien zum Bestimmen der Ausdehnung verwendet werden.
boundingBox?: string[]
Eigenschaftswert
string[]
datetime
Entweder ein Datum/eine Uhrzeit oder ein Intervall, offen oder geschlossen. Datums- und Uhrzeitausdrücke entsprechen RFC 3339. Offene Intervalle werden mit Doppelpunkten ausgedrückt.
Beispiele:
- Ein Datum-Uhrzeit-Datum: "2018-02-12T23:20:50Z"
- Ein geschlossenes Intervall: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
- Offene Intervalle: "2018-02-12T00:00:00Z/.." oder ".. /2018-03-18T12:31:12Z"
Es werden nur Features ausgewählt, die über eine temporale Eigenschaft verfügen, die den Wert von datetime schneidet.
Wenn ein Feature über mehrere zeitliche Eigenschaften verfügt, ist es die Entscheidung des Servers, ob nur eine einzelne temporale Eigenschaft zum Bestimmen der Ausdehnung oder alle relevanten temporalen Eigenschaften verwendet wird.
datetime?: string
Eigenschaftswert
string
durationInMinutes
Dauer der URL-Signatur beträgt Minuten.
durationInMinutes?: number
Eigenschaftswert
number
limit
Der optionale limit-Parameter empfiehlt die Anzahl der Elemente, die im Antwortdokument vorhanden sein sollten.
Wenn der Wert des Grenzwertparameters größer als der angegebene Grenzwert ist, muss der Server die maximal mögliche Anzahl von Elementen zurückgeben, anstatt mit einem Fehler zu antworten.
Es werden nur Elemente gezählt, die sich auf der ersten Ebene der Sammlung im Antwortdokument befinden. Verschachtelte Objekte, die in den explizit angeforderten Elementen enthalten sind, dürfen nicht gezählt werden.
Minimum = 1. Höchstwert = 10000. Standardwert = 10.
limit?: number
Eigenschaftswert
number
sign
Ob man Asset-URLs in der Antwort signieren soll.
sign?: string
Eigenschaftswert
string
token
Paginierungstoken zum Abrufen der nächsten Ergebnismenge.
token?: string
Eigenschaftswert
string
Geerbte Eigenschaftsdetails
abortSignal
Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
abortSignal?: AbortSignalLike
Eigenschaftswert
von OperationOptions.abortSignal geerbt
onResponse
Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.
onResponse?: RawResponseCallback
Eigenschaftswert
von OperationOptions.onResponse geerbt
requestOptions
Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.
requestOptions?: OperationRequestOptions
Eigenschaftswert
Von OperationOptions.requestOptions geerbt
tracingOptions
Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.
tracingOptions?: OperationTracingOptions
Eigenschaftswert
von OperationOptions.tracingOptions geerbt