[]
【重要】2024年1月公開のアップデート「未適用」のお客様へ デモ ヘルプ APIリファレンス
トライアル版
(Showing Draft Content)

Wijmo_Chart.Charttooltip

ChartTooltip クラス

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

階層

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

プロパティ

content

content: any

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

ツールチップの内容は文字列として指定するほかに、 HitTestInfo オブジェクトを パラメーターとして受け取る関数として指定することもできます。 ツールチップの内容が文字列の場合、 以下のパラメーターを含めることができます。

  • propertyName: ポイントによって表されるデータオブジェクトのプロパティ。
  • seriesName: データポイントを含む系列の名前（FlexChartのみ）。
  • pointIndex: データポイントのインデックス。
  • value: データポイントの Value （FlexChartのyの値、または FlexPie　の項目の値）。
  • x: データポイントの x の値（FlexChartのみ）。
  • y: データポイントの y の値（FlexChartのみ）。
  • name: データポイントの Name （FlexChart のxの値、または FlexPie の凡例エントリ）。

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

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

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

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

cssClass

cssClass: string

ツールチップを表示するときに使用するCSSクラス名を取得または設定します。

gap

gap: number

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

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

hideDelay

hideDelay: number

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

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

isContentHtml

isContentHtml: boolean

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

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

isVisible

isVisible: boolean

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

showAtMouse

showAtMouse: boolean

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

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

showDelay

showDelay: number

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

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

threshold

threshold: number

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

メソッド

dispose

  • dispose(): void

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

    戻り値 void

getTooltip

  • getTooltip(element: any): string

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

    引数

    • element: any

      ツールチップで説明する要素、要素ID、またはコントロール。

    戻り値 string

    Tooltip content associated with the given element.

hide

  • hide(): void

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

    戻り値 void

onPopup

setTooltip

  • setTooltip(element: any, content: string): void

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

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

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

    引数

    • element: any

      ツールチップで説明する要素、要素ID、またはコントロール。

    • content: string

      ツールチップの内容、またはツールチップの内容を含む要素のID。

    戻り値 void

show

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

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

    引数

    • element: any

      ツールチップで説明する要素、要素ID、またはコントロール。

    • content: string

      ツールチップの内容、またはツールチップの内容を含む要素のID。

    • オプション bounds: Rect

      ツールチップが対象とする領域の範囲を定義するオプションの要素。 これを指定しない場合は、（getBoundingClientRect メソッドによって報告される）要素の範囲が使用されます。

    戻り値 void

イベント

popup: Event

ツールチップの内容が表示される前に発生します。

イベントハンドラでイベントパラメーターを変更してツールチップの内容をカスタマイズしたり、ツールチップの表示を抑制したりできます。