HaruAnnotation::setHighlightMode

(PECL haru >= 0.0.1)

HaruAnnotation::setHighlightMode — アノテーションの強調モードを設定する

説明

HaruAnnotation::setHighlightMode ( int $mode ) : bool

アノテーションをクリックした際の表示方法を定義します。 この関数は、リンクアノテーションに対してのみ使用します。

パラメータ

mode

アノテーションの強調モード。以下のいずれかの値となります。

  • HaruAnnotation::NO_HIGHLIGHT - 強調しない。
  • HaruAnnotation::INVERT_BOX - アノテーションの内容を反転する。
  • HaruAnnotation::INVERT_BORDER - アノテーションの枠線を反転する。
  • HaruAnnotation::DOWN_APPEARANCE - アノテーションを目立たなくする。

返り値

成功した場合に TRUE を返します。

エラー / 例外

エラー時に HaruException をスローします。