ICollectionItemsConfig
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Configuration for retrieving collection items (geospatial features).
export interface ICollectionItemsConfig
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) (Optional) Bounding box filter (minx,miny,maxx,maxy). | ||
string | (ALPHA) Collection identifier. | ||
(ALPHA) (Optional) Kind of geo collection - STATIC (default) or CUSTOM. STATIC collections use /api/v1/location/collections/{collectionId}/items CUSTOM collections use /api/v1/location/custom/collections/{collectionId}/items | |||
number | (ALPHA) (Optional) Maximum number of features to return. | ||
string[] | (ALPHA) (Optional) List of values to filter features by. |
Property details
ICollectionItemsConfig.bboxpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Bounding box filter (minx,miny,maxx,maxy).
bbox?: string;
ICollectionItemsConfig.collectionIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Collection identifier.
collectionId: string;
ICollectionItemsConfig.kindpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Kind of geo collection - STATIC (default) or CUSTOM. STATIC collections use /api/v1/location/collections/{collectionId}/items CUSTOM collections use /api/v1/location/custom/collections/{collectionId}/items
kind?: GeoCollectionKind;
ICollectionItemsConfig.limitpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Maximum number of features to return.
limit?: number;
ICollectionItemsConfig.valuespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
List of values to filter features by.
values?: string[];