Kumo Charts

メソッド

createProChart() が返すオブジェクト(Vue と React のコンポーネントは created で同じオブジェクトを渡します):

メンバー 説明
chart 現在のチャート(@kumo-charts/core の Chart)。トップバーと描画ツールはこれに働きます。準備ができるまでは null
charts マルチチャートレイアウトに表示しているすべてのチャート。現在のチャートも含みます。コンテナが狭いときは現在のチャートだけを表示します
setSymbol(id, target?) 現在のチャートの銘柄を切り替えます。銘柄を連動させているときはすべてのチャートを一緒に切り替えます。まず resolveSymbol で銘柄を探し、見つからなければ reject して切り替えません
setTimeframe(timeframe, target?) 現在のチャートの時間足を切り替えます。提供する時間足のいずれかである必要があります
setChartType(type, settings?, target?) チャートタイプ。「チャートタイプ」を参照。settings は設定のある足の種類(ティックバーなど)の設定で、setChartType('tick', { count: 500 }) のように書き、渡していないものはそのまま
applyOptions(options) 表示後にオプションを変えます。前の節を参照
addIndicator(type, input?, target?) 現在のチャートにインジケーターを 1 つ追加し、その id を返します。input(ProChartIndicatorInput)では id、params、source、visible、lines、levels、autoscale、pane(下を参照)を渡せます
updateIndicator(id, patch, target?) インジケーターを変えます。params と lines はキーごとにマージし、ほかは置き換えます
removeIndicator(id, target?) インジケーターを削除します
registerIndicator(indicator) 独自のインジケーターを登録します。「カスタムインジケーター」を参照
unregisterIndicator(type) ページが登録したインジケーターを取り下げます。ダイアログには出なくなり、チャート上のそのインジケーターは描かれなくなりますが状態には残り、もう一度登録するとまた描かれます
registerDrawing(drawing) 独自の描画ツールを登録します。「カスタム描画ツール」を参照
unregisterDrawing(type) ページが登録した描画ツールを取り下げます。描画ツールバーからはなくなり、チャート上のその描画は描かれなくなりますが状態には残り、もう一度登録するとまた描かれます
addComparison(symbol, input?, target?) 現在のチャートで銘柄を 1 つ比較し、その id を返します。input(ProChartComparisonInput)では id、placement(percent がデフォルト、scale、pane)、style、color、width、visible を渡せます。「銘柄比較」を参照
updateComparison(id, patch, target?) 比較銘柄を変えます。渡した設定を置き換え、ほかはそのまま
removeComparison(id, target?) 比較銘柄を外します
getAlerts(symbol?) すべての銘柄(または 1 つの銘柄)のアラート。それぞれに symbol と status(ページが監視しているかどうか)が付きます。「アラート」を参照
addAlert(alert, symbol?) 銘柄にアラートを追加し、その id を返します。銘柄を書かなければ現在のチャートの銘柄
updateAlert(id, patch)、removeAlert(id) アラートを変える(ProChartAlertPatch:渡した設定を置き換え、ほかはそのまま)、アラートを削除する
setRemoteAlerts(statuses) アラートの判定を別の場所に任せます(たとえば自前のサーバーで、ページを閉じても通常どおり通知する)。ページは監視をやめ、渡された状態を表示します。null でページに戻します(「アラート」を参照)
reportAlert(id, { time, price }) 別の場所で判定したアラートが発動したとき。ページが自分で発動したときと同じくメッセージを出し、音を鳴らし、alert イベント(remote: true)を発火させます
describeAlert(id) アラートが発動したときにページが出すタイトルと本文({ title, body }、チャートの現在の言語)。別の場所から通知を送るときに同じ文言を使えます
setLayout(grid) マルチチャートレイアウト:single、columns(左右)、rows(上下)、three(左に大 1 枚・右に小 2 枚)、three-right(左に小 2 枚・右に大 1 枚)、four、six-wide(2 行 3 列)、six-tall(3 行 2 列)、six-left(左に大 1 枚・右に小 5 枚)、six-top(上に大 1 枚・下に小 5 枚)
setLinks({ symbol, timeframe, crosshair, time, drawings }) ほかのチャートが現在のチャートに合わせて銘柄の切り替え、時間足の切り替え、クロスヘアの移動、時間の同期を行うか、描画を共有するか(オン:同じ銘柄のチャートで描画を 1 つ共有、オフ:それぞれ別に描く)。渡したものだけを変えます
setActiveChart(index) レイアウトの index 番目(0 から)のチャートを現在のチャートにします
setFavoriteTimeframes(timeframes) トップバーに直接表示する時間足。残りは時間足メニューに入ります
setFavoriteChartTypes(types) トップバーのチャートタイプボタンの横に表示するチャートタイプ。メニューで星印を付けるのと同じです
setFavoriteDrawingTools(types) お気に入り描画ツールのバーに置く描画ツール。ツール一覧で星印を付けるのと同じです。空ならバーを表示しません
setAlertSound(sound) アラート音の全体のオン・オフと音量:{ on?, volume? }。volume は 0 から 1 で、渡していないものは変わりません
startReplay(time?, target?)、stopReplay(target?) time の足からリプレイし、同じ銘柄のチャートも一緒です。time を渡さないとリプレイボタンを押したのと同じで、ユーザーがチャート上で開始点を選びます
openDialog(dialog)、closeDialog() 銘柄検索(symbolSearch)、銘柄比較(compare)、インジケーター(indicators)、チャート設定(chartSettings)、チャートデータのエクスポート(exportData)、ショートカット一覧(shortcuts)のウィンドウを開きます
notify(text) チャートの上に通知を 1 つ表示します。ユーザーは閉じられます
getChartView(target?) 1 つのチャートが表示している内容で、状態に保存されるものと同じです:銘柄、時間足、チャートタイプと足の種類ごとの設定、インジケーター、比較銘柄、価格軸、現在値、そしてユーザーがドラッグしたペインの高さ(paneHeights)
getLayout() レイアウト:grid(チャートの枚数)、active(現在のチャート)、links(ほかのチャートが現在のチャートの何に追従するか)
getState() 状態全体(ChartState)。storage に保存するものと同じです。「状態の保存」を参照
setState(state) getState() が返した状態を表示します。チャートはそれに従って作り直されます
getDrawings(target?) あるチャートのある銘柄の描画。target は { chart?, symbol? } で、渡さなければ現在のチャートとその銘柄です。描画はチャートに属し、表示していない銘柄の分も保存されています
addDrawing(drawing, symbol?) 銘柄に描画を 1 つ追加し、その id を返します。下の「メソッドで描画する」を参照
updateDrawing(id, patch, symbol?) 描画を変えます。points、text、timeframes などはまるごと置き換え、style はフィールドごとにマージします
removeDrawing(id, symbol?) 描画を削除します。描画上のアラートも一緒に削除します
on(event, listener) イベントをリッスンし、リッスンをやめる関数を返します
destroy() チャートをページから取り除き、相場の購読を止めます。まだ待ち行列にある呼び出しは一緒に reject されます

