Maps: Documentation

Google Maps Integration - Open Source Extension for Joomla. Easily add beautiful, interactive Google Maps to your Joomla website.
Learn More.

The documentation is also available within the application by using the Documentation button, or by hovering the mouse over help (?) points.

Quick Start

---

After initial installation your API Key is not set. Insert your API Key into the corresponding field in Google Maps Options > API tab, or create individual maps. Note that a default Latitude and Longitude are already set to a demo location, you will need to adjust these coordinates to your specific location. Use the Content Snippet found in the Google Maps Options > General tab, as described in the Documentation. Also make sure that you clear the Cache of your Joomla and browser. As of June 11th 2018, Google requires that all projects must be associated with a billing account. Keyless usage will result in a degraded experience, or an error. Learn More.

Updates

---

Authorization Code

The Authorization Code is required for the Pro edition in order to get live updates. To install updates using the Joomla Extensions Update system, insert your Authorization Code here. Get your Authorization Code from your Eorisis account - 'Subscriptions & Renewals' page on eorisis.com. The Free edition can get live updates without an Authorization Code.

Google Maps

Create, manage, and add items to specific pages.

---

New/Edit Google Map

Title
Set a title for the list in the backend. It will not be used in the generated HTML.

---

General

Latitude:
(Use Global / Custom)
In geography, latitude is a geographic coordinate that specifies the north-south position of a point on the Earth's surface. Latitude is an angle which ranges from 0° at the Equator to 90° (North or South) at the poles.
Find or enter latitude & longitude


Longitude:
(Use Global / Custom)
Longitude is a geographic coordinate that specifies the east-west position of a point on the Earth's surface. It is an angular measurement, usually expressed in degrees and denoted by the Greek letter lambda (λ).
Find or enter latitude & longitude


Content Snippet:
(Use Global / Custom)
Default: {eorisis_googlemap}
This is the snippet to be used in your content in your text editor at any point you want the map to appear. You can use it in any content area such as Articles, Article Categories, Contact Address fields, or any other, in Joomla core, or in any extension that provides content fields. You can change the snippet to fit your needs, but remember that any previously saved snippets in your content will no longer produce a map and will need to be updated to the new one.

---

API

API Key:
(Use Global / Custom)
Your Google Maps API Key listed in your Google Maps API Console > APIs > Maps JavaScript API. If you do not have an API Key, you have to create one in your Google Maps console.


Map ID:
(Use Global / Custom)
A map ID is an identifier that's associated with a specific map style or feature. Configure a map style and associate it with a map ID in the Google Cloud Console. To create a map ID, in the Cloud Console, go to the Maps Management page and select Create New Map ID to display the Create New Map ID form.

---

Appearance

Map Type:
(Use Global / Custom)
(Roadmap / Satellite / Hybrid / Terrain)
There are four types of maps available within the Maps JavaScript API. In addition to the familiar 'painted' road map tiles, the Maps JavaScript API also supports other maps types. The following map types are available in the Maps JavaScript API:

- Roadmap: Displays the default road map view. This is the default map type.
- Satellite: Displays Google Earth satellite images.
- Hybrid: Displays a mixture of normal and satellite views.
- Terrain: Displays a physical map based on terrain information.


Zoom:
(Use Global / Custom)
The initial resolution at which to display the map is set by the zoom property, where zoom 0 corresponds to a map of the Earth fully zoomed out, and larger zoom levels zoom in at a higher resolution. Specify zoom level as an integer.

Offering a map of the entire Earth as a single image would either require an immense map, or a small map with very low resolution. As a result, map images within Google Maps and the Maps JavaScript API are broken up into map 'tiles' and 'zoom levels'. At low zoom levels, a small set of map tiles covers a wide area, at higher zoom levels, the tiles are of higher resolution and cover a smaller area. The following list shows the approximate level of detail you can expect to see at each zoom level:

1: World
5: Landmass/continent
10: City
15: Streets
20: Buildings


