“Ultimate Grid Pro ” Documentation by FWDesign


“Ultimate Grid Pro”

Version: 4.0
By:© FWD (Future Web Design)
Email: contact@webdesign-flash.ro

Thank you for purchasing our script. If you have any questions that are beyond the scope of this help file, please feel free to email via our email. Thanks so much!


Table of Contents

  1. IMPORTANT NOTES - read this before anything else
  2. Preparing thumbnails and images
  3. Ultimate Grid Pro installation
  4. Constructor parameters
  5. Setup galleries
  6. Setup Facebook share button
  7. API specifications
  8. Sources and Credits

A) IMPORTANT NOTES - make sure you read this! - top

Please note that the UGP installation and configuration is not complicated but because it has a lot of customizable settings it might seem complicated, please go through the entire documentation before trying to install it into your own page. Basically what it must be done is to copy some html and js code from the examples we provided and paste it into your own html page and of course add your own content.

The server is character case sensitive so make sure that the UGP settings are identical to those from the provided examples.

B) Preparing thumbnails and images! - top

To have the best possible visual grid and use your own custom size images they should be saved as follow, first set the thumbnailMaxWidth and thumbnailMaxHeight parameters to your desired thumbnails size, than save your image to this two values, this way you will have a sharp grid and it will load fast and perform well on all devices.

C) Ultimate Grid Pro installation - top

In the download files there is a start folder and in this folder there are example html files for each display type. You can use one of them to copy and paste the required html and js code based on the skin and display type that you need. In this tutorial we have used the in.html file.

This is how UGP is installed in a HTML page, please read the Constructor parameters section, it will explain all settings in details.

D) Constructor parameters - top

Please open in.html with a text editor as reference. These parameters represents the possible setting of UGP, they are all described below.

		

MAIN SETTINGS.

CAPTION

GALLERIES MENU SETTING.

GRID THUMBNAILS SETTINGS.

THUMBNAILS VIDEO.

LIGHTBOX SETTINGS.

E) Setup galleries - top

Please open with a text editor the in.html file as reference.

In this section is explained how to setup a gallery with two categories. Below is a representation of a gallery with four categories. You can add as manny categories as you want and a thumbnail an be part of one, more or all categories.

As it can be seen the gallery is created using ul and li HTML elements with some custom attributes, what is important to note is that the gallery must have an unique id, this id is required by UGP and it must be set to the galleryId property like this galleryId:"myGallery".

All thumbnails images that will be loaded in the grid MUST have the same width and height so please make sure that you save your images properly!

	

Add thumbnail:

To add a simple thumbnail please check the markup below, the data-thumb-src is required, it is the image that is loaded in the grid.

The data-thumb-caption is optional and represents the thumbnail caption.

