StacSearchParameters interface

Paket:
@azure/planetarycomputer

Sök modell. * Definierar parametrar för en STAC-sökning POST-förfrågan.

Egenskaper

boundingBox

Begränsningsbox för rumslig filtrering i format [väst, söder, öst, nord].
collections

Lista över samlings-ID:n att söka i.
conformanceClass

Konferens

Åsidosätter datetime-validering från basförfrågan.
datetime

Antingen ett datum/tid eller ett intervall, öppet eller stängt. Datum- och tidsuttryck följer RFC 3339. Öppna intervall uttrycks med dubbla punkter.

Examples:

  • Ett datum/tid: "2018-02-12T23:20:50Z"
  • Ett stängt intervall: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
  • Öppna intervaller: "2018-02-12T00:00:00Z/.." eller ".. /2018-03-18T12:31:12Z"

Endast funktioner som har en temporal egenskap som överlappar värdet för datetime markeras.

Om en funktion har flera temporala egenskaper är det serverns beslut om endast en enda temporal egenskap används för att fastställa omfattningen eller alla relevanta temporala egenskaper.
fields

Specificerar vilka fält som ska inkluderas eller uteslutas i STAC-sökresultaten.

Se STAC Fields-tillägget.
filter

CQL2-filter

Se STAC-filtertillägget.
filterCoordinateReferenceSystem

Koordinatreferenssystem för filtret.
filterLang

Filterspråk att använda för filteruttrycket.
ids

Lista över specifika föremåls-ID:n att returnera.
intersects

GeoJSON-geometri för rumslig filtrering.
limit

Maximalt antal resultat som ska returneras.
query

STAC-fråga

Se STAC Query Extension.
sortBy

Sortera kriterier för sökresultaten.

Se STAC Sort-tillägget.
token

Pagineringstoken för att hämta nästa uppsättning resultat.

Egenskapsinformation

boundingBox

Begränsningsbox för rumslig filtrering i format [väst, söder, öst, nord].

boundingBox?: number[]

Egenskapsvärde

number[]

collections

Lista över samlings-ID:n att söka i.

collections?: string[]

Egenskapsvärde

string[]

conformanceClass

Konferens

Åsidosätter datetime-validering från basförfrågan.

conformanceClass?: Record<string, any>

Egenskapsvärde

Record<string, any>

datetime

Antingen ett datum/tid eller ett intervall, öppet eller stängt. Datum- och tidsuttryck följer RFC 3339. Öppna intervall uttrycks med dubbla punkter.

Examples:

  • Ett datum/tid: "2018-02-12T23:20:50Z"
  • Ett stängt intervall: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
  • Öppna intervaller: "2018-02-12T00:00:00Z/.." eller ".. /2018-03-18T12:31:12Z"

Endast funktioner som har en temporal egenskap som överlappar värdet för datetime markeras.

Om en funktion har flera temporala egenskaper är det serverns beslut om endast en enda temporal egenskap används för att fastställa omfattningen eller alla relevanta temporala egenskaper.

datetime?: string

Egenskapsvärde

string

fields

Specificerar vilka fält som ska inkluderas eller uteslutas i STAC-sökresultaten.

Se STAC Fields-tillägget.

fields?: SearchOptionsFields[]

Egenskapsvärde

SearchOptionsFields[]

filter

CQL2-filter

Se STAC-filtertillägget.

filter?: Record<string, any>

Egenskapsvärde

Record<string, any>

filterCoordinateReferenceSystem

Koordinatreferenssystem för filtret.

filterCoordinateReferenceSystem?: string

Egenskapsvärde

string

filterLang

Filterspråk att använda för filteruttrycket.

filterLang?: string

Egenskapsvärde

string

ids

Lista över specifika föremåls-ID:n att returnera.

ids?: string[]

Egenskapsvärde

string[]

intersects

GeoJSON-geometri för rumslig filtrering.

intersects?: GeometryUnion

Egenskapsvärde

GeometryUnion

limit

Maximalt antal resultat som ska returneras.

limit?: number

Egenskapsvärde

number

query

STAC-fråga

Se STAC Query Extension.

query?: Record<string, any>

Egenskapsvärde

Record<string, any>

sortBy

Sortera kriterier för sökresultaten.

Se STAC Sort-tillägget.

sortBy?: StacSortExtension[]

Egenskapsvärde

StacSortExtension[]

token

Pagineringstoken för att hämta nästa uppsättning resultat.

token?: string

Egenskapsvärde

string