Width:
(Use Global / Custom)
The width of the map.


Height:
(Use Global / Custom)
The height of the map.


Marker:
(Use Global / Custom)
A marker identifies a location on a map.


Marker Title:
(Use Global / Custom)
A title for the marker to be displayed on mouse-over.

---

Localization

You can customize your map for a specific country or region in the following ways: Change the default language settings. Specify a region, which alters the map's behavior based on a given country or territory.

If you set the language of the map, it's important to consider setting the region too. This helps ensure that your application complies with local laws.

The Maps JavaScript API also supports bi-directional (Bidi) text containing characters in both left-to-right (LTR) and right-to-left (RTL) languages natively. Examples of RTL languages include Arabic, Hebrew, and Farsi. Generally, you should specify RTL language pages to render properly by adding dir='rtl' to the page's html element.


Language:
(Use Global / Custom)
By default, the Maps JavaScript API uses the user's preferred language setting as specified in the browser, when displaying textual information such as the names for controls, copyright notices, driving directions and labels on maps. In most cases, it's preferable to respect the browser setting. However, if you want the Maps JavaScript API to ignore the browser's language setting, you can force it to display information in a particular language.

The language parameter affects the names of controls, copyright notices, driving directions, and control labels, as well as the responses to service requests. The effect on services is not as apparent. For example, when geocoding street level addresses the country name is returned in the language you requested, but the rest of the address will be specific to the location you are geocoding. On the other hand, postal and political results are returned in the requested language.


Region:
(Use Global / Custom)
Add the region when loading the Maps, if you want to alter your application to serve different map tiles or bias the application (such as biasing geocoding results towards the region).

You are encouraged to always set a region parameter as various services (such as Places Autocomplete) tend to provide better results when the region is set. It is also your responsibility to ensure that your application complies with local laws by ensuring that the correct region localization is applied for the country in which the application is hosted.

---

Controls

Default UI:
(Use Global / Custom)
You may wish to turn off the default UI buttons entirely. This disables any UI control buttons from the Map. It does not, however, affect mouse gestures or keyboard shortcuts on the base map.


Zoom:
(Use Global / Custom)
Enables/disables the Zoom control. By default, this control is visible and appears near the bottom right of the map.


Map Type:
(Use Global / Custom)
Enables/disables the Map Type control that lets the user toggle between map types (such as Map and Satellite). By default, this control is visible and appears in the top left corner of the map.


Scale:
(Use Global / Custom)
Enables/disables the Scale control that provides a simple map scale. By default, this control is not visible. When enabled, it will always appear in the bottom right corner of the map.


Street View:
(Use Global / Custom)
Enables/disables the Pegman control that lets the user activate a Street View panorama. By default, this control is visible and appears near the bottom right of the map.


Rotate:
(Use Global / Custom)
Enables/disables the appearance of a Rotate control for controlling the orientation of 45° imagery. By default, the control's presence is determined by the presence or absence of 45° imagery for the given map type at the current zoom and location.


Full Screen:
(Use Global / Custom)
Enables/disables the control that opens the map in fullscreen mode. By default, this control is enabled by default on desktop and Android devices. When enabled, the control appears near the top right of the map.


Gesture Handling:
(Use Global / Custom)
When a user scrolls a page that contains a map, the scrolling action can unintentionally cause the map to zoom. This behavior can be controlled using the Gesture Handling map option.

Auto: Default.
Cooperative: Allowing the user to scroll the page normally, without zooming or panning the map. Users can zoom the map by clicking the zoom controls. They can also zoom and pan by using two-finger movements on the map for touchscreen devices.
Greedy: The map reacts to all touch gestures and scroll events unlike Cooperative.
None: Disables gestures on the map.

---

Area

Part
Attach this element to the part of you choice.

- All HTML Pages: Exclude Article Categories (All / Select / None)
Select whether you want this element to be excluded from the pages of articles within the categories of your choice. You can select more than one category.

