home / documentation / reference / slideoutinterval

SlideOutInterval

Description:

The interval, in milliseconds, that the browser should wait between adjustments to a sliding menu. Smaller numbers mean that the "slide" effect will happen faster (i.e., the menu itself will slide out of view faster).

Value:

Integer, or JavaScript expression that returns an integer. Negative values are not allowed.

Applies To:

Menus.

Browser Compatibility:

SlideOutInterval is not supported in Netscape 4.x, Internet Explorer 4.x, or earlier Gecko browsers (Netscape 7.02 and earlier, Mozilla 1.2 and earlier).

Comments:

You must always specify SlideOutInterval as an integer, or a JavaScript expression that returns an integer. Do not use quoted strings or non-numerical characters when defining SlideOutInterval.

In general, we recommend settings in the range of 5 (fastest) to 30 (slowest). The speed with which the menus redraw is highly dependent on the user's browser and CPU speed; if the speed is set too fast the user may not see any sliding effect at all; and too slow will be annoying.

SlideOutInterval is part of the custom transition routines included in the HM_Loader.js file and discussed in detail in the Custom Transitions Mini-Tutorial. In order to apply a sliding effect to a menu display, you must include the key SlideOutTo parameter, as well as register the custom functions with the HierMenus setTrans and killTrans menu event hooks:

ScrollEnabled:1,
SlideOutTo:"left",
setTrans:HM_f_SetSlide,
killTrans:HM_f_KillSlide,

For reasons having to do with the sliding effect itself, all sliding menus must be ScrollEnabled.

SlideInInterval is applied to the menu adjustment speed when it is being diplayed. SlideOutInterval is applied to the menu adjustment speed when it is being hidden.

We do not recommend the use of both slide in and slide out menus on the same page. While interesting, this effect can be very annoying to site visitors.

Examples:

// Ok:
SlideOutInterval:5, 
SlideOutInterval:10,  // hundredth of a second
SlideOutInterval:(HM_Opera)?20:10, 
   // 20 if Opera, 10 otherwise

// Incorrect:
SlideOutInterval:.5,
SlideOutInterval:-20,
SlideOutInterval:"20",      // quotes not allowed
SlideOutInterval:"(HM_Opera)?20:10", 
   // no quoted expressions

Default:

20 in Opera, 10 in all other browsers.

See Also:

SlideInInterval, SlideInPercent, SlideOutPercent, SlideInFrom, SlideOutTo, setTrans, killTrans, Custom Transitions Mini-Tutorial