Top > Blog > Programming

overLIB リファレンス

この記事は OverLib 3.51 を元に書きました。2006/04/07 時点では OverLib 4.21 がリリースされているようです。
基本的な使い方には違いはないようですが、細かいところで差異があるかもしれません。

表:overLib で使用できる変数・定数
変数名 対応する定数 値の型 デフォルト値 推奨値 内容
色設定  トップへ
ol_fgcolor FGCOLOR HTML カラー
(文字列)
“#CCCCFF” 明るい色 ツールチップ内部の背景色
ol_bgcolor BGCOLOR HTML カラー
(文字列)
“#333399” 暗めの色 ツールチップのボーダー及びキャプション部分の背景色
ol_textcolor TEXTCOLOR HTML カラー
(文字列)
“#000000” 暗めの色 ツールチップ内部のテキスト色
ol_capcolor CAPCOLOR HTML カラー
(文字列)
“#FFFFFF” 明るい色 キャプション部分のテキスト色
ol_closecolor CLOSECOLOR HTML カラー
(文字列)
“#9999FF” やや明るい色 Sticky (付箋紙)モードを使用している際の「Close」リンクのテキスト色
フォント設定  トップへ
ol_textfont TEXTFONT フォント名
(文字列)
“Verdana,
Arial,
Helvetica”
ツールチップのフォント
ol_captionfont CAPTIONFONT フォント名
(文字列)
“Verdana,
Arial,
Helvetica”
キャプション部分のフォント
ol_closefont CLOSEFONT フォント名
(文字列)
“Verdana,
Arial,
Helvetica”
“Close”部分のフォント
(Stickyモード)
ol_textsize TEXTSIZE フォントサイズ
(文字列)
“1” ~ “7”
“1” ツールチップのフォントサイズ
ol_captionsize CAPTIONSIZE フォントサイズ
(文字列)
“1” ~ “7”
“1” キャプション部分のフォントサイズ
ol_closesize CLOSESIZE フォントサイズ
(文字列)
“1” ~ “7”
“1” “Close”部分のフォントサイズ
(Stickyモード)
サイズ設定  トップへ
ol_width WIDTH 数値文字列 “200” “100”~”300″ ツールチップの横幅(ピクセル)
ol_height HEIGHT 数値 -1 ツールチップの縦幅(ピクセル)
ol_border BORDER 数値文字列 “1” “1”~”3″ ツールチップの枠線幅(ピクセル)
位置設定  トップへ
ol_offsetx OFFSETX 数値 10 3 ~ 12 ツールチップの出現位置。
カーソル位置を基準として左右の距離(ピクセル)
ol_offsety OFFSETY 数値 10 3 ~ 12 ツールチップの出現位置。
カーソル位置を基準として下方向の距離(ピクセル)
ol_hpos LEFT, CENTER, RIGHT 定数(LEFT, CENTER, RIGHT) RIGHT ツールチップの出現位置。カーソル位置を基準として、LEFT:左、CENTER:中央、RIGHT:右、に表示する。
ol_hposを使う場合は、LEFT,CENTER,RIGHTのいずれかの定数を代入する(例1)。overlib() 関数の引数として使う場合は、特に第二引数は指定しない(例2)。
例1)ol_hpos = CENTER;
例2)overlib(CENTER);
ol_vpos ABOVE, BELOW 定数(ABOVE, BELOW) BELOW ツールチップの出現位置。カーソル位置を基準として、ABOVE:上、BELOW:下、に表示する。
ol_vposを使う場合は、ABOVE, BELOWのいずれかの定数を代入する(例1)。overlib() 関数の引数として使う場合は、特に第二引数は指定しない(例2)。
例1)ol_vpos = ABOVE;
例2)overlib(ABOVE);
ol_aboveheight HEIGHT 数値 0 ツールチップの出現位置。カーソル位置を基準として、上方向に何ピクセル移動させるかを指定する。
ol_snapx SNAPX 数値 0 ツールチップ出現位置の水平方向グリッド幅。
ol_snapy SNAPY 数値 0 ツールチップ出現位置の垂直方向グリッド幅。
ol_fixx FIXX 数値 -1 ツールチップを固定位置に表示する場合の水平位置。表示されているドキュメントの左上を基準として、左端からの距離(ピクセル)
ol_fixy FIXY 数値 -1 ツールチップを固定位置に表示する場合の垂直位置。表示されているドキュメントの左上を基準として上端からの距離(ピクセル)
ol_hauto HAUTO 0 または 1 0 カーソル位置が、画面を4分割した際のどの区画にあるかによって、自動的に表示位置を調整するように変更するフラグ。1 で on になる。
ol_vauto VAUTO 0 または 1 0 カーソル位置が、画面を4分割した際のどの区画にあるかによって、自動的に表示位置を調整するように変更するフラグ。1 で on になる。
テキスト設定  トップへ
ol_text 文字列 “Default Text” ツールチップのデフォルトテキスト。overlib() で特に指定しなかった場合に表示される。
ol_cap CAPTION 文字列 “” キャプション部分のデフォルトテキスト。””(空文字)ならば特に指定が無い限りキャプションは表示されない。
画像設定  トップへ
ol_background BACKGROUND パス文字列 “” ツールチップのデフォルト背景イメージをパスで指定する。絶対パス・相対パス共に可。
ol_padxl PADX 数値 1 ツールチップのデフォルト背景イメージ(ol_background, BACKGROUND)が指定されている場合の、表示テキストの左余白(ピクセル)。

