Map

Core map properties (extent sets, levels of detail).

Map JSON tree

"map": {
"extentSets": [
{
extentSetNode
},
{...},
{...},
...
],
"lodSets": [
{
lodSetNode
},
{...},
{...}
...
],
"tileSchemas": [
{
tileSchemaNode
},
{...},
{...}
...
],
"components": {
"mouseInfo": {
"enabled": ...,
"spatialReference": {...}
},
"northArrow": {
"enabled": ...,
"arrowIcon": ...,
"poleIcon": ...
},
"overviewMap": {
"enabled": ...,
"expandFactor": ...
},
"scaleBar": {
"enabled": ...
},
"basemap": {
"enabled": ...
}
},
"initialBasemapId": ...,
"baseMaps": [
{
baseMapNode
},
{...},
{...}
...
],
"layers": [
{
layerNode
},
{...},
{...}
...
],
"legend": { 🚧 }
}

attributionNode JSON tree

{
"text": {
"enabled": ...
"value": ...
},
"logo": {
"enabled": ...
"altText": ...
"value": ...
"link": ...
}
}

⬆️ back to Map

extentSetNode JSON tree

{
"id": ...,
"spatialReference": {
"wkid": ...
},
"default": {...},
"full": {...},
"maximum": {...}
}

⬆️ back to Map

extentWithReferenceNode JSON tree

