Startup Options

Disable project change

If true, changing project (after one has been loaded) will be disabled. ()

disableProjectChange: true

ngDisableProjectChange= true

true | false

Extensions

You can provide your own Core extensions. ()

{ extensions: [ … ] }

-

json / javascript

Extensions overrides

During the development of a project extension, you can use this option to load your local code instead of the project's extension's jsUrl. ()

{ extensionsUrlOverride: [ … ] }

-

json

Enable/Disable Geolocation

By default, the geolocation is activated (if the browser supports it). You can disable the geolocation by using this option. ()

geolocationEnabled: false

ngGeolocationEnabled =false

true | false

Disable UI visibility

If set to true, NG Core will not display a basic UI providing loading progress information, a login form and a project list. By default, this option is disabled in NG App. ()

hideMainLayout: true

-

true | false

Session language

If set to any of the locales supported by JMap NG, it will define the session locale, bypassing browser or user-defined locale. ()

locale: “en“

ngLocale=fr

string

Legacy authentication

If set to true, will revert to a REST API-based authentication setup

legacyAuthentication: true

ngLegacyAuthentication=true

boolean

Organization id

The JMap Cloud organization id. Used when passing a session refresh token (see below). ()

organizationId: "my-organization-id"

organizationId="my-organization-id"

string

Project thumbnails

If true will load all project thumbnails (base 64 images) asynchronously. ()

loadProjectThumbnails: true

-

boolean

Project id

Id of the JMap project to open. ()

projectId: 12

ngProjectId=12

number

Project name

Name of the JMap project to open. If both a project id and a project name are provided, project id will be used. ()

projectName: “World“

ngProjectName=The world url encoded => ngProjectName=World

string

Projects loaded callback

You can provide some JS code to be executed when all project definitions have been loaded from the backend. ()

onProjectsChange: (params) => console.log( params.projects )

-

javascript function() => void

Rest API URL

The Rest API URL of your JMap Server instance. ()

restBaseUrl: “https://api.jmapcloud.io/“

-

string

Session refresh token

A JMap Cloud refresh token used to initiate a session. If valid, will be used to identify the user. ). Using this option will automatically activate the legacy authentication.

token: “v1.MRq[.....]Rehef72YWws“

ngToken=v1.MRq[.....]Rehef72YWws

string

Initial Extent

Will adjust the map to fit the extent when it first loads. (sw = bbox south-west, ne = bbox north-east) (). This option has precedence over the following options: bearing, center, rotation and zoom

map: { extent: { sw: { x: 12.4, y: 45.34 }, ne: { x: 24.4, y: 55.34} } }

ngExtent=12.48|45.34 |24.4|55.34 url encoded => ngExtent=12.48%7C45.34 %7C24.4%7C55.34

json | string

Maximum Extent

Will constrain the map to the specified extent(sw = bbox south-west, ne = bbox north-east) (). .

map: { maximumExtent: { sw: { x: 12.4, y: 45.34 }, ne: { x: 24.4, y: 55.34} } }

ngMaximumExtent=12.48|45.34 |24.4|55.34 url encoded => ngMaximumExtent=12.48%7C45.34 %7C24.4%7C55.34

json | string

Rotation control

By default, the map rotation control is visible, but can be hidden with this parameter. (). This option is overridden by the extent option

map: { mapRotation ControlVisible: true }

ngMapRotationControl Visible=false

true | false

Google Maps Api Key

This option is not yet available for JMap Cloud.

If no Google Maps API key is set in the JMap Cloud or JMap Server configuration, you can provide the API key as a JS parameter. The Google Maps API key is not mandatory, but if you don't provide one you won't have access to the Google Maps basemaps. (API doc)

map: { googleMapsApiKey: “Bse….32k“ }

-

string

Mapbox token

If no Mapbox access token is set in the JMap Cloud or JMap Server configuration, you can provide the token as a JS parameter. The Mapbox token is not mandatory, but if you don't provide one you won't have access to the Mapbox basemaps. ()

map: { mapboxToken: “xgb….4f5“ }

-

string

Navigation history control visibility

By default, the navigation history control is visible, but can be hidden with this parameter. ()

