DataRegisterMosaicsSearchOptionalParams interface
Optional parameters.
- Extends
Properties
| bounding |
Geographic bounding box to filter items [west, south, east, north] |
| collections | List of STAC collection IDs to include in the mosaic |
| datetime | Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots. Examples:
Only features that have a temporal property that intersects the value of
If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties. |
| filter | Filter |
| filter |
Query language format used in the filter parameter |
| ids | List of specific STAC item IDs to include in the mosaic |
| intersects | GeoJSON geometry to spatially filter items by intersection |
| metadata | Additional metadata to associate with the mosaic |
| query | Query |
| sort |
Criteria for ordering items in the mosaic |
Inherited Properties
| abort |
The signal which can be used to abort requests. |
| on |
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times. |
| request |
Options used when creating and sending HTTP requests for this operation. |
| tracing |
Options used when tracing is enabled. |
Property Details
boundingBox
Geographic bounding box to filter items [west, south, east, north]
boundingBox?: number[]Property Value
number[]
collections
List of STAC collection IDs to include in the mosaic
collections?: string[]Property Value
string[]
datetime
Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.
Examples:
- A date-time: "2018-02-12T23:20:50Z"
- A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
- Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
Only features that have a temporal property that intersects the value of
datetime are selected.
If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.
datetime?: stringProperty Value
string
filter
Filter
filter?: Record<string, any>Property Value
Record<string, any>
filterLanguage
Query language format used in the filter parameter
filterLanguage?: stringProperty Value
string
ids
List of specific STAC item IDs to include in the mosaic
ids?: string[]Property Value
string[]
intersects
GeoJSON geometry to spatially filter items by intersection
intersects?: GeometryUnionProperty Value
metadata
Additional metadata to associate with the mosaic
metadata?: MosaicMetadataProperty Value
query
Query
query?: Record<string, any>Property Value
Record<string, any>
sortBy
Criteria for ordering items in the mosaic
sortBy?: StacSortExtension[]Property Value
Inherited Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLikeProperty Value
Inherited From OperationOptions.abortSignal
onResponse
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
onResponse?: RawResponseCallbackProperty Value
Inherited From OperationOptions.onResponse
requestOptions
Options used when creating and sending HTTP requests for this operation.
requestOptions?: OperationRequestOptionsProperty Value
Inherited From OperationOptions.requestOptions
tracingOptions
Options used when tracing is enabled.
tracingOptions?: OperationTracingOptionsProperty Value
Inherited From OperationOptions.tracingOptions
