Template:Zh OpenStreetMap Description Map

From Documentation
Jump to navigation Jump to search

Creating Map

We turn to the menu "Maps".


OSM-Map-List.png


Enter the number of maps with the correct configuration for us.

Coordinates it is convenient to choose by dragging the marker (the value is automatically substituted in the form fields ) or by clicking the mouse on the desired location.


Map properties

OSM-Map-Detail-Map.png

Title Map title
Description Description
Latitude Map center Latitude
Longitude Map center Longitude
Width Map Width,

if set to 0, map will be 100% wide

Height Map Height

if set to 0, map will be 100% height.
You can apply Zh Template Map FullScreen to your map page to show map in full screen or for the other cases


Map Details

OSM-Map-Detail-Details-1.png


OSM-Map-Detail-Details-2.png


Show Title as Placemark Show map title as a placemark
  • No - Do not show marker
  • Simple - Marker without animation
  • Bounce - Marker with animation (Bounce)
  • Elastic Bounce - Marker with animation (Elastic Bounce)
Open Popup Open Popup for map title immediately
Disable AutoPan Disable AutoPan when open popup
Map Bounds Map bounds to protect navigation outside map

You have to enter Latitude1,Longitude1;Latitude2,Longitude2
ie pair of coordinates separated by semicolon and in one coordinate has values separated by comma
The first coordinate - left bottom, the second - right top of bounds

Zoom Initial Map Zoom
Min Zoom Min Zoom for Map
Max Zoom Max Zoom for Map
Draggable Enable/disable Map dragging
Map Type Initial Map Type
  • OpenStreetMap
  • OpenTopoMap
  • First Custom Map Type
OpenStreetMap Layer The enabled/disabled state of the OpenStreetMap Layer and ability to use Map Type Control to switch to that layer
OpenTopoMap Layer The enabled/disabled state of the OpenTopoMap Layer and ability to use Map Type Control to switch to that layer
Allow Custom Map Types The enabled/disabled using custom map type and ability to use Map Type Control to switch to that layers
Custom Map Types List List of custom map types ID for using on map, separator ;

Example: 1;2;5
If you set Map Type to First Custom Map Type, then first ID will be default map type

KML Layer URL of the KML Layer, that would be displayed on the map
Category The category that this map is assigned to

Using KML or GPX Layer

If you have KML file, you can put into accessible folder on site and fill URL in map field KML Layer.

If you want to use more than one file (or want to use GPX), you can use "featute", that path field of Paths is not required

  • go to Paths list
  • create path
  • fill Layer options on File Layer tab

And after that new layer will be displayed

Moreover you can control its properties by path properties (in case KML or GPX layer type), or use internal parser for flexible control.

Map Header

OSM-Map-Detail-Header.png

Header HTML-text HTML text on top of the map
Show Header Separator Show Separator after Header HTML text


Map Footer

OSM-Map-Detail-Footer.png

Show Footer Separator Show Separator before Footer HTML text
Footer HTML-text HTML text on bottom of the map


Map Controls

There are three sliders in this section

OSM-Map-Detail-MapControls.png

The first slider is

OSM-Map-Detail-MapControls-1.png

OSM-Map-Detail-MapControls-2.png


Zoom Control The enabled/disabled state of the Zoom Control
Scale Control The enabled/disabled state of the Scale Control
Scale Control: Maximum width Maximum width of the control in pixels. The width is set dynamically to show round values (e.g. 100, 200, 500)
Scale Control: metric Whether to show the metric scale line (m/km)
Scale Control: imperial Whether to show the imperial scale line (mi/ft)
Scale Control: update when idle If true, the control is updated on move end, otherwise it's always up-to-date (updated on move)
Double Click Zoom Enables/disables zoom and center on double click
Scroll Wheel Zoom The enabled/disabled state of the scrollwheel zooming on the map
Hide Single Base Layer in Map Type Control If true, the base layers in the control will be hidden when there is only one
Home Button The enabled/disabled feature to reset map center and/or zoom to initial value
Overlay Opacity The enabled/disabled feature to change opacity for Ground Overlays


The second slider is


OSM-Map-Detail-MapControls-Geocoder.png


Geocoder Control The enabled/disabled state of the Geocoder Control
Collapse Geocoder Collapse control unless hovered or clicked
Provider Geocoding service used by the control to perform the actual geocoding queries