map: { navigationHistory ControlVisible: true }

ngNavigationHistory ControlVisible=true

true | false

Map ready callback

This function is triggered only once, the first time the map is loaded. ()

map: { onStartupMapReadyFn: map => { console.log(“The map is ready“, map) } }

-

javascript function(map: mapboxgl.Map) => void

Map initial rotation

The initial rotation of the map (clockwise rotation). ()

map: { rotation: 45 }

ngRotation=45

number

Scale-control position

The scale control position on the map. ()

map: { scaleControlPosition: “bottom-right“ }

-

“top-left” | “top-right” | “bottom-right” | “bottom-left”

Scale-control unit

The scale control unit. ()

map: { scaleControlUnit: “imperial“ }

-

imperial | metric | nautical

Scale-control visibility

By default, the scale control is visible, but can be hidden with this parameter. (

map: { scaleControlVisible: true }

ngScaleControlVisible=false

true | false

Map Info-control visibility

By default, the Map Info control is visible, but can be hidden with this parameter. ()

map: { mapInfoControlVisible: true }

ngMapInfoControlVisible=false

true | false

Terrain-control visibility

By default, the Terrain control is visible, but can be hidden with this parameter. (

map: { terrainControlVisible: true }

ngTerrainControlVisible=false

true | false

Search

When the map is loaded, will execute a search by attribute(s) on the layer, and zoom to the matching features. You can search using multiple attribute values by passing an array in the javascript form, or by passing trailing values in the URL form. An optional parameter lets you specify to display a MouseOver popup on the result feature. This popup will only be displayed if the showMapPopup parameter is true, and if there is only one result to the search. In the URL form, showMapPopup must be passed as a keyword, and at the beginning of the query string ()

map:{ search: { layerId: 2, attributeName: “PEC“, attributeValue: [“RT 201“, "RT 202"], showMapPopup: true } }

ngSearch=showMapPopup |2|PEC|RT 201|RT 202 url encoded => ngSearch=showMapPopup %7C2%7CPEC %7CRT%20201 %7CRT%20202

json | string

Zoom level

The initial zoom level of the map. (). This option is overridden by the extent option

map: { zoom: 5.3456 }

-

number

Login screen background image

You can set a custom background image for the login screen by setting an image url. This image will be displayed to the left of the JMap NG login form. (). Only effective when using legacy authentication

application: { loginBackgroundImageUrl: “http://my-server/my-image“, … }

-

string

Logo image

You can set a custom logo image by setting an image url. The logo will be displayed above the JMap NG login form. (). Only effective when using legacy authentication

application: { logoImageUrl: “http://my-server/my-image“, … }

-

string

App loaded callback

You can provide JS code that will be executed when the app is ready. ()

application: { onAppLoad: () => console.log(“App is loaded“), … }

-

javascript function() => void

App unloaded callback

You can provide JS code that will be executed when the app is unloaded. ()

application: { onAppUnload: () => console.log(“App is not loaded anymore“), … }

-

javascript function() => void

Display a panel

Will show the specified panel at startup. ()

application: { panel: “query“, … }

ngPanel= selection

"layer" | "selection" | "measure" | "mapcontext"| "print" | "user" | "query" | "annotation" | "geometry"

Project list background image

You can set a custom background image for the project list screen by setting an image url. This image will be displayed to the left of the project list. ()

application: { projectBackgroundImageUrl: “http://my-server/my-image“, … }

-

string

Initial side panel visibility

Controls side panel initial visibility. ()

application: { sidePanelInitialVisibility: false, … }

ngSidePanelInitialVisibility= false

true | false

Simple Search control visibility

By default, the Simple Search control is visible, but can be hidden with this parameter. ()

application: { simpleSearchControlVisible: false, … }

ngSimpleSearchControlVisible=false

true | false

Geocoding control visibility

By default, the Geocoding control is visible, but can be hidden with this parameter. ()

application: { geocodingControlVisible: false, … }

ngGeocodingControlVisible=false

true | false

Theme

Will set the theme, dark or light. ()

application: { theme: “light“, … }

ngTheme=light

light | dark