chart、charts、on、destroy 以外のメソッドはどれも Promise を返します:

  • 準備ができる前の呼び出しは待ち行列に入り、準備ができたら呼び出した順に実行するので、作成直後に呼んでも問題ありません。結果が要らなければそのまま呼べば十分です。destroy() の時点でまだ待ち行列にある呼び出しは、それ以降の呼び出しと同じく reject されます:The pro chart was destroyed: create another one.
  • 使い方を間違えると Promise が reject され、エラーメッセージがどこが違うか、何を書けるかを示します。たとえば There is no indicator "RSII": the types are MA, EMA, …、The timeframe "7m" is not offered: the timeframes are 1m, 5m, … です。インジケーターのパラメーター、データソース、基準線はチャートライブラリの checkIndicatorInput() で検査し(価格帯別出来高も同じ)、エラーメッセージはチャートライブラリの chart.indicators.add() と同じで、たとえば params.period must be at least 1, received 0. です。設定に書き間違えたフィールド(たとえば param)があっても reject され、黙って効かないということはありません。
  • メソッドはデフォルトで現在のチャート(トップバーで強調されているもの)に働きます。target を取るメソッドは、現在のチャートを変えずにレイアウト内の別のチャートを操作できます。{ chart: 1 } は 2 枚目(0 から)で、たとえば addIndicator('RSI', {}, { chart: 1 }) です。
const id = await chart.addIndicator('RSI', { params: { period: 6 } });
await chart.updateIndicator(id, { lines: { rsi: { color: '#f59e0b', width: 2 } } });
chart.setLayout('columns');
chart.startReplay(Date.UTC(2026, 0, 5)); // 2026-01-05 の足からリプレイ

インジケーターをどのペインに描くかは pane で決まります。null(デフォルト)はインジケーターのタイプに従い、メインペイン用のインジケーターはローソク足の上に、それ以外は専用のペインに、出来高はローソク足の下部に描きます。'main' はローソク足の上に描きます(本来専用のペインに描くインジケーターは、ローソク足の上で独自のスケールを使い、ローソク足を押しつぶしません)。'new' は専用のペインです。チャートでそれより前にある別のインジケーターの id を書くと、そのインジケーターとペインを共有します。共有していたインジケーターが削除されると、タイプに従って描きます。ユーザーがペインの境目をドラッグして変えた高さは状態に保存され、次に開いても同じ高さです。

const rsi = await chart.addIndicator('RSI');
await chart.addIndicator('KDJ', { pane: rsi }); // RSI と同じペインに描く
await chart.updateIndicator('vol-1', { pane: 'new' }); // 出来高を専用のペインに