There is an useful attribute explained below.

		
    • Thumbnails video and audio

    Lightbox Image Support

    Lightbox Image Support (.jpg, .jpeg, .png, .bmp,.webp, .gif, .tif, .tiff, .jfi, .jfif, .exif, .svg).

  • Add thumbnail with custom link:

    To add a thumbnail when clicked to open a new page please check the markup below, the data-thumb-src is required, it is the image that is loaded in the grid.

    The data-thumb-caption is optional and represents the thumbnail caption.

    Attributes below.

    		
    • Open new page

    Link Click Support

    Open a custom page with in the same or a different tab..

  • Add thumbnail with video or audio:

    To add a thumbnail please check the markup below, the data-thumb-src is required, it is the image that is loaded in the grid.

    To add a video (.mp4) or audio(.mp3) to play inside the thumbnail use the The data-thumb-video-src.

    There are other attributes that can be added to add extra functionality to the video/audio thumbnail explained below.

    The data-thumb-caption is optional and represents the thumbnail caption.

    
    		
    • Thumbnails video and audio

    Thumbnail audio support

    Thumbmail audio support, self hosted or external hosted .mp4.

  • Add Lightbox image:

    To add a lightbox image please check the markup below, the data-rl-src is required, it is the lightbox source, in this case an image (.jpg, .jpeg, .png).

    The data-thumb-caption is optional and represents the thumbnail caption.

    The data-rl-caption is optional and represents the lightbox caption.

    		
    		

    Add Lightbox video or audio:

    To add a lightbox video or audio please check the markup below, the data-rl-src is required, it is the lightbox source, in this case the video or audio src, supported formats are:

    The data-thumb-caption is optional and represents the thumbnail caption.

    The data-rl-caption is optional and represents the lightbox caption.

    		
    • Lightbox multimedia

    Lightbox Cloud Storage

    Google Drive, Dropbox, and pretty much all cloud storage platforms, Easy Video Player.

    Google Drive And Other Cloud Storage

    Google Drive, Dropbox, and pretty much all cloud storage platforms, Easy Video Player.

  • Add 360 degree video and VR:

    To add a 360 degree video add the data-is-360="" attribute, please note that only .mp4 videos work and HLS if the CORS allows it. To show the VR button set the rlShow360DegreeVideoVrButton:"yes".

    		
    		

    Add VAST or Google IMA SDK:

    To add a VAST or Google IMA SDK file as advertisement use the data-rl-vast-src and pass the URL as the source, ex: data-rl-vast-src="//googleads.g.doubleclick.net/pagead/ads?ad_type=video&client=ca-video-pub-4968145218643279&videoad_start_delay=0&description_url=http%3A%2F%2Fwww.google.com&max_ad_duration=40000&adtest=on".

    Add video/audio poster:

    To add a poster use the data-rl-poster-src and pass the URL as the source, ex: data-rl-poster-src="media/images/adsense.jpg".

    Add video thumbnails preview:

    For .mp4 files if you want a small thumbnails preview use the data-rl-preview-src and pass the URL as the source, ex: data-rl-preview-src="auto".

    G) API specifications - top

    Inside the start file there is HTML file called API-example.html, open it with a text editor as reference. Below is a table with all API events and methods.

    Methods:

    Name Method Description

    updateCategory

    updateCategory(categoryId:int):void Update the category based on id, the counting starts from zero 0

    Event listeners:

    Event Prefix Description
    ready FWDUGP.READY Dispatched when UGP API is ready to be used.
    categoryUpdate FWDUGP.CATEGORY_UPDATE Dispatched when UGP a category is changed.
    thumbVideoStart FWDUGP.THUMB_VIDEO_START Dispatched when the thumbnail video has started.
    thumbVideoPlay FWDUGP.THUMB_VIDEO_PLAY Dispatched when the thumbnail video playes.
    thumbVideoPause FWDUGP.THUMB_VIDEO_PAUSE Dispatched when the thumbnail video is paused.
    thumbVideoPlayComplete FWDUGP.THUMB_VIDEO_PLAY_COMPLETE Dispatched when the thumbnail video has finished playing.
    goFullScreen FWDUGP.GO_FULLSCREEN Dispatched when the thumbnail video is going fullscreen.
    goNormalScreen FWDUGP.GO_NORMALSCREEN Dispatched when the thumbnail video is going normalscreen.
    error FWDUGP.ERROR Dispatched when an error occurs, it has a parameter named error which returns the error text.
    showStart FWDUGP.LIGHTBOX_SHOW_START Dispatched when UGP lightbox starts to show.
    showComplete FWDUGP.LIGHTBOX_SHOW_COMPLETE Dispatched when UGP show animation is complete.
    hideStart FWDUGP.LIGHTBOX_HIDE_START Dispatched when UGP lightbox starts to hide.
    hideComplete FWDUGP.LIGHTBOX_HIDE_COMPLETE Dispatched when UGP hide animation is complete.
    startToUpdateItem FWDUGP.START_TO_UPDATE_ITEM Event dispatched when the lightbox item has changed and it is first showed before any settings or visual are initalized, it has a parameter that contains info about the current lightbox item.

    H) Sources and Credits - top

    This plugin was made by Tibi from FWD (FWDesign) Future Web Design, for more information and support contact us at contact@webdesign-flash.ro

    Once again, thank you so much for purchasing this item. As I said at the beginning, I'd be glad to help you if you have any questions regarding this Ultimate Grid Pro and I'll do my best to assist.

    FWDesign

    Go To Table of Contents