イベント
chart.on() で監視します。戻り値は監視を解除する関数です。
const off = chart.on('crosshairMove', (event) => {
/* ... */
});
off(); // 監視をやめるチャートを破棄すると、すべての監視は自動で解除されます。
いつ発行されるか
ほとんどのイベントはユーザーが操作したときだけ発行され、自分で API を呼んで行った変更が改めて通知されることはありません。たとえば、ユーザーがラインを引くと drawingsChange が発行されますが、chart.drawings.add() を呼んでも発行されません。そのため、イベントで受け取った変更をサーバーに保存し、サーバーからチャートに設定し直しても、イベントが行ったり来たりすることはありません。
例外は barsChange、visibleRangeChange、typesChange、optionsChange です。これらはチャートの現在の状態を伝えるもので、誰が変更したかにかかわらず発行されます。
API 呼び出しのイベントは、呼び出しが処理を終えてから、戻る前に発行されます。読み取りも同じです。たとえば visibleRange() が新しい表示範囲を計算したとき、visibleRangeChange は計算が終わってから発行されるので、リスナーの中でチャートを変えても戻り値は変わりません。
複数の API 呼び出しをまとめて反映し、イベントを 1 回だけ発行させたいときは batch() を使います。
chart.batch(() => {
chart.data.set(bars, { interval: '1m' });
chart.data.setTimeframe('1h');
chart.timeScale.scrollToRealTime();
});コアのイベント
| イベント | いつ | 詳細 |
|---|---|---|
crosshairMove |
マウスがチャート上で動いたとき、チャートから離れたとき | 操作 |
visibleRangeChange |
見えている範囲が変わったとき | 操作 |
loadMore |
いちばん古い足の近くまでドラッグしたとき | データ |
barsChange |
表示されるローソク足が変わったとき | データ |
click |
クリック | 操作 |
doubleClick |
ダブルクリック | 同上 |
contextMenu |
右クリック。監視していればブラウザのメニューは出ない | 同上 |
selectionChange |
ユーザーがオブジェクトを選択したとき、選択を解除したとき | 操作 |
paneResize |
ユーザーがペインの区切り線のドラッグを終えたとき | ペイン |
legendButtonClick |
凡例のボタンがクリックされたとき | 外観 |
buttonClick |
注文やアラートのラベルのボタンがクリックされたとき | 注文ラインと約定マーカー |
typesChange |
シリーズ、ローソク足の変換、インジケーター、描画の種類が登録・削除されたとき | モジュール |
optionsChange |
オプションが設定されたとき(applyOptions()、loadState()) |
カスタムモジュール |
モジュールのイベント
モジュールを読み込んだときだけ使えます。
| イベント | モジュール | いつ |
|---|---|---|
drawingsChange |
描画 | ユーザーが描画を作成・変更・削除したとき、または元に戻す・やり直したとき |
toolEnd |
描画 | ユーザーが描き終えたとき、または Esc や右クリックで取り消したとき |
orderDrag |
注文ライン | ユーザーが注文ラインをドラッグしたとき |
alertDrag |
アラート | ユーザーがアラートラインをドラッグしたとき |
alertTrigger |
アラート | アラートが発動したとき |
replay |
リプレイ | リプレイが 1 本進んだとき、または最後まで再生したとき |
ドラッグのイベントは段階ごとに発行されます。start、move、end の順で、Esc で取り消したときは cancel です。イベントにはドラッグ前の価格と現在の価格が含まれます。
chart.on('orderDrag', ({ id, phase, price, initialPrice }) => {
if (phase === 'end') {
modifyOrder(id, price); // 離したときだけ注文を変更する
}
});TypeScript では
イベント名とイベントの内容には型があり、チャートのモジュールに連動します。描画モジュールを読み込んでいなければ、chart.on('drawingsChange', ...) はコンパイル時にエラーになります。
ほかのフレームワーク向けのコンポーネントのように、すべてのイベントを転送したいときは、@kumo-charts/core/all の ALL_EVENTS がコアとすべてのモジュールのイベント名、AllEventMap がその型です。