fastgallery

Fast Gallery Configuration Options

Return to the Fast Gallery Documentation Index

The following XML configuration options are available to Fast Gallery in the gallery.xml file (or other XML file name, depending on your choice). To edit these options, you should use a good text editor like Textpad, and you should be extremely mindful of XML editing errors, since such errors will prevent the gallery from loading.

galleryname

This is fairly self-explanatory. It's the gallery name (title), which by default appears in Accidental Presidency font at the top of layouts 1 and 2. Please note that this option does not exist for layouts 3 - 6, since those layouts hide this text.

You may notice that I've added a few extra spaces before the final quote:

galleryname="Gallery name "

The reason for this is that the gallery name, by default, begins at the margin. Thus, adding a small amount of space indents the gallery name.

layout

Please refer to the layout documentation for information on this configuration option. This value can be 1 - 6, depending on the page layout that you want.

preferredstage, stagewidth, stageheight

Set these options to change the default stage width. For stagewidth and stageheight to be effective, you must set:

preferredstage="1"

Then, set stagewidth and stageheight to the desired dimensions, in pixels. These options are only available in Fast Gallery 2.3 or higher!

popuplink

Setting this option to "1" will allow you to open the image in a larger popup window. When the mouse is positioned over the image, the text "Click here to view larger version" will appear automatically. Setting this option to "0" will ensure that this link does not appear.

Please be aware that for the popup link to actually work, you must have the gallery loaded within a web browser, rather than as a stand-alone Flash application. In other words, use one of the .html files to test this option, rather than loading the SWF directly.

popuplinktext

This is the text for the popuplink, described above. Thus, popuplink must be set to "1" for this option to work. By default, popuplinktext is set to "Click here to view larger version".

popuplinkfont

This is the font for the popup link text. Available options are: Arial, Times, Courier, Verdana, Georgia. In the screenshot below, this has been set to Courier, i.e. -

popuplinkfont="Courier"

smoothscroll

This option is only available for layouts 3 - 6. If set to "0", then the automatic scrolling is turned off, and arrows are used to navigate the thumbnails instead. If set to "1", the thumbnails will scroll automatically when the mouse is positioned over the thumbnail bar.

In the below screenshot, smoothscroll has been changed to "0", and layout has been changed to "3".

speedsmoothness

The smoothness of the speed scrolling when "smoothscroll" is set to "1" (and a layout is used which allows smooth scrolling, like Layout 3). Possible values are all positive integers. Recommended values are between 0 - 20.

scrollwhenclose

If activated (set to "1"), then the scrolling will only occur when the user positions the mouse over the thumbnail area.

maxspeed

The maximum speed of the scrolling when smoothscroll is activated. Possible values are all positive integers. Recommended values are between 1 - 15.

picbgcolor

This is the frame color of the main image, as well as thumbnails. Technically, it's only the background color, but since the image occupies the center of the background, this option effectively changes the frame color. This must be a hexidecimal color code in 0xRRGGBB format.

In this screenshot, I've taken the same options that I had previously (smoothscroll="0" and layout="3") and then changed picbgcolor to "0xffff00" (yellow).

pnlcolor

This option changes the overall background, which is grey by default. Setting pnlcolor="0x0000ff", with layout="1", produces the following effect.

thumbloadbarcolor

This is the loading bar color for thumbnail images. At the time of writing this documentation, the thumbnails loaded too fast to create a good screenshot. :) Try changing this property to see the effect.

captionbgcolor

This is the background color of the image caption text. Setting this to "0xff0000" (red), produces this effect:

captioncolor

Text color of the image caption. Setting this to "0x00ff00" (green), produces this:

titlecolor

The color of the title text. This option is only available for layouts 1 and 2, since layouts 3 - 6 hide the title text.

pagebtncolor

The color of the left and right arrows. This option is available always when layouts 1 and 2 are used, and it is available in layouts 3 - 6 only when the "smoothscroll" option to set to "0". The image below shows the result when pagebtncolor="0xff0000"

animpagebtns

If set to "0", the left and right arrows will not animate on roll-over.

showcaption

If set to "0", the image caption will not appear at the top of the image. The caption background color bar will also disappear. To completely make the caption bar icons (zoom, print, etc.) disappear, you may also need to set "showprintbtn" and "showzoombtns" to "0".

showselected

By default, the thumbnail which is currently loaded as the main image highlights red after loading. If this option is set to "0", then the thumbnail is not highlighted in red - i.e., after clicking the thumbnail to load the image, the thumbnail returns to its normal state.

