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.
| Code Block | ||
|---|---|---|
| ||
{
"name": "project_settings_gb",
"type": "projectSettings",
"content": {
"geoSearchCountries": [
"GB"
],
"geoSearchProviders": [
"Mapbox"
]
}
}
|
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"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
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"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
...
| Status | ||||
|---|---|---|---|---|
|
...
array of ISO 3166 alpha-2 country codes, to which the geographic search will be limited
...
| Status | ||||
|---|---|---|---|---|
|
...
list of geosearch providers
default = [Mapbox]
...
content.projectTemplate
...
array of dataset links
...
content.projectTemplate.dataset
...
URL link to the dataset, which will be loadable with data during custom create project
...
Visual representation
...
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
The content you are trying to reach has been moved here: https://docs.clevermaps.io/docs/project-settingsWe are proud to announce that we have launched a new documentation. Please update your saved links and bookmarks to follow a new address docs.clevermaps.io. |