The third slider is

OSM-Map-Detail-MapControls-Position-1.png

OSM-Map-Detail-MapControls-Position-2.png


Map Type Control Position on a map
Zoom Control Position on a map
Scale Control Position on a map
Geolocation Control Position on a map
Geocoder Control Position on a map
Placemark List Button Position on a map
Home Button Position on a map
Overlay Opacity Position on a map

Map Properties for Placemarks

OSM-Map-Detail-Placemarks-1.png


OSM-Map-Detail-Placemarks-2.png

Placemark ordering Order placemarks. It is useful when you show placemark list
  • Placemark title
  • Category title and ordering
  • Category title (descending) and ordering
  • User ordering index
  • Group title and Placemark title
  • Group title (descending) and Placemark title
  • Group user ordering index and Placemark title
  • Group user ordering index (descending) and Placemark title
  • Date of creation
  • Date of creation (descending)
Auto-center and auto-zoom Calculate and set zoom and map center to show all placemarks
Show placemarks in cluster Create cluster for markers
Marker Cluster Zoom Level Zoom Level on which Clusterer starts group markers
Group Placemarks in Cluster by Group Property Create cluster for each group (and you can override cluster icon)
Remember, if you use this feature (without managing markers by group list), you have to activate group in cluster (by setting Active in Group List)
Place overlapping placemarks on a spiral Enable feature to show overlapped placemarks on a spiral or create special list
Zoom on cluster click Zoom map to fit cluster bounds
Show cluster coverage When mouse over a cluster it shows the bounds of its markers
Show placemark creation information You can show information about user and date of placemark creation
  • No
  • Username
  • Date of creation
  • Date of creation and Username
  • Username (after toolbar)
  • Date of creation (after toolbar)
  • Date of creation and Username (after toolbar)

Map Properties for Placemark List

OSM-Map-Detail-PlacemarkList.png

Width Placemark List Width in pixels

If set 0 then you've got 100% width.
It can be useful in bottom position and 100% map width

Height Placemark List Height in pixels
Position Values
  • No - there is no placemark list
  • ... - overlay on map
  • Left and Right - table layout
  • List-Map and Map-List - div layout
  • External - you can put ul-tag with id=OMapsMarkerUL in your place to define your place to show placemark list

For example,

<ul id="OMapsMarkerUL" style="list-style-type: none;"></ul>
Style Values
  • Simple - predefined in CSS-file
  • Advanced - predefined in CSS-file
  • External - you can define it in your template
Background Color Background Color

Example: #EAEAEA

As for gradient in my example, I've got it from internet sites. When you specify background color #E6E6E6, I add into style line

background: #E6E6E6

I've got this example

