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

Tooltip クラスを拡張してチャートのツールチップを提供します。

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

constructor(): void

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

戻り値
void

プロパティ

content

ツールチップの内容を取得または設定します。

この内容は文字列として指定するほかに、aHitTestInfoオブジェクトをパラメーターとして受け取る関数として指定することもできます。

ツールチップの内容が文字列の場合、以下のパラメーターを含めることができます。

  • propertyName: Any property of the data object represented by the point.
  • seriesName: Name of the series that contains the data point (FlexChart only).
  • pointIndex: Index of the data point.
  • value: Value of the data point (y-value for FlexChart, item value for FlexPie).
  • x: x-value of the data point (FlexChart only).
  • y: y-value of the data point (FlexChart only).
  • name: Name of the data point (x-value for FlexChart or legend entry for FlexPie).

パラメーターは波かっこで囲む必要があります。例:

// 'country'と'sales'はデータオブジェクトのプロパティです
  chart.tooltip.content = '{country}, sales:{sales}';

次の例は、関数を使用してツールチップの内容を設定する方法を示します。

// ツールチップの内容を設定します。
  chart.tooltip.content = function (ht) {
    return ht.name + ":" + ht.value.toFixed();
  }
any

cssClass

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

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

継承元
Tooltip
string

gap

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

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

継承元
Tooltip
number

hideDelay

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

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

継承元
Tooltip
number

isAnimated

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

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

継承元
Tooltip
boolean

isContentHtml

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

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

継承元
Tooltip
boolean

isVisible

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

継承元
Tooltip
boolean

position

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

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

継承元
Tooltip
PopupPosition

showAtMouse

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

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

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

継承元
Tooltip
boolean

showDelay

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

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

継承元
Tooltip
number

threshold

ツールチップを表示する範囲の要素からの最大距離を取得または設定します。

number

メソッド

dispose

dispose(): void

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

継承元
Tooltip
戻り値
void

getTooltip

getTooltip(element: any): string

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

パラメーター
  • element: any

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

継承元
Tooltip
戻り値
string

hide

hide(): void

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

継承元
Tooltip
戻り値
void

onPopup

onPopup(e: TooltipEventArgs): boolean

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

パラメーター
継承元
Tooltip
戻り値
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.

継承元
Tooltip
戻り値
void

show

show(element: any, content: string, bounds?: Rect): 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 element that defines the bounds of the area that the tooltip targets. If not provided, the bounds of the element are used (as reported by the getBoundingClientRect method).

戻り値
void

イベント