{
"xmin": {
"ymin": {
"xmax": {
"ymax": {
"spatialReference": {
"wkid": ...
},
}

⬆️ back to Map

initialLayerSettings JSON tree

{
"opacity": ...,
"visibility": ...,
"boundingBox": ...,
"query": ...,
"snapshot": ...,
"hovertips": ...,
}

⬆️ back to Map

lodSetNode JSON tree

{
"id": ...,
"lods": [
{
"level": ...,
"resolution": ...,
"scale": ...
},
{...},
{...},
...
]
}

⬆️ back to Map

tileSchemaNode JSON tree

{
"id": ...,
"name": ...,
"extentSetId": ...,
"lodSetId": ...,
"overviewUrl": {
"layerType": ...,
"url": ...
}
"hasNorthPole": ...,
}

⬆️ back to Map

baseMapNode JSON tree

{
"id": ...,
"name": ...,
"description": ...,
"typeSummary": ...,
"altText": ...,
"thumbnailUrl": ...,
"tileSchemaId": ...,
"layers": [
{
"id": ...,
"layerType": ...,
"url": ...
},
{...},
{...}
],
"attribution": ...,
}
}

⬆️ back to Map

layerNode JSON tree

[
{
basicLayerNode
OR
featureLayerNode
OR
wmsLayerNode
OR
dynamicLayerNode
},
{...},
{...}
]

⬆️ back to Map

basicLayerNode JSON tree

{
"id": ...,
"name": ...,
"url": ...,
"refreshInterval": ...,
"metadataUrl": ...,
"catalogueUrl": ...,
"layerType": ...,
"extent": {...},
"controls": {...},
"disabledControls": {...},
"state": {...}
}

⬆️ back to Map

featureLayerNode JSON tree

{
"id": ...,
"name": ...,
"url": ...,
"refreshInterval": ...,
"metadataUrl": ...,
"catalogueUrl": ...,
"layerType": ...,
"toggleSymbology": {...},
"tolerance": {...},
"extent": {...},
"controls": {...},
"disabledControls": {...},
"state": {...},
"table":
{
tableNode
}
}

⬆️ back to Map

wmsLayerNode JSON tree

{
"id": ...,
"name": ...,
"url": ...,
"refreshInterval": ...,
"metadataUrl": ...,
"catalogueUrl": ...,
"layerType": ...,
"featureInfoMimeType": ...,
"legendMimeType": ...,
"layerEntries": [
{
wmsLayerEntryNode
},
{...},
{...}
],
"extent": {...},
"controls": {...},
"disabledControls": {...},
"state": {...}
}

⬆️ back to Map

wmsLayerEntryNode JSON tree

{
"id": ...,
"name": ...,
"allStyles": [...],
"currentStyle": ...,
"controls": {...},
"state": {...}
}

⬆️ back to Map

dynamicLayerNode JSON tree

{
"id": ...,
"name": ...,
"url": ...,
"refreshInterval": ...,
"metadataUrl": ...,
"catalogueUrl": ...,
"layerType": ...,
"toggleSymbology": ...,
"tolerance": ...,
"singleEntryCollapse": ...,
"imageFormat": ...,
"layerEntries": [
{
dynamicLayerEntryNode
},
{...},
{...}
],
"extent": {...},
"controls": {...},
"disabledControls": {...},
"state": {...}
}

⬆️ back to Map

dynamicLayerEntryNode JSON tree

{
"index": ...,
"name": ...,
"outfields": ...,
"stateOnly": ...,
"extent": {...},
"controls": {...},
"state": {...},
"table":
{
tableNode
}
}

⬆️ back to Map

tableNode JSON tree

{
"title": ...,
"description": ...,
"maximize": ...,
"search": ...,
"applyMap": ...,
"columns": [
{
columnNode
}
{...},
{...}
]
}

⬆️ back to Map

columnNode JSON tree

{
"data": ...,
"title": ...,
"description": ...,
"visible": ...,
"width": ...,
"sort": ...,
"searchable": ...,
"filter": [
{
filterNode
}
{...},
{...}
]
}

⬆️ back to Map

filterNode JSON tree

{
"type": ...,
"value": ...,
"static": ...
}

⬆️ back to Map

map

Core map properties (extent sets, levels of detail).

Type	Author section	Advance	Required
object	Map/Extents and Levels of Details	-	-

⬆️ back to Map

map:extentSets

The default, full and maximum extents of the map. |

Type	Author section	Advance	Required
array	Map/Extents and Levels of Details	-	-

⬆️ back to Map

map:lodSets

The levels of detail (zoom scales) available for the map.

Type	Author section	Advance	Required
array	Map/Extents and Levels of Details	-	Yes

⬆️ back to Map

map:tileSchemas

A unique combination of an LoD and an extent set (each basemap must fit into a tile schema).

Type	Author section	Advance	Required
array	Map/Extents and Levels of Details	Yes	Yes

⬆️ back to Map

map:components

Map components.

Type	Author section	Advance	Required
object	Map/Components	-	-

map:components:mouseInfo

Display cursor coordinates at the bottom of the screen.

Type	Author section	Advance	Required
object	Map/Components	-	-

map:components:mouseInfo:enabled

Enabling mouse information at the bottom of the screen.

Type	Default value	Example	Author section	Advance	Required
boolean	-	`true`	Map/Components	-	-

map:components:mouseInfo:spatialReference

Coordinates system and projection used to retrieve localization info from the mouse cursor. For more info see node:spatialReference_

map:components:northArrow

Everything about the North arrow

Type	Author section	Advance	Required
object	Map/Components	-	-

map:components:northArrow:arrowIcon

The graphical icon url/data url of the north arrow.

Type	Default value	Example	Author section	Advance	Required
string	-	`"data:image/png;base64,image encoded"`	Map/Components	-	-

map:components:northArrow:poleIcon

The graphical icon url/data url of the north pole that replaces north arrow when it's on north pole.

Type	Default value	Example	Author section	Advance	Required
string	-	`"data:image/png;base64,image encoded"`	Map/Components	-	-

map:components:northArrow:enabled

Enabling North arrow.

Type	Default value	Example	Author section	Advance	Required
boolean	true	`true`	Map/Components	-	-

map:components:overviewMap

Collapsable overview map.

Type	Author section	Advance	Required
object	Map/Components	-	-

Name	Type	Description	Default value	Example	Author section	Advance	Required
overviewMap : enabled	boolean		-	`true`	Map/Components	-	-
overviewMap : expandFactor	number		`2`	`5`	`true`	Map/Components	-

map:components:scaleBar

Scale bar.

Type	Author section	Advance	Required
object	Map/Components	-	-

Name	Type	Default value	Example	Author section	Advance	Required
scaleBar : enabled	boolean	-	`true`	Map/Components	-	-

map:components:basemap

Collapsable overview map.

Type	Author section	Advance	Required
object	Map/Components	-	-

Name	Type	Default value	Example	Author section	Advance	Required
basemap : enabled	boolean	-	`true`	Map/Components	-	-

⬆️ back to Map

map:initialBasemapId

Initial basemap to load. If not supplied viewer will select any basemap.

Type	Default value	Example	Author section	Advance	Required
string	`Viewer choice`	`"myBaseMapID"`	Map/Basemaps	-	-

⬆️ back to Map

Nodes

Nodes are objects that are part of other object definition

node:attribution:text

Attribution text information.

Name	Type	Description	Default value	Example	Author section	Advance	Required
enabled	boolean	-	`true`	`"true"`	Map/Basemaps	Yes	Yes
value	string	Optional. Contains the attribution value. If empty, it will use copyright text from the server.	`-`	`-`	Map/Basemaps	Yes	Yes

node:attribution:logo

Attribution logo.

Name	Type	Description	Default value	Example	Author section	Advance	Required
enabled	boolean	-	`true`	`true`	Map/Basemaps	Yes	Yes
value	string	URL for the image.	`-`	`"https://path2Image/myAttributionLogo.png"`	Map/Basemaps	Yes	Yes
altText	string	Alternate text for the image.	`-`	`"Attribution is here !"`	Map/Basemaps	Yes	Yes
link	string	URL to go to when clicked.	`-`	`http://www.canada.ca"`	Map/Basemaps	Yes	Yes

⬆️ back to attributionNode

node:extentSetNode:id

Extents set id.

Type	Default value	Example	Author section	Advance	Required
string	`-`	`"EXT_Lambert_3978"`	Map/Extents and Levels of Details	-	Yes

node:extentSetNode:default

The default (starting) extent. For more info see node:extentNode.

Type	Author section	Advance	Required
object	Map/Extents and Levels of Details	-	-

node:extentSetNode:full

The full extent (should give good view of the whole map, not necessarily the maximum extent); default will be used if not supplied. For more info see node:extentNode.

Type	Author section	Advance	Required
object	Map/Extents and Levels of Details	-	-

node:extentSetNode:maximum

The maximum extent; full or default extents will be used if not supplied. For more info see node:extentNode.

Type	Author section	Advance	Required
object	Map/Extents and Levels of Details	-	-

⬆️ back to extentSetNode

node:spatialReference

Projection

Type	Author section	Advance	Required
object	Map	-	-

node:spatialReference:wkid

Well-known identifier.

Type	Default value	Example	Author section	Advance	Required
string	`-`	`3978`	Map	-	-

⬆️ back to Map

node:lodSetNode:id

Level of details Set id.

Type	Default value	Example	Author section	Advance	Required
string	`-`	`"LOD_Lambert_3978"`	Map/Extents and Levels of Details	Yes	Yes

node:lodSetNode:lods

Level of details for a specific tile schema.

Type	Author section	Advance	Required
array	Map/Extents and Levels of Details	Yes	Yes

node:lodSetNode:lods:level

A sequential integer that identify a level.

Type	Default value	Example	Author section	Advance	Required
number	`-`	`3`	Map/Extents and Levels of Details	Yes	Yes

node:lodSetNode:lods:resolution

The smallest spaces between two display elements expressed in map unit of the corresponding projection.

Type	Default value	Example	Author section	Advance	Required
number	`-`	`38364.660062653464`	Map/Extents and Levels of Details	Yes	Yes

node:lodSetNode:lods:scale

Ratio between distance measure on a map and the corresponding distance on the ground.

Type	Default value	Example	Author section	Advance	Required
number	`-`	`145000000`	Map/Extents and Levels of Details	Yes	Yes

⬆️ back to lodSetNode

node:tileSchemaNode:id

A unique id identifying a tile schema (combination of an extent set and a zoom scale).

Type	Default value	Example	Author section	Advance	Required
string	`-`	`"EXT_Lambert_3978#LOD_Lambert_3978"`	Map/Extents and Levels of Details	Yes	Yes

node:tileSchemaNode:name

The name to display in the basemap selector for the set of basemaps referencing this schema.

Type	Default value	Example	Author section	Advance	Required
string	`-`	`"Lambert Maps"`	Map/Extents and Levels of Details	Yes	Yes

node:tileSchemaNode:extentSetId

The extent set to be used for this basemap (should reference map.extentSets.id).

Type	Default value	Example	Author section	Advance	Required
string	`-`	`"EXT_Lambert_3978"`	Map/Extents and Levels of Details	Yes	Yes

node:tileSchemaNode:lodSetId

Optional. The level of details set to be used for this basemap.

Type	Default value	Example	Author section	Advance	Required
string	`-`	`"LOD_Lambert_3978"`	Map/Extents and Levels of Details	Yes	Yes

node:tileSchemaNode:overviewUrl

Optional. If set, the overview map will use this layer instead of the active basemap.

Type	Author section	Advance	Required
object	Map/Extents and Levels of Details	Yes	-

node:tileSchemaNode:overviewUrl:layerType

Layer type that can be of one of those values ["esriImage", "esriTile"]

Type	Default value	Example	Author section	Advance	Required
string	-	`"esriTile"`	Map/Extents and Levels of Details	Yes	Yes

node:tileSchemaNode:overviewUrl:url

The service endpoint of the layer. It should match the type provided in [layerType]((#nodetileschemanodeoverviewurllayertype).

Type	Default value	Example	Author section	Advance	Required
string	-	`"https://services.arcgisonline.com/.../World_Street_Map/MapServer"`	Map/Extents and Levels of Details	Yes	Yes

node:tileSchemaNode:hasNorthPole:url

Indicates if the map projection includes a north pole. Defaults to false to avoid errors.

Type	Default value	Example	Author section	Advance	Required
boolean	-	`true`	Map/Extents and Levels of Details	Yes	Yes

⬆️ back to tileSchemaNode

node:extentNode

Extents coordinates in projection system used by the layer.

Name	Type	Default value	Example	Author section	Advance	Required
xmin	number	`-`	`-2681457`	Map	-	-
ymin	number	`-`	`-883440`	Map	-	-
xmax	number	`-`	`3549492`	Map	-	-
ymax	number	`-`	`3482193`	Map	-	-

⬆️ back to extentNode

node:extentWithReferenceNode

Extents coordinates in projection system used by the layer.

Name	Type	Default value	Example	Author section	Advance	Required
xmin	number	`-`	`-2681457`	Map/Layers	-	Yes
ymin	number	`-`	`-883440`	Map/Layers	-	Yes
xmax	number	`-`	`3549492`	Map/Layers	-	Yes
ymax	number	`-`	`3482193`	Map/Layers	-	Yes

⬆️ back to extentWithReferenceNode

node:initialLayerSettings

Initial layer settings.

Name	Type	Description	Default value	Example	Author section	Advance	Required
opacity	number	Initial opacity.	`1`	`true`	Map/Layers	Yes	-
visibility	boolean	Initial visibility setting.	`true`	`true`	Map/Layers	Yes	-
boundingBox	boolean	Display bounding box.	`false`	`true`	Map/Layers	Yes	-
query	boolean	Allow querying.	`true`	`true`	Map/Layers	Yes	-
snapshot	boolean	Retrieve all feature data immediately on load.	`false`	`true`	Map/Layers	Yes	-
hovertips	boolean	Disable hover tips.	`true`	`true`	Map/Layers	Yes	-

⬆️ back to initialLayerSettings

node:legendEntryControls

A list of all controls to be enabled on the specified layer. Possible values are: "opacity", "visibility", "boundingBox", "query", "snapshot", "metadata", "boundaryZoom", "refresh", "reload", "remove", "settings", "data", "styles"

Type	Default value	Example	Author section	Advance	Required
array	-	`["opacity", "visibility", "boundingBox", "refresh", "reload", "remove", "settings"]`	Map/Layers	Yes	-

⬆️ back to layerNode

node:baseMapNode

BaseMaps node properties.

Type	Author section	Advance	Required
object	Map/Basemaps	-	-

node:baseMapNode:id

A unique identifier for the basemap.

Type	Default value	Example	Author section	Advance	Required
string	-	`"baseRNCan_transport"`	Map/Basemaps	-	Yes

node:baseMapNode:name

Name of the basemap used for labeling.

Type	Default value	Example	Author section	Advance	Required
string	-	`"Transport with labels."`	Map/Basemaps	-	Yes

node:baseMapNode:description

Description of the basemap. Will be visible when basemap selector is expanded.Description of the basemap. Will be visible when basemap selector is expanded.

Type	Default value	Example	Author section	Advance	Required
string	-	`"This Canadian basemap provides geographic context with bilingual labels and an emphasis on transportation networks. From Natural Resources Canada."`	Map/Basemaps	-	Yes

node:baseMapNode:altText

Alt text for the basemap thumbnail image.Alt text for the basemap thumbnail image.

Type	Default value	Example	Author section	Advance	Required
string	-	`"Transport with labels."`	Map/Basemaps	-	Yes

node:baseMapNode:thumbnailUrl

Path to image file to display in the basemap selector.

Type	Default value	Example	Author section	Advance	Required
string	-	`"https://path2Image/myThumbnailImage.png"`	Map/Basemaps	Yes	Yes

node:baseMapNode:tileSchemaId

The tile schema for this basemap (should reference map.tileSchemas.id).

Type	Default value	Example	Author section	Advance	Required
string	-	`"canadaLambert-01"`	Map/Basemaps	-	Yes

node:baseMapNode:layers

A set of URLs which should be composited to form a basemap entry.

Type	Author section	Advance	Required
array	Map/Basemaps	-	-

Each item contains these three properties

Name	Type	Default value	Example	Author section	Advance	Required
id	string	`-`	`"CBMT"`	Map/Basemaps	Yes	Yes
layerType	string	`-`	`"esriFeature"`	Map/Basemaps	Yes	Yes
url	string	`-`	`"https://.../services/BaseMaps/CBMT3978/MapServer"`	Map/Basemaps	-	Yes

⬆️ back to baseMapNode

node:basicLayerNode

Layers coming from either esri image or tile services.

Type	Author section	Advance	Required
object	Map/Layers or Map/Extents and Levels of Details	-	-

node:basicLayerNode:id

The id of the layer for referencing within the viewer (does not relate directly to any external service).

Type	Default value	Example	Author section	Advance	Required
string	-	`"basicLayer_1"`	Map/Layers or Map/Extents and Levels of Details	-	Yes

node:basicLayerNode:name

The display name of the layer. If it is not present the viewer will make an attempt to scrape this information.

Type	Default value	Example	Author section	Advance	Required
string	-	`"Elevation"`	Map/Layers or Map/Extents and Levels of Details	-	Yes

node:basicLayerNode:url

The service endpoint of the layer. It should match the type provided in layerType.

Type	Default value	Example	Author section	Advance	Required
string	-	`"https://.../arcgis/rest/services/tileService"`	Map/Layers or Map/Extents and Levels of Details	-	Yes

node:basicLayerNode:refreshInterval

The automatic refresh interval of the layer in minutes. Maximum interval is 100 minutes.

Type	Default value	Example	Author section	Advance	Required
number	`0`	`5`	Map/Layers or Map/Extents and Levels of Details	Yes	-

node:basicLayerNode:metadataUrl

The metadata url of the layer service.

Type	Default value	Example	Author section	Advance	Required
string	`null`	`"https://.../metaDat"`	Map/Layers or Map/Extents and Levels of Details	Yes	-

node:basicLayerNode:catalogueUrl

The metadata url of the layer service.

Type	Default value	Example	Author section	Advance	Required
string	`null`	`"https://.../catalogue"`	Map/Layers or Map/Extents and Levels of Details	Yes	-

node:basicLayerNode:layerType

Type of layer. Can be either esriImage or esriTile.

Type	Default value	Example	Author section	Advance	Required
string	`-`	`"esriFeature"`	Map/Layers or Map/Extents and Levels of Details	-	Yes

⬆️ back to basicLayerNode

node:featureLayerNode

Layers coming from an esri feature service.

Type	Author section	Advance	Required
object	Map/Layers	-	-

node:featureLayerNode:id

The id of the layer for referencing within the viewer (does not relate directly to any external service).

Type	Default value	Example	Author section	Advance	Required
string	-	`"featureLayer_1"`	Map/Layers	-	Yes

node:featureLayerNode:name

The display name of the layer. If it is not present the viewer will make an attempt to scrape this information.

Type	Default value	Example	Author section	Advance	Required
string	-	`"Power plants"`	Map/Layers	-	Yes

node:featureLayerNode:url

The service endpoint of the layer. It should match the type provided in layerType.

Type	Default value	Example	Author section	Advance	Required
string	-	`"https://.../MapServer/20"`	Map/Layers	-	Yes

node:featureLayerNode:refreshInterval

The automatic refresh interval of the layer in minutes. Maximum interval is 100 minutes.

Type	Default value	Example	Author section	Advance	Required
number	`0`	`5`	Map/Layers	Yes	-

node:featureLayerNode:metadataUrl

The metadata url of the layer service.

Type	Default value	Example	Author section	Advance	Required
string	`null`	`"https://.../metaDat"`	Map/Layers	Yes	-

node:featureLayerNode:catalogueUrl

The metadata url of the layer service.

Type	Default value	Example	Author section	Advance	Required
string	`null`	`"https://.../catalogue"`	Map/Layers	Yes	-

node:featureLayerNode:layerType

Type of layer which can only be esriFeature.

Type	Default value	Example	Author section	Advance	Required
string	`-`	`"esriFeature"`	Map/Layers	-	Yes

node:featureLayerNode:toggleSymbology

Allows individual symbols to have visibility toggled on/off.

Type	Default value	Example	Author section	Advance	Required
boolean	`true`	`true`	Map/Layers	Yes	-

node:featureLayerNode:tolerance

Specifies the tolerance in pixels when determining if a feature was clicked. Should be non-negative integer.

Type	Default value	Example	Author section	Advance	Required
boolean	`5`	`8`	Map/Layers	Yes	-

⬆️ back to featureLayerNode

node:wmsLayerNode

Layers coming from an esri feature service.

Type	Author section	Advance	Required
object	Map/Layers	-	-

node:wmsLayerNode:id

The id of the layer for referencing within the viewer (does not relate directly to any external service).

Type	Default value	Example	Author section	Advance	Required
string	-	`"wmsLayer_1"`	Map/Layers	-	Yes

node:wmsLayerNode:name

The display name of the layer. If it is not present the viewer will make an attempt to scrape this information.

Type	Default value	Example	Author section	Advance	Required
string	-	`"Power plants"`	Map/Layers	-	Yes

node:wmsLayerNode:url

The service endpoint of the layer. It should match the type provided in layerType.

Type	Default value	Example	Author section	Advance	Required
string	-	`"https://.../WMSServer"`	Map/Layers	-	Yes

node:wmsLayerNode:refreshInterval

The automatic refresh interval of the layer in minutes. Maximum interval is 100 minutes.

Type	Default value	Example	Author section	Advance	Required
number	`0`	`5`	Map/Layers	Yes	-

node:wmsLayerNode:metadataUrl

The metadata url of the layer service.

Type	Default value	Example	Author section	Advance	Required
string	`null`	`"https://.../metaDat"`	Map/Layers	Yes	-

node:wmsLayerNode:catalogueUrl

The metadata url of the layer service.

Type	Default value	Example	Author section	Advance	Required
string	`null`	`"https://.../catalogue"`	Map/Layers	Yes	-

node:wmsLayerNode:layerType

Type of layer which can only be ogcWms.

Type	Default value	Example	Author section	Advance	Required
string	`-`	`"ogcWms"`	Map/Layers	-	Yes

node:wmsLayerNode:featureInfoMimeType

If specified indicates that GetFeatureInfo should be enabled for this WMS and indicates the format that should be requested. Possible values are [ "text/html;fgpv=summary", "text/html", "text/plain", "application/json" ].

Type	Default value	Example	Author section	Advance	Required
string	`-`	`"text/plain"`	Map/Layers	-	-

node:wmsLayerNode:legendMimeType

If specified indicates that GetLegendGraphic should be enabled for this WMS and indicates the format that should be requested. Possible values are [ "image/png", "image/gif", "image/jpeg", "image/svg", "image/svg+xml" ].

Type	Default value	Example	Author section	Advance	Required
string	`-`	`"image/png"`	Map/Layers	-	-

⬆️ back to wmsLayerNode

node:wmsLayerEntryNode

One layer entry in a WMS service.

Type	Author section	Advance	Required
object	Map/Layers	-	-

node:wmsLayerEntryNode:id

The id of the layer entry in the WMS.

Type	Default value	Example	Author section	Advance	Required
string	-	`"wind_en"`	Map/Layers	-	Yes

node:wmsLayerEntryNode:name

A descriptive name for the layer. To be used in the legend.

Type	Default value	Example	Author section	Advance	Required
string	-	`"Wind layer"`	Map/Layers	-	Yes

node:wmsLayerEntryNode:allStyles

All the styles for the layer entry in the WMS.

Type	Default value	Example	Author section	Advance	Required
array	-	`[ "WINDARROW", "WINDARROWKMH", "WINDSPEED", "WINDSPEEDKMH" ]`	Map/Layers	-	Yes

node:wmsLayerEntryNode:currentStyle

The current style for the layer entry in the WMS.

Type	Default value	Example	Author section	Advance	Required
string	-	`"WINDSPEEDKMH"`	Map/Layers	Yes	-

⬆️ back to wmsLayerEntryNode

node:dynamicLayerNode

Layers coming from an esri feature service.

Type	Author section	Advance	Required
object	Map/Layers	-	-

node:dynamicLayerNode:id

The id of the layer for referencing within the viewer (does not relate directly to any external service).

Type	Default value	Example	Author section	Advance	Required
string	-	`"dynamicLayer_1"`	Map/Layers	-	Yes

node:dynamicLayerNode:name

The display name of the layer. If it is not present the viewer will make an attempt to scrape this information.

Type	Default value	Example	Author section	Advance	Required
string	-	`"Power plants"`	Map/Layers	-	Yes

node:dynamicLayerNode:url

The service endpoint of the layer. It should match the type provided in layerType.

Type	Default value	Example	Author section	Advance	Required
string	-	`"https://.../MapServer/"`	Map/Layers	-	Yes

node:dynamicLayerNode:refreshInterval

The automatic refresh interval of the layer in minutes. Maximum interval is 100 minutes.

Type	Default value	Example	Author section	Advance	Required
number	`0`	`5`	Map/Layers	Yes	-

node:dynamicLayerNode:metadataUrl

The metadata url of the layer service.

Type	Default value	Example	Author section	Advance	Required
string	`null`	`"https://.../metaDat"`	Map/Layers	Yes	-

node:dynamicLayerNode:catalogueUrl

The metadata url of the layer service.

Type	Default value	Example	Author section	Advance	Required
string	`null`	`"https://.../catalogue"`	Map/Layers	Yes	-

node:dynamicLayerNode:layerType

Type of layer which can only be esriDynamic.

Type	Default value	Example	Author section	Advance	Required
string	`-`	`"esriDynamic"`	Map/Layers	-	Yes

node:dynamicLayerNode:toggleSymbology

Allows individual symbols to have visibility toggled on/off.

Type	Default value	Example	Author section	Advance	Required
boolean	`true`	`true`	Map/Layers	Yes	-

node:dynamicLayerNode:singleEntryCollapse

Indicates that the dynamic layer with a single layer entry should be rendered without the root group.

Type	Default value	Example	Author section	Advance	Required
boolean	`true`	`true`	Map/Layers	-	-

node:dynamicLayerNode:tolerance

Specifies the tolerance in pixels when determining if a feature was clicked. Should be non-negative integer.

Type	Default value	Example	Author section	Advance	Required
boolean	`5`	`8`	Map/Layers	Yes	-

⬆️ back to dynamicLayerNode

node:dynamicLayerEntryNode

Layer entry coming from an esri dynamic service.

Type	Author section	Advance	Required
object	Map/Layers	-	-

node:dynamicLayerEntryNode:index

The index of the layer in the map service.

Type	Default value	Example	Author section	Advance	Required
number	-	`0`	Map/Layers	-	Yes

node:dynamicLayerEntryNode:name

A descriptive name for the layer, can override the name coming from the service.

Type	Default value	Example	Author section	Advance	Required
string	-	`"Solar stations"`	Map/Layers	-	-

node:dynamicLayerEntryNode:outfields

A descriptive name for the layer, can override the name coming from the service.

Type	Default value	Example	Author section	Advance	Required
string	-	`"Solar stations"`	Map/Layers	Yes	-

node:dynamicLayerEntryNode:stateOnly

A flag indicating this entry is only for state tracking (i.e. it should not be displayed on the UI and all of the controls will be ignored, but the layer itself will be displayed on the map with the given state settings).

Type	Default value	Example	Author section	Advance	Required
boolean	`false`	`true`	Map/Layers	Yes	-

⬆️ back to dynamicLayerNode

node:tableNode

Specifies how layers columns and global search are set.

Type	Author section	Advance	Required
object	Map/Layers	Yes	-

node:tableNode:title

Specifies the table title to apply.

Type	Default value	Example	Author section	Advance	Required
string	-	`"GeoChronology"`	Map/Layers	Yes	-

node:tableNode:description

Specifies the additional information to display in the setting panel to give more information about a table.

Type	Default value	Example	Author section	Advance	Required
string	-	`"Here is my description."`	Map/Layers	Yes	-

node:tableNode:maximize

Specifies the default table size when first open. True: maximize view; False: split view.

Type	Default value	Example	Author section	Advance	Required
boolean	`false`	`true`	Map/Layers	Yes	-

node:tableNode:search

Specifies the default filter to apply to a table (for global search).

Name	Type	Default value	Example	Author section	Advance	Required
enabled	boolean	`true`	`true`	Map/Layers	Yes	-------
value	string	`null`	`"LAST_UPDATED:2005-02-22"`	Map/Layers	Yes	-------

node:tableNode:applyMap

Specifies if the default filters (from columns filter) are apply to the map (definition query). True: it is applied; False: it is not applied.

Type	Default value	Example	Author section	Advance	Required
boolean	`false`	`true`	Map/Layers	Yes	-

⬆️ back to tableNode

node:columnNode

Specifies option for each column. OID field must be present, if not data will not appear. The order they appears inside the table is the same as the order of this array.

Type	Author section	Advance	Required
object	Map/Layers	Yes	-

node:columnNode:data

Specifies the field name (data) to use to link to the layer column. Must exist in the layer.

Type	Default value	Example	Author section	Advance	Required
string	-	`"LAST_UPDATED"`	Map/Layers	Yes	-

node:columnNode:title

Specifies the column title, uses the layer column name or alias if missing.

Type	Default value	Example	Author section	Advance	Required
string	-	`"Last updated"`	Map/Layers	Yes	-

node:columnNode:description

Specifies the additional information to display in the setting panel to give more information about a column. Do not add description if missing.

Type	Default value	Example	Author section	Advance	Required
string	-	`"Here is my description."`	Map/Layers	Yes	-

node:columnNode:visible

Specifies if column is visible by default. True: column is visible; False: column is hidden.

Type	Default value	Example	Author section	Advance	Required
boolean	`true`	`true`	Map/Layers	Yes	-

node:columnNode:width

Specifies the column width. If missing, calculated column width will be used.

Type	Default value	Example	Author section	Advance	Required
number	-	`12`	Map/Layers	Yes	-

node:columnNode:sort

Specifies if column is sort. If missing, no sort is applied. Possible values are ["asc", "desc"].

Type	Default value	Example	Author section	Advance	Required
string	-	`"asc"`	Map/Layers	Yes	-

node:columnNode:searchable

Specifies if column can be filtered. True: column can be filtered; False: no filter can be applied from global search or filter. If this is false, do not set a filter because it will not be use.

Type	Default value	Example	Author section	Advance	Required
boolean	`true`	`true`	Map/Layers	Yes	-

⬆️ back to columnNode

node:filterNode

Specifies the filter information for a column.

Type	Author section	Advance	Required
object	Map/Layers	Yes	-

node:filterNode:type

Specifies the filter type to use. If type is not specified, data field type will be use. String filter can be string or selector. Other filter must be the same type. If not, apply on map will fails. Possible values are [ "string", "number", "date", "selector" ].

Type	Default value	Example	Author section	Advance	Required
string	-	`"date"`	Map/Layers	Yes	Yes

node:filterNode:value

Specifies the filter value. For date and number values are split by ',' (e.g. 0,100 or for date 2005-02-22,2005-04-30). Dates need to be in the format YYYY-MM-DD. For selector it needs an array like ["Fire", "Fatality"].

Type	Default value	Example	Author section	Advance	Required
string	-	`"2005-02-22,2005-04-30"`	Map/Layers	Yes	-

node:filterNode:static

Specifies if filter is modifiable. True: filter value can't be modified; False: filter value can be modified.

Type	Default value	Example	Author section	Advance	Required
boolean	`false`	`true`	Map/Layers	Yes	-

⬆️ back to filterNode

⬆️ back to Map top

Annex

Schema

FGPV JSON schema
- Map
- UI
- Services
- Version
- Language

Version

Version update

Other

T & C of Use: English license | French license
Pull request process

Map

Map

Map JSON tree

map

Nodes

Annex

Clone this wiki locally