|
ArtScene Parameters
Click an item in the list to the left to find out more about it.
Width & Height
The width and height of the applet are set in the HTML code you add to the web page. Be sure to change the dimensions in the <object> and the <embed> tags.
ArtScene's dimensions can be almost whatever you want. However, ArtScene was designed as something of a 'feature' applet occupying a space at least 400 pixels wide by 200 pixels high, and may not give as good an effect when used at a much smaller size.
Parameters
The parameters below should be added to your datafile in the form NAME=VALUE (for instance, BgColor=FF0000). Each parameter should be on a separate line. You can leave blank lines in the list to organize the parameters into groups if you want to. The parameter names are not case-sensitive, and neither are the values, so BgColor=FF0000 is the same as bgcolor=ff0000. You can add the parameters to your file in any order. Most parameters have a default value which we show in bold text below: if you don't include the parameter in your datafile, the default value will be used automatically.
BgColor
Sets the primary background color of the applet. The default value is 000000 (black). (Note that ArtScene can only change the background color after it has loaded. To have the same background color shown before the browser starts loading the applet, change the BgColor setting in the HTML code too.)
BgGradientColor
Specifies the color to use for a gradient effect in the applet's background. If no gradient effect is wanted, set this to match the BgColor. The default color is 18182A (very dark gray).
NudgeCenterLine
Thumbnail images sit on an invisible line across the exact center of the applet. This parameter accepts a negative or positive number to "nudge" that line upward or downward respectively. For example, to nudge the center-line and thumbnails downward by 10 pixels, set this parameter to 10. The default value is 0. (Note that ArtScene will prevent the center-line being nudged too far downward or upward.)
DefaultTarget
Every image can link to a separate URL, and it can open it into a separate frame or window: we provide numbered Target parameters for that. However, you probably want most (or maybe all) the links to open into one particular frame. Enter the frame name in this parameter, and every item without its own Target parameter will open the link into this 'default' frame. As well as frame names you've defined in your documents, you can use the HTML names _self, _top, _parent, _blank or _new. If you leave this parameter out of your datafile, links will open into _self (the frame or window containing the applet).
Name
Specifies a name for this instance of the applet. This is only necessary if you are using the applet in conjunction with our free Satellite add-on, and it's explained in the documentation for Satellite, available from the Cool Focus web site. If you are not using Satellite with this applet, it's best not to include this parameter in your datafile (although nothing bad will happen if you do).
SatelliteAuto
A choice of yes or no. This parameter applies only if you are using ArtScene with our Satellite add-on. By default, ArtScene works like the majority of Cool Focus applets, sending a notification to Satellite when the mouse moves over an image. If this parameter is set to Yes, mouse movement is ignored, and Satellite will always display the text associated with the currently-selected image, updating itself when a different image is selected.
ShowVersion
A yes or no value. This parameter is included in all Cool Focus Flash applets, and its default is no. If set to 'yes', the version number of the applet (and other details) will be shown when the applet starts. This is included only for troubleshooting purposes, to help you determine which version of an applet you're using. It should be set to 'no' (or removed from your datafile) before you publish your page.
Note: If the applet is not registered, this information will always be shown when the applet starts, regardless of the ShowVersion parameter's setting.
AnimationDelay
A number which sets the speed at which images slide forward and backward when clicked. A higher value results in slower animation. The default value is 15.
ImageSpacing
A number which specifies the horizontal spacing (in pixels) between each image. The default spacing is 6.
LimitImageExpand
A yes or no value, with a default of Yes. By default, when a thumbnail is clicked, it will not expand to greater dimensions than the original image size. If this parameter is set to No, images will expand as far as the applet's dimensions allow, regardless of whether that enlarges them beyond their native dimensions. (Note that expanding images beyond their original size could cause them to appear pixelated. See Choosing Images for more details.)
ReflectionDepth
A number from 0100 which sets the intensity of the image reflections, where high numbers produce a more visible reflection. The default is 35.
ShowSelector
A yes or no value which specifies whether or not the selector is shown at the corners of an image when the mouse moves over it. The default is Yes.
SelectorColor
The color of the selector that appears at the corners of an image when the mouse moves over it. The default color is 3399FF (light blue).
FlashSelector
A yes or no value which specifies whether or not the selector flashes (fades in and out) when visible, or remains a solid color.
SelectedImage
A number which specifies which (if any) image should be selected, scrolled into view and moved forward when ArtScene starts. This can be a number between 1 and the total number of images you display, or 0 if no image should be selected.
ThumbnailHeight
A number from 0 upwards. By default, ArtScene determines the maximum size for thumbnails automatically and displays them at that maximum size. If you'd like the thumbnails to be smaller than the size used by ArtScene, enter their required height here. (The width will be scaled accordingly.) The default setting is 0, which tells ArtScene to manage thumbnail sizes.
ThumbnailHandCursor
A choice of yes or no which specifies whether or not to display a hand cursor when the mouse moves over a thumbnail image. The default is No.
CaptionFont
Sets the name, size and style of font to use for the text caption shown below the selected image, with each part separated by commas. The default is Sans,8,plain.
- Name: You can include any number of font names, separated by pipe symbols (|), and the applet will use the first font available on the user's system. To ensure compatibility, finish with one of these generic names: Sans, Serif or Typewriter.
- Size: The size of the font in points.
- Style: The style can be plain, bold, italic or bold-italic.
An example font parameter would be: Comic Sans MS|Verdana|Arial|Sans,9,bold.
CaptionHeight
A number value of 0 or higher which sets the height of the caption area below the images. This should be tall enough to display image captions (if used) with your chosen CaptionFont. Expanded images rest on the top of the caption area with their reflection below, so a good sized CaptionHeight helps the reflection effect. The default is 30.
CaptionNudge
A positive or negative number. ArtScene positions the text captions automatically. If you're not happy with the caption's vertical position, specify a negative or positive amount (in pixels) by which the captions should be nudged upwards or downwards respectively. For example, a value of 5 will nudge them down 5 pixels. The default value is 0.
CaptionGlowColor
Sets the color of the subtle glow effect used in the caption area behind the text captions. (For images without a caption, the glow is not used.) The default color is FFFFFF (white).
CaptionGlowDepth
A number value from 0 to 100 setting the intensity of the glow effect behind text captions, where higher values produce a more intense glow. Setting this to 0 removes the glow effect. The default value is 40.
CaptionTextColor
Sets the text color of the captions, with a default value of D8DBE6 (light gray).
CaptionTextFocusColor
If an item has a URL parameter (making it act as a link) this sets the color of the caption when the mouse moves over it. (Non-linking items don't react to mouse-over on captions.) The default color is 3399FF (light blue).
CaptionTextPressColor
If an item has a URL parameter (making it act as a link) this sets the color of the caption when clicked. (Non-linking items don't react to mouse-down on captions.) The default color is 0066CC (mid-blue).
CaptionLinkUnderline
A yes or no value which specifies whether or not linking captions should be permanently underlined to give a clearer indication that they can be clicked. The default is No.
CaptionLinkEnterUnderline
Another yes or no value which specifies whether or not linking captions should be underlined when the mouse moves over them. (If CaptionLinkUnderline is set to Yes, this parameter is ignored.) The default value is Yes.
ScrollAmount
A number which sets the distance in pixels that images scroll at each animation step. The default is 6 pixels. Use this with ScrollDelay to fine-tune the scrolling.
ScrollDelay
A number which sets the speed at which images are scrolled left and right using the arrow buttons. The default is 5, and higher values result in slower movement. Use this with ScrollAmount to fine-tune the scrolling.
ScrollColor
Sets the primary color of the hover-sensitive scroll bars at either side of the applet. The bars are partially transparent at the top and bottom (unless the mouse is over them), allowing the applet's BgColor to show. The default color is 1B1B34 (very dark gray).
ScrollGradientColor
Sets the color used for the scroll bars' gradient effect. If no gradient effect is wanted, set this to match ScrollColor. The default color is 46465A (gray).
ScrollArrowColor
Sets the color of the arrow on a scroll bar when the bar is enabled and the mouse isn't over it. The default color is 8080A6 (mid gray).
ScrollArrowFocusColor
Sets the color of the arrow on a scroll bar when the bar is enabled and the mouse moves onto it. The default color is 3399FF (light blue).
ScrollArrowDisabledColor
Sets the color of the arrow on a scroll bar when the bar is disabled (images cannot be scrolled in that direction). The default color is 000000 (black).
ScrollHandCursor
A yes or no value which specifies whether or not to display a hand cursor when the mouse moves onto a scroll bar. The default is No.
LoadText
While ArtScene is loading images as it starts, it displays a progress bar. This parameter specifies the text to be displayed while the applet is loading images. The default text is Loading...
LoadTextColor
Sets the text color used for the LoadText, with a default of D8DBE6 (light gray).
LoadProgressBorderColor
Sets the color of the border around the progress bar shown while ArtScene loads images. The default color is 606074 (gray).
LoadProgressFillColor
Sets the primary fill color of the progress bar shown while the applet loads. The default color is 9090A0 (light gray).
LoadProgressGradientColor
Sets the gradient color of the progress bar which gives it a 3D look. If a solid (non-gradient) bar is wanted, set this to match the LoadProgressFillColor. The default color is 282835 (dark gray).
TestLoading
A yes or no parameter. When set To Yes, this freezes the applet at the "Loading..." screen to make the parameters above easier to test. Set this to No before publishing.
SoundThumbnailClick
Specifies the absolute or relative URL of an MP3 audio file to play when the clicks ('selects') an thumbnail image to expand it. If you don't want to play a sound for this event, just leave this parameter out of your datafile.
SoundLinkClick
Specifies the absolute or relative URL of an MP3 audio file to play when the mouse is clicked on a linking caption. If you don't want to play a sound for this event, just leave this parameter out of your datafile.
SoundLinkRelease
Specifies the absolute or relative URL of an MP3 audio file to play when the mouse is released after clicking a linking caption. If you don't want to play a sound for this event, just leave this parameter out of your datafile.
Images
The parameters below are the most important ones: they set the images to be displayed by ArtScene, any captions to display with the images, and the URLs (if required) that each should link to. You must include at least one Image parameter or ArtScene will display nothing at all!
The parameters all have numbers after their names, and the numbers you use must be consecutive, starting from 1. If you want to show 10 images, but you forget to include an Image7 parameter, ArtScene will stop looking for any more, and will only find images 1 to 6.
Image1, Image2, ..., Imagen
These parameters specify the absolute or relative URLs of the images you want ArtScene to display. The images will be shown in numerical order from left to right, starting from 1, and you can include as many images as you like. The images must be in JPEG format. If you want to include GIF images, you must convert them to Flash .SWF files first (see Image Support in Flash Applets).
Caption1, Caption2, ..., Captionn
An optional text caption to display below the image when the image is selected and expanded. The Caption must be short enough to fit onto a single line within the width of the applet.
URL1, URL2, ..., URLn
The optional URL to which the image with the same number should link when its Caption is clicked. If you don't want the image to act as a link, don't include a URL parameter for it. To make items behave like links in all respects except linking somewhere (which can be useful for testing), use a dollar sign ($, or when encoded, %24) as the first character of the URL.
Note: If you assign a Caption to an image, the Caption will act as the link. If you don't assign a Caption, the link will be fired when the user clicks the image to expand it, and the expand-animation has completed.
Target1, Target2, ..., Targetn
The name of the frame or window into which the URL should open. If you don't include this parameter, the frame name set in the DefaultTarget parameter will be used.
|