example15_vr9.php HOME Examples overview Download Ask a question / privacy policy / imprint

AJAX-ZOOM - no toolbar, "image map" outside, zoom slider enabled, custom navi using API functions. Responsive ready!

This example is about the "image map" placed outside of the viewer. An "image map" defines as a small representation of the image where the user sees what part of the large image is visible in the zoomed viewport of the viewer. The user can also drag the small rectangular indicator within the "image map" and by doing so, pan the large, zoomed image in the viewer.

The default placement of the "image map" is inside the viewer at an adjustable corner. In this example, the "image map" displays outside of the zoom viewer.

Test: - display the above AJAX-ZOOM "image map" in place of the selected thumbnail image.

$.axZm.thumbGallery extension

In this example, several images from different locations hand over to the AJAX-ZOOM $.axZm.thumbGallery extension by the zoomData option. This option is one of many available for the $.axZm.thumbGallery extension. Instead of defining the image paths for each image separately, you can also set the "zoomDir" option to load all images from a specified folder automatically. While loading, the extension instantly generates thumbnails of the high-resolution images and arranges them in a responsive grid next to the viewer. You can choose the transition type for switching between images.

To achieve a similar result without utilizing the $.axZm.thumbGallery extension, you could also use the AJAX-ZOOM native API methods. The most important method is $.fn.axZm.zoomSwitch. It allows you to control the switching between images from outside of the viewer. With the $.fn.axZm.loadAjaxSet method it is furthermore possible to load a different set of images into the already loaded instance of the gallery.

The $.axZm.thumbGallery, however, is commented and you can take the extension as the basis to create your custom functionality. Besides this example, several other examples use the $.axZm.thumbGallery extension. Therefore, before declaring a functionality as missing, you might want to view other examples and inspect the options of the extension1.


