$options

Associative array of options to pass to the jQuery.indiciaMapPanel plugin. Has the following possible options:

• indiciaSvc
  
• indiciaGeoSvc
  
• readAuth
  Provides read authentication tokens for the warehouse. Only required when there is a location control linked to the warehouse associated with this map.
• height
  Height of the map panel, in pixels.
• width
  Width of the map panel, in pixels or as a percentage if followed by a % symbol.
• initial_lat
  Latitude of the centre of the initially displayed map, using WGS84.
• initial_long
  Longitude of the centre of the initially displayed map, using WGS84.
• initial_zoom
  
• scroll_wheel_zoom
  Does the scroll wheel zoom the map in and out when over the map? Defaults to true. When using the scroll wheel to look up and down a data entry form it can be easy to inadvertantly scroll the map, so it may be desirable to disable this feature in some cases.
• proxy
  
• displayFormat
  
• presetLayers
  Array of preset layers to include. Options are 'google_physical', 'google_streets', 'google_hybrid', 'google_satellite', 'openlayers_wms', 'nasa_mosaic', 'virtual_earth' (deprecated, use bing_aerial), 'bing_aerial', 'bing_hybrid, 'bing_shaded', 'osm' (for OpenStreetMap), 'osm_th' (for OpenStreetMap Tiles@Home).
• tilecacheLayers
  Array of layer definitions for tilecaches, which are pre-cached background tiles. They are less flexible but much faster than typical WMS services. The array is associative, with the following keys: caption - The display name of the layer servers - array list of server URLs for the cache layerName - the name of the layer within the cache settings - any other settings that need to be passed to the tilecache, e.g. the server resolutions or file format.
• indiciaWMSLayers
  
• indiciaWFSLayers
  
• layers
  An array of JavaScript variables which point to additional OpenLayers layer objects to add to the map. The JavaScript for creating these layers can be added to data_entry_helper::$onload_javascript before calling the map_panel method.
• clickableLayers
  If support for clicking on a layer to provide info on the clicked objects is required, set this to an array containing the JavaScript variable names for the OpenLayers WMS layer objects you have created for the clickable layers. The JavaScript for creating these layers can be added to data_entry_helper::$onload_javascript before calling the map_panel method and they can be the same layers as those referred to in the layers parameter.
• clickableLayersOutputMode
  Set to popup to display the information retrieved from a click operation on a popup window, set to div to display the information in a specified HTML div, or to customFunction to call a JavaScript function after the click operation allowing custom functionality such as navigation to another page. Default is popup.
• clickableLayersOutputDiv
  ID of the HTML div to output information retrieved from a click operation into, if clickableLayersOutputMode is set to div.
• customClickFn Set to the name of a global custom JavaScript function which will handle the event of clicking on the map if you want custom functionality. Provide this when clickableLayersOutputMode=customFunction. The function will receive a single parameter containing an array of features.
• clickableLayersOutputFn
  Allows overridding of the appearance of the output when clicking on the map for WMS or vector layers. Should be set to a JavaScript function name which takes a list of features and the map div as parameters, then returns the HTML to output.
• clickableLayersOutputColumns
  An associated array of column field names with column titles as the values which defines the columns that are output when clicking on a data point. If ommitted, then all columns are output using their original field names.
• locationLayerName
  If using a location select or autocomplete control, then set this to the name of a feature type exposed on GeoServer which contains the id, name and boundary geometry of each location that can be selected. Then when the user clicks on the map the system is able to automatically populate the locations control with the clicked on location. Ensure that the feature type is styled on GeoServer to appear as required, though it will be added to the map with semi-transparency. To use this feature ensure that a proxy is set, e.g. by using the Indicia Proxy module in Drupal.
• locationLayerFilter
  If using a location layer, then set this to a cql filter in order to select e.g. locations for a website or locations of a type. The filter can act on any fields in the feature type that locationLayerName refers to.
• controls
  
• toolbarDiv
  If set to 'map' then any required toolbuttons are output directly onto the map canvas (in the top right corner). Alternatively can be set to 'top', 'bottom' or the id of a div on the page to output them into.
• toolbarPrefix
  Content to include at the beginning of the map toolbar. Not applicable when the toolbar is added directly to the map.
• toolbarSuffix
  Content to include at the end of the map toolbar. Not applicable when the toolbar is added directly to the map.