- All HTML Pages: Exclude Contact Categories (All / Select / None)
Select whether you want this element to be excluded from the pages of contacts within the categories of your choice. You can select more than one category.

- All HTML Pages: Exclude Menu Items
Exclude this element from one or more menu items of the site.

- Menu Items
Attach this element to one or more menu items of your choice.

- Article IDs
Comma separated IDs of articles.

- Article Categories
Select one or more categories from the list.

- Contact Categories
Select one or more categories from the list.

- 3rd Party Components
Select one or more components from the list of components that are detected to be installed on your site. Core Joomla components are not on this list.

- Page Relative URI (Is / Has / Starts With / Ends With)
Compare the Relative URI string based on the given options.

- Page Relative URI: Is
When you want to apply this element on pages where the Relative URI is exactly the same from start to end.

- Page Relative URI: Has
When you want to apply this element on pages where the Relative URI has the given string.

- Page Relative URI: Starts With
When you want to apply this element on pages where the Relative URI starts with the given string.

- Page Relative URI: Ends With
When you want to apply this element on pages where the Relative URI ends with the given string.

- Page Relative URI: String
The text string to be compared with the Relative URI of a page.

- Page Relative URI: Case Sensitive
Upper case and lower case text can be treated as distinct (case sensitive) or equivalent (case insensitive). Searches within electronic text can usually be sensitive to case or not, as required. When Case Sensitive is On the following example text cases will be considered as different: APP, App, app.

- Filter (Include / Exclude)
You can either include this element to the selected area or exclude it. If you Include it, it will appear only on that area and nowhere else. If you Exclude it, it will appear everywhere except the area you selected.

- Maps Module

Categories

---

Items can be organized in categories.

Maps Module

---

You can assign the module to any page(s) of your site, and select any of the maps you have created to be displayed. You can also Use Global.

Google Maps Options

Global options for Google Maps.

---

General

Latitude:
In geography, latitude is a geographic coordinate that specifies the north-south position of a point on the Earth's surface. Latitude is an angle which ranges from 0° at the Equator to 90° (North or South) at the poles.
Find or enter latitude & longitude


Longitude:
Longitude is a geographic coordinate that specifies the east-west position of a point on the Earth's surface. It is an angular measurement, usually expressed in degrees and denoted by the Greek letter lambda (λ).
Find or enter latitude & longitude


Content Snippet:
Default: {eorisis_googlemap}
This is the snippet to be used in your content in your text editor at any point you want the map to appear. You can use it in any content area such as Articles, Article Categories, Contact Address fields, or any other, in Joomla core, or in any extension that provides content fields. You can change the snippet to fit your needs, but remember that any previously saved snippets in your content will no longer produce a map and will need to be updated to the new one.

---

API

API Key:
Your Google Maps API Key listed in your Google Maps API Console > APIs > Maps JavaScript API. If you do not have an API Key, you have to create one in your Google Maps console.


Map ID:
A map ID is an identifier that's associated with a specific map style or feature. Configure a map style and associate it with a map ID in the Google Cloud Console. To create a map ID, in the Cloud Console, go to the Maps Management page and select Create New Map ID to display the Create New Map ID form.

---

Appearance

Map Type:
(Roadmap / Satellite / Hybrid / Terrain)
There are four types of maps available within the Maps JavaScript API. In addition to the familiar 'painted' road map tiles, the Maps JavaScript API also supports other maps types. The following map types are available in the Maps JavaScript API:

- Roadmap: Displays the default road map view. This is the default map type.
- Satellite: Displays Google Earth satellite images.
- Hybrid: Displays a mixture of normal and satellite views.
- Terrain: Displays a physical map based on terrain information.


Zoom:
The initial resolution at which to display the map is set by the zoom property, where zoom 0 corresponds to a map of the Earth fully zoomed out, and larger zoom levels zoom in at a higher resolution. Specify zoom level as an integer.