In this example, the "native" toolbar is completly disabled. Instead, the mNavi buttons are set in onBeforeStart callback within the JavaScript code that initiates the extension. You can also set it in /axZm/zoomConfig.inc.php or in /axZm/zoomConfigCustom.inc.php file after elseif ($_GET['example'] == 18) {. See also the "embedExample" option below.

Image map

Unlike in most other examples, in this one, the image map locates outside of the AJAX-ZOOM viewer. The name of the AJAX-ZOOM option that does it is mapParent. You can find it initially defined in /axZm/zoomConfig.inc.php. The option sets the ID of a block element where the map should fit inside. Accordingly, that element can be anywhere. In this example, the mapParent option is set in onBeforeStart callback within the initiation code of the extension - jQuery.axZm.mapParent = 'mapContainer'; and not within a PHP configuration file. You can do that with some AJAX-ZOOM options.

The $.axZm.thumbGallery extension also has an option that places the "image map" over or seemingly in place of the selected thumbnail image! If that option is enabled, the JavaScript code of the extension changes the mapParent option whenever an image switches. In this particular layout, however, we have chosen to hide the AJAX-ZOOM "image map" on small screens (below 991px) by a @media CSS rule.

JavaScript & CSS files

<!-- jQuery core, needed if not already present! -->
<script type="text/javascript" src="../axZm/plugins/jquery-1.8.3.min.js"></script>

<!-- AJAX-ZOOM core, needed! -->
<link rel="stylesheet" href="../axZm/axZm.css" type="text/css">
<script type="text/javascript" src="../axZm/jquery.axZm.js"></script>

<!-- AJAX-ZOOM thumbGallery extension, needed! -->
<link rel="stylesheet" href="../axZm/extensions/jquery.axZm.thumbGallery.css" type="text/css">
<link rel="stylesheet" href="../axZm/extensions/jquery.axZm.azGrid.css" type="text/css">
<script type="text/javascript" src="../axZm/extensions/jquery.axZm.thumbGallery.js"></script>

Example layout


HTML markup in body

All containers can be responsive! If the container where AJAX-ZOOM loads into is responsive, you must set the embedResponsive option below to true.

<div class="row" id="outerParent">
	<div class="col-md-6" id="outerLeft">
		<!-- Container where AJAX-ZOOM will be loaded into -->
		<div id="zoomInlineContent"></div>
	<div class="col-md-6" id="outerRight">
			<!-- Container where thumbs will be loaded into -->
			<div id="thumbsParentContainer"></div>

			<!-- Container for map -->
			<div id="mapContainer" style=""></div>



$.azThumbGallery - documentation (options)

axZmPath 'auto' Path to /axZm directory, e.g. /test/axZm/
folderSelect 'select' The look of navigation for subfolders. Only useable if "zoomDir" is defined (not with "zoomData"). Possible values: "select", "folders", "imgFolders" or false
zoomDir null Path to subfolders with images; If "folderSelect" is set to false, then you can define the path directly to some folder with images.
firstFolder null After page loads select from which "zoomDir" subfolder thumbnails should be loaded first, integer (index of subfolder) or string (name of the subfolder). If nothitng is defined and there is no hash value (see "setHash" option below), then first subfolder is selected instantly.
zoomData null Alternativly to "zoomDir" where all images from a folder or subfolders are loaded, you can define several images from different folders. Here "zoomData" can be CSV string separated with "|"; it can also be an array or it can be an object where property values are the paths of the images.
folderIconPrefix 'folder_icon_' Applied if folderSelect is set to "folders". Value is the prefix of icon image located in /axZm/icons directory. On default the three icons are: folder_icon_close.png, folder_icon_close_over.png, folder_icon_open.png
imgFoldersSettings {} This option is applied only if the value of "folderSelect" option is "imgFolders".
thumbNumber 3 amount of icons to show, max 3
thumbWidth 32width of the icons
thumbHeight 32 height of the icons
thumbRetina true true will double the resolution of the thumbnails images
thumbQual 100 jpg quality of the thumbnail image
thumbMode 'contain' possible values: "contain", "cover" or false
thumbsCache true cache thumbnails
thumbOpacity 1.0 opacity
folderNameFunc function This is a "filter" function for the titles of the subfolders. The first argument passed to the function is the name of the subfolder from the file system. This input string can be changed and returned in a different way. On default this function makes first letter uppercase, replaces _ (underscore) to empty space and truncates the resulting string to max. 15 characters. If you do not want to have any changes, simply set folderNameFunc to function(input){return input;}
axZmCallBacks {} AJAX-ZOOM has several callbacks, https://www.ajax-zoom.com/index.php?cid=docs#onBeforeStart
fullScreenApi false Try to open AJAX-ZOOM at browsers fullscreen mode, possible on modern browsers except IE < 10 and mobile
setHash false Set location hash when users navigate between the folders. Setting the location hash will result in switching between folders when the user hits browser backword button. Also if the location address is copied with the hash, opening it again will load this folder at first.
thumbWidth 120 Width of the thumbnail image
thumbHeight 120 Height of the thumbnail image
thumbRetina true true will double the resolution of the thumbnails images but keep "thumbWidth" and "thumbHeight" on screen
thumbsCache true Cache thumbnails
thumbQual 90 jpg quality of the thumbnail image
thumbMode false possible values: "contain", "cover" or false
thumbBackColor '#FFFFFF' Background color of the thumb if "thumbMode" is set to "contain"
thumbPadding null Quickly overwrite the css padding of the thumbs
thumbMarginRight null Quickly overwride the css margin to the right of the thumbs
thumbMarginBottom null Quickly overwride the css margin to the bottom of the thumbs
thumbCss {} Quickly overwride any other CSS
thumbPreloadingImg 'ajax-loader-map-white.gif' Image located in /axZm/icons directory which will appear before the thumbs are loaded
thumbDescr [] array; poaaible array elements: fileName, thumbDescr, fullDescr; thumbDescr and fullDescr are returned from AJAX-ZOOM for regular thumbs. On default thumbDescr returns resolution of the original image. It is adjustable in /axZm/zoomConfig.inc.php or /axZm/zoomConfigCustom.inc.php over $zoom['config']['galleryThumbDesc'] and $zoom['config']['galleryThumbFullDesc'] options.
thumbDescrJoin '<br>' If thumbDescr has more than one elemets, they will be splitted by this string
thumbDescrTruncate false integer - truncate each of the descriptions adding [...] or false
thumbsPerPage null In case the number of thumbs will exceed "thumbsPerPage" value, the extension will append "page numbers" under the thumbs. null disables the feature.
thumbsContainer 'thumbsParentContainer' ID of the container where thumbs should be inserted. Container can be responsive.
selectContainer 'selectParentContainer' ID of the container where folders navigation - "folderSelect" should be inserted. Container can be responsive.
ajaxZoomOpenMode 'fullscreen' Determines how AJAX-ZOOM is opened when the user clicks on the image thumbs, possible values:
  • 'fullscreen' - AJAX-ZOOM opens at fullscreen mode, see also "fullScreenApi" option
  • 'fancyboxFullscreen' - AJAX-ZOOM opens in the responsive Fancybox. Fancybox is a commonly used lightbox jQuery plugin
  • 'fancybox' - AJAX-ZOOM opens in regular fixed width and height Fancybox
  • 'colorbox' - AJAX-ZOOM opens in Colorbox with fixed width and height. Colorbox is an other popular lightbox plugin
  • 'zoomSwitch' - In case "embedMode" is enabled, which means that AJAX-ZOOM is already opened next to the thumbs, clicking on the thumb will just switch the image within AJAX-ZOOM. This value is set instantly when "embedMode" is set to true;
exampleFullscreen 'mouseOverExtension' Configuration set 2 which is passed to AJAX-ZOOM when "ajaxZoomOpenMode" is 'fullscreen'
exampleFancyboxFullscreen 'mouseOverExtension' Configuration set 2 which is passed to AJAX-ZOOM when "ajaxZoomOpenMode" is 'fancyboxFullscreen'
exampleFancybox 'modal' Configuration set 2 which is passed to AJAX-ZOOM when "ajaxZoomOpenMode" is 'fancybox'
exampleColorbox 'modal' Configuration set 2 which is passed to AJAX-ZOOM when "ajaxZoomOpenMode" is 'colorbox'
fancyBoxParam {} If fancybox is used in "ajaxZoomOpenMode" option, Fancybox options
colorBoxParam {} If colorbox is used in "ajaxZoomOpenMode" option, Colorbox options
embedMode false Display AJAX-ZOOM next to the thumbs
embedDivID '' ID of the container where AJAX-ZOOM player in "embedMode" should be inserted. In case "embedDivID" is a responsive container, please set "embedResponsive" to true!
embedResponsive false If "embedDivID" is responsive, you should enable this option.
embedExample 9 Configuration set 1 which is passed to AJAX-ZOOM when "embedMode" is enabled
embedZoomSwitchAnm 'SwipeHorz' When clicked on the thumbs the image inside AJAX-ZOOM will be switched with one of the following effects: "Center", "Top", "Right", "Bottom", "Left", "StretchVert", "StretchHorz", "SwipeHorz", "SwipeVert", "Vert", "Horz";
embedZoomSwitchSpeed 300 Set speed (duration) of switching, overrides following AJAX-ZOOM internal options: galleryFadeInSpeed, galleryInnerFade, gallerySlideSwipeSpeed; set to "embedZoomSwitchSpeed" to diable this overriding.
embedSwitchWithPage true If "thumbsPerPage" is activated and page numbers are present, then clicking on the page number will switch to the first shown image on that page.
embedFirstImage 1 When gallery loads first the index (number) or file name which should be loaded first. See also "firstFolder" option in case applied.
1 examples where $.azThumbGallery is used:
  • example5.php
  • example7.php
  • example8.php
  • example11.php
  • example16.php
  • example21.php
2 you will find the respective configuration set in /axZm/zoomConfigCustom.inc.php after
elseif ($_GET['example'] == [someValue])
There you can change existing options or copy from /axZm/zoomConfig.inc.php other options to change the values.

Comments (0)

Leave a Comment

Looking for a place to add a personal image? Visit www.gravatar.com to get Your own gravatar, a globally-recognized avatar. After you're all setup, your personal image will be attached every time you comment.
Load other examples in slider