Skip to content

URL parameters

Jump to bottom
F.Moser edited this page Jan 19, 2022 · 29 revisions

MapX list of url parameters

  • closePanels
/**
* Close all panels at init time.
* 
* @param {Boolean|String} <value> true|false.
* @example `app.mapx.org?closePanels=true`
*/
  • showProjectsListByRole
/**
* Display a modal dialog at the beginning of a session with filtered project
*
* @param {string} <group> One of ['any','member','publisher','admin']
* @example `app.mapx.org?showProjectsListByRole=member`
*/
  • showProjectsListByTitle
/**
* Display a modal dialog at the beginning of a session with filtered project
*
* @param {string} <title> project title in english
* @example `app.mapx.org?showProjectsListByTitle=WESR*`
*/
  • project
/**
* Loads a specific project page in MapX. If not specified, MapX loads the "World" project page by default, or the last project that was visualized by the logged user.
*
* @param {string} <values> The ID of one project.
* @example `app.mapx.org?project=YYY`
*/
  • views
/**
* Filter the views in the panel according to their ID. It accepts multiple IDs. It requires the parameter "project" to be stated.
*
* @param {string} <values> The ID of a number of views, separated by a comma.
* @example `app.mapx.org?project=YYY&views=XXX`
*/
  • viewsListFilterActivated
/**
* Hide other views than those specified in `views`. Same effect as if the button "Filter Activated Views" was active.
*
* @param {boolean} <value> 
* @example `app.mapx.org?project=YYY&views=XXX&viewsListFilterActivated=true`
*/
  • viewsListFlatMode
/**
* Display the views list outside the categories tree structure, if any. Everything will be on the base level.  
*
* @param {boolean} <value> 
* @example `app.mapx.org?project=YYY&views=XXX&viewsListFlatMode=true`
*/
  • zoomToViews
/**
* Automatically zoom on the views extent after everything is loaded
*
* @param {boolean} <value> 
* @example `app.mapx.org?project=YYY&views=XXX&zoomToViews=true`
*/
  • collections
/**
* Filter the views in the panel according to the collections they are tagged with. If more than one collection is stated, the views tagged with at least one of them are loaded. It requires "project" parameter to be stated in the url.
*
* @param {string} <values> The name of one or more collection must be stated, separated by a comma.
* @example `app.mapx.org?project=YYY&collections=unbiodiversitylab,pollution`
*/
  • collectionsSelectOperator
/**
* Define how the combination of collections in the url must be used in 
* order to filter views in the panel. Use only when filtering according 
* to more than one collection. Requires the "project" parameter to be stated.
*
* @param {string} <value> ANY|ALL. "ANY" is the default value. MapX loads the
* views that are tagged with at least one of the collections stated in the url. 
* The use of "ANY" is equivalent to not stating "collectionsSelectOperator" in 
* the url. "ALL" forces the filter criteria to only load the views that are
* tagged with all the stated collections. 
* @example `app.mapx.org?project=YYY&collections=unbiodiversitylab,pollution&collectionsSelectOperator=ALL`
*/
  • lockProject
/**
* Disable the click function on the project button. The consequence is that the user can't change project from the MapX page. Requires the "project" parameter to be stated.
*
* @param {Boolean|String} <value> true|false.  
* @example `app.mapx.org?lockProject=true`
*/
  • noViews
/**
* Loads a specific project in MapX with no views displayed on the views panel. This parameter stands above the filtering process operated through other parameters such as "collections", "collectionsSelectOperator", "views". Requires the "project" parameter to be stated.
* 
* @param {Boolean|String} <value> true|false.  
* @example `app.mapx.org?noViews=true`
*/
  • storyAutoStart
/**
* Loads a specific storymap without the usual interface and directly plays it.
* 
* @param {Boolean|String} <value> true|false. It must be associated to the parameter "views", which should be equal to 1 only view of story map type.  
* @example `app.mapx.org?views=XXX&storyAutoStart=true`
*/
  • lat
/**
* Defines the latitude of the centroid of the map when MapX is loaded (in EPSG:4326). It overwrites the default spatial parameters associated to a project for the specific session.
* 
* @param {numeric} <values>  min: -90, max: 90. Spatial parameters (lat, lng, zoom) are either all required in the URL or none of them is used.
* @example `https://app.mapx.org/?lat=-9.52&lng=18.41&zoom=6`
*/
  • lng
/**
* Defines the longitude of the centroid of the map when MapX is loaded (in EPSG:4326). It overwrites the default spatial parameters associated to a project for the specific session.
* 
* @param {numeric} <values> min: -180, max: 180.  Spatial parameters (lat, lng, zoom) are either all required in the URL or none of them is used.
* @example `https://app.mapx.org/?lat=-9.52&lng=18.41&zoom=6`
*/
  • zoom
/**
* Defines the zoom level of the map when MapX is loaded. It overwrites the default spatial parameters associated to a project for the specific session.
* 
* @param {numeric} <values>  min: 0, max: 22.  Spatial parameters (lat, lng, zoom) are either all required in the URL or none of them is used.
* @example `https://app.mapx.org/?lat=-9.52&lng=18.41&zoom=6`
*/
  • action
/**
* Internal method for passing encrypted actions
*
* @param {string} <action> Encrypted string
* @example `app.mapx.org?action=xxxxx`
*/
  • language
/**
* Loads the app on a specific language. Content that does not exist in the selected language will be displayed in english. If not specified, the default language "english" is used.
*
* @param {string} <language> 2 digits code among "en", "fr, "es", "de", "ru", "fa", "ps", "bn", "zh". 
* @example `app.mapx.org/?language=fr`
*/

Anything unclear or inaccurate? Please let us know at [email protected]

Clone this wiki locally