Project settings object is used to define project specific features. It references only datasets. Also, apart from other metadata objects, there can be only one project settings object in a project.
Syntax
This is the project settings object of the Retail Solution Demo. This demo covers only a part of the Birmingham area, so we use the code for the Great Britain - GB.
{ "name": "project_settings_gb", "type": "projectSettings", "content": { "geoSearchCountries": [ "GB" ], "geoSearchProviders": [ "Mapbox" ] } }
Additional syntax examples
This example has a projectTemplate
object with settings related to project templates.
Key description
content
Key | Type | Optionality | Description | Constraints |
---|---|---|---|---|
geoSearchCountries | array | REQUIRED | array of ISO 3166 alpha-2 country codes, to which the geographic search will be limited | (A-Z) |
| array | REQUIRED | list of geosearch providers default = | [Mapbox] |
projectTemplate | object | OPTIONAL | object containing settings related to project templates | |
trustedOrigins | array | OPTIONAL | list of whitelisted URL for iFrame postMessage API. Add a URL if you want to communicate with iFrame from your page. |
|
allowUnsecuredOrigins | boolean | OPTIONAL | enables embedding of current project to any URL. Enabling this option could have a security impact, please consider security risk. List of URLs in default = |
content.projectTemplate
Key | Type | Optionality | Description | Constraints |
---|---|---|---|---|
templateDatasets | array | OPTIONAL | array of dataset links | size => 1 |
content.projectTemplate.dataset
Key | Type | Optionality | Description | Constraints |
---|---|---|---|---|
dataset | string | OPTIONAL | URL link to the dataset, which will be loadable with data during custom create project | /rest/projects/$projectId/md/datasets?name= |
Visual representation
Project settings do not have a visual representation in the application.