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.
...
This example has a projectTemplate object with settings related to project templates.
Example of a projectSettings object with trustedOrigins
| Code Block |
|---|
{
"name": "project_settings_template",
"type": "projectSettings",
"content": {
"geoSearchCountries": [
"GB"
],
"geoSearchProviders": [
"Mapbox"
],
"trustedOrigins": [
"http://stories.clevermaps.io",
"https://www.stories.clevermaps.io:443"
]
}
} |
This example has a trustedOrigins array with URL whitelisted for iFrame postMessage API.
Example of a projectSettings object with defaultViews
| Code Block |
|---|
{
"name": "project_settings_template",
"type": "projectSettings",
"content": {
"geoSearchCountries": [
"GB"
],
"geoSearchProviders": [
"Mapbox"
],
"defaultViews": [
"/rest/projects/$projectId/md/views?name=catchment_area_view",
"/rest/projects/$projectId/md/views?name=restaurants_rating_view"
]
}
} |
This example has a defaultViews array with URLs of views to be displayed in UI/dumped into project dump for all project members.
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 |
tructedOrgins default = | ||||||||||
| array |
| list of views (URLs corresponding to views) to be displayed in UI/dumped into project dump for all project members |
|
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.