Skip to content

Commit 9ef9a9e

Browse files
author
Allison Zheng
authored
Update README.md (#105)
* Update README.md adds estimate-area documentation
1 parent 1aff431 commit 9ef9a9e

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ export MAPBOX_ACCESS_TOKEN=my.token
4242
* [`view-source`](#view-source)
4343
* [`list-sources`](#list-source)
4444
* [`delete-source`](#delete-source)
45+
* [`estimate-area`](#estimate-area)
4546
* Recipes
4647
* [`view-recipe`](#view-recipe)
4748
* [`validate-recipe`](#validate-recipe)
@@ -150,6 +151,41 @@ tilesets delete-source
150151

151152
Permanently delete a tileset source and all of its files. This is not a recoverable action!
152153

154+
### estimate-area
155+
156+
```shell
157+
tilesets estimate-area <features> -p/--precision <precision>
158+
```
159+
160+
Estimates tiled area (km<sup>2</sup>) of features with a specified precision. Accepts line-delimited GeoJSON or GeoJSON feature collections as files or via `stdin` or a list of string-encoded coordinate pairs of the form "[lng, lat]", or "lng, lat", or "lng lat". Precision must be 10m, 1m, 30cm or 1cm.
161+
162+
Flags:
163+
164+
* `-p` or `--precision` [required]: precision level
165+
* `--no-validation` [optional]: do not validate source data locally before area calculation
166+
* `--force-1cm` [optional]: the --force-1cm flag must be present to enable 1cm precision area calculation and may take longer for large feature inputs or data with global extents. 1cm precision for tileset processing is only available upon request after contacting [Mapbox support](https://support.mapbox.com/hc/en-us/requests/new?ticket_form_id=360000291231)
167+
168+
Usage
169+
170+
```shell
171+
172+
# GeoJSON feature files
173+
tilesets estimate-area ./file1.geojson ./file2.geojson -p <precision>
174+
175+
# GeoJSON features in stdin redirection 1
176+
tilesets estimate-area -p <precision> < ./file.geojson
177+
178+
# GeoJSON features in stdin redirection 2
179+
cat ./file.geojson | tilesets estimate-area -p <precision>
180+
181+
# GeoJSON features in stdin stream
182+
tilesets estimate-area --precision <precision>
183+
<features>
184+
185+
# coordinate pairs (must be in quotes)
186+
tilesets estimate-area "[lng,lat]" "[lng,lat]" --precision <precision>
187+
```
188+
153189
### view-recipe
154190

155191
Prints the Recipe JSON to stdout.

0 commit comments

Comments
 (0)