Skip to content

Commit aca6415

Browse files
committed
docs: Add item ID filter docs
1 parent bf297e3 commit aca6415

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -261,10 +261,12 @@ const { results } = useStacSearch();
261261
Option | Type | Description
262262
------------------ | --------- | -------------
263263
`submit` | `function` | Callback to submit the search using the current filter parameters. Excecutes an API call to the specified STAC API.
264+
`ids` | `array<string>` | List of item IDs to match in the search, `undefined` if unset.
265+
`setIds(itemIds)` | `function` | Callback to set `ids`. `itemIds` must be an `array` of `string` with the IDs of the selected items, or `undefined` to reset.
264266
`bbox` | `array<number>` | Array of coordinates `[northWestLon, northWestLat, southEastLon, southEastLat]`, `undefined` if unset.
265-
`setBbox(bbox)` | `function` | Callback to set `bbox`. `bbox` must be an array of coordinates `[northWestLon, northWestLat, southEastLon, southEastLat]`, or `undefined` to reset.
267+
`setBbox(bbox)` | `function` | Callback to set `bbox`. `bbox` must be an array of coordinates `[northWestLon, northWestLat, southEastLon, southEastLat]`, or `undefined` to reset.
266268
`collections` | `array<string>` | List of select collection IDs included in the search query. `undefined` if unset.
267-
`setCollections(collectionIDs)` | `function` | Callback to set `collections`. `collectionIDs` must be an `array` of `string` with the IDs of the selection collections, or `undefined` to reset.
269+
`setCollections(collectionIDs)` | `function` | Callback to set `collections`. `collectionIDs` must be an `array` of `string` with the IDs of the selected collections, or `undefined` to reset.
268270
`dateRangeFrom` | `string` | The from-date of the search query. `undefined` if unset.
269271
`setDateRangeFrom(fromDate)` | `function` | Callback to set `dateRangeFrom`. `fromDate` must be ISO representation of a date, ie. `2022-05-18`, or `undefined` to reset.
270272
`dateRangeTo` | `string` | The to-date of the search query. `undefined` if unset.

0 commit comments

Comments
 (0)