Offering a map of the entire Earth as a single image would either require an immense map, or a small map with very low resolution. As a result, map images within Google Maps and the Maps JavaScript API are broken up into map 'tiles' and 'zoom levels'. At low zoom levels, a small set of map tiles covers a wide area, at higher zoom levels, the tiles are of higher resolution and cover a smaller area. The following list shows the approximate level of detail you can expect to see at each zoom level:

1: World
5: Landmass/continent
10: City
15: Streets
20: Buildings


Width:
The width of the map.


Height:
The height of the map.


Marker:
(On / Off)
A marker identifies a location on a map.


Marker Title:
A title for the marker to be displayed on mouse-over.

---

Localization

You can customize your map for a specific country or region in the following ways: Change the default language settings. Specify a region, which alters the map's behavior based on a given country or territory.

If you set the language of the map, it's important to consider setting the region too. This helps ensure that your application complies with local laws.

The Maps JavaScript API also supports bi-directional (Bidi) text containing characters in both left-to-right (LTR) and right-to-left (RTL) languages natively. Examples of RTL languages include Arabic, Hebrew, and Farsi. Generally, you should specify RTL language pages to render properly by adding dir='rtl' to the page's html element.


Language:
(Auto / Custom)
By default, the Maps JavaScript API uses the user's preferred language setting as specified in the browser, when displaying textual information such as the names for controls, copyright notices, driving directions and labels on maps. In most cases, it's preferable to respect the browser setting. However, if you want the Maps JavaScript API to ignore the browser's language setting, you can force it to display information in a particular language.

The language parameter affects the names of controls, copyright notices, driving directions, and control labels, as well as the responses to service requests. The effect on services is not as apparent. For example, when geocoding street level addresses the country name is returned in the language you requested, but the rest of the address will be specific to the location you are geocoding. On the other hand, postal and political results are returned in the requested language.


Region:
(Auto / Custom)
Add the region when loading the Maps, if you want to alter your application to serve different map tiles or bias the application (such as biasing geocoding results towards the region).

You are encouraged to always set a region parameter as various services (such as Places Autocomplete) tend to provide better results when the region is set. It is also your responsibility to ensure that your application complies with local laws by ensuring that the correct region localization is applied for the country in which the application is hosted.

---

Controls

Default UI:
(On / Off)
You may wish to turn off the default UI buttons entirely. This disables any UI control buttons from the Map. It does not, however, affect mouse gestures or keyboard shortcuts on the base map.


Zoom:
(On / Off)
Enables/disables the Zoom control. By default, this control is visible and appears near the bottom right of the map.


Map Type:
(On / Off)
Enables/disables the Map Type control that lets the user toggle between map types (such as Map and Satellite). By default, this control is visible and appears in the top left corner of the map.


Scale:
(On / Off)
Enables/disables the Scale control that provides a simple map scale. By default, this control is not visible. When enabled, it will always appear in the bottom right corner of the map.


Street View:
(On / Off)
Enables/disables the Pegman control that lets the user activate a Street View panorama. By default, this control is visible and appears near the bottom right of the map.


Rotate:
(On / Off)
Enables/disables the appearance of a Rotate control for controlling the orientation of 45° imagery. By default, the control's presence is determined by the presence or absence of 45° imagery for the given map type at the current zoom and location.


Full Screen:
(On / Off)
Enables/disables the control that opens the map in fullscreen mode. By default, this control is enabled by default on desktop and Android devices. When enabled, the control appears near the top right of the map.


Gesture Handling:
(Auto / Cooperative / Greedy / None)
When a user scrolls a page that contains a map, the scrolling action can unintentionally cause the map to zoom. This behavior can be controlled using the Gesture Handling map option.

Auto: Default.
Cooperative: Allowing the user to scroll the page normally, without zooming or panning the map. Users can zoom the map by clicking the zoom controls. They can also zoom and pan by using two-finger movements on the map for touchscreen devices.
Greedy: The map reacts to all touch gestures and scroll events unlike Cooperative.
None: Disables gestures on the map.

Preferences

Global preferences that apply sitewide.

