Skip to content

Extend documentation for presetsFile #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
josephguillaume wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Extend documentation for presetsFile #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ Install via npm: `npm install --save overpass-wizard`. The module exposes a sing
* `compactNWR`: produces a query with `nwr` statements if possible (instead of listing `node`, `way` and `relation` separately), resulting in more compact results (default: true)
* `aroundRadius`: radius (in m) to be used with `around <location>` searches (default: 1000)
* `comment`: boolean or string. if false, no comments will be added to the Overpass query output. if it is a string, it will be used in the header to explain what the query is doing
* `freeFormPresets`: (*experimental*) path to a JSON file with presets in the [schema](https://github.com/openstreetmap/iD/blob/master/data/presets/presets.json) used by the iD editor. Used to expand *free form* search input (e.g. `Hotel in Vienna`).
* `freeFormPresets`: (*experimental*) path to a JSON file with a presets object in the [schema](https://github.com/openstreetmap/iD/blob/develop/data/presets/presets.json) used by the iD editor. Used to expand *free form* search input (e.g. `Hotel in Vienna`). Each preset is a named object that must have fields `name`, `terms`, `geometry` and `tags`. Presets with `searchable:false` are ignored.
1 change: 1 addition & 0 deletions overpass-wizard
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ var argv = require('yargs')
.boolean('no-compact').describe('no-compact','don\'t use the compact "nwr" syntax (for use with older Overpass-API servers)')
.string('bbox').alias('b', 'bbox').describe('bbox','string to replace {{bbox}} shortcuts with')
.string('around-radius').describe('around-radius','radius to use for "around <location>" queries')
.string('presetsFile').describe('presetsFile','(experimental) path to a JSON file with iD editor schema presets. Used to expand free form search input (e.g. Hotel in Vienna).')

.string('timeout').alias('t', 'timeout').default('timeout', 25).describe('timeout','timeout of overpass query in seconds')
.string('maxsize').describe('maxsize','memory limit of overpass query (in bytes)')
Expand Down