mapStoreConfig File

Configuration Options

• geoStoreBase: Geostore URL (if empty http://<server>:<port>/geostore/rest/ is used)

• proxy:proxy URL

• defaultLanguage: default language code,

• gsSources: Sources for getCapabilities: example:

  { "mapquest": { "ptype": "gxp_mapquestsource" }, "osm": { "ptype": "gxp_osmsource" }, "google": { "ptype": "gxp_googlesource" }, "bing": { "ptype": "gxp_bingsource" }, "ol": { "ptype": "gxp_olsource" } },

• proj4jsDefs: additional proj4js Definitions example:

    {"EPSG:3003":"+proj=tmerc +lat_0=0 +lon_0=9 +k=0.9996 +x_0=1500000 +y_0=0 +ellps=intl +units=m +no_defs"}
  

• map Map Configuration. Example:

  { "projection": "EPSG:900913", "units": "m", "center": [1250000.000000, 5370000.000000], "zoom":5, "maxExtent": [ -20037508.34, -20037508.34, 20037508.34, 20037508.34 ], "layers": [{ "source": "mapquest", "title": "MapQuest OpenStreetMap", "name": "osm", "group": "background" }] }

• tools:Optional Array of tools configurations. If present, overrides the configuration in Composer.js.

• customTools: Optional Array of tools configurations. MapStore provides a default list of plugin used for the viewer. Using customTools you can provide an additional plugin configuration list to the default one.By default you cannot have two configuration of the same plugin. So that defined in customTools override the default one. In order to override this behavior MapStore allows you to specify a forceMultiple (setted to true) for the additional plugin configuration. In this way you can have multiple plugin’s instances. Below an example, to set a custom extent for the Zoom To Max Extent plugin:

    	"customTools":[
    	{
                "ptype": "gxp_zoomtoextent",
                "actionTarget": {"target": "paneltbar", "index": 1},
    	    "extent":[ 1046403.2 , 5200006.1,  1413757.5 ,   5544708.1]
    	},
    	{
                "ptype": "gxp_zoomtoextent",
                "forceMultiple":true,
                "actionTarget": {"target": "paneltbar", "index": 13}
                
    	}
    	/...
  

This configuration will change the extent of the default plugin (first config) and will add another one,using the forceMultiple attribute, with the default values instead.

• portalConfig: Optional configuration to override gxp Viewer configuration. See here for more details.
• customPanels: Optional Array of Ext.Panel configurations. If present and tools is not defined, add tools in Composer.js configuration.
• georeferences_data: Array of regions. If present, overrides the default georeferences_data variable defined in data/georeferences.js.
• cswconfig: configuration for cswViewer (if present).
• tab : forced tab visualization of the viewport.

Complete Example:

		{
		"geoStoreBase":"http://localhost:8080/geostore/rest/",
		"proxy":"/http_proxy/proxy/?url=",
		"defaultLanguage": "en",
		"gsSources":{ 

			"mapquest": {
				"ptype": "gxp_mapquestsource"
			}, 
			"osm": { 
				"ptype": "gxp_osmsource"
			},
			"google": {
				"ptype": "gxp_googlesource" 
			},
			"bing": {
				"ptype": "gxp_bingsource" 
			}, 
			"ol": { 
				"ptype": "gxp_olsource" 
			}
		},
		"map": {
			"projection": "EPSG:900913",
			"units": "m",
			"center": [1250000.000000, 5370000.000000],
			"zoom":5,
			"maxExtent": [
				-20037508.34, -20037508.34,
				20037508.34, 20037508.34
			],
			"layers": [
				{
					"source": "bing",
					"title": "Bing Aerial",
					"name": "Aerial",
					"group": "background"
				}, {
					"source": "osm",
					"title": "Open Street Map",
					"name": "mapnik",
					"group": "background"
				},{
					"source": "mapquest",
					"title": "MapQuest OpenStreetMap",
					"name": "osm",
					"group": "background"
				},{
					"source": "google",
					"title": "Google Roadmap",
					"name": "ROADMAP",
					"group": "background"
				},{
					"source": "google",
					"title": "Google Terrain",
					"name": "TERRAIN",
					"group": "background"
				},{
					"source": "google",
					"title": "Google Hybrid",
					"name": "HYBRID",
					"group": "background"
				}
			]
		
		},
		"customTools": [
				{
				ptype: "gxp_googleearth",
				actionTarget: {target: "paneltbar", index: 24}
				}
		]
	}

Examples

In this section we show some useful configuration tricks.

Configure an empty background layer

To add an empty background to the backgrounds list, add the following configuration to the map layers array:

   {
        "source": "ol",
        "group": "background",
        "fixed": true,
        "type": "OpenLayers.Layer",
        "visibility": false,
        "args": [
            "None", {"visibility": false}
        ]
   }

Add Custom panels directly from configuration

The customPanels attribute is an Array that can contain many Ext.Component configuration object that will be placed inside MapStore.

They can be used to wrap plugins, contain custom html or also other custom panels. One exemple of the use of custom panels is the markerEditor.

http://localhost:8081/viewer?config=markerEditor

The customPanelSample configuration is an ad hoc exemple to help you to use this useful configuration option. It shows nested panel definition, plugin placement, custom html, and also an IFrame.

http://localhost:8081/?config=customPanelSample

NOTE: if you want to place some custom panels inside other custom panel (e.g. some panels inside a tab), you have to place the container before the other panels in the array.

Custom panels can have the target attribute (String) . If present, the panel will be placed inside the container with this string as id (for exemple, the tab panel that contains the layer tree and the legend has west as id). If target is not present the panel will be placed inside the portalPanel.

This is an extract from customPanelSample.js

"customPanels":[
        {
            "xtype":"panel",
            "id":"additionalTab", 
	    "target": "west",
	    "title": "my New Tab",
            "layout":"accordion"
        },{
		"target":"additionalTab",
		"html":"This is a custom panel. Both this and 'my New Tab' are custom panels.",
		"title": "Panel 1"
	},{
		"target":"additionalTab",
		"html":"insert your plugin here",
		"title": "Panel 2"
	},{
            "xtype":"tabpanel",
            "id":"east", 
            "region": "east",
            "width": 570,
            "minWidth":550,
		"activeTab": 0,
		"border":false,
            "collapseMode": "mini" ,
	    "items":{
		"xtype":"panel",
		"id":"editor",
		"title":"editor",
		"layout":"fit",
		"target":"east"
			
	    }
        },{
	    "xtype":"panel",
            "id":"south", 
	    "region":"south",
	    "html":"another custom panel....",
	    "height":100
	},{
	    "target":"east",
	    "html":"<iframe style='width:100%;height:100%' src='http://mapstore.geo-solutions.it' ><iframe/>",
	    "layout":"fit",
            "itemId":"startTab",
	    "title": "MapStore WebSite"
	}
    ],
//....
"customTools":[
//...
{
	"ptype": "gxp_marker_editor",
	"outputTarget":"editor",
        "toggleGroup":"toolGroup"
}]