ASP.NET MVC コントロールヘルプ
Tooltip クラス
ファイル
wijmo.js
モジュール
wijmo
派生クラス
ChartTooltip

ページ上の要素に関する追加情報を表示するポップアップウィンドウを提供します。

Tooltipクラスは、次の2つのモードで使用できます。

**自動モード:** {setTooltip メソッドを使用して、 Tooltip をページの1つ以上の要素に接続します。 Tooltip がイベントを自動的に監視し、 ユーザーがツールチップをトリガーするアクションを実行したときにツールチップを表示します。 次に例を示します。

```typescript import { Tooltip } from '@grapecity/wijmo'; let tt = new Tooltip(); tt.setTooltip('#menu', 'Select commands.'); tt.setTooltip('#tree', 'Explore the hierarchy.'); tt.setTooltip('#chart', '#idChartTooltip'); ```

**手動モード**: 呼び出し元がshow メソッドとhide メソッドを 使用してツールチップの表示/非表示を制御します。 次に例を示します。

```typescript import { Tooltip } from '@grapecity/wijmo'; let tt = new Tooltip(); element.addEventListener('click', () => { if (tt.isVisible) { tt.hide(); } else { tt.show(element, 'This is an important element!'); } }); ```

次の例は、Tooltip クラスを使用してExcelスタイルのメモを FlexGrid コントロールのセルに追加する方法を示しています。

{@sample Grid/CustomCells/CellNotes/purejs デモ}

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

constructor(options?: any): Tooltip

Tooltipクラスの新しいインスタンスを初期化します。

パラメーター
戻り値
Tooltip

プロパティ

cssClass

ツールチップに追加するCSSクラス名を取得または設定します。

このプロパティのデフォルト値は空の文字列です。

string

gap

ツールチップとターゲット要素との距離を取得または設定します。

このプロパティのデフォルト値は**6**ピクセルです。

number

hideDelay

マウスがターゲット要素の上に乗った時、ツールチップが消えるまでの遅延(ミリ秒単位)を取得または設定します。

このプロパティのデフォルト値は **ゼロ** ミリ秒です。これにより、 マウスが要素から離れるまで、ツールチップが表示されたままになります。

number

isAnimated

ツールチップを表示するときにフェードインアニメーションを使用するかどうかを決定する値を取得または設定します。

このプロパティのデフォルト値は **false**です。

boolean

isContentHtml

ツールチップのコンテンツをプレーンテキストとして表示するか、HTMLとして表示するかを決定する値を取得または設定します。

このプロパティのデフォルト値は**true**です。

boolean

isVisible

ツールチップが表示されているかどうかを示す値を取得します。

boolean

position

オーナ要素に対してツールチップを表示する必要があるPopupPositionを取得または設定します。

このプロパティのデフォルト値は**PopupPosition.Above**です。

PopupPosition

showAtMouse

ツールチップをターゲット要素ではなくマウスの位置を基準にして計算するかどうかを決定する値を取得または設定します。

このプロパティのデフォルト値は**false**です。 これにより、ツールチップの位置がターゲット要素に基づいて計算されます。

positionプロパティは、 ターゲット要素またはマウスの位置に対するツールチップの位置を決定するために 使用されます。

boolean

showDelay

マウスがターゲット要素に入ってからツールチップが表示されるまでの遅延(ミリ秒単位)を取得または設定します。

このプロパティのデフォルト値は**500**ミリ秒です。

number

メソッド

dispose

dispose(): void

このTooltip インスタンスに関連付けられたすべてのツールチップを削除します。

戻り値
void

getTooltip

getTooltip(element: any): string

指定した要素に関連付けられたツールチップの内容を取得します。

パラメーター
  • element: any

    Element, element ID, or control that the tooltip explains.

戻り値
string

hide

hide(): void

ツールチップが現在表示されている場合、非表示にします。

戻り値
void

onPopup

onPopup(e: TooltipEventArgs): boolean

popup イベントを発生させます。

パラメーター
戻り値
boolean

setTooltip

setTooltip(element: any, content: string | null, position?: PopupPosition): void

ページ上の指定した要素にツールチップの内容を割り当てます。

ページ上の任意の数の要素に対して同じツールチップを使用して情報を表示できます。要素からツールチップを削除するには、setTooltip を呼び出して内容をnullに設定します。

すべての要素のツールチップを削除するには、dispose メソッドを呼び出します。

パラメーター
  • element: any

    Element, single element CSS selector, or control that the tooltip explains.

  • content: string | null

    Tooltip content or ID of the element that contains the tooltip content.

  • position: PopupPosition Optional

    Position where the tooltip should be displayed with respect to the owner element.

戻り値
void

show

show(element: any, content: string, bounds?: Rect, position?: PopupPosition): void

指定した要素の横に指定した内容を含むツールチップを表示します。

パラメーター
  • element: any

    Element, element ID, or control that the tooltip explains.

  • content: string

    Tooltip content or ID of the element that contains the tooltip content.

  • bounds: Rect Optional

    Optional parameter that defines the bounds of the area that the tooltip targets. If not provided, the element bounds are used.

  • position: PopupPosition Optional

    Optional parameter that specifies the position of the tooltip with respect to the reference bounds. If provided, this value overrides the setting of the position property.

戻り値
void

イベント