-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make MetricGroup type property optional, rebuild docs
- Loading branch information
Showing
5 changed files
with
52 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
37 changes: 37 additions & 0 deletions
37
website/docs/api/geoprocessing/functions/getFeaturesForSketchBBoxes.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# getFeaturesForSketchBBoxes() | ||
|
||
```ts | ||
function getFeaturesForSketchBBoxes( | ||
sketch, | ||
fgbUrl, | ||
uniqueIdProperty?): Promise<Feature<Polygon | MultiPolygon, GeoJsonProperties>[]> | ||
``` | ||
|
||
Loads features from a FlatGeobuf referenced by URL, which intersect the | ||
bounding boxes of each individual sketch in a SketchCollection, or a single | ||
Sketch. | ||
|
||
In the case of a SketchCollection, it is possible that duplicate features may | ||
be fetched in the case of overlapping bounding boxes or very large features | ||
that span multiple bounding boxes. This function will de-dupe those features. | ||
Ideally, there is a feature.id property set. If not the caller can provide a | ||
uniqueIdProperty to de-dupe features. If neither is provided, a hash of the | ||
feature coordinates will be used. | ||
|
||
If feature.id is not available, and uniqueIdProperty is not provided, there | ||
is the potential for elimination of features that are geometrically identical | ||
but have different properties. | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| ------ | ------ | ------ | | ||
| `sketch` | [`Sketch`](../interfaces/Sketch.md)\<[`SketchGeometryTypes`](../type-aliases/SketchGeometryTypes.md)\> \| [`SketchCollection`](../interfaces/SketchCollection.md)\<[`SketchGeometryTypes`](../type-aliases/SketchGeometryTypes.md)\> | Sketch or SketchCollection | | ||
| `fgbUrl` | `string` | FlatGeobuf location | | ||
| `uniqueIdProperty`? | `string` | Used to de-dupe features when feature.id is not available | | ||
|
||
## Returns | ||
|
||
`Promise`\<[`Feature`](../interfaces/Feature.md)\<[`Polygon`](../interfaces/Polygon.md) \| [`MultiPolygon`](../interfaces/MultiPolygon.md), [`GeoJsonProperties`](../type-aliases/GeoJsonProperties.md)\>[]\> | ||
|
||
array of features |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters