This command reference lists the commands you can use to control overLIB. There are multiple ways
to customize overLIB and using commands all the time is NOT the correct way of doing this. Read the
documentation for more information about other ways to customize overLIB.
Remeber that commands are always in uppercase (case-sensitive) and can have none or many parameters.
STICKY
Makes the popup stick around until closed.
Variable: ol_sticky.
WIDTHpixels
Sets the width of the box to some other size.
Variable: ol_width.
HEIGHTpixels
Sets the height of the box.
Variable: ol_height.
LEFT
Makes the popups go to the left of the mouse.
Variable: ol_hpos.
RIGHT
Makes the popups go to the right of the mouse.
Variable: ol_hpos.
CENTER
Makes the popups go to the center of the mouse.
Variable: ol_hpos.
ABOVE
Makes the popups go above the mouse.
Note: Only possible when HEIGHT has been set.
Variable: ol_vpos.
BELOW
Makes the popups go below the mouse.
Variable: ol_vpos.
OFFSETXx
How far away from the pointer the popup will show up, horizontally.
Variable: ol_offsetx.
OFFSETYy
How far away from the pointer the popup will show up, vertically.
Variable: ol_offsety.
AUTOSTATUS
Sets the status bar's text to the popup's text.
Overrides STATUS.
Variable: ol_autostatus.
AUTOSTATUSCAP
Sets the status bar's text to the popup's caption.
Overrides AUTOSTATUS and STATUS.
Variable: ol_autostatus.
SNAPXgrid
Snaps the popup to an even position in a horizontal grid.
Variable: ol_snapx.
SNAPYgrid
Snaps the popup to an even position in a vertical grid.
Variable: ol_snapy.
FIXXposition
Locks the popups horizontal position.
Overrides all other horizontal placement.
Variable: ol_fixx.
FIXYposition
Locks the popups vertical position.
Overrides all other vertical placement.
Variable: ol_fixy.
FRAMEframe
Controls popups in a different frame. Make sure you have the <DIV>
tag in the target frame as well. The frame parameter passed to this command
should not be a text string. This feature, although working well, is
considered experimental. Example: overlib('Text', FRAME, parent.below),
assuming you have a frame called below.
Variable: ol_frame.
TIMEOUTmillisecs
Makes the popup go away after the requested delay.
Variable: ol_timeout.
DELAYmillisecs
Makes that popup behave like a tooltip. It will popup only after a certain delay specified in millisecs.
Variable: ol_delay.
HAUTO
Automatically determine if the popup should be to the left or right of the mouse.
This command toggles the feature on or off.
Variable: ol_hauto.
VAUTO
Automatically determine if the popup should be to the above or below of the mouse.
This command toggles the feature on or off.
Variable: ol_vauto.
CLOSECLICK
Force users to click on "Close" to close sticky popups. This command toggles the feature on and off.
Variable: ol_closeclick.
FGCOLORcolor
Color of the inside of the popup box.
Variable: ol_fgcolor.
BGCOLORcolor
Color of the border of the popup box.
Variable: ol_bgcolor.
TEXTCOLORcolor
Sets the color of the text inside the box.
Variable: ol_textcolor.
CAPCOLORcolor
Sets the color of the box's caption.
Variable: ol_capcolor.
CLOSECOLORcolor
Sets the color of the close text.
Variable: ol_closecolor.
TEXTFONTfont
Sets the font to be used by the main text.
Variable: ol_textfont.
CAPTIONFONTfont
Sets the font of the caption.
Variable: ol_capfont.
CLOSEFONTfont
Defines the font for the "Close" text.
Variable: ol_closefont.
TEXTSIZEsize
Size of the main text's font.
Variable: ol_textsize.
CAPTIONSIZEsize
Size of the caption's font.
Variable: ol_captionsize.
CLOSESIZEsize
Size of the "Close" text's font.
Variable: ol_closesize.
FGBACKGROUNDpicture
Defines a picture to use instead of color for the inside of the popup.
You will most likely want to set FGCOLOR to '' or the color will show as well.
Variable: ol_fgbackground.
BGBACKGROUNDpicture
Defines a picture to use instead of color for the border of the popup.
You will most likely want to set BGCOLOR to '' or the color will show as well.
When having a Close link, Netscape will re-render the table cells, making things look bad.
Variable: ol_bgbackground.
CAPICONurl
Displays a small icon before the popup caption.
Variable: ol_capicon.
BORDERpixels
Makes the border of the popups thicker or thinner.
Variable: ol_border.
BACKGROUNDpicture
Instead of using the table box as background, your picture will be used.
Variable: ol_background.
PADXleftright
Pads the background picture with horizontal whitespace for text placement.
Note that this is a two parameter command.
Variable: ol_padxl and ol_padxr.
PADYtopbottom
Pads the background picture with vertical whitespace for text placement.
Note that this is a two parameter command.
Variable: ol_padyt and ol_padyb.
FULLHTML
Allows you to control the html over a BACKGROUND picture completely. The html code is expected in "text".
Variable: ol_fullhtml.
CAPTIONtitle
Sets the caption of the popup.
Variable: ol_cap.
CLOSETEXTtext
Replaces the text "Close" with something else.
Variable: ol_close.
NOCLOSE
Doesn't display the text "Close" on stickies with caption.
Variable: ol_close.
INARRAYid
Tells overLIB to read the text from the ol_texts array, located in overlib.js (or on page).
This parameter can be used instead of text.
Example: overlib(INARRAY, 1);
Variable: ol_texts.
CAPARRAYid
Tells overLIB to read the caption from the ol_caps array.
Variable: ol_caps.
FUNCTIONfunctionname
Calls the specified function and takes the return value as the text that should be displayed in the popup.
The function is called when the overLIB command parser runs.
Variable: ol_function.
STATUStext
Sets the text in the browsers status bar to text.
Variable: ol_status.