定数 PADX は左右余白を一括して指定する。
ol_padxr PADX 数値 1 ツールチップのデフォルト背景イメージ(ol_background, BACKGROUND)が指定されている場合の、表示テキストの右余白(ピクセル)。

定数 PADX は左右余白を一括して指定する。
ol_padyt PADY 数値 1 ツールチップのデフォルト背景イメージ(ol_background, BACKGROUND)が指定されている場合の、表示テキストの上余白(ピクセル)。

定数 PADY は上下余白を一括して指定する。
ol_padyb PADY 数値 1 ツールチップのデフォルト背景イメージ(ol_background, BACKGROUND)が指定されている場合の、表示テキストの下余白(ピクセル)。

定数 PADY は上下余白を一括して指定する。
ol_fgbackground FGBACKGROUND パス文字列 “” ツールチップの背景イメージをパスで指定する。絶対パス・相対パス共に可。
ol_bgbackground BGBACKGROUND パス文字列 “” ツールチップのフレームイメージをパスで指定する。絶対パス・相対パス共に可。
ol_capicon CAPICON パス文字列 “” キャプション部分に表示するアイコンイメージをパスで指定する。絶対パス・相対パス共に可。
ステータスバー設定  トップへ
ol_status STATUS 文字列 “” ツールチップ表示中、ステータスバーに表示する文字列。A 要素で overlib() を呼び出している場合は、href 属性の内容がステータスバーに表示されて機能しない場合がある。その場合は SPAN 要素とスタイルシートを使う方法が良い。
ol_autostatus AUTOSTATUS 0, 1, 2 0 ステータスバーに表示する文字列を下記の通り設定するフラグ。
0:ステータス表示なし
1:ツールチップの内容をステータスバーに表示
2:キャプションの内容をステータスバーに表示

また、overlib(AUTOSTATUS) を使うと、下記のように ol_autostatus の動作が反転する。
ol_autostatus が 0 の場合
 ツールチップの内容をステータスバーに表示
ol_autostatus が 1 の場合
 ol_status の内容をステータスバーに表示
ol_autostatus が 2 の場合
 ツールチップの内容をステータスバーに表示
