Zh OpenStreetMap Plugin Article Overview Map

From Documentation
Jump to navigation Jump to search

Purpose

Plugin for component is created for inserting maps into articles, which have attributes for Overview Map.


Installation

Install the plugin in Extension Manager.

Make it active.


It is plugin for component, therefore component have to be installed

Plugin supports autoupdate feature

Configuration

You have to configure plugin - custom fields and other settings.

OSM Article Overview Plugin-1.png

OSM Article Overview Plugin-2.png


Map Title Default map, if it is not specified in plugin call
Field Group The group of latitude and longitude and other fields belong to
Latitude Property to get latitude value
Longitude Property to get longitude value
Icon Type Property to get icon type value
Icon X-offset Property to get icon X-offset value
Icon Y-offset Property to get icon Y-offset value
Marker Marker Type
  • No - Do not show marker
  • Simple - Marker without animation
  • Simple: Bounce - Marker with animation (Bounce)
  • Simple: Elastic Bounce - Marker with animation (Elastic Bounce)
  • Icon File: Simple - Marker without animation
  • Icon File: Bounce - Marker with animation (Bounce)
  • Icon File: Elastic Bounce - Marker with animation (Elastic Bounce)
Open Popup Execute action which described in Action by Click
Popup Content Content of Popup
  • Title
  • None
Action by Click Action by Click on this placemark
  • Open Popup
  • Open Article in the same page
  • Open Article in new page
  • None
Article Button in Popup toolbar Show Article Button in Popup toolbar
Show GPS information Show GPS information (coordinates) in popup
Default values Section for default values if no data exists
Icon Type Icon Type
Icon X-offset Icon offset
Icon Y-offset Icon offset

Using

Show Map

You can show the map with only one specific placemark for an article. All attributes loaded from article custom fields, if icon is not defined - default value will be used. To do this, insert the following call

{zhosmmap-overview:NNN;Center;Zoom;MapType;Width;Height;Action}

where

  • NNN - map ID, if you don't specify it, default value will be used
  • Center - map center or placemark is new center of map, valid values:
    • map
    • placemark
  • Zoom - new zoom of map, valid values
    • values from 0 to 25 to override zoom
    • do not change - do not change map zoom
  • MapType - new map type
    • OSM
    • OPENTOPOMAP
    • do not change - do not change map type
  • Width - new map width
    • width value in pixels
    • do not change - do not change map width
  • Height - new map height
    • height value in pixels
    • do not change - do not change map height
  • Action - execute action when loaded map, you can enter comma separated values
    • do not change - do not execute anything
    • click - execute click action on placemark.
    • bounce - set animation for placemark (bounce).
    • elastic bounce - set animation for placemark (elastic bounce).
    • exclusive bounce - set animation for placemark (bounce only one placemark).
    • exclusive elastic bounce - set animation for placemark (elastic bounce only one placemark).


For action you have to set Center=placemark


Examples:

1. Lets call with all defaults

{zhosmmap-overview:}


In this case map will be used defaults, defined in plugin settings


2. Call for defined map

{zhosmmap-overview:10}


In this case map with ID=10 will be used.


3. Call with center by article placemark

{zhosmmap-overview:;placemark}


As you can see map ID is not defined


4. Set map zoom and actions

{zhosmmap-overview:;placemark;14;;;;bounce}


Show Map with map objects, filter by article list

You can show the map with all map objects, which belonging to this map, and show articles on map by specify article list. All attributes loaded from article custom fields, if icon is not defined - default value will be used. To do this, insert the following call

{zhosmmap-overview-articlelist:ArticleList;NNN;Center;Zoom;MapType;Width;Height;Action}

where

  • ArticleList - (required) list of articles IDs, separated by comma
  • NNN - map ID, if you don't specify it, default value will be used
  • Center - map center or placemark is new center of map, valid values:
    • map
    • placemark
  • Zoom - new zoom of map, valid values
    • values from 0 to 25 to override zoom
    • do not change - do not change map zoom
  • MapType - new map type
    • OSM
    • OPENTOPOMAP
    • do not change - do not change map type
  • Width - new map width
    • width value in pixels
    • do not change - do not change map width
  • Height - new map height
    • height value in pixels
    • do not change - do not change map height
  • Action - execute action when loaded map, you can enter comma separated values
    • do not change - do not execute anything
    • click - execute click action on placemark.
    • bounce - set animation for placemark (bounce).
    • elastic bounce - set animation for placemark (elastic bounce).
    • exclusive bounce - set animation for placemark (bounce only one placemark).
    • exclusive elastic bounce - set animation for placemark (elastic bounce only one placemark).


For action you have to set Center=placemark


Show Map with map objects, filter by article category list

You can show the map with all map objects, which belonging to this map, and show articles on map by specify article category list. All attributes loaded from article custom fields, if icon is not defined - default value will be used. To do this, insert the following call

{zhosmmap-overview-category:CategoryList;NNN;Center;Zoom;MapType;Width;Height;Action}

where

  • CategoryList- (required) list of article categories IDs, separated by comma
  • NNN - map ID, if you don't specify it, default value will be used
  • Center - map center or placemark is new center of map, valid values:
    • map
    • placemark
  • Zoom - new zoom of map, valid values
    • values from 0 to 25 to override zoom
    • do not change - do not change map zoom
  • MapType - new map type
    • OSM
    • OPENTOPOMAP
    • do not change - do not change map type
  • Width - new map width
    • width value in pixels
    • do not change - do not change map width
  • Height - new map height
    • height value in pixels
    • do not change - do not change map height
  • Action - execute action when loaded map, you can enter comma separated values
    • do not change - do not execute anything
    • click - execute click action on placemark.
    • bounce - set animation for placemark (bounce).
    • elastic bounce - set animation for placemark (elastic bounce).
    • exclusive bounce - set animation for placemark (bounce only one placemark).
    • exclusive elastic bounce - set animation for placemark (elastic bounce only one placemark).


For action you have to set Center=placemark

Restrictions

Plugin does not work in contacts, because of a contact has type, that differs from "content"

It is plugin for component, therefore component have to be installed

See also

Icon-attachment.pngDetail component description

Icon-attachment.pngModule for component



Language: English  • русский