ユーザーも画面上で移動できます。ポインターを凡例のインジケーターの行に乗せ、末尾の「⋯」ボタンでメニューを開くと、「移動」に「メインチャート」(すでにローソク足の上にあるときはない)、「新規ペイン」(すでにペインを 1 つ占有しているときはない)、そしてほかのペインにある各インジケーターが、凡例の名前で「MACD 12 26 9 と同じペイン」のように並びます。それより後ろにあるインジケーターのペインへ移すと、チャート上での順序もそのインジケーターの後ろへ一緒に移るので、前後を気にする必要はありません。元のペインで一緒だったインジケーターはそのペインに残り、位置もユーザーがドラッグした高さも変わりません。移したものがペインの先頭だったときは、残ったインジケーターのチャート上での順序がその前に移り、ペインは残った最初のインジケーターで記録されます(paneHeights の高さもそちらへ移ります)。新規ペインに移したものは、常にいちばん下に新しいペインを開きます。移した結果は updateIndicator() で pane を変えたのと同じく状態に保存され、ペインの高さもこれまで通り記憶されます。価格帯別出来高はローソク足の上に描き、ペインを占めないので、このメニューはありません。

chart と charts はチャートライブラリの Chart で、そのメソッド(座標の変換、スクリーンショット、マーカーなど)を直接使えます。インジケーターと描画は上のメソッドで変えてください。chart に直接追加したインジケーターはプロチャートが把握しておらず、次の同期で取り除かれます。

チャートは作り直されることがあります。マルチチャートレイアウトの切り替え、setState()、コンテナが狭くなって現在のチャートだけを表示するときは、元の Chart が新しいものに替わります。ページが各チャートに独自のマーカーやラインを置くには、chartReady をリッスンします。各チャートができたとき(最初のチャートも含む)に発火し、そのチャートのレイアウト内での位置、新しい Chart、表示している銘柄と時間足が付きます:

chart.on('chartReady', ({ instance, symbol }) => {
  instance.markers.set(myTrades(symbol)); // ページ独自の約定マーカー
});

チャートが銘柄や時間足を替えても Chart は変わりません。symbolChange、timeframeChange に合わせて自分で描いたものを更新します。銘柄、時間足、足の種類を替えたとき、チャートは元の時間と拡大率のままです。最新の足を見ていたなら、新しい最新の足が元の位置に現れます(右側の余白は変わりません)。過去をさかのぼって見ていたなら、右端の時間は変わらず、新しいデータが十分古くまでないときは、先に過去のデータを読み込んでからその時間に戻ります。

メソッドで描画する

描画はチャートに属します:各チャート(各タブ)の描画は、描いたときにチャートが表示していた銘柄ごとに分けて、そのチャートの状態(ChartView.drawings)に保存されます。チャートの銘柄を替えてまた戻しても、元の描画は残っています。1 つのレイアウトの複数のチャートは、デフォルトで描画を共有します(links.drawings がオン。トップバーのレイアウトメニューの「描画を同期」)。同じ銘柄を表示しているチャートは 1 つの描画を共有し、レイアウトの最初のチャートの状態に保存され、どのチャートで描いても、変えても、元に戻してもやり直しても同じです。別の銘柄を表示しているチャートは、その銘柄自身の描画を使います。「描画を同期」をオフにすると、各チャートはそれぞれ別に描きます。オフにしたときは各チャートがその時点の描画のコピーを受け取り、オンにしたときは各チャートの描画が最初のチャートにまとめられます(同じ id は 1 つとみなす)。新しくチャートを開くと、元のチャートの状態を(その描画ごと)コピーし、その後はそれぞれ別に描きます。アラートは引き続き銘柄ごとに保存され、監視する描画は各チャートから探します(同じ描画をコピーした複数のチャートでは id が同じで、1 つとみなします)。

addDrawing() などのメソッドの target は { chart?, symbol? } で、chart はレイアウト内でのチャートの位置、symbol は銘柄です。どちらも渡さなければ、現在のチャートとそれが表示している銘柄です:

  • そのチャートがその銘柄を表示しているときは、そのチャート上で変えます。ユーザーが描いたのと同じで、元に戻せます。
  • そうでなければ、チャートのルールで検査してからそのチャートに保存し、その銘柄を表示したときに現れます。

描画の形式はチャートライブラリの chart.drawings.add() と同じで(type、points、style、text、timeframes など。チャートライブラリの描画のドキュメントを参照)、id を渡さなければ自動で作ります。座標は渡した時間と価格に正確に設定し、吸着しません。

const id = await chart.addDrawing({
  type: 'horizontal-line',
  points: [{ time: Date.UTC(2026, 0, 5), price: 1688 }],
  style: { color: '#e5484d', lineStyle: 'dashed' },
  text: 'レジスタンス'
});
await chart.updateDrawing(id, { style: { extendRight: true } });
await chart.addDrawing({ type: 'rectangle', points: [/* … */] }, { chart: 1, symbol: '000001.SZ' }); // 2 枚目のチャート、別の銘柄

変化のたびに(ユーザーが描いた・変えたものでも、メソッドで変えたものでも)drawingsChange が発火し、そのチャートのその銘柄のすべての描画が付きます。

↑↓ で選択 · Enter で開く · Esc で閉じる