DEPRECATION WARNING

This documentation is not using the current rendering mechanism and will be deleted by December 31st, 2020. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

Configuration

Target group: Developers, Integrators

Minimal Example

  • It is necessary to include static template Maps2 Default (maps2)
  • It is necessary to include one of these static templates Maps2 for Google Maps (maps2) or
    Maps2 for Open Street Map (maps2)

We prefer to set a Storage PID with help of TypoScript Constants:

plugin.tx_maps2.persistence {
   # Define Storage PID where Maps records are located
   storagePid = 4
}

TypoScript Setup Reference

In this section we describe the TS properties of plugin.tx_maps2.setting.*

Property Data type Default
infoWindowContentTemplatePath String EXT:maps2/…
infoWindow Array  
mapProvider String template related (gm or osm)
markerClusterer Array template related

infoWindowContentTemplatePath

Example: plugin.tx_maps2.settings.infoWindowContentTemplatePath = EXT:your_sitepackage/Resources/Templates/InfoWindowContent.html

Here you can define your own Fluid-Template for these little PopUps of Markers

infoWindow

This property contains currently two properties to set the size of the images within infoWindow PopUp of Markers.

Example: plugin.tx_maps2.settings.infoWindow.image.width = 150c Example: plugin.tx_maps2.settings.infoWindow.image.height = 150c

image.width

Set the maximum width of images within the InfoWindow PopUp

image.height

Set the maximum height of images within the InfoWindow PopUp

mapProvider

Normally you don’t have to change that value, as it will be set automatically with the chosen static template. So, if you use static template for OSM, this value will be set to osm. In case of the static template for Google Maps the value will be set to gm.

markerClusterer

This feature is only available for mapProvider gm (Google Maps).

If you have many POIs at a small range, it may help to activate markerClusterer to build little groups of POIs. That way you will not see all thousands of POIs anymore, but maybe 5 groups, showing the amount of contained POIs. If you zoom into the map, new groups, with a smaller collection will be build. If the collection reduces to 1 you will see the original POI again.

Plugin settings

This section covers all settings, which can be defined in the maps2 plugin and TypoScript.

Important

Every setting can also be defined by TypoScript: plugin.tx_maps2.settings.[propertyName]

Property Title Sheet Type
poiCollection Show poiCollection General integer
categories Categories General string
mapWidth Map width General string
mapHeight Map height General string
allowMapTemplatePath AllowMap template path General string
zoom Zoom Map Options integer
forceZoom Force Zoom Map Options boolean
mapTypeId Map type Map Options string
zoomControl Zoom control Map Options boolean
mapTypeControl Map type control Map Options boolean
scaleControl Scale control Map Options boolean
streetViewControl Street view control Map Options boolean
fullScreenControl Full Screen control Map Options boolean
activateScrollWheel Activate Scroll Wheel zoom Map Options boolean

poiCollection

Define a poiCollection which should be shown on the website

categories

If you have not set a fixed poiCollection above you can choose one or more categories here. If you have chosen more than one category some checkboxes will appear below the map in frontend where you can switch the markers of the chosen category on and off.

mapWidth

The width of the map.

mapHeight

The height of the map.

allowMapTemplatePath

With this setting you can override the default template from extension configuration. This setting it not part of the
plugin configuration and can only be set within the settings-part in TS setup. File prefixes like EXT: are allowed. Please have a look into the extension configuration for a detailed explaination.

zoom

A zoom value how deep to zoom in into the map.

forceZoom

This setting is only interessting, if you will show multiple POIs on map. In that case maps2 will zoom out until all POIs can be displayed. This is realized with the BoundingBox feature of Google Maps or OpenStreetMap. If you don’t want maps2 to zoom out, because you have POIs all around the world for example, you can activate this checkbox to prevent automatic zooming.

mapTypeId

Show Roadmap, Earthview or Streetview

zoomControl

Show a zoom control.

mapTypeControl

Show a map type control.

scaleControl

Show a scale control.

streetViewControl

Show a street view control.

fullScreenControl

Toggle between normal and full screen mode.

activateScrollWheel

If deactivated you can not zoom via your mouse scroll wheel.