---

General

Clear Frontend Cache
(On / Off)
When Joomla Global Configuration has caching enabled, activating this option ensures that the Frontend cache is automatically cleared during actions like saving.

Interface

Customize the User Interface (UI) to your liking.

---

General

Side Bar Menus
Select the visibility of the Side Bar Menus. The Side Bar appears on the left and provides an easy way to navigate to different sections directly.


Layout Colors
(Default / Eorisis)

---

Buttons

Documentation Button
(Dashboard / On / Off)
Select the visibility of the Documentation button on the toolbars. The button opens a modal window with the online documentation of the software.


Changelog Button
(Dashboard / On / Off)
Select the visibility of the Changelog button on the toolbars. The button opens a modal window with the online changelog of the software.


Toolbar Buttons
(Group / Separate)
Whether to Group the buttons of the toolbar or not, such as Save, Save & Close, etc. Joomla 4 or higher

---

Google Maps List

Category
(Show Column & Under Title / Show Column / Show Under Title / Hide)
Select the visibility of the Category an item belongs to, in the list of items.


Category Prefix
(Show / Hide)
Select the visibility of the word Category before the actual category the item belongs to. This is only visible when your Category setting allows for the visibility of the category.


Language
(Show / Hide)
Select the visibility of this column in the list of items in the Backend.


Author
(Show / Hide)
Select the visibility of this column in the list of items in the Backend.


Created Date
(Show / Hide)
Select the visibility of this column in the list of items in the Backend.


ID
(Show / Hide)
Select the visibility of this column in the list of items in the Backend.

---

Notifications

Display notifications in the administration area. If the system detects any kind of misconfiguration in your Joomla CMS or the extension, it will display a notification in the Dashboard or a specific section. It is recommended to keep them on.


Quick Start
(On / Off)

Setup Plugin
(On / Off)

cURL
(On / Off)

Permissions

Default permissions used for all items in this component.
Manage the permission settings for the user groups below.
If you change the setting, it will apply to this and all child groups and items.

---

Inherited
The permissions from the parent group will be used.

Allowed
The group being edited will be able to take this action (but if this is in conflict with the parent group it will have no impact; a conflict will be indicated by Not Allowed (Locked) under Calculated Settings).

Denied (Not Allowed)
No matter what the parent group's setting is, the group being edited can't take this action.

Not Set
Used only for the Public group in global configuration. The Public group is the parent of all other groups. If a permission is not set, it is treated as Deny but can be changed for child groups, components, categories and items.


Configure ACL & Options
(Inherited / Allowed / Denied)
Allows users in the group to edit the options and permissions of this application.


Configure Options Only
(Inherited / Allowed / Denied)
Allows users in the group to edit the options except the permissions of this application.


Access Administration Interface
(Inherited / Allowed / Denied)
Allows users in the group to access the administration interface for this application.


Create
(Inherited / Allowed / Denied)
Allows users in this group to create items and categories in this application.


Delete
(Inherited / Allowed / Denied)
Allows users in this group to delete items and categories in this application.


Edit
(Inherited / Allowed / Denied)
Allows users in this group to edit items and categories in this application.


Edit State
(Inherited / Allowed / Denied)
Allows users in this group to change the state of items and categories in this application.


Edit Own
(Inherited / Allowed / Denied)
Allows users in this group to edit any items and categories they have created in this application.


Edit Update Options
(Inherited / Allowed / Denied)
Allows users in this group to edit the Update options of this application.


Edit Preferences
(Inherited / Allowed / Denied)
Allows users in this group to edit the Preferences of this application.


Edit Interface
(Inherited / Allowed / Denied)
Allows users in this group to edit the UI of this application.


Edit Google Maps Options
(Inherited / Allowed / Denied)
Allows users in this group to edit the Google Maps global options of this application.

Notes

---

It is currently not possible to use more than 1 API key, more than 1 Language, or more than 1 Region on the same page, as they are part of the API URL that must exist only once on the page.