1. The following table describes the attributes that the <settings> element contains:
| Node name |
Possible values |
Default value |
Description |
| General properties |
| galleryWidth |
≥0 |
820 |
The width of the gallery, in pixels. |
| galleryHeight |
≥0 |
470 |
The height of the gallery, in pixels. |
| galleryBgColor |
|
undefined |
The background color of the gallery. |
| galleryBackground |
|
undefined |
The background image of the gallery. |
| galleryCornerRadius |
≥0 |
0 |
The corner radius for the gallery area, in pixels. |
| autoPlay |
true, false |
false |
Specifies whether the gallery should start rotating images automatically (true) or not (false). |
| delayTime |
≥0 |
5 |
Amount of delay between images, in seconds. |
| randomImages |
true, false |
false |
Determines whether to display images in sequential (false) or random (true) order. |
| pauseOnMouseOver |
true, false |
false |
Specifies whether the gallery should pause rotating images when the mouse is over the gallery area (true) or not (false). |
| repeatMode |
true, false |
true |
Defines the gallery's behavior when it reaches the last image in the category. |
| startCategoryIndex |
≥0 |
0 |
The index of the category to be displayed first in the sequence when the XML file is loaded. This is a zero-based index, so 0 is the first category. |
| frostedGlassEffectBlurAmount |
0-255 |
32 |
The amount of blur used for creating "Frosted Glass" effect. |
| Transitions properties |
| transitionType |
1, 2 |
1 |
The type of transition to be applied when changing images: 1 — "Fade", 2 — "Move". |
| transitionOrientation |
horizontal, vertical |
horizontal |
The geometric orientation of a transition (for "Move" effect only). |
| transitionDuration |
0-3 |
0.6 |
The length of time that a transition takes, in seconds. |
| Category area properties |
| showCategoryArea |
true, false |
true |
Determines if the category area is visible. |
| categoryAreaHPosition |
left, center, right |
left |
The horizontal position of the category area. |
| categoryAreaVPosition |
top, center, bottom |
top |
The vertical position of the category area. |
| categoryAreaOrientation |
horizontal, vertical |
horizontal |
The geometric orientation of the category area. |
| categoryAreaXOffset |
≥0 |
0 |
The X offset of the category area from the left or right edge of the gallery (depending on the value of categoryAreaHPosition), in pixels. |
| categoryAreaYOffset |
≥0 |
0 |
The Y offset of the category area from the top or bottom edge of the gallery (depending on the value of categoryAreaVPosition), in pixels. |
| categoryAreaLength |
≥0 or undefined |
undefined |
The width or height of the category area (depending on the value of categoryAreaOrientation). Leave this parameter blank if you want the category area length to be set automatically. |
| categoryAreaAutoHide |
true, false |
false |
Determines whether to show (hide) the category area automatically when the mouse is over (out of) the gallery. |
| categoryWidth |
≥0 |
undefined |
The width of the category item, in pixels. |
| categoryHeight |
≥0 |
undefined |
The height of the category item, in pixels. |
| categorySpacing |
≥0 |
0 |
The spacing between category items, in pixels. |
| categoryTextMargin |
≥0 |
10 |
The left and right margins of the text of a category item, in pixels. |
| categoryTextAlignment |
left, center, right |
left |
The text alignment for the text of a category item. |
| categoryFontSize |
≥1 |
11 |
The point size for the font of the category text. |
| categoryEmbedFonts |
true, false |
false |
Indicates whether the font of the category text is an embedded font (true) or normal (false). |
| categoryFontColor |
|
000000 |
The text color of a category item. |
| categoryOverFontColor |
|
undefined |
The color of text when the pointer rolls over a category item. |
| categorySelectedFontColor |
|
undefined |
The text color of the selected category item. |
| categoryBgColor |
|
undefined |
The background color of a category item. |
| categoryOverBgColor |
|
undefined |
The background color of a rolled-over category item. |
| categorySelectedBgColor |
|
undefined |
The background color of a selected category item. |
| categoryBgAlpha |
0-100 |
0 |
The background transparency of a category item. |
| categoryOverBgAlpha |
0-100 |
0 |
The background transparency of a rolled-over category item. |
| categorySelectedBgAlpha |
0-100 |
0 |
The background transparency of a selected category item. |
| categoryRollAnimationDuration |
0-0.3 |
0.1 |
The length of time that the animation takes when the pointer rolls over a category item, in seconds. |
| categoryAreaCornerRadius |
≥0 |
0 |
The corner radius for the background of the category area, in pixels. |
| categoryAreaBgColor |
|
undefined |
The background color of the category area. |
| categoryAreaBgAlpha |
0-100 |
undefined |
The background transparency of the category area. |
| categoryAreaBgFrostedGlass |
true, false |
false |
Determines whether to apply the "Frosted Glass" effect to the background of the category area (true) or not (false). |
| categoryAreaBorder |
top, bottom, left, right |
undefined |
Specifies which side of the outer border of the category area is displayed. |
| categoryAreaBorderColor |
|
undefined |
The color of the border of the category area. |
| categoryAreaBorderAlpha |
0-100 |
undefined |
The alpha transparency of the border of the category area. |
| categoryAreaBorderThickness |
≥0 |
1 |
The thickness of the border of the category area, in pixels. |
| categoryAreaPaddingLeftRight |
≥0 |
0 |
The spacing between the left edge of the category area and category items, and between the right edge of the category area and category items, in pixels. |
| categoryAreaPaddingTopBottom |
≥0 |
0 |
The spacing between the top edge of the category area and category items, and between the bottom edge of the category area and category items, in pixels. |
| Image area properties |
| imageAreaWidth |
≥0 |
undefined |
The width of the image area, in pixels. Leave this parameter blank if you want the width of the image area to be equal to the width of the gallery. |
| imageAreaHeight |
≥0 |
undefined |
The height of the image area, in pixels. Leave this parameter blank if you want the height of the image area to be equal to the height of the gallery. |
| imageAreaCornerRadius |
≥0 |
undefined |
The corner radius for the image area, in pixels. |
| imageAreaXPosition |
≥0 |
0 |
The X position of the image area relative to the left edge of the gallery. |
| imageAreaYPosition |
≥0 |
0 |
The Y position of the image area relative to the top edge of the gallery. |
| imageFitting |
fitWidth, fitHeight, fitAll, fitToArea, none |
none |
Specifies which option to use for fitting the image:
- "fitWidth" — zooms in or out so that the entire image width fits in the image area;
- "fitHeight" — zooms in or out so that the entire image height fits in the image area;
- "fitAll" — zooms in or out so that the entire image fits in the image area;
- "fitToArea" — zooms in or out so that the image area to be
filled entirely with the maximum amount of image space;
- "none" — no zooming applied to the image. |
| imageCentering |
true, false |
false |
Determines whether to center the image both horizontally and vertically on the image area (true) or not (false). |
| transparentImages |
true, false |
false |
Determines whether to use specific (true) or ordinary (false) mechanism for transitions. The specific one is needed if transparent images (PNG, GIF) are used. |
| Thumbnail bar properties |
| showThumbnailBar |
true, false |
true |
Determines if the thumbnail bar is visible. |
| thumbnailBarHPosition |
left, center, right |
right |
The horizontal position of the thumbnail bar. |
| thumbnailBarVPosition |
top, center, bottom |
bottom |
The vertical position of the thumbnail bar. |
| thumbnailBarOrientation |
horizontal, vertical |
horizontal |
The geometric orientation of the thumbnail bar. |
| thumbnailBarXOffset |
≥0 |
10 |
The X offset of the thumbnail bar from the left or right edge of the gallery (depending on the value of thumbnailBarHPosition), in pixels. |
| thumbnailBarYOffset |
≥0 |
10 |
The Y offset of the thumbnail bar from the top or bottom edge of the gallery (depending on the value of thumbnailBarVPosition), in pixels. |
| thumbnailBarLength |
≥0 or undefined |
undefined |
The width or height of the thumbnail bar background (depending on the value of thumbnailBarOrientation). Leave this parameter blank if you want the thumbnail bar length to be set automatically. |
| thumbnailBarAutoHide |
true, false |
false |
Determines whether to show (hide) the thumbnail bar automatically when the mouse is over (out of) the gallery. |
| thumbnailsShadow |
true, false |
true |
Determines whether to draw shadows for thumbnails (true) or not (false). |
| thumbnailsShadowColor |
|
000000 |
The color of the shadow of a thumbnail. |
| thumbnailsShadowAlpha |
0-100 |
50 |
The alpha transparency of the shadow of a thumbnail. |
| thumbnailsAnimationAtStart |
true, false |
false |
Determines whether to apply the animation effect to thumbnails each time after selecting a new category (true) or not (false). |
| Thumbnail bar background properties |
| showThumbnailBarBackground |
true, false |
true |
Determines whether to show the background of the thumbnail bar (true) or not (false). |
| thumbnailBarBgColor |
|
FFFFFF |
The color of the thumbnail bar background. |
| thumbnailBarBgAlpha |
0-100 |
50 |
The alpha transparency of the thumbnail bar background. |
| thumbnailBarBgFrostedGlass |
true, false |
false |
Determines whether to apply the "Frosted Glass" effect to the background of the thumbnail bar (true) or not (false). |
| thumbnailBarBorder |
top, bottom, left, right |
undefined |
Specifies which side of the outer border of the thumbnail bar is displayed. |
| thumbnailBarBorderColor |
|
undefined |
The color of the border of the thumbnail bar. |
| thumbnailBarBorderAlpha |
0-100 |
undefined |
The alpha transparency of the border of the thumbnail bar. |
| thumbnailBarBorderThickness |
≥0 |
1 |
The thickness of the border of the thumbnail bar, in pixels. |
| thumbnailBarPadding |
≥0 |
10 |
The spacing between the edges of the thumbnail bar background and the thumbnail scroll bar, in pixels. |
| thumbnailBarAlignment |
TL, BR, C |
TL |
The alignment of the thumbnail scroll bar relative to the edges of the thumbnail bar area:
- "TL" — top or left (depending on the value of thumbnailBarOrientation);
- "C" — center;
- "BR" — bottom or right (depending on the value of thumbnailBarOrientation). |
| thumbnailBarCornerRadius |
≥0 |
0 |
The corner radius for the background of the thumbnail bar, in pixels. |
| Thumbnails scrolling properties |
| thumbnailsVisibleAreaLength |
>0 or undefined |
undefined |
The maximum length of the thumbnail bar that can be shown at a time, in pixels. If the length of the thumbnail bar exceeds the value of thumbnailsVisibleAreaLength then thumbnails scrolling is turned on. Leave this parameter blank if you want all thumbnails to be shown. |
| thumbnailsScrollingType |
dynamic, static |
dynamic |
Defines the conditions at which thumbnails start scrolling: on hovering the mouse over the thumbnail bar and moving it to and fro (dynamic), or on clicking the arrow buttons (static). |
| scrollingArrowSize |
≥2 |
8 |
The size of the arrow button, in pixels. The arrow buttons are displayed if thumbnailsScrollingType is set to "static". |
| scrollingArrowThickness |
≥1 |
4 |
The line thickness of the arrow, in pixels. |
| scrollingArrowStyle |
round, square |
round |
The line style of the arrow. |
| scrollingArrowColor |
|
666666 |
The color of the arrow button. |
| scrollingArrowOverColor |
|
FF9900 |
The color of the arrow button when the mouse rolls over it. |
| scrollingArrowDisabledColor |
|
999999 |
The color of the arrow button when it is disabled. |
| scrollingArrowAlpha |
0-100 |
70 |
The alpha transparency of the arrow button. |
| scrollingStep |
≥0 |
60 |
The distance (in pixels) at which the thumbnails scroll forward or backward each time the user clicks the arrow buttons. |
| Thumbnail properties |
| thumbnailWidth |
≥0 |
60 |
The width of the thumbnail, in pixels. |
| thumbnailHeight |
≥0 |
40 |
The height of the thumbnail, in pixels. |
| thumbnailSpacing |
≥0 |
0 |
The spacing between thumbnails, in pixels. |
| thumbnailBgColor |
|
undefined |
The background color of the thumbnail. |
| thumbnailBgAlpha |
0-100 |
undefined |
The background transparency of the thumbnail. |
| thumbnailOverBorderColor |
|
undefined |
The color of the thumbnail border when the mouse rolls over the thumbnail. |
| thumbnailOverBorderThickness |
0-30 |
1 |
The thickness of the thumbnail border when the mouse rolls over the thumbnail. |
| thumbnailSelectedBorderColor |
|
FF9900 |
The thickness of the thumbnail border when it is selected. |
| thumbnailFitting |
fitAll, fitToArea, none |
fitToArea |
Specifies which option to use for fitting the thumbnail image:
- "fitAll" — zooms in or out so that the entire thumbnail image fits in the thumbnail area;
- "fitToArea" — zooms in or out so that the thumbnail area to be
filled entirely with the maximum amount of thumbnail image space;
- "none" — no zooming applied to the thumbnail image. |
| thumbnailRollAnimationSpeed |
1, 2, 3, 4 |
2 |
The conventional values of animation speed when the mouse rolls over the thumbnail: "1" is the slowest, "4" is the fastest. |
| Navigation Pointer properties |
| showNavigationPointer |
true, false |
true |
Determines whether to show the navigation pointer (true) or not (false). The navigation pointer is a mouse-event sensitive arrow to navigate to the next or previous image in the gallery. |
| navigationPointerAreaOffset |
|
0,0,0,0 |
The top, right, bottom and left offsets of the area inside the gallery area where the navigation pointer is enabled, in pixels. |
| Controls properties |
| showControls |
true, false |
false |
Determines if the controls are visible. |
| controlsHPosition |
left, center, right |
right |
The horizontal position of the controls area. |
| controlsVPosition |
top, center, bottom |
bottom |
The vertical position of the controls area. |
| controlsXOffset |
≥0 |
10 |
The X offset of the controls area from the left or right edge of the gallery (depending on the value of controlsHPosition), in pixels. |
| controlsYOffset |
≥0 |
10 |
The Y offset of the controls area from the top or bottom edge of the gallery (depending on the value of controlsVPosition), in pixels. |
| controlsAutoHide |
true, false |
false |
Determines whether to show (hide) the controls automatically when the mouse is over (out of) the gallery. |
| showNavigationArrows |
true, false |
true |
Determines whether to show the navigation arrows (true) or not (false). |
| navigationArrowSize |
≥2 |
8 |
The size of the arrow button, in pixels. |
| navigationArrowThickness |
≥1 |
2 |
The line thickness of the arrow, in pixels. |
| navigationArrowColor |
|
666666 |
The color of the arrow button. |
| navigationArrowOverColor |
|
FF9900 |
The color of the arrow button when the mouse rolls over it. |
| navigationArrowAlpha |
0-100 |
100 |
The alpha transparency of the arrow button. |
| arrowRollAnimationDuration |
0-0.3 |
0.1 |
The length of time that the animation takes when the pointer rolls over a navigation arrow button, in seconds. |
| showImagesCounter |
true, false |
true |
Determines whether to show the images counter (true) or not (false). |
| imagesCounterFontSize |
≥1 |
11 |
The point size for the font of the images counter. |
| imagesCounterColor |
|
000000 |
The text color of the images counter. |
| imagesCounterFirstNumberColor |
|
undefined |
The color of the first number of the images counter. |
| imagesCounterFontWeight |
normal, bold |
normal |
Specifies whether the text of the images counter is boldface or normal. |
| imagesCounterEmbedFonts |
true, false |
false |
Indicates whether the font of the images counter is an embedded font (true) or normal (false). |
| controlsAreaWidth |
≥0 |
undefined |
The width of the controls area, in pixels. Leave this parameter blank if you want the controls area width to be resized automatically. |
| controlsAreaHeight |
≥0 |
undefined |
The height of the controls area, in pixels. Leave this parameter blank if you want the controls area height to be resized automatically. |
| controlsAreaCornerRadius |
≥0 |
0 |
The corner radius for the background of the controls area, in pixels. |
| controlsAreaBgColor |
|
undefined |
The background color of the controls area. |
| controlsAreaBgAlpha |
0-100 |
undefined |
The background transparency of the controls area. |
| controlsAreaBgFrostedGlass |
true, false |
false |
Determines whether to apply the "Frosted Glass" effect to the background of the controls area (true) or not (false). |
| Description properties |
| showDescription |
true, false |
true |
Determines if the description area is visible. |
| descriptionHPosition |
left, center, right |
left |
The horizontal position of the description area. |
| descriptionVPosition |
top, center, bottom |
top |
The vertical position of the description area. |
| descriptionAreaWidth |
≥0 |
The width of the gallery |
The width of the description area, in pixels. |
| descriptionAreaHeight |
≥0 or undefined |
undefined |
The height of the description area, in pixels. Leave this parameter blank if you want the description area height to be resized automatically. |
| descriptionAreaXOffset |
≥0 |
10 |
The X offset of the description area from the left or right edge of the gallery (depending on the value of descriptionHPosition), in pixels. |
| descriptionAreaYOffset |
≥0 |
10 |
The Y offset of the description area from the top or bottom edge of the gallery (depending on the value of descriptionVPosition), in pixels. |
| descriptionAreaCornerRadius |
0-100 |
0 |
The corner radius for the background of the description area, in pixels. |
| descriptionAreaAutoHide |
true, false |
false |
Determines whether to show (hide) the description automatically when the mouse is over (out of) the gallery. |
| descriptionTransitionDuration |
0-1 |
0.3 |
The length of time that the description text transition takes, in seconds. |
| descriptionTextSliding |
true, false |
false |
Determines whether to apply a sliding effect to the description text (true) or not (false). |
| descriptionTextSlidingDirection |
left, right |
left |
The direction of the sliding motion applied to the description text. |
| descriptionTextBlindEffect |
true, false |
false |
Determines whether to apply the blind effect to the description text (true) or not (false).
Note: You can not mix using the "blind" effect together with the "sliding" effect or "blur animation". |
| descriptionTextBlurAnimation |
true, false |
false |
Determines whether to apply the blur animation to the description text (true) or not (false). |
| descriptionFontSize |
≥1 |
11 |
The point size for the font of the description text. |
| descriptionFontColor |
|
000000 |
The color of the description text. |
| descriptionEmbedFonts |
true, false |
false |
Indicates whether the font of the description text is an embedded font (true) or normal (false). |
| descriptionTextAlignment |
left, center, right, justify |
left |
The text alignment for the description text. |
| descriptionTextLineSpacing |
-36...72 |
0 |
The line spacing for the description text, in points. |
| descriptionTextLetterSpacing |
-60...60 |
0 |
The letter spacing for the description text, in points. |
| descriptionTextMarginLeft |
≥0 |
0 |
The left margin of the description text, relative to the left edge of the description area, in pixels. |
| descriptionTextMarginRight |
≥0 |
0 |
The right margin of the description text, relative to the right edge of the description area, in pixels. |
| descriptionTextMarginTop |
≥0 |
0 |
The top margin of the description text, relative to the top edge of the description area, in pixels. |
| descriptionTextMarginBottom |
≥0 |
0 |
The bottom margin of the description text, relative to the bottom edge of the description area, in pixels. |
| descriptionTextCssUrl |
|
undefined |
The URL of a CSS file to load. If this parameter is set (the value is not blank), the gallery attempts to load the specified CSS file. If the file is loaded successfully, the CSS rules are applied to the description text. |
| descriptionTextScrolling |
true, false |
false |
Determines whether to scroll the description text when the mouse wheel is rolled. |
| descriptionAreaBgColor |
|
undefined |
The background color of the description area. |
| descriptionAreaBgAlpha |
0-100 |
undefined |
The background transparency of the description area. |
| descriptionAreaBgFrostedGlass |
true, false |
false |
Determines whether to apply the "Frosted Glass" effect to the background of the description area (true) or not (false).
Note: When applying the "Frosted Glass" effect to the description area background, it is recommended:
- to set descriptionAreaHeight to some fixed value;
- to set descriptionAreaBgFixed to "true";
- not to use slides with a blank description. |
| descriptionAreaBgFixed |
true, false |
false |
Determines whether the background of the description area fades in/out (false) or stays fixed (true) for the duration of the text transition effect. |
| descriptionAreaBorder |
top, bottom, left, right |
undefined |
Specifies which sides of the outer border of the description area are displayed. Multiple values should be separated by commas, without blank space after commas. |
| descriptionAreaBorderColor |
|
undefined |
The color of the border of the description area. |
| descriptionAreaBorderAlpha |
0-100 |
undefined |
The alpha transparency of the border of the description area. |
| descriptionAreaBorderThickness |
≥0 |
1 |
The thickness of the border of the description area, in pixels. |
| Preloader properties |
| showImagePreloader |
true, false |
true |
Determines whether to show the image preloader (true) or not (false). |
| imagePreloaderColor |
|
FFFFFF |
The color of the image preloader. |
| showThumbnailPreloader |
true, false |
true |
Determines whether to show the thumbnail preloader (true) or not (false). |
| thumbnailPreloaderColor |
|
FFFFFF |
The color of the thumbnail preloader. |
2. The <categories> element can contain an unlimited number of <category> nodes. Each <category> node represents a category object and should have one required attribute label.
3. The <category> element can contain one <category_text> node and an unlimited number of <image> nodes.