Documentation for Iyosis Maps

Last Updated on 15 May 2011 Remzi 01 May 2011

Contents

Joomla 1.5 and Joomla 1.6 versions of Iyosis Maps are similar to each other. But to keep the documentation clear we prefered to prepare separate documentation for each version.

1. Joomla 1.6

1.1. Installation

Extract the downloaded file “com_iyosismaps_v1.x_unzipme.zip” with WinZip or a similar tool.
Go to Joomla Extension Manager and upload the file with a name like “com_iyosismaps_J1.6_v1.x_unzipme.zip”.
(Optional) If you want to display maps in content items you should install the Iyosis Maps Content Plugin. To do this go to Joomla Extensions Manager and upload the file with a name like “plg_iyosismaps_J1.6_v1.x.zip”.

1.2. Structure

The structure of the component consists of three main objects; maps, markers, polylines and polygons. You need to create at least one map to use this component but markers, polylines and polygons are optional.

1.3. Maps

To create a new map go to Joomla Administration > Iyosis Maps > Maps and click 'New' button. There are four tabs on the map creation page to make it easily manageable: Map, Controls, Content before and after map and Center Marker. Find below informations about every field on a map creation page.

1.3.1. Tab > Map

Title: Title is also shown as page title on the frontend.
Map type: Roadmap, Satellite, Hybrid or Terrain
Map width: Width of the map in pixels; if map width is empty, the default value '500' will be used.
Map height: Height of the map in pixels; if map height is empty, the default value '300' will be used.
Latitude and Longitude: The coordinates of the map center, you can easily specify these values with the help of the reference map below and draggable marker or enter the values manually. If you leave them empty the default values '20' and '-40' will be used.
Zoom level: Zoom level of the map, this value will be set automatically by the reference map if you change the zoom level. It can be set manually too. Zoom level can have a value between 0 and 21.

1.3.2. Tab > Controls

All options to manage map controls can be found here.

Zoom control: The Zoom control displays a slider (for large maps) or small "+/-" buttons (for small maps) to control the zoom level of the map.
MapType control: The MapType control lets the user toggle between map types (such as roadmap and satellite).
Pan control: The Pan control displays buttons for panning the map.
Scale control: The Scale control displays a map scale element.
Street View control: The Street View control contains a Pegman icon which can be dragged onto the map to enable Street View.
Overview Map control: The Overview Map control displays a thumbnail overview map reflecting the current map viewport within a wider area.
Scrollwheel zooming: Controlls scrollwheel zooming on the map. The scrollwheel is enabled by default.
Double click zooming: Enables/disables zoom and center on double click. Enabled by default.
Dragging: If disabled, prevents the map from being dragged. Dragging is enabled by default.

1.3.3. Tab > Content before and after the map

Content before and after map can be added here simply with the default Joomla WYSIWYG editor. You can add some extra informations, images or something else around the map. That is optional and disabled if is empty.

1.3.4. Tab > Center marker

Settings to manage the marker at the center of the map.

Center marker: Enable or disable the center marker, if it is enabled a marker will be displayed with the coordinates of the map center.
Icon: Select an icon from the list.
Info window: Enable or disable the info window for center marker. If enabled an info window will be displayed after an mouse click on the marker. The content of the info window can be set below in the description field.
Description: The content of the info window, if you leave this field empty info window will be disabled.

1.4. Markers

Additional markers can be created here. To create a new marker go to Joomla Administration > Iyosis Maps > Markers and click New. There are two tabs in the marker creation page to make it easily manageable: Marker and Info window. Find below informations about every field on a marker creation page.

1.4.1. Tab > Marker

Map: Select the map which the marker should be displayed on.
Icon: Select an icon from the list.
Latitude and Longitude: The coordinates of the marker. You can easily specify these values with the help of the reference map below and draggable marker or enter the values manually. If you leave them empty the default values '20' and '-40' will be used.

1.4.2. Tab > Info window

Info window: Enable or disable the info window for the marker. If enabled an info window will be displayed after an mouse click on the marker. The content of the info window can be set below in the description field.
Description: The content of the info window can be set here easily with help of the default Joomla WYSIWYG editor. If you leave this field empty info window will be disabled.

1.5. Icons

To create a new icon go to Joomla Administration > Iyosis Maps > Icons and click New.

Icon URL: Enter an URL of an image to use it as marker icon. You can use any image from online libraries or upload an image on your own server. e.g. 'http://www.google.com/mapfiles/marker.png'
Icon size: (width,height) The display size of the image. If the size is not provided, it will be set when the image loads. e.g. '20,34'
Icon origin: (x,y) A point, where x is the distance on the x-axis, and y is the distance on the y-axis. By default, the origin is located at the top left corner of the image '0,0'
Icon anchor: (x,y) The position at which to anchor an image in correspondance to the location of the marker on the map. A point, where x is the distance on the x-axis, and y is the distance on the y-axis. By default, the anchor is located along the center point of the bottom of the image. e.g. '10,34'
Shadow URL: Enter an URL of an image to use it as marker shadow. You can use any image from online libraries or upload an image on your own server. e.g. 'http://www.google.com/mapfiles/shadow50.png'
Shadow size: (width,height) The display size of the image. If the size is not provided, it will be set when the image loads. e.g. '20,34'
Shadow origin: (x,y) A point, where x is the distance on the x-axis, and y is the distance on the y-axis. By default, the origin is located at the top left corner of the image '0,0'
Shadow anchor:(x,y) The position at which to anchor an image in correspondance to the location of the marker on the map. A point, where x is the distance on the x-axis, and y is the distance on the y-axis. By default, the anchor is located along the center point of the bottom of the image. e.g. '10,34'

