ImageGallery is used to display images. Images can also be added and removed as well.
| Description |
| Type | Description | |
| descriptionPaneWidth | String | Number |
Width of description pane. |
| enableDescriptionPane | Boolean |
Enable description pane. |
| enableFullScreen | Boolean |
Enable full screen mode. |
| enableThumbnails | Boolean |
Enable thumbnails pane. |
| fullScreen | Boolean |
Specify whether ImageGallery is currently in full screen mode or not (normal mode). |
| imageList | Object[] |
Array of JSON image object. JSON image object must have "url" attribute, which point to the image, and primary key attribute, which have unique value. |
| imagePrimaryKey | String |
Specify attribute name of JSON image object which acts as a key. |
| showDescriptionPane | Boolean |
Show description pane |
| showThumbnails | Boolean |
Show thumbnails pane. |
| thumbnailImageRatio | String |
Width:height ratio of thumbnail image. String must be in form of "width:height". |
| thumbnailsHeight | String | Number |
Height of thumbnails pane. |
| thumbnailsURLSuffix | String |
String which will append to the end of each image url to specify corresponding thumbnail image url. |
| Return type | Description | |
| addImage(imgJSON) | None |
Append new image into the gallery. JSON image object must have "url" attribute, which points to the image, and primary key attribute, which have unique value. |
| clearAllImages() | None |
Clear all images in the gallery. |
| clearDisplayImage() | None |
Clear currently displayed image from main image pane. This method does not remove image from the gallery. |
| displayImage(primaryKey) | None |
Display image in main image pane. |
| getDisplayImage() | Object |
Get currently displayed image in the gallery. |
| removeImage(primaryKey) | None |
Remove an image from the gallery. |
| Description | ||
| exit-full-screen |
Fires when the gallery leaves full screen mode. |
|
| full-image-click |
Fires when user click on main image pane. |
|
| full-screen |
Fires when the gallery goes into full screen mode. |
|
| image-display |
Fires when image is displayed on main image pane. |
|
| next-image-button-click |
Fires when user click on next image button. |
|
| previous-image-button-click |
Fires when user click on previous image button. |
|
| thumbnail-image-click |
Fires when user click on thumbnail image. |
Specify whether ImageGallery is currently in full screen mode or not (normal mode).
Array of JSON image object. JSON image object must have "url" attribute, which point to the image, and primary key attribute, which have unique value.
Width:height ratio of thumbnail image. String must be in form of "width:height".
String which will append to the end of each image url to specify corresponding thumbnail image url.
Append new image into the gallery. JSON image object must have "url" attribute, which points to the image, and primary key attribute, which have unique value.
<Object>
imgJSON
|
Required |
JSON Image Object. |
Clear all images in the gallery.
Clear currently displayed image from main image pane. This method does not remove image from the gallery.
Display image in main image pane.
<String>
primaryKey
|
Required |
Primary key of image you want to display. |
Remove an image from the gallery.
<String>
primaryKey
|
Required |
Primary key of image to be deleted. |
Fires when the gallery leaves full screen mode.
Fires when user click on main image pane.
<Object>
image
|
Image JSON Object. |
Fires when the gallery goes into full screen mode.
Fires when image is displayed on main image pane.
<Object>
image
|
Image JSON object |
Fires when user click on thumbnail image.
<Object>
image
|
Image JSON object. |