StacGetItemCollectionOptionalParams interface
Optional parameters.
- Extends
Properties
| bounding |
Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth):
The coordinate reference system of the values is WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84). For WGS 84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge). If the vertical axis is included, the third and the sixth number are the bottom and the top of the 3-dimensional bounding box. If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries. |
| 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. |
| duration |
URL signature duration in minutes. |
| limit | The optional limit parameter recommends the number of items that should be present in the response document. If the limit parameter value is greater than advertised limit maximum, the server must return the maximum possible number of items, rather than responding with an error. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items must not be counted. Minimum = 1. Maximum = 10000. Default = 10. |
| sign | Whether to sign asset URLs in the response. |
| token | Pagination token for fetching the next set of results. |
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
Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth):
- Lower left corner, coordinate axis 1
- Lower left corner, coordinate axis 2
- Minimum value, coordinate axis 3 (optional)
- Upper right corner, coordinate axis 1
- Upper right corner, coordinate axis 2
- Maximum value, coordinate axis 3 (optional)
The coordinate reference system of the values is WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84).
For WGS 84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge).
If the vertical axis is included, the third and the sixth number are the bottom and the top of the 3-dimensional bounding box.
If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries.
boundingBox?: 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
durationInMinutes
URL signature duration in minutes.
durationInMinutes?: numberProperty Value
number
limit
The optional limit parameter recommends the number of items that should be present in the response document.
If the limit parameter value is greater than advertised limit maximum, the server must return the maximum possible number of items, rather than responding with an error.
Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items must not be counted.
Minimum = 1. Maximum = 10000. Default = 10.
limit?: numberProperty Value
number
sign
Whether to sign asset URLs in the response.
sign?: stringProperty Value
string
token
Pagination token for fetching the next set of results.
token?: stringProperty Value
string
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