background: #fefcea; /* For old browsers */
    background: -moz-linear-gradient(top, #fefcea, #f1da36); /* Firefox 3.6+ */
    /* Chrome 1-9, Safari 4-5 */
    background: -webkit-gradient(linear, left top, left bottom, 
                color-stop(0%,#fefcea), color-stop(100%,#f1da36));
    /* Chrome 10+, Safari 5.1+ */
    background: -webkit-linear-gradient(top, #fefcea, #f1da36);
    background: -o-linear-gradient(top, #fefcea, #f1da36); /* Opera 11.10+ */
    background: -ms-linear-gradient(top, #fefcea, #f1da36); /* IE10 */
    background: linear-gradient(top, #fefcea, #f1da36); /* CSS3 */ 
    padding: 10px;
    border: 1px solid #333;


I don't know is it true example, for all cases. But, for example, why not. I've replace start and end colors to mine. And, first background: we don't enter, because I do it.

And after all this is mine code

#E6E6E6; /* For old browsers */
     background: -moz-linear-gradient(top, #E6E6E6, #AAAAAA); /* Firefox 3.6+ */
     /* Chrome 1-9, Safari 4-5 */
     background: -webkit-gradient(linear, left top, left bottom,
                  color-stop(0%,#E6E6E6), color-stop(100%,#AAAAAA));
     /* Chrome 10+, Safari 5.1+ */
     background: -webkit-linear-gradient(top, #E6E6E6, #AAAAAA);
     background: -o-linear-gradient(top, #E6E6E6, #AAAAAA); /* Opera 11.10+ */
     background: -ms-linear-gradient(top, #E6E6E6, #AAAAAA); /* IE10 */
     background: linear-gradient(top, #E6E6E6, #AAAAAA); /* CSS3 */
     padding: 10px;
     border: 1px solid #333;

I note that in IE9 there is no gradient. But it is not task to do it in my component by CSS. In any case you can do it by image and applying for class.

Action by Click Action to do when you Click on link
  • Center - center map on placemark
  • Click - execute click function for placemark
  • Center and Click - center map on placemark and execute click function for placemark
  • Center, Animate - center map on placemark and animate placemark icon
  • Click, Animate - execute click function for placemark and animate placemark icon
  • Center, Animate and Click - center map on placemark, animate placemark icon and execute click function for placemark
Placemark List Content Text from which placemark list contains
  • Title - placemark title
  • Title and Description - placemark title and desciption
  • Title and Addition HTML text - placemark title and addition HTML text
  • Icon and Title - placemark icon and title
  • Icon, Title and Description
  • Icon, Title and Addition HTML text - placemark icon, title and addition HTML text
  • Icon, Title and Description (table) - table layout
  • Icon, Title and Addition HTML text (table) - table layout
  • Title and Image - placemark title and image (thumbnail)
  • Title, Image and Description
  • Title, Image and Addition HTML text
  • Image and Title
  • Image, Title and Description
  • Image, Title and Addition HTML text
  • Image, Title and Description (table) - table layout
  • Image, Title and Addition HTML text (table) - table layout
  • Table: Title - placemark title and table layout
  • Table: Title and Description - placemark title and description and table layout
  • Table: Title and Addition HTML text - placemark title and addition HTML text and table layout
Appearance Appearance of placemark list
  • Open List - placemark list is opened
  • Icon Button - additional icon button control on map
  • Text Button - additional text button control on map
  • Icon Button and Open List - additional icon button control on map and list is opened
  • Text Button and Open List - additional text button control on map and list is opened
Search placemark field Enable feature to search by autocomplete placemarks in placemark list

Groups

OSM-Map-Detail-Groups-1.png


OSM-Map-Detail-Groups-2.png

Group Control Position and type of list of group, that would be displayed for marker management
  • No - there is not placemark control by group list
  • Left - List of group on the left (table style)
  • Right - List of group on the right (table style)
  • Top - List of group on the top (table style)
  • Bottom - List of group on the bottom (table style)
  • Group-Map - List of group on the top (div style)
  • Map-Group - List of group on the bottom (div style)
  • External - List of group in user defined position (special tag)
Group Type Behavior of group list
  • Toggle Group
  • Only One Active Group
Manage Placemarks Enable ability to manage placemarks by Group List
Synchronize with placemark list Show/Hide placemarks in placemark list depends on group state
Manage Paths Enable ability to manage paths by Group List
Group ordering Group order in list
  • Group title
  • Category Title and ordering
  • User ordering index
Group Column Width Column width for the left or right position of list group
Show Group Show text, icon of group in list of group
  • Text
  • Icon
  • Text and Icon
Display Show All and Hide All buttons Show buttons to show/hide all groups by one click
  • No
  • Text
  • Icon
  • Text and Icon
Search group field Display search field to find group in group list
Group CSS Type of group decoration

There are two predefined style
and one (external) – for you, which you can set style in you template. ID for tags depend on Group CSS field. See details in Marker Grouping

Group List Title Group List Title
Top Description Description on top of the list
Show Top-Separator The enabled/disabled state of Separator on top of the list
Show Bottom-Separator The enabled/disabled state of Separator on botom of the list
Bottom Description Description on bottom of the list

Route

OSM-Map-Detail-Route.png


Draggable The enabled/disabled ability route to be draggable
Show Route Panel Enable show route details
Travel Mode: Driving The enabled/disabled ability to be show this travel mode
Travel Mode: Walking The enabled/disabled ability to be show this travel mode
Travel Mode: Bicycling The enabled/disabled ability to be show this travel mode
Travel Mode: Public Transit The enabled/disabled ability to be show this travel mode
Unit System Use this unit system option when create route
  • Metric System (kilometers)
  • Imperial (English) System (miles)

Advanced Options

OSM-Map-Detail-AdvancedOptions-1.png


OSM-Map-Detail-AdvancedOptions-2.png


OSM-Map-Detail-AdvancedOptions-3.png


Show hover text Show hover text for map objects (placemarks, paths)
Hover Popup Style Hover Popup style
Display Popup Content Display Popup Content
  • Default - display as popup
  • Panel - display content in panel (on its tabs)
Panel width Panel width in pixels
Open Panel Initial Panel state
Loading map objects dynamically Enable feature to load placemarks by AJAX
  • No
  • JQuery
  • Mootools
Load type Type of loading placemarks, ie load it all, or depends on some conditions
  • All
  • All (two steps: use map bounds, all the rest)
  • Use map bounds
Buffer size for placemarks You can load placemarks by parts
Buffer size for paths You can load paths by parts
Loading content data dynamically Enable feature to load map objects popup content by AJAX
  • No
  • JQuery
  • Mootools

Ie your page can contains placemark or path creation code, but all popup content can be loaded dynamically.
If placemarks loaded by AJAX it by default loads content dynamically too.

Placemark Filter Restriction displaying placemarks on some rules.
Allow to user enter placemarks Enable registered users to create and/or alter placemarks on map.
Insert Allowed User can create new placemarks
Update Allowed User can update existing placemarks
Delete Allowed User can delete existing placemarks
New Placemark State Placemark Status for created user placemark.
New Contact State Contact Status for created user contact (if enabled contact integration).
Show Icon Type Selector for New Placemark The enabled/disabled state of selecting Icon Type when user creates placemark.
CSS Class The class name for map div tag
Additional CSS styles for loading List of CSS style files for loading when map is loading, separated by new line or semicolon
Additional JavaScript files for loading List of JavaScript files for loading when map is loading, separated by new line or semicolon
Placemark Rating Enable Placemark rating feature.
  • No
  • JQuery
  • Mootools
Map text override You can use this feature to override Standard text for map controls etc by using special interface in component administration area or change some interface or map object properties

Geolocation

OSM-Map-Detail-Geolocation.png

Auto Positioning Auto Positioning when map is loading
Geolocation Control Show Geolocation Control
Geolocation Button Style Geolocation Button Style
  • Icon
  • Text
  • Icon and Text


Integration

OSM-Map-Detail-Integration.png

Use contacts The enabled/disabled state of using contacts

You can enable using contact information and associate your placemark with contact to display contact information in placemark popup.

Contact Details You can enter names of attributes to show. Separator is ;

Acceptable values

  • name
  • position
  • address
  • city
  • suburb
  • state
  • province
  • country
  • postcode
  • zipcode
  • phone
  • mobile
  • fax
  • email
  • website

You can enter it in any order, and by it the contact will be shown.

Note: postcode and zipcode – it is the same field, but different labels will be.

Check contact fields, and you'll see this pairs: City or Suburb, State or Province, Postal / ZIP Code


For example: position;name;mobile

to show position, contact name and mobile phone

Use users The enabled/disabled state of using users

You can enable using user information and associate your placemark with user to display user information in placemark popup.

Allow open Google Maps Enable/disable feature to open Google Maps (link or button in placemark popup)
Allow open Google Maps for map center placemark Show link, which opens Google Map for map center
  • Link in Popup (show direction), open link in new page
  • Link in Popup (show direction), open link in the same page
  • Link below map (show direction), open link in new page
  • Link below map (show direction), open link in the same page
  • Link in Popup and below map (show direction), open links in new page
  • Link in Popup and below map (show direction), open links in the same page
  • Link in Popup (show marker for title), open link in new page
  • Link in Popup (show marker for title), open link in the same page
  • Link below map (show marker for title), open link in new page
  • Link below map (show marker for title), open link in the same page
  • Link in Popup and below map (show marker for title), open links in new page
  • Link in Popup and below map (show marker for title), open links in the same page
  • Link in Popup (show marker for coordinates), open link in new page
  • Link in Popup (show marker for coordinates), open link in the same page
  • Link below map (show marker for coordinates), open link in new page
  • Link below map (show marker for coordinates), open link in the same page
  • Link in Popup and below map (show marker for coordinates), open links in new page
  • Link in Popup and below map (show marker for coordinates), open links in the same page

Display

OSM-Map-Detail-Display.png