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.
...
Project settings object syntax
| Code Block |
|---|
{
"name": "project_settings_gb",
"type": "projectSettings",
"content": {
"geoSearchCountries": [
"GB"
],
"geoSearchProviders": [
"Mapbox"
]
}
}
|
| Code Block | title |
Example of a dumped project settings
| Code Block | |
|---|---|
| true | {
"url": "/rest/projects/kt3hz932v53vabh8/md/projectSettings/qr0kekodkijcuhev",
"dumpTime": "2018-06-27T19:42:27Z",
"version": "1",
"content": {
"id": "qr0kekodkijcuhev",
"name": "project_settings_gb",
"type": "projectSettings",
"content": {
"geoSearchCountries": [
"GB"
],
"geoSearchProviders": [
"Mapbox"
]
},
"accessInfo": {
"createdAt": "2018-06-27T11:26:07Z"
},
"links": [
{
"rel": "self",
"href": "/rest/projects/kt3hz932v53vabh8/md/projectSettings/qr0kekodkijcuhev"
}
]
}
}
|
Additional syntax examples
...
Example of a projectSettings object with template
| Code Block | |
|---|---|
| true | {
"name": "project_settings_template",
"type": "projectSettings",
"content": {
"geoSearchCountries": [
"GB"
],
"geoSearchProviders": [
"Mapbox"
],
"projectTemplate": {
"templateDatasets": [
{
"dataset": "/rest/projects/$projectId/md/datasets?name=baskets"
}
]
}
}
} |
This example has a projectTemplate object with settings related to project templates.
Key description
content
Key | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| array |
| array of ISO 3166 alpha-2 country codes, to which the geographic search will be limited |
| ||||||
| array |
| list of geosearch providers default = |
| ||||||
| object |
| object containing settings related to project templates | |||||||
| array |
| list of whitelisted URL for iFrame postMessage API. Add a URL if you want to communicate with iFrame from your page. |
| ||||||
| boolean |
| allows embedding of current project to any URL and communicate via postMessage API. Enabling this option could have a security impact, please consider security risk of this setting. Values in default = |
content.projectTemplate
Key | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| array |
| array of dataset links |
|
content.projectTemplate.dataset
Key | Type | Optionality | Description | Constraints | |||||
|---|---|---|---|---|---|---|---|---|---|
| string |
| URL link to |
the dataset, which |
will be loadable with data during custom create project |
|
Visual representation
Project settings do not have a visual representation in the application.