FGPV_schema_doc

The Federal Geospatial Platform Viewer (FGPV) schema V. 2.3

The schema.json file can be found here

[Map](#map)
UI
Services
Version
Language

Appendix

UI

User Interface configuration

"ui": {
    "fullscreen": ...,
    "logoUrl": ...,
    "title": ...,
    "restrictNavigation": ...,
    "failureFeedback": {
        "failureMessage": ...,
        "failureImageUrl": ...
    },
    "appBar": {
        "sideMenu": ...,
        "geoSearch": ...,
        "basemap": ...,
        "layers": ...
    },
    "navBar": {
        "extra": ...
    },
    "sideMenu": {
        "logo": ...,
        "items": [   ]
    },
    "about": {
            "content": ...,
        OR
            "folderName": ...
    },
    "help": {
        "folderName": ...,
    },
    "legend": {
        "reorderable": ...,
        "allowImport": ...,
        "isOpen": {
                "large": ...,
                "medium": ...,
                "small": ...
        }
    },
    "tableIsOpen": {
        "id": ...,
        "large": ...,
        "medium": ...,
        "small": ...
    }
}

ui

User Interface configuration.

Type	Author section	Advance	Required
object	UI	-	-

ui:fullscreen

Indicates viewer takes up entire viewport.

Type	Default value	Example	Author section	Advance	Required
boolean	`false`	`false`	UI/General	-	-

ui:logoUrl

An optional image to be used in the place of the default viewer logo.

Type	Default value	Example	Author section	Advance	Required
string	-	`"data:image/png;base64,image encoded"`	UI/Side Menu	Yes	-

ui:title

An optional title to be used in the place of the default viewer title.

Type	Default value	Example	Author section	Advance	Required
string	-	`My custom title`	UI/Side Menu	-	-

ui:restrictNavigation

Will restrict the user from panning beyond the maximum extent.

Type	Default value	Example	Author section	Advance	Required
boolean	`false`	`false`	UI/Navigation	-	-

ui:failureFeedback

Failure information.

Type	Author section	Advance	Required
object	UI/General	Yes	-

ui:failureFeedback:failureMessage

An optional message to be used in place of the failure message.

Type	Default value	Example	Author section	Advance	Required
string	-	`"That's a fail :-("`	UI/General	Yes	-

ui:failureFeedback:failureImageUrl

An optional image to be used in place of the failure Image.

Type	Default value	Example	Author section	Advance	Required
string	-	`"https://path2Image/MyFailureImage.gif"`	UI/General	Yes	-

ui:appBar

Provides configuration to the main app toolbar. If not supplied, the default appbar controls are displayed. To completely hide the toolbar, provide the following: { sideMenu: false, geoSearch: false, layers: false }.

Type	Author section	Advance	Required
object	UI/Application Bar	-	-

appBar:sideMenu

Shows the side menu button in the main app toolbar.

Type	Default value	Example	Author section	Advance	Required
boolean	`true`	`true`	UI/Application Bar	-	-

appBar:geoSearch

Shows the geosearch button in the main app toolbar. The button will be hidden if geosearch component is disabled or no search service URLs are provided.

Type	Default value	Example	Author section	Advance	Required
boolean	`true`	`true`	UI/Application Bar	-	-

appBar:basemap

Shows the basemap selector button in the main app toolbar.

Type	Default value	Example	Author section	Advance	Required
boolean	`true`	`true`	UI/Application Bar	-	-

appBar:layers

Shows the layers button in the main app toolbar.

Type	Default value	Example	Author section	Advance	Required
boolean	`true`	`true`	UI/Application Bar	-	-

ui:navBar

Provides configuration to the nav bar. If not supplied the default nav bar buttons are shown.

Type	Author section	Advance	Required
object	UI/Navigation	-	-

navBar:extra

Set visible navigation bar buttons. Possible values: "geoLocator", "home", "basemap", "help", "fullscreen", "geoSearch", "sideMenu", "layers"

Type	Default value	Example	Author section	Advance	Required
array	`["fullscreen", "geoLocator", "home", "help"]`	`["home", "help", "fullscreen", "geoSearch", "sideMenu", "layers"]`	UI/Navigation	-	-

sideMenu

Type	Default value	Example	Author section	Advance	Required
ui : sideMenu	object	Specifies which options are available in the left side menu.			UI/Side Menu
sideMenu : logo	boolean	Indicates if the logo should be shown in the left side menu.	`true`	`true`	UI/Side Menu
sideMenu : items	array	Side Menu set of buttons. Divide the menu using array symbols []. Possible values are "layers", "basemap", "geoSearch", "about", "fullscreen", "export", "share", "touch", "help", "language", "plugins"	`[["layers", "basemap"], ["fullscreen", "export", "share", "touch", "help", "about"], ["language"], ["plugins"]]`	`[["layers", "basemap"], ["fullscreen", "export", "about"], ["language"]]`	UI/Side Menu

about

Type	Default value	Example	Author section	Advance	Required
about	object	Specifies the location/content of the about section.			UI/Side Menu
about : content	string	The content of the about section.	-	`"This is about about"`	UI/Side Menu
about : folderName	string	The folder which contains the content for the about section.	-	`\aboutIsHere\`	UI/Side Menu

Type	Default value	Example	Author section	Advance	Required
help	object	Specifies details for the Help section.			UI/Side Menu
help : folderName	string	Help folder name which contains the help description and images.		`\HelpIsHere\`	UI/Side Menu

legend

Type	Default value	Example	Author section	Advance	Required
legend	object	Specifies options for the legend like reordering, importing, etc.			UI/General
legend : reorderable	boolean	Specifies if the items in the legend can be reordered; structured legend ignores this property.	`true`	`true`	UI/General
legend : allowImport	boolean	Specifies if the user-added layers are allowed.	`true`	`true`	UI/General
legend : isOpen	object	Specifies whether the legend is opened by default on initial loading of the map for small, medium, and large viewports.			UI/General
isOpen : large	boolean	Whether the legend is opened by default on initial loading of the map for large viewports.	`false`	`false`	UI/General
isOpen : medium	boolean	Whether the legend is opened by default on initial loading of the map for medium viewports.	`false`	`false`	UI/General
isOpen : small	boolean	Whether the legend is opened by default on initial loading of the map for small viewports.	`false`	`false`	UI/General

tableIsOpen

Type	Default value	Example	Author section	Advance	Required
tableIsOpen	object	A set of service endpoints used by the viewer.			UI/General
id	string	The id of the layer for referencing within the viewer.	-	`"mylayerID"`	UI/General
large	boolean	Whether the table panel is opened by default on initial loading of the map for large viewports.	`false`	`false`	UI/General
medium	boolean	Whether the table panel is opened by default on initial loading of the map for medium viewports.	`false`	`false`	UI/General
small	boolean	Whether the table panel is opened by default on initial loading of the map for small viewports.	`false`	`false`	UI/General

back to UI top

Services

A set of service endpoints used by the viewer.

"services": {
    "proxyUrl": ...,
    "exportMapUrl": ...,
    "geometryUrl": ...,
    "googleAPIKey": ...,
    "search": {
        "disabledSearches": [...],
        "serviceUrls": {
            "geoNames": ...,
            "geoLocation": ...,
            "geoSuggest": ...,
            "provinces": ...,
            "types": ...,
        }
    },
    "export": {
        "title": {
            "isSelected": ...,
            "isSelectable": ...,
            "value": ...
        },
        "map": {
            "isSelected": ...,
            "isSelectable": ...
        },
        "mapElements": {
            "isSelected": ...,
            "isSelectable": ...
        },
        "legend": {
            "isSelected": ...,
            "isSelectable": ...
        },
        "footnote": {
            "isSelected": ...,
            "isSelectable": ...,
            "value": ...
        },
        "timestamp": {
            "isSelected": ...,
            "isSelectable": ...
        }
    }
}

services

A set of service endpoints used by the viewer.

Type	Default value	Example	Author section	Advance	Required
object			Services	-	-

services:proxyUrl

An optional proxy to be used for dealing with same-origin issues. URL must either be a relative path on the same server or an absolute path on a server which sets CORS headers.

Type	Default value	Example	Author section	Advance	Required
string	`""`	`"http://.../ProxyEndPoint"`	Services/Service End Points	Yes	-

services:exportMapUrl

An ESRI service endpoint for generating map images. Should point directly to an endpoint that can be consumed by ESRI PrintTask. NOTE: The PrintTask service has to be asynchronous.

Type	Default value	Example	Author section	Advance	Required
string	`""`	`"http://.../ExportMapEndPoint"`	Services/Service End Points	Yes	-

services:geometryUrl*

A URL to an ESRI ArcGIS geometry service REST endpoint.

Type	Default value	Example	Author section	Advance	Required
string	`""`	`"http://.../GeometryEndPoint"`	Services/Service End Points	Yes	-

services:googleAPIKey

Google API key to enable geo location.

Type	Default value	Example	Author section	Advance	Required
string	`""`	`"AIzaSyBT6w4TvRdWFhFk35tc"`	Services/Service End Points	Yes	-

services:search

Search properties including ability to disable certain types of searches (NTS, FSA, and/or LAT/LNG) and to set service endpoint urls.

Type	Default value	Example	Author section	Advance	Required
object			Services/Geo Search	-	-

services:search:disabledSearches

Enable specific types of searches including: National Topographic System, Postal Code/Foward Sorting Area or Latitude/Longitude (e.g. 58.12;-100.67).

Type	Default value	Example	Author section	Advance	Required
array	`[]`	`["NTS","LAT/LNG"]`	Services/Geo Search	-	-

services:search:serviceUrls

Service endpoint urls.

Type	Default value	Example	Author section	Advance	Required
object			Services/Geo Search	Yes	-

services:serviceUrls:geoLocation

Endpoint url for geoLocation service.

Type	Default value	Example	Author section	Advance	Required
string	`""`	`"https://.../en/locate?q="`	Services/Geo Search	Yes	-

services:serviceUrls:geoNames

Endpoint url for geoNames service.

Type	Default value	Example	Author section	Advance	Required
string	`""`	`"https://.../en/geonames.json"`	Services/Geo Search	Yes	-

services:serviceUrls:geoSuggest

Endpoint url for geoSuggest service.

Type	Default value	Example	Author section	Advance	Required
string	`""`	`"https://.../en/suggest?q="`	Services/Geo Search	Yes	-

services:serviceUrls:provinces

Endpoint url for provinces service

Type	Default value	Example	Author section	Advance	Required
string	`""`	`"https://.../en/codes/province.json"`	Services/Geo Search	Yes	-

services:serviceUrls:types

Endpoint url for types service.

Type	Default value	Example	Author section	Advance	Required
string	`""`	`"https://.../en/codes/concise.json"`	Services/Geo Search	Yes	-

services:export

Export properties.

Type	Author section	Advance	Required
object	Services/Export Map	-	-

services:export:title

Export title's properties.

Type	Author section	Advance	Required
object	Services/Export Map	-	-

Name	Type	Description	Default value	Example	Author section	Advance	Required
title : isSelectable	boolean		`true`	`true`	Services/Export Map	-	-
title : isSelected	boolean		`true`	`true`	Services/Export Map	-	-
title : value	string	Value to appear by default	`""`	`"My map title"`	Services/Export Map	-	-

services:export:map

Map component.

Type	Author section	Advance	Required
object	Services/Export Map	Yes	-

Name	Type	Description	Default value	Example	Author section	Advance	Required
map : isSelectable	boolean		`true`	`true`	Services/Export Map	Yes	-
map : isSelected	boolean		`true`	`true`	Services/Export Map	Yes	-

services:export:mapElements

North arrow and scalebar component.

Type	Author section	Advance	Required
object

Name	Type	Description	Default value	Example	Author section	Advance	Required
mapElements : isSelectable	boolean		`true`	`true`	Services/Export Map	-	-
mapElements : isSelected	boolean		`true`	`true`	Services/Export Map	-	-

services:export:legend

Legend component.

Type	Author section	Advance	Required
object	Services/Export Map	Yes	-

Name	Type	Description	Default value	Example	Author section	Advance	Required
legend : isSelectable	boolean		`true`	`true`	Services/Export Map	-	-
legend : isSelected	boolean		`true`	`true`	Services/Export Map	-	-

services:export:footnote

Foot notice to add to exported map.

Type	Author section	Advance	Required
object	Services/Export Map	Yes	-

Name	Type	Description	Default value	Example	Author section	Advance	Required
footnote : isSelectable	boolean		`true`	`true`	Services/Export Map	-	-
footnote : isSelected	boolean		`true`	`true`	Services/Export Map	-	-
footnote : value	string	Footnote value to appear by default	`""`	`"This is a foot notice"`	Services/Export Map	-	-

services:export:timestamp

Timestamp component.

Type	Author section	Advance	Required
object	Services/Export Map	-	-

Name	Type	Description	Default value	Example	Author section	Advance	Required
timestamp : isSelectable	boolean		`true`	`true`	Services/Export Map	-	-
timestamp : isSelected	boolean		`true`	`true`	Services/Export Map	-	-

back to Services top

Version

The schema version used to validate the configuration file. The schema should enumerate the list of versions accepted by this version of the viewer.

"version": "2.2"

Language

ISO 639-1 code indicating the language of strings in the schema file.

ISO 639-1 code	Language	Default
"en"	English	Yes
"fr"	French

"language": "en"

Appendix

ui : fullscreen

    "ui"{
        ...,
        "fullscreen": true,
        ...
    }

back to fullscreen

ui : logoUrl

Note: if you want your custom logo to be shown, you have to set "sideMenu" {"logo": true} (see sideMenu)

    "ui"{
        ...,
        "logoUrl": "data:image/png;base64,image encoded",
        ...
    }

back to logoUrl

ui : title

    "ui"{
        ...,
        "title": "Custom title",
        ...
    }

title

back to title

ui : restrictNavigation

    "ui"{
        ...,
        "restrictNavigation": true,
        ...
    }

back to restrictNavigation

ui : failureFeedback

    "ui"{
        ...,
        "failureFeedback": {
            "failureMessage": "That's a fail :-(",
            "failureImageUrl":"https://files.gitter.im/AleksueiR/eR5s/dinoscream.gif"
        },
        ...
    }

failureFeedback

back to failureFeedback

ui : appBar

The application bar could be found at the top left corner of the viewer.

    "ui"{
        ...,
        "appBar": {
            "sideMenu": true,
            "geoSearch": true,
            "basemap": true,
            "layers": true
        },
        ...
    }

Putting false to an element will hide it.

appBar

back to appBar

ui : navBar

The application bar could be found at the bottom right corner of the viewer.

    "ui"{
        ...,
        "navBar": {
            "extra": ["fullscreen", "geoLocator", "home", "help", "basemap", "geoSearch", "sideMenu", "layers"]
        },
        ...
    }

navBar

back to navBar

services : proxyUrl

You can find more information about proxy services here.

    "services"{
        ...,
        "proxyUrl": "http://.../ProxyEndPoint",
        ...
    }

back to proxyUrl

services : exportMapUrl

You can find more information about exporting map to image services here.

    "services"{
        ...,
        "exportMapUrl": "http://.../ExportMapEndPoint",
        ...
    }

This service is used when you push the DOWNLOAD button of the export dialog window.

download

back to exportMapUrl

services : geometryUrl

You can find more information about the geometry services here.

    "services"{
        ...,
        "geometryUrl": "http://.../GeometryEndPoint",
        ...
    }

back to geometryUrl

services : googleAPIKey

You can find more information about the google API Key service here.

    "services"{
        ...,
        "googleAPIKey": "AIzaSyBT6w4TvRdWFhFk35tc",
        ...
    }

back to googleAPIKey

services : search

    "services"{
        ...,
        "search": {
            "disabledSearches": [...],
            "serviceUrls": {...}
        }
        ...
    }

Searches can be done through the search bar.

back to search

services : search : disabledSearches

Be cautious, the types of search identified in the array will be enabled in the viewer.

        "search": {
            "disabledSearches": ["NTS","LAT/LNG"],
            ...
        }

back to search

services : search : serviceUrls

Default search services are provided by Natural Resources Canada and cover Canadian territories. You can find more information about thoses services here:

GeoLocation API: "geoLocation" and "geoSuggets"

GeoNames API: "geoNames", "provinces" and "types"

    "search": {
        "serviceUrls":{
            "geoNames":"https://geogratis.gc.ca/services/geoname/en/geonames.json",
            "geoLocation":"https://geogratis.gc.ca/services/geolocation/en/locate?q=",
            "geoSuggest":"https://geogratis.gc.ca/services/geolocation/en/suggest?q=",
            "provinces":"https://geogratis.gc.ca/services/geoname/en/codes/province.json",
            "types":"https://geogratis.gc.ca/services/geoname/en/codes/concise.json"
        },
        ...
    }

back to serviceUrls

services : export

    "services"{
        ...,
        "export": {
            "title": {...},
            "map": {...},
            "mapElements": {...},
            "legend": {...},
            "footnote": {...},
            "timestamp": {...}
        },
        ...
    }

Accessing export dialog window

Access

Accessing the export settings can be done through the settings button . Each element of the settings panel can be selected or not by setting the attribute "isSelected" and show or hide in the panel with the use of "isSelectable".

Settings

back to export

services : export : title

    "export": {
      ...,
      "title": {
        "isSelectable": true,
        "isSelected": true,
        "value": "Title"
      },
      ...
    }

title

back to title

services : export : map

    "export": {
      ...,
      "map": {
        "isSelectable": true,
        "isSelected": true
      },
      ...
    }

map

back to map

services : export : mapElements

    "export": {
      ...,
      "mapElements": {
        "isSelectable": true,
        "isSelected": true
      },
      ...
    }

mapElements

back to mapElements

services : export : legend

    "export": {
      ...,
      "legend": {
        "isSelectable": true,
        "isSelected": true
      },
      ...
    }

legend

back to legend

services : export : footnote

    "export": {
      ...,
      "footnote": {
        "isSelectable": true,
        "isSelected": true
      },
      ...
    }

footnote

back to footnote

services : export : timestamp

    "export": {
      ...,
      "timestamp": {
        "isSelectable": true,
        "isSelected": false
      },
      ...
    }

timestamp

back to timestamp

Schema

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

Version

Version update

Other

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

Uh oh!

FGPV_schema_doc

The Federal Geospatial Platform Viewer (FGPV) schema V. 2.3

UI

ui

sideMenu

about

legend

tableIsOpen

Services

services

services:serviceUrls:geoLocation

services:serviceUrls:geoNames

services:serviceUrls:geoSuggest

services:serviceUrls:provinces

services:serviceUrls:types

Version

Language

Appendix

ui : fullscreen

ui : logoUrl

ui : title

ui : restrictNavigation

ui : failureFeedback

ui : appBar

ui : navBar

services : proxyUrl

services : exportMapUrl

services : geometryUrl

services : googleAPIKey

services : search

services : search : disabledSearches

services : search : serviceUrls

services : export

services : export : title

services : export : map

services : export : mapElements

services : export : legend

services : export : footnote

services : export : timestamp

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Clone this wiki locally