Skip to content
UKChris-osm edited this page Nov 14, 2021 · 7 revisions

Feature files are optional .geojson files found under the features/ folder.

Each feature file defines a custom region (aka geofence) where a brand or organization is considered valid.

  • features/*
    • us/new_jersey.geojson
    • ca/quebec.geojson
    • and so on…

When naming a .geojson file, consider if the area you've drawn matches an existing ISO 3166-2 area. For example, if you're adding a .geojson for Alberta in Canada, then the ISO 3166-2:CA value of ca-ab.geojson would be ideal.

File contents

Each file should contain a single GeoJSON Feature. (Note: A FeatureCollection containing a single Feature is ok too - the build script can handle this.)

Only Polygon and MultiPolygon geometries are supported.

The build script will automatically generate an id property to match the filename.

Feature files look like this:

{
  "type": "Feature",
  "id": "new_jersey.geojson",
  "properties": {},
  "geometry": {
    "type": "Polygon",
    "coordinates": []
  }
}

GeoJSON Protips

Home

For Contributors

Contributing to the index

Advanced Topics

For Developers

Information for developers using the name-suggestion-index in another project.

For Maintainers

Information for maintainers, including how to clone and build the project.

 

Clone this wiki locally