StacSearchParameters interface

Paket:
@azure/planetarycomputer

Suchmodell suchen. * Definiert Parameter für eine STAC-Suche POST-Anfrage.

Eigenschaften

boundingBox

Begrenzungsbox für räumliche Filterung im Format [West, Süd, Ost, Nord].
collections

Liste der Sammlungs-IDs, in denen man suchen sollte.
conformanceClass

Konferenz

Überschreibt die Datetime-Validierung aus dem Basisanforderungsmodell.
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.
fields

Spezifiziert, welche Felder in den STAC-Suchergebnissen aufgenommen oder ausgeschlossen werden sollen.

Siehe die STAC Fields-Erweiterung.
filter

CQL2-Filter

Siehe die STAC-Filtererweiterung.
filterCoordinateReferenceSystem

Koordinatenreferenzsystem für den Filter.
filterLang

Filtersprache für den Filterausdruck zu verwenden.
ids

Liste spezifischer Artikel-IDs, die zurückgegeben werden sollten.
intersects

GeoJSON-Geometrie für räumliche Filterung.
limit

Maximale Anzahl der zurückzugebenden Ergebnisse.
query

STAC-Abfrage

Siehe die STAC-Abfrageerweiterung.
sortBy

Sortierkriterien für die Suchergebnisse.

Siehe die STAC Sort-Erweiterung.
token

Paginierungstoken zum Abrufen der nächsten Ergebnismenge.

Details zur Eigenschaft

boundingBox

Begrenzungsbox für räumliche Filterung im Format [West, Süd, Ost, Nord].

boundingBox?: number[]

Eigenschaftswert

number[]

collections

Liste der Sammlungs-IDs, in denen man suchen sollte.

collections?: string[]

Eigenschaftswert

string[]

conformanceClass

Konferenz

Überschreibt die Datetime-Validierung aus dem Basisanforderungsmodell.

conformanceClass?: Record<string, any>

Eigenschaftswert

Record<string, any>

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

fields

Spezifiziert, welche Felder in den STAC-Suchergebnissen aufgenommen oder ausgeschlossen werden sollen.

Siehe die STAC Fields-Erweiterung.

fields?: SearchOptionsFields[]

Eigenschaftswert

SearchOptionsFields[]

filter

CQL2-Filter

Siehe die STAC-Filtererweiterung.

filter?: Record<string, any>

Eigenschaftswert

Record<string, any>

filterCoordinateReferenceSystem

Koordinatenreferenzsystem für den Filter.

filterCoordinateReferenceSystem?: string

Eigenschaftswert

string

filterLang

Filtersprache für den Filterausdruck zu verwenden.

filterLang?: string

Eigenschaftswert

string

ids

Liste spezifischer Artikel-IDs, die zurückgegeben werden sollten.

ids?: string[]

Eigenschaftswert

string[]

intersects

GeoJSON-Geometrie für räumliche Filterung.

intersects?: GeometryUnion

Eigenschaftswert

GeometryUnion

limit

Maximale Anzahl der zurückzugebenden Ergebnisse.

limit?: number

Eigenschaftswert

number

query

STAC-Abfrage

Siehe die STAC-Abfrageerweiterung.

query?: Record<string, any>

Eigenschaftswert

Record<string, any>

sortBy

Sortierkriterien für die Suchergebnisse.

Siehe die STAC Sort-Erweiterung.

sortBy?: StacSortExtension[]

Eigenschaftswert

StacSortExtension[]

token

Paginierungstoken zum Abrufen der nächsten Ergebnismenge.

token?: string

Eigenschaftswert

string