URL Launch Parameters

Administrators can create URLs with parameters to display the Spectrum Spatial™ Analyst interface in a specific way.

Parameters added to the URL override the settings for the selected map project. Parameters entered incorrectly are ignored and the settings for the default map project used instead. You can specify the map project name, locator address data set, and language. Parameters also:

  • Show specific map features with a call out.
  • Highlight the location of a specific place using a marker.
  • Show results of nearest features to a location.
  • Define map overlays to be toggled as visible.
  • Specify the active base map.
  • Draw a concentric ring.

Parameters

The following table shows the parameters you can specify in the URL for launching Spectrum Spatial™ Analyst:

Parameter Description Example
mapcfg The name of the map project to use. mapcfg=mytestmap
lang

The supported languages are:

  • cy (Welsh)
  • da (Danish)
  • de (German)
  • en (English - default)
  • en-au (English - Australian)
  • en-gb (English - British)
  • en-us (English - American)
  • fi (Finnish)
  • fr (French)
  • nl (Dutch)
  • pt (Portuguese)
  • sv (Swedish)
  • es (Spanish)
  • ja (Japanese)
  • tr (Turkish)
  • it (Italian)

To launch the Spectrum Spatial™ Analyst in one of these languages, add a "lang" parameter to the end of the URL.

 lang=cy
x The X location of the map center point. The map is centered here. x=530000
y The Y location of the map center point. The map is centered here. y=183000
lon The lon location of the map center point. The map is lon=1.131415 centered here.
Note: If both X,Y and lon lat mentioned in the url, lon,lat will be given preference. lon, lat values should be Corresponding to projection (EPSG:4326).
 lon=1.131415
lat The lat location of the map center point. The map is lat=1.131415 centered here. lat=1.131415
showRings Specifies whether a circle or concentric rings are added to Spectrum Spatial™ Analyst as an annotation. One or more comma-separated values can be included. If a single value is specified, a circle is added. If more than one value is specified, then concentric rings are added. Units come from the showRingsUnit parameter and default to meters when showRingsUnit is omitted. You can enter 2 to 5 rings only.
Note: The concentric circle is drawn at the XY location. The radius can be a whole number or decimal up to a maximum of 2 or 3 decimal places.
 showRings=2.2,4,6,8
showRingsUnit Specifies the unit for the showRings parameter. The supported units are kilometers, meters, miles, and feet. the unit is in meters. showRingsUnit=kilometers
addAsLayer

Determines whether the X,Y (or lat lon) location specified is added as a point vector layer into Spectrum Spatial™ Analyst. If omitted the default is false. The layer will appear in the map legend.

 addAsLayer=true
layerName

Defines the name of the layer added with addAsLayer param, by default the name will be pointLayer.

layerName= vectorLayer
custTemplate Helps the user define a custom template on callout for the layer Created by addAsLayer.

Using a custom template with the showInfo parameter set to true allows users to launch Spectrum Spatial™ Analyst at any arbitrary location and show any information that the admin has added to the template. For example, the template can be designed to make server-side requests to calculate the total insured risk value at that point or to show other information both related or unrelated to the map layers loaded into Spectrum Spatial™ Analyst. Custom templates save to the following folder in Spectrum:-

C:\Program Files\Pitney Bowes\SpectrumSpatialAnalyst\ customerconfigurations\analyst\theme\infotemplates

Refer to Appendix D for more details.

 custTemplate=MyTemplate
reload When set to true, Spectrum Spatial™ Analyst re-freshes the browser page as if browsing the URL for the first time. When set to false (the default value when reload is not specified), the URL parameters (such as the X, Y and Zoom) are applied to the current map in the browser view. reload=true
zoom The map zoom to use when Spectrum Spatial™ Analyst is launched. zoom=10
showInfo Indicates whether the map call out is shown by passing true. The map call out is shown at the XY location and a query at that point is made on the visible map layers to retrieve attribute data for the call out.

showInfo=true
showNearest Indicates whether a search nearest result set is displayed using the XY as the search center. You pass the name of the search table as the parameter and optionally a name for the location that is specified by the XY (the name is displayed in the map area (showing the nearest Primary Schools to Our Office for example). The repository path is supported for Tables or Table name.
Note: Zoom is not a valid parameter when a valid value exists for showNearest in the URL.

‘addrName’ is an optional parameter for the showNearest URL, but it requires a valid value for the search location.

Note: Different tables may have the same name with different repository paths. By default, the search picks the first repository path in the find nearest configuration.

showNearest=Primary Schools

addrName=Our Office
queryTable a Named Table name on which query will be executed. queryTable=/QA-Maps/NamedTables/ListedBuildings
queryColumn a column name of that table for query criteria.

queryColumn=LB_NO
queryValues comma-separated list of values for query criteria
Note: If query values contains special characters, such as , " '$ #%^&*(), it needs to be encoded before passing in as query values.

queryValues=1325,1326
overlays A comma-separated list of map overlays to be toggled to visible when Spectrum Spatial™ Analyst is launched. The overlays must be included in the map configuration specified in mapcfg. Any overlays in the map configuration that are not listed will be toggled invisible. A user can change the visibility after Spectrum Spatial™ Analyst is launched using the legend control. overlays=Development Map, Conservation Map
baseMap The name of the active basemap when Spectrum Spatial™ Analyst is launched. It must be one of the base maps included in the map configuration specified in mapcfg. baseMap=Hybrid

Behavior when Specifying Conflicting Parameters

Be aware of the following when defining your URLs:

  • The parameters passed in the URL override the settings defined in the map configuration.
  • If any of the parameters are missing, then the default map configuration settings apply.
  • The showInfo and showNearest parameters are mutually exclusive. Now, you get an error if you specify both showInfo and showNearest parameters.
  • For showNearest, when a search nearest displays, it shows the nearest 10 features at their full extent and also the locator marker at the search XY location.
  • For overlays and base, when map overlays or the base map are not present in the map configuration, then the default map configuration settings apply.