Regional Features - osmlab/name-suggestion-index GitHub Wiki

The NSI project has a collection of .geojson features corresponding to the internal or administrative borders of several countries for use with the locationSet property. These features represent a country's subdivisions, which can be referred to as either "states", "provinces", "regions", "counties", "districts", etc. The features use the local area's ISO 3166-2 naming conventions for their file names and id values.

List of available ISO 3166-2 compatible features

Below is a simplified, non-exhaustive list of available ISO 3166-2 compatible features within the NSI, which all require the .geojson extension when referenced. The table also lists a couple of exceptions where the .geojson extension is not needed; these subdivisions are built-in to the country-coder project and thus can be referenced directly without the .geojson file extension. For a full list of available features, please browse the NSI's features folder.

Location Features ISO Standard Examples Exceptions
Australia States within Australia ISO 3166-2:AU Queensland (au-qld.geojson)Victoria (au-vic.geojson) Tazmania (au-tas)
Austria States of Austria ISO 3166-2:AT Vienna (at-9.geojson) Carinthia (at-2.geojson) None
Canada Canadian Provinces ISO 3166-2:CA Alberta (ca-ab.geojson)Quebec (ca-qc.geojson) None
France Regions within France ISO 3166-2:FR Île-de-France (fr-idf.geojson)Provence-Alpes-Côte-d’Azur (fr-pac.geojson) None
Germany States within Germany ISO 3166-2:DE Berlin (de-be.geojson)Hessen (de-he.geojson) None
Japan Prefectures of Japan ISO 3166-2:JP Chiba (jp-12.geojson) Aichi (jp-23.geojson) None
New Zealand Regions within New Zealand ISO 3166-2:NZ Marlborough (nz-mbh.geojson)Wellington (nz-wgn.geojson) None
United States States within the United States ISO 3166-2:US New Jersey (us-nj.geojson)California (us-ca.geojson) Alaska (us-ak)Hawaii (us-hi)

There is partial support for Counties in Great Britain (UK) which follow the ISO 3166-2:GB standard. One exception is gb-lon.geojson, which represents London as a whole, but gb-lon isn't part of the ISO 3166-2:GB standard, as each London Borough has its own ISO value.

Using the features

The file names of the regional features follow the ISO 3166-2 standard for that country; e.g., US-FL.geojson for the feature representing the US state of Florida. If you wish to assign a locationSet area confined to a single region, you may use the id of the .geojson feature for that region, such as us-fl.geojson for Florida (note the difference in case from the feature's file name). For example:

"locationSet": {"include": ["us-fl.geojson"]}

You can also use multiple regions if need be, such as Florida & Georgia, for example:

"locationSet": {"include": ["us-ga.geojson","us-fl.geojson"]}

Or exclude regions, such as everywhere in the USA except for Florida & Georgia for example:

"locationSet": {
  "include": ["us"],
  "exclude": ["us-ga.geojson","us-fl.geojson"]
}

As previously mentioned, the subdivisions built-in to the country-coder project can be referenced directly without the .geojson file extension:

"locationSet": {"include": ["us-ak"]}
"locationSet": {"include": ["us-hi"]}

Adding and editing features

See Creating and Editing Feature Files for guidance on how to add new features or edit existing features using QGIS.