1.6. Polylines

Polylines are drawn as a series of straight segments on the map. You can specify custom colors, weights, and opacities for the stroke of the line. To create a new polyline go to Joomla Administration > Iyosis Maps > Polylines and click New. There are two tabs in the polyline creation page to make it easily manageable: Polyline and Info window. Find below informations about every field in a polyline creation page.

1.6.1. Tab > Polyline

Map: Select the map which the polyline should be displayed on.
Stroke color: Stroke color specifies a hexadecimal HTML color of the format "FFFFFF".
Stroke opacity: Stroke opacity specifies a numerical fractional value between 0.0 and 1.0 (default) of the opacity of the line's color.
Stroke weight: Stroke weight specifies the weight of the line's stroke in pixels.
Coordinates: Coordinates can be created easily with the help of the reference map below. To draw a polyline minimum two coordinates are required. You can clear the whenever you want with the 'Clear The Map' button.

1.6.2. Tab > Info window

Info window: Enable or disable the info window for the polyline. If enabled an info window will be displayed after an mouse click on the polyline. The content of the info window can be set below in the description field.
Description: The content of the info window can be set here easily with help of the default Joomla WYSIWYG editor. If you leave this field empty info window will be disabled.

1.7. Polygons

Polygon objects are similar to Polyline objects in that they consist of a series of coordinates in an ordered sequence. However, instead of being open-ended, polygons are designed to define regions within a closed loop. Similar to polylines, they allow you to define a stroke, which affects the outline of the polygon; unlike polylines, they also allow you to define a fill region inside the polygon. To create a new polygon go to Joomla Administration > Iyosis Maps > Polygons and click New. There are two tabs in the polyline creation page to make it easily manageable: Polygon and Info window. Find below informations about every field in a polygon creation page.

1.7.1. Tab > Polygon

Map: Select the map which the polygon should be displayed on.
Stroke color: Stroke color specifies a hexadecimal HTML color of the format "FFFFFF".
Stroke opacity: Stroke opacity specifies a numerical fractional value between 0.0 and 1.0 (default) of the opacity of the line's color.
Stroke weight: Stroke weight specifies the weight of the line's stroke in pixels.
Coordinates: Coordinates can be created easily with the help of the reference map below. To draw a polyline minimum two coordinates are required. You can clear the whenever you want with the 'Clear The Map' button.

1.7.2. Tab > Info window

2. Joomla 1.5

Iyosis Maps has been developed first with Joomla 1.5 and the latest version of Iyosis Maps for Joomla 1.5 is 1.5.1.

2.1. Installation

Extract the downloaded file “com_iyosismaps_v1.x_unzipme.zip” with a tool like WinZip or WinRar.
Go to your Joomla Extension Manager and upload the file with a name like “com_iyosismaps_J1.5_v1.x_unzipme.zip”.

2.2. Structure

The structure of the component is maintained by three objects, maps, markers and polylines. A map to create is required to use the component but markers and polylines are optional.

2.3. Maps

To create a new map go to Joomla Administration > Iyosis Maps > Maps and click New. There are four tabs in the map creation page to make it easily manageable: Map, Controls, Content before and after map and Center Marker. You can find below informations about every field in a map creation page.

2.3.1. Tab > Map

Name: Name is also shown as page title on the frontend.
Map type: Roadmap, Satellite, Hybrid or Terrain
Map width: Width of the map in pixels, if you leave it empty the default value '500' will be used.
Map height: Height of the map in pixels, if you leave it empty the default value '300' will be used.
Latitude and Longitude: The coordinates of the center of the map. You can easily specify these values with the help of the reference map below and draggable marker or enter the values manually. If you leave them empty the default values '20' and '-40' will be used.
Zoom level: Zoom level of the map, this value will be set automatically by the reference map below if you change the zoom level. It can be set manually too. Zoom level can have a value between 0 and 21.

2.3.2. Tab > Controls

All options to manage map controls can be found here.

2.3.3. Tab > Content before and after the map

2.3.4. Tab > Center marker

Settings to manage the marker at the center of the map.

Marker image: An image URL can be set here to replace the default marker icon. Ex: http://www.google.com/mapfiles/markerA.png. If you leave it empty, default marker will be used. Some sample markers can be found here: http://www.iyosis.com/index.php?option=com_content&id=11

2.4. Markers

Additional markers can be created here. To create a new marker go to Joomla Administration > Iyosis Maps > Markers and click New. There are two tabs in the marker creation page to make it easily manageable: Marker and Info window. You can find below informations about every field in a marker creation page.

2.4.1. Tab > Marker

2.4.2. Tab > Info window

2.5. Polylines

Polylines are drawn as a series of straight segments on the map. You can specify custom colors, weights, and opacities for the stroke of the line. To create a new polyline go to Joomla Administration > Iyosis Maps > Polylines and click New. There are two tabs in the polyline creation page to make it easily manageable: Polyline and Info window. You can find below informations about every field in a polyline creation page.

2.5.1. Tab > Polyline

Name: Name of the polyline.
Map: Select the map which the polyline should be displayed on.
Stroke color: Stroke color specifies a hexadecimal HTML color of the format "#FFFFFF".
Stroke opacity: Stroke opacity specifies a numerical fractional value between 0.0 and 1.0 (default) of the opacity of the line's color.
Stroke weight: Stroke weight specifies the weight of the line's stroke in pixels.
Coordinates: Coordinates can be created easily with the help of the reference map below. To draw a polyline minimum two coordinates are required. You can clear the whenever you want with the 'Clear The Map' button.

IYOSIS

Newsletter