Zh YandexMap Plugin

From Documentation
Revision as of 14:30, 9 October 2019 by Admin (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Purpose

Plugin for component is created for inserting maps into articles.

Moreover, since it is a plugin for the content (type is content), then you can insert code to call in the Custom HTML module and display the map as a module. It is recommended to put width=0 (which corresponds to the width: 100%), in order to map automatically fills the width of the module, and is resized (eg, a variable template size) and did not occur map oversizing.


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

Using

Show Map

To show the map in an article, insert the following code 

{zhyandexmap:MMM;Hidden Container Text}

where

  • MMM - (required) map ID. It is displayed in a map list.
  • Hidden Container Text - if you want to show map in hidden container (link), by clicking on it - show map

It is restriction to use some symbols. You must not use this symbols in Hidden Container Text text value
< > / \

Show Map by Placemark

Also, you can show the map with only one specific marker. To do this, insert the following call 

{zhyandexmap-marker:NNN;Center;Zoom;MapType;Width;Height;Hidden Container Text}

where

  • NNN - (required) placemark ID
  • Center - map center or placemark is new center of map, valid values:
    • map
    • placemark
  • Zoom - new zoom of map, valid values
    • values from 1 to 17 to override zoom
    • do not change - do not change map zoom
    • max available - max available for current map type
  • MapType - new map type
    • MAP
    • SATELLITE
    • HYBRID
    • PMAP
    • PHYBRID
    • 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
  • Hidden Container Text - if you want to show map in hidden container (link), by clicking on it - show map


It is restriction to use some symbols. You must not use this symbols in Hidden Container Text text value
< > / \


Example 1:
{zhyandexmap-marker:5;placemark;10}


Example 2:
{zhyandexmap-marker:1;map;do not change}


Example 3:
{zhyandexmap-marker:4}
In this case

  • Center by default set to map
  • Zoom by default is set to do not change



Example 4:
{zhyandexmap-marker:1;;15}
In this case

  • Center by default set to map
  • Zoom is set 15



Show map by Placemark List

To show the map with placemarks from different maps (and this placemarks is specified by list) by the following call 

{zhyandexmap-markerlist:PlacemarkList;MMM;Zoom;MapType;Width;Height;Hidden Container Text;Center}

where

  • PlacemarkList - (required) list of placemarks IDs, separated by comma
  • MMM - (required) map ID
  • Zoom - new zoom of map, valid values
    • values from 1 to 17 to override zoom
    • do not change - do not change map zoom
    • max available - max available for current map type
  • MapType - new map type
    • MAP
    • SATELLITE
    • HYBRID
    • PMAP
    • PHYBRID
    • 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
  • Hidden Container Text - if you want to show map in hidden container (link), by clicking on it - show map
  • Center - map center or placemark ID is new center of map, valid values:
    • placemark ID for center map by it. Placemark have to be defined by latitude and longitude
    • do not change - do not change map center

It is restriction to use some symbols. You must not use this symbols in Hidden Container Text text value
< > / \

Example 1:

{zhyandexmap-markerlist:1,2,5;10}
In this case you'll see placemark with ID=1, with ID=2 and with ID=5 on map with ID=10

Show map by Placemark Group List

To show the map with markers from different maps with markers, which have a definite group by the following call 

{zhyandexmap-group:PlacemarkGroupList;MMM;Zoom;MapType;Width;Height;Hidden Container Text;Center}

where

  • PlacemarkGroupList - (required) list of placemark group IDs, separated by comma
  • MMM - (required) map ID
  • Zoom - new zoom of map, valid values
    • values from 1 to 17 to override zoom
    • do not change - do not change map zoom
    • max available - max available for current map type
  • MapType - new map type
    • MAP
    • SATELLITE
    • HYBRID
    • PMAP
    • PHYBRID
    • 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
  • Hidden Container Text - if you want to show map in hidden container (link), by clicking on it - show map
  • Center - map center or placemark ID is new center of map, valid values:
    • placemark ID for center map by it. Placemark have to be defined by latitude and longitude
    • do not change - do not change map center

It is restriction to use some symbols. You must not use this symbols in Hidden Container Text text value
< > / \

Show Map by Category List

You can show the map with markers from different maps by marker category. To do this, insert the following call 

{zhyandexmap-category:PlacemarkCategoryList;MMM;Zoom;MapType;Width;Height;Hidden Container Text;Center}

where

  • PlacemarkCategoryList - (required) list of placemark category IDs, separated by comma
  • MMM - (required) map ID
  • Zoom - new zoom of map, valid values
    • values from 1 to 17 to override zoom
    • do not change - do not change map zoom
    • max available - max available for current map type
  • MapType - new map type
    • MAP
    • SATELLITE
    • HYBRID
    • PMAP
    • PHYBRID
    • 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
  • Hidden Container Text - if you want to show map in hidden container (link), by clicking on it - show map
  • Center - map center or placemark ID is new center of map, valid values:
    • placemark ID for center map by it. Placemark have to be defined by latitude and longitude
    • do not change - do not change map center

It is restriction to use some symbols. You must not use this symbols in Hidden Container Text text value
< > / \

When you show map by category, all objects on map (placemarks, routes, paths) is filtered by this category.

Show Map in Lightbox

To show the map in lightbox, insert the following code 

{zhyandexmap-lightbox:MMM;Title;Width;Height;Image;PlacemarkList}

where

  • MMM – (required) map id
  • Title – title on link
  • Width – width of lightbox-window
  • Height – height of lightbox-window.
  • Image - filename of image, which can be displayed.

Images you have to store in component asset folder, and specify only filename and extension 

administrator/components/com_zhyandexmap/assets/lightbox/
  • PlacemarkList - list of placemarks IDs, separated by comma


It is restriction to use some symbols. You must not use this symbols in Title text value
< > / \

Map is displaying as component, not as plugin. I.e. the plugin calls the component. There is one specialty. CSS from template not loaded.


Example 1:

{zhyandexmap-lightbox:2;;800;500;ZhukLogo.png}

  • In this case link title is not displayed, just only image.


If you don't set title and image - there is default text is displayed as title.

Restrictions

Plugin does not work in contacts, because of a contact has type, that differs from "content"
But you have opportunity write article like contact page, as you like, and include map
Or you can use module in this case

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

It is restriction to use some symbols. You must not use this symbols in text values
< > / \

See also

Detail component description

Module for component



Language: English  • русский
Retrieved from "https://wiki.zhuk.cc/index.php?title=Zh_YandexMap_Plugin&oldid=3025"