Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

Key description

content

KeyTypeOptionalityDescriptionConstraints
geoSearchCountriesarray

Status
colourRed
titlerequired

array of ISO 3166 alpha-2 country codes, to which the geographic search will be limited

(A-Z)
geoSearchProvidersarray
Status
colourRed
titlerequired

list of geosearch providers

default = [Mapbox]

[Mapbox]
projectTemplateobject
Status
colourGreen
titleoptional
object containing settings related to project templates
trustedOrigins
array
Status
colourGreen
titleoptional
list of whitelisted URL for iFrame postMessage API. Add a URL if you want to communicate with iFrame from your page.

[protocol://host.name.domain:PORT]

allowUnsecuredOrigins
boolean
Status
colourGreen
titleoptional

enables embedding of current project to any URL. Enabling this option could have a security impact, please consider security risk.

List of URLs in tructedOrgins is ignored once allowUnsecuredOrigins is set to true.

default = false


content.projectTemplate

KeyTypeOptionalityDescriptionConstraints
templateDatasetsarray

Status
colourGreen
titleoptional

array of dataset links

size => 1

...

KeyTypeOptionalityDescriptionConstraints
datasetstring

Status
colourGreen
titleoptional

URL link to the dataset, which will be loadable with data during custom create project

/rest/projects/$projectId/md/datasets?name={datasetName}

Visual representation

...