SimpleViewer-Pro 1.9 ActionScript Options
This document applies to SimpleViewer-Pro version 1.9. SimpleViewer-Pro has been upgraded to version 2.3.0. View upgrade information.
The following is a list of the ActionScript Options that can set for SimpleViewer-Pro. For instructions on how to do this, check here.
General
| Option Name | Default Value | Description |
| fixedLayout | false | Whether to used fixed layout of stage elements, or dynamic resizing based on browser window size |
| preloadImages | true | Whether to automatically preload all images. |
| useSmoothing | true | Whether to smooth resized images. Setting this to 'true' improves image quality but uses more CPU resources. If you have a large gallery that is running slowly, setting this to false may help. |
| enableMouseWheel | true | Whether to accept mouse wheel input to navigate images. |
| enableLooping | false | Whether navigating beyond last image goes back to first image. |
| soundPath | null | Relative or absolute path to an MP3 file to load as gallery music (e.g. "sounds/music.mp3"). Relative paths are relative to the HTML document that contains SimpleViewer. Loaded MP3 will start playing as it is downloading. MP3 will loop forever. |
Main Image
| Option Name | Default Value | Description |
| enableImageDownScaling | true | Whether images are resized smaller to fit stage (not used if fixedLayout == true) |
| enableImageButtons | true | Whether to use image navigation buttons (arrow buttons that overlay the main image) |
| hideImageButtonsOnRollOut | true | Whether to hide the image navigation buttons when the mouse is not rolled over them |
| imageFadeLength | 5 | Image fade tween length (frames) |
| imageVAlign |
"center" | Vertical placment of the image within the square image area. Can be "center", "top" or "bottom". |
| imageHAlign | "center" | Horizontal placement of the image within the square image area. Can be "center", "left" or "right". |
Thumbnails
| Option Name | Default Value | Description |
| thumbnailWidth | 65 | Width of thumbnail images (pixels) |
| thumbnailHeight | 65 | Height of thumbnail images (pixels) |
| thumbnailPadding | 14 | Space between thumbs (pixels) |
| showThumbnailVisited | true | Whether to show visited dogear icon |
| showThumbnailLoadBar | true | Whether to show load bar on image load |
| thumbnailFrameWidth | 2 | Width of thumbnail frame (pixels) |
| thumbnailRollOverFrameWidth | 5 | Width of thumbnail frame when mouse is over thumb (pixels) |
| thumbnailSelectedFrameOffset | 3 | Distance that thumb frame is offset when thumb is selected (pixels) |
| thumbnailLoadBarHeight | 10 | heigth of thumbnail load bar (pixels) |
| thumbnailClickShift | 2 | Distance thumbnail moves on click (pixels) |
| thumbnailLoadingAlpha | 60 | Alpha of thumbnail while image loads (percent) |
| thumbnailMotionLength | 20 | Thumb paging slide animation tween time (frames) |
Captions
| Option Name | Default Value | Description |
| showCaptions | true | Whether to show Image Captions |
| showTitle | true | Whether to show gallery title |
| showCaptionOnRollover | false | Whether to display the image caption on thumbnail rollover. |
| captionUnderThumbs | true | Whether to show the captions under the thumbnails (true) or the main image (false). |
| captionFontSize | 13 | Caption font size |
| titleFontSize | 16 | Title font size |
| captionPadding | 14 | Space between image and caption. Used if 'captionUnderThumbs' is false. (pixels) |
AutoPlay
| Option Name | Default Value | Description |
| enablePlayButton | false | Whether to show play button for autoplay mode. |
| playAtStart | false | Whether to automatically start playing when gallery is loaded. |
| displayTime | 5 | Number of seconds each image will display in autoplay mode. |
Back Button
| Option Name | Default Value | Description |
| showBackButton | false | Whether to show optional back button. |
| backButtonText | <b>< <u>Back</b></u>" | Display HTML text for optional back button. |
Colors
If these are not set, color are loaded from XML options. Color values are hex-numbers in this format: 0xFF00FF
| Option Name | Default Value | Description |
| imageFrameColor | null | Color of main image frame and image nav buttons (overrides XML 'frameColor' value) |
| thumbnailFrameColor | null | Color of thumbnail frames (overrides XML 'frameColor' value) |
| pagingArrowsColor | null | Color of thumbnail paging arrows (overrides XML 'frameColor' value) |
| titleTextColor | null | Color of caption text (overrides XML 'textColor' value) |
| captionTextColor | null | Color of title text (overrides XML 'textColor' value) |
Fixed Layout Positions
These options are only used if fixedLayout is set to true. ThumbArea width and Height are determined by columns, rows, thumbnailWidth, thumbnailHeight and thumbnailPadding. These values are in pixels.
| Option Name | Default Value | Description |
| imageAreaX | null | X position of Image Area |
| imageAreaY | null | Y position of Image Area |
| imageAreaWidth | null | Width of Image Area |
| imageAreaHeight | null | Height of Image Area |
| thumbAreaX | null | X position of Thumbnails |
| thumbAreaY | null | Y position of Thumbnails |
| backThumbArrowX | null | X position of Back Thumb Arrow (relative to top left of Thumb Area) |
| backThumbArrowY | null | Y position of Back Thumb Arrow (relative to top left of Thumb Area) |
| nextThumbArrowX | null | X position of Next Thumb Arrow (relative to top left of Thumb Area) |
| nextThumbArrowY | null | Y position of Next Thumb Arrow (relative to top left of Thumb Area) |
| titleX | null | X position of Title text |
| titleY | null | Y position of Title text |
| titleWidth | null | Width of Title text |
| titleHeight | null | Height of Title text |
| captionX | null | X position of caption text. |
| captionY | null | Y position of caption text |
| captionWidth | null | Width of caption text |
| captionHeight | null | Height of caption text |
| downLoadLinkX | null | X position of download link |
| downLoadLinkY | null | Y position of download link |
| backButtonX | null | X position of optional back button. |
| backButtonY | null | Y position of optional back button. |
XML Options Overrides
Setting these values will replace the values loaded from the XML options.
| Option Name | Default Value | Description |
| maxImageWidth | 480 | Width of the widest image in the gallery. Used to determine the best layout for your gallery (pixels). |
| maxImageHeight | 480 | Height of tallest image in the gallery. Used to determine the best layout for your gallery (pixels). |
| frameWidth | 20 | Width of image frame (pixels). |
| stagePadding | 40 | Width of padding around gallery edge (pixels). To have the image flush to the edge of the swf, set this to 0. |
| navPadding | 40 | Distance between image and thumbnails (pixels). |
| thumbnailColumns | 3 | Number of thumbnail rows. To disable thumbnails completely set this value to 0 |
| thumbnailRows | 3 | Number of thumbnail columns. To disable thumbnails completely set this value to 0. |
| navPosition | left | Position of thumbnails relative to image. Can be "top", "bottom","left" or "right". |
| vAlign | center | Vertical placment of the image and thumbnails within the SWF. Can be "center", "top" or "bottom". |
| hAlign | center | Horizontal placement of the image and thumbnails within the SWF. Can be "center", "left" or "right". |
| title | SimpleViewer Gallery | Text to display as gallery Title |
| enableRightClickOpen | true | Whether to display a 'Open In new Window...' dialog when right-clicking on an image. Can be "true" or "false" |
| backgroundImagePath | Relative or absolute path to a JPG or SWF to load as the gallery background. Relative paths are relative to the HTML document that contains SimpleViewer. |
|
| imagePath | Relative or absolute path to images folder. This value is only required if you don't want to put your images in the 'images' folder. Relative paths are relative to the HTML document that contains SimpleViewer. Note that this path should include a trailing forward slash (for example: imagePath="my_image_folder/"). |
|
| thumbPath | Relative or absolute path to thumbnail images folder. This value is only required if you don't want to put your thumbnail images in the 'thumbs' folder. Relative paths are relative to the HTML document that contains SimpleViewer. Note that this path should include a trailing forward slash (for example: thumbPath="my_thumb_folder/"). |