Sticky(付箋紙)モード設定  トップへ
ol_sticky STICKY 0 または 1 0 ツールチップを付箋紙のように固定表示にするフラグ。ol_cap に任意の文字 (半角スペースでも可)を指定しておかないと、「Close」が表示されずにツールチップが表示されたままになる。
ol_close CLOSETEXT 文字列 “Close” Sticky モードの際に表示される、ツールチップを閉じる為のテキストリンクの表示内容。
NOCLOSE overlib() 関数の引数にこの定数を指定すると、Sticky モード時に「Close」が表示されなくなる。
ol_timeout TIMEOUT 数値(ミリ秒) 0 Sticky モードの際にツールチップを自動的に閉じるまでの時間設定。
ol_closeclick CLOSECLICK 0 または 1 0 1 の場合は「Close」をクリックして初めてツールチップが閉じるようになる。0 ではマウスを重ねるとすぐに閉じる。
その他  トップへ
ol_fullhtml FULLHTML 0 または 1 0 1の場合、ツールチップ内部の表示を HTML で完全にカスタマイズできる。overlib() の引数として定数を使う場合は、第二引数は必要ない。
ol_frame FRAME フレームオブジェクト self ツールチップを表示するフレームを指定。
ol_function FUNCTION Function オブジェクト null ツールチップを表示する際に呼び出す JavaScript 関数を指定。
ol_delay DELAY 数値(ミリ秒) 0 ツールチップを表示するまでの遅延時間を指定。
スタイルシート設定  トップへ
ol_css 定数(CSSOFF, CSSSTYLE, CSSCLASS) CSSOFF スタイルシートを使う場合に、その適用方法に従って指定。
CSSSTYLE:インラインスタイルシート
CSSCLASS:別途定義してあるスタイルシートクラス
CSSSTYLE の場合は、各色設定・フォント設定等と同じ変数に、スタイルシートの定義する。
CSSCLASS設定  トップへ
ol_fgclass スタイルシートクラス定義(文字列) “” ol_fgcolor と同じ。
ol_bgclass スタイルシートクラス定義(文字列) “” ol_bgcolor と同じ。
ol_textfontclass スタイルシートクラス定義(文字列) “” ol_textfont と同じ。
ol_captionfontclass スタイルシートクラス定義(文字列) “” ol_captionfont と同じ。
ol_closefontclass スタイルシートクラス定義(文字列) “” ol_closefont と同じ。
CSSSTYLE設定  トップへ
ol_padunit PADUNIT 固定値(文字列)
“px”, “%”, “in”, “cm”
“px” 余白(padding)を指定する変数に適用する単位。
ol_heightunit HEIGHTUNIT 固定値(文字列)
“px”, “%”, “in”, “cm”
“px” 高さを指定する変数に適用する単位。
ol_widthunit WIDTHUNIT 固定値(文字列)
“px”, “%”, “in”, “cm”
“px” 幅を指定する変数に適用する単位。
ol_textdecoration TEXTDECORATION 固定値(文字列)
“none”, “underline”, “line-through”, “blink”
“none” テキストの装飾をスタイルシートで指定。
ol_textstyle TEXTSTYLE 固定値(文字列)
“normal”, “italic”
“normal” テキストスタイルをスタイルシートで指定。
ol_textweight TEXTWEIGHT 固定値(文字列)
“normal”, “bold”, “bolder”, “lighter”,, 等
“normal” テキストの太さをスタイルシートで指定。
ol_captionsizeunit CAPTIONSIZEUNIT 固定値(文字列)
“px”, “%”, “in”, “cm”
“px” キャプションの文字サイズを指定する際の単位。
ol_captiondecoration CAPTIONDECORATION 固定値(文字列)
“none”, “underline”, “line-through”, “blink”
“none” キャプションの装飾をスタイルシートで指定。
ol_captionstyle CAPTIONSTYLE 固定値(文字列)
“normal”, “italic”
“normal” キャプションのスタイルをスタイルシートで指定。
ol_captionweight CAPTIONWEIGHT 固定値(文字列)
“normal”, “bold”, “bolder”, “lighter”,, 等
“bold” キャプションの太さをスタイルシートで指定。
ol_closesizeunit CLOSESIZEUNIT 固定値(文字列)
“px”, “%”, “in”, “cm”
“px” “Close”の文字サイズを指定する際の単位。
ol_closedecoration CLOSEDECORATION 固定値(文字列)
“none”, “underline”, “line-through”, “blink”
“none” “Close”の装飾をスタイルシートで指定。
ol_closestyle CLOSESTYLE 固定値(文字列)
“normal”, “italic”
“normal” “Close”のスタイルをスタイルシートで指定。
ol_closeweight CLOSEWEIGHT 固定値(文字列)
“normal”, “bold”, “bolder”, “lighter”,, 等
“normal” “Close”の太さをスタイルシートで指定。

コメントの投稿