• helpDiv
  Set to 'bottom' to add a div containing help hints below the map. Set to the name of a div to output help hints into that div. Otherwise no help hints are displayed.
• clickForSpatialRef
  Does clicking on the map set the spatial reference of the sample input controls on the form the map appears on (if any)? Defaults to true.
• allowPolygonRecording
  If a drawPolygon or drawLine control is present, do these set the spatial reference of the sample input controls on the form the map appears on (if any)? The spatial ref is set to the polygon centroid and the sample geometry is set to the polygon itself allowing polygons for records.
• editLayer
  
• editLayerName
  
• standardControls An array of predefined controls that are added to the map. Select from:
  layerSwitcher - a button in the corner of the map which opens a panel allowing selection of the visible layers.
  drawPolygon - a tool for drawing polygons onto the map edit layer.
  drawLine - a tool for drawing lines onto the map edit layer.
  drawPoint - a tool for drawing points onto the map edit layer.
  zoomBox - allow zooming to a bounding box, drawn whilst holding the shift key down. This functionality is provided by the panZoom and panZoomBar controls as well so is only relevant when they are not selected. panZoom - simple controls in the corner of the map for panning and zooming. panZoomBar - controls in the corner of the map for panning and zooming, including a slide bar for zooming. modifyFeature - a tool for selecting a feature on the map edit layer then editing the vertices of the feature. selectFeature - a tool for selecting a feature on the map edit layer. hoverFeatureHighlight - highlights the feature on the map edit layer which is under the mouse cursor position. Default is layerSwitcher, panZoom and graticule.
• initialFeatureWkt
  Well known text for a geometry to load onto the map at startup, normally corresponding to the geometry of the record being edited.
• initialBoundaryWkt
  Well known text for a geometry to load onto the map at startup, normally corresponding to the geometry of the boundary being edited (e.g. a site boundary).
• defaultSystem
  
• latLongFormat
  Override the format for display of lat long references. Select from D (decimal degrees, the default), DM (degrees and decimal minutes) or DMS (degrees, minutes and decimal seconds).
• srefId
  Override the id of the control that has the grid reference value
• srefSystemId
  Override the id of the control that has the spatial reference system value
• geomId
  
• clickedSrefPrecisionMin
  Specify the minimum precision allowed when clicking on the map to get a grid square. If not set then the grid square selected will increase to its maximum size as the map is zoomed out. E.g. specify 4 for a 1km British National Grid square.
• clickedSrefPrecisionMax
  Specify the maximum precision allowed when clicking on the map to get a grid square. If not set then the grid square selected will decrease to its minimum size as the map is zoomed in. E.g. specify 4 for a 1km British National Grid square.
• msgGeorefSelectPlace
  
• msgGeorefNothingFound
  
• msgSrefOutsideGrid
  Message displayed when point outside of grid reference range is clicked.
• msgSrefNotRecognised
  Message displayed when a grid reference is typed that is not recognised.
• maxZoom
  Limit the maximum zoom used when clicking on the map to set a point spatial reference. Use this to prevent over zooming on background maps.
• tabDiv
  If loading this control onto a set of tabs, specify the tab control's div ID here. This allows the control to automatically generate code which only generates the map when the tab is shown.
• setupJs
  When there is JavaScript to run before the map is initialised, put the JavaScript into this option. This allows the map to run the setup JavaScript just in time, immediately before the map is created. This avoids problems where the setup JavaScript causes the OpenLayers library to be initialised too earlier if the map is on a div.
• setupJs
  When there is JavaScript to run before the map is initialised, put the JavaScript into this option. This allows the map to run the setup JavaScript just in time, immediately before the map is created. This avoids problems where the setup JavaScript causes the OpenLayers library to be initialised too earlier if the map is on a div.
• graticuleProjection
  EPSG code (including EPSG:) for the projection used for the graticule (grid overlay).
• graticuleBounds
  Array of the bounding box coordinates for the graticule(W,S,E,N).
• rememberPos
  Set to true to enable restoring the map position when the page is reloaded. Requires jquery.cookie plugin. As this feature requires cookies, you should notify your users in compliance with European cookie law if you use this option.

$olOptions

Optional array of settings for the OpenLayers map object. If overriding the projection or displayProjection settings, just pass the EPSG number, e.g. 27700.