7. Navigation

Plugin Location

The plugin location is the core plugin that deals with geographic navigation on the map. It handles bboxes (visible areas) and scales; it drives the tools zoom-in, zoom-out and panning, the directional arrows around the main map and the overview map.

The corresponding configuration files are location.ini (client-side) and location.ini (server-side).

7.1. Client-side Configuration

Here are the options that can be set:

  • scalesActive: boolean, if true, the scales dropdown list is displayed (default: false). If no visible scales are defined on the server, a simple input text will be displayed.
  • recenterActive: boolean, if true, the coords recentering form is displayed (default: false)
  • idRecenterActive: boolean, if true, the id recentering fields will be displayed (default: false)
  • idRecenterLayers the comma separated list of layers which will appear in the id recentering selection form. If this list is absent, all msLayers appear in the form.
  • shortcutsActive: boolean, if true, the shortcuts (direct access dropdown list) are displayed (default: false)
  • scaleUnitLimit: scale above which DHTML measures use km ; below, they use m.
  • panRatio: ratio for panning by clicking directional arrows. Default is 1 (no overlap, no gap). Values below 1 result in an overlap of the old and the new maps; values above 1 in a gap between these two maps.
  • weightZoomIn: integer defining display order of the zoom_in tool icon in toolbar (if not specified, default to 10). A negative weight disables the tool.
  • weightZoomOut: see weightZoomIn (default to 11)
  • weightPan: see weightZoomIn (default to 12)

7.2. Server-side Configuration

Here are the options that can be set:

  • minScale: if set, minimal scale allowed.
  • maxScale: if set, maximal scale allowed
  • scaleModeDiscrete: boolean, if true, only specified scales (see below) can be set.
  • zoomFactor: the zoom factor to use whan scaleModeDiscrete is set to false.
  • scales.#.value (# = 0, 1, 2, ...): available value of the scale in discrete mode.
  • scales.#.label (# = 0, 1, 2, ...): label of the scale, to be displayed in the dropdown list on the client.
  • scales.#.visible (# = 0, 1, 2, ...): boolean, if true, the scale is displayed in the dropdown list. If false, this scale can only be selected by zoom-in/zoom-out. Default is true.
  • shortcuts.#.label (# = 0, 1, 2, ...): label of the shortcut; appears in the direct access dropdown list on the client.
  • shortcuts.#.bbox (# = 0, 1, 2, ...): geographic bbox of the shortcut.
  • recenterMargin: margin to add around the centered-on object (valid for lines and polygons). Expressed in percent of the width/height of the object.
  • recenterDefaultScale: scale to use when the centered-on object is a point.

7.3. Related Elements Elsewhere

The maximal extent of the geographical zone is set by the EXTENT command in the mapfile.

The initial bbox is set by the active initialMapState. It is to be configured in the myMap.ini file, using the following syntax:

mapInfo.initialMapStates.initialMapStateId.location.bbox = "xmin,ymin,xmax,ymax"