selectioncolor

This property is only available when "showselected" is set to "1". selectioncolor is the color that the thumbnail changes to after loading. The screenshot below demonstrates what selectioncolor="0x0000ff" produces.

roundrect & roundpix

These options control the "rounded-ness" of the image edges and thumbnail edges. For example, with roundrect="1" and roundpix="10", the following effect is produced. As you can see, the corners of all images are slightly curved.

showprintbtn & showzoombtns

These options control the visibility of the print and zoom icons. If showprintbtn is set to "0", then the print button disappears. If showzoombtns is set to "0", then the zoom buttons disappear.

For example, in this screenshot, showprintbtn is "0" but showzoombtns is "1". As you can see, the icons do not actually re-position themselves... this option controls only the visibility (show/hide).

zoomincrement

This is the % increment for zooming (both zoom in and zoom out). If set to 100, for example, the image will double in size when zoom in is clicked. This valud should probably remain between 5 - 30.

This option is restricted by the "maxzoom" contraint, which is described below. If you set zoomincrement to "100", for example, then maxzoom will be exceeded if zoom out is clicked even once, which would effectively prevent the user from zooming out at all. This is another reason to keep zoomincrement low.

maxzoom

The maximum possible zoom, whether in or out. If set to 4 (the default), then the image can get at most 4X larger than the original size, or 4X smaller than the original size.

loadthumbsatonce

If set to "1", then all thumbnail images will be loaded simultaneously at startup, rather than one at a time.

thumbloaddelay

The delay between loading each thumbnail, in milliseconds. This is used only if loadthumbsatonce is set to "0".

drawshadows, shadowwidth, shadowcolor, and shadowalpha

As you can probably tell, these options control the size, color, and transparency of the shadows. The best thing to do is just play with these and re-load the SWF to see the effect. drawshadows can be "1" or "0" (on/off), whereas shadowwidth can assume any positive integer. shadowcolor must be a hexidecimal color value, and shadowalpha should be an integer value between 0 and 100.

The screenshot below shows what the gallery looks like with a very large shadowwidth value of 10, and the color set to navy blue (0x000099), and the shadow transparency set to 90 (not very transparent). In other words, these values:

drawshadows="1"
shadowwidth="10"
shadowcolor="0x000090"
shadowalpha="90"

drawbgshadows

There is an additional level of shadowing around the gallery edge that can be enabled with this option. In the screenshot below, drawbgshadows is set to "1", and shadowcolor is "0x0000ff"

imageamount

This sets the maximum number of thumbnails to show when using a single-column thumbnail layout. For example, when imageamount is set to "3" with layout 4 (smooth scrolling turned off), the result looks something like this:

imgtransition

This option is not currently used. It is in development for the next version of Fast Gallery.

autoresize

If set to "0", then the image will assume a size that matches its true aspect ratio. This will allow you to view the full image in the available layout, but it may cause the viewable area to shrink to fit the aspect ratio of the image, as shown below.

thumbresize

If a thumbnail does not match the basic 70x70, then it will be resized to fit, if this option is enabled.

slideshow and slideshowdelay

FastGallery has a "slideshow" mode by which the images will automatically loop to display all images in your gallery in order. Set slideshow="1", then reload your gallery to see this in action. slideshowdelay is the number of seconds between transitions. Obviously, that parameter only has an effect if slideshow="1".

halign and valign

The horizontal and vertical alignment of the main image. Options for halign include "left", "center", and "right". Options for valign include "top", "middle", and "bottom".

Here's the gallery with a small image loaded, but with halign="center", and valign="middle", so that the image is centered vertically and horizontally within the available space.

hmargin

This value will be used when halign is set to either left or right. The gallery will apply this extra margin to whichever side has been set. For instance, an hmargin="150" and halign="left" would force images to be left-aligned, with an extra 150px margin from the border or the thumbnails, whichever is on the left in the chosen layout.

thumbpadding1

The padding on one side of the thumbnail list when layouts 3 - 6 are used. Change this value and observe the effect to determine which side this affects.

thumbpadding2

The padding on the other side of the thumbnail list when layouts 3 - 6 are used. Change this value and observe the effect to determine which side this affects.

caption_orientation

This changes the position of the caption, and the caption background to either above the image, below the image, at the bottom but floating above the image, or at the top but floating above the image. Possible values are:

top / bottom / top-float / bottom-float

Here's what they look like in a couple of different layouts:

caption_orientation="bottom-float" (with layout 1):

caption_orientation="top" (with layout 3):