Kumo Charts

ボタン・メニュー・ウォッチリスト

独自のボタン

buttons はページのボタンをチャートの中に置き、見た目は組み込みのものと同じです:

createProChart(container, {
  datafeed,
  symbol: '600519.SH',
  buttons: [
    // トップバーの左側、組み込みのツールの後ろ。
    { id: 'trade', text: '注文', icon: 'plus', onClick: () => openOrderTicket() },
    // トップバーの右側、メニュー付き。
    {
      id: 'share',
      icon: 'more',
      text: '共有',
      placement: 'end',
      items: [
        { id: 'link', label: 'リンクをコピー', onClick: copyLink },
        { type: 'separator' },
        { id: 'image', label: '画像を保存', icon: 'camera', onClick: saveImage }
      ]
    },
    // 描画ツールバーのいちばん下。アイコンだけを表示し、テキストはツールチップ。
    {
      id: 'ruler',
      icon: 'M4 18L18 4M7 15l2 2M11 11l2 2M15 7l2 2',
      text: '定規',
      placement: 'drawings'
    }
  ]
});
フィールド 説明
id 必須。ボタンごとに異なり、buttonClick イベントで使います
text ボタンの文字。アイコンがあるときはツールチップの文言にもなります(幅が狭いときはアイコンだけを表示)。言語ごとに { en, zh, ja, ko } で渡せます。en は必須で、渡していない言語では en を表示します
icon 組み込みのアイコンの名前(bell、star、camera、plus、more など)、または 24×24 のグリッド上の SVG パス(組み込みのアイコンと同じく線で描く)
placement start(デフォルト、トップバーの左側)、end(トップバーの右側、レイアウトボタンの前)、drawings(描画ツールバーのいちばん下。アイコンが必須)
active 押された見た目。リプレイ中のリプレイボタンのように
disabled クリックできない
items メニュー項目。ボタンをクリックするとメニューが開きます
onClick クリックしたときに呼ばれます

クリックすると、まず onClick を呼び、次に buttonClick イベント({ id, item })を発火します。Vue や React ではイベントをリッスンするほうが手軽で、関数をオプションに書かずに済みます。ボタンの状態を変えるには(たとえば active の切り替え)、applyOptions({ buttons }) で新しいボタンのリストを渡します。

メニュー項目:id、label(必須)、icon、checked(チェックマーク。true か false)、disabled、danger(削除のような操作)、tone(文字を上昇か下落の色にする:up、down。買いと売りなど)、field(項目内の数値入力欄。たとえば数量:value、step(矢印キー 1 回で増減する量)、min、onChange。この項目を選んだときも onClick は通常どおり実行され、その中で onChange が記録した値を読みます。文字と入力欄はマウスのある側に寄せるので、メニューがマウスの右側に開くときは文字が左になります)、items(サブメニュー)、onClick。区切り線は { type: 'separator' }、項目のまとまりの上に置く小見出し(選択できない)は { type: 'heading', label } と書きます。小さなボタンを 1 行に並べるには { type: 'buttons', id, buttons, tone, caption, captionHint } と書きます。buttons の各ボタンには id、label、disabled、hint(ポインターを乗せたときのツールチップ。なぜクリックできないかなど)、caption(ポインターを乗せているあいだ、この行の文字の位置に表示する内容)、onClick があり、どれをクリックしてもメニュー項目を 1 つ選んだのと同じになります(メニューが閉じ、contextMenuClick がその id を伝えます)。caption はこの行の文字(たとえば数量)で、ボタンの反対側に置き(field のある項目と同じくマウスのある側に寄せる)、captionHint はそのツールチップです。選んでも選ばなくてもよい選択肢の行は { type: 'chips', id, options, value, onChange } と書きます。options の各要素には value(文字列)と label があり、value は選ばれているもの(null はどれも選ばれていない)です。1 つクリックするとそれが選ばれ、もう一度クリックするとどれも選ばれなくなり、onChange が新しい値を受け取ります。メニューは閉じず、すぐにもう一度 contextMenu を呼んで新しいメニュー項目に替えるので、ほかの項目にそれを選んだあとの状態を表示させられます(メニュー内の数値入力欄を変えたときも同じです)。この 2 種類の行はポインターでしかクリックできず、矢印キーでは飛ばされます。ユーザーはチャート設定の「操作」にある「右クリックメニューを編集」で、チャートの組み込みの項目の一部のチェックを外せます(チャートの設定 hiddenMenu に保存)。ページの項目とチャート設定の項目は常に表示されます。

右クリックメニュー

contextMenu は関数で、チャート上で右クリックするたびに呼ばれ、返したメニュー項目は右クリックメニューのいちばん上に入ります。メニューが開いているあいだに、関数が読んだ Vue のリアクティブなデータ(気配値など)が変わると、もう一度呼んで新しいメニュー項目に替えるので、数量のように価格に応じて変わる数字がリアルタイムに更新されます。読んでいるのが Vue のリアクティブなデータでないとき(React や素の JS のページなど)は、データが変わったら chart.refreshContextMenu() を呼ぶと、開いているメニューがメニュー項目を取り直します。メニューが開いていなければ何もしません。引数はクリックした場所です:chart(何番目のチャートか)、symbol、time(ポインターの下の足の時間)、price(ポインターの位置の価格。銘柄の小数桁に丸める。メインペインにないときは null)。

createProChart(container, {
  datafeed,
  symbol: '600519.SH',
  contextMenu: ({ symbol, price }) =>
    price === null
      ? []
      : [
          { id: 'buy', label: `指値買い ${price}`, onClick: () => order(symbol, 'buy', price) },
          { id: 'sell', label: `指値売り ${price}`, onClick: () => order(symbol, 'sell', price) }
        ]
});

選ぶと、まずメニュー項目の onClick を呼び、次に contextMenuClick イベント({ id, chart, symbol, time, price }。注文ライン上でクリックしたときは order も付く)を発火します。追加されるのは描画領域の右クリックメニューだけで、描画、アラートライン、軸の右クリックメニューは変わりません。メニューが閉じたとき(または別のメニューに替わったとき)は contextMenuClose イベントが発火し、引数は開いたときに contextMenu に渡したものと同じです。たとえばメニューを開いているあいだにクリックした価格にラインを描いていたなら、このとき片付けます。

注文ラインの右クリックメニュー:ページが自分で描いた注文ライン(chart.orders)の上で右クリックすると、引数に order(そのラインの id)が加わり、メニューはそのライン専用になります。ページが返した項目だけで、チャート自身の項目は付きません。order に応じて、そのラインに意味のある操作(注文の取消、ストップの解除など)を返してください。空の配列を返すと、そのライン上の右クリックメニューはチャートの元のメニューのままです。注文ライン以外でクリックしたときは order がなく、これまでと同じです。

ウォッチリスト

ウォッチリストはページ自身のもので(どこに保存し、どう表示するかはページが決めます)、チャートは銘柄検索でその星印を点灯させるだけです。リストにある銘柄の id を watchlist に渡し、ユーザーが星印をクリックするとチャートが watchlistStar を発火し、ページはリストを変えてからもう一度渡します:

const chart = createProChart(container, { datafeed, symbol: 'BTCUSDT', watchlist: myList.ids() });

chart.on('watchlistStar', ({ symbol, starred }) => {
  if (starred) {
    myList.add(symbol);
  } else {
    myList.remove(symbol);
  }

  chart.applyOptions({ watchlist: myList.ids() });
});

星印はポインターを行に乗せたときに表示され、すでにウォッチリストにあるものは常に点灯しています。watchlist を渡さない(または null を渡す)と星印はありません。

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