StockChart API

インポート

import { StockChart } from "@sixtyfold/stock";

上記の公開エントリポイントを使用します。型のみのインポートはアプリケーション JavaScript から削除されます。

`ChartOverlayError`

1 つ以上の宣言的オーバーレイソースを適用できない場合に報告されるエラー。

インポート @sixtyfold/stockクラス

class ChartOverlayError extends Error

メンバー	定義	説明
`cause?`	`Error \| undefined`	チャートオーバーレイのエラー原因。
`message`	`string`	メッセージ本文。
`name`	`"ChartOverlayError"`	このチャートオーバーレイエラーの表示名。
`sources`	`readonly string[]`	チャートオーバーレイエラーの発生源。
`stack?`	`string \| undefined`	スタックテキスト。

`ChartRendererError`

チャートレンダラーが起動時または使用中に失敗したときに報告されるエラー。

インポート @sixtyfold/stockクラス

class ChartRendererError extends Error

メンバー	定義	説明
`cause?`	`Error \| undefined`	チャートレンダラーのエラー原因。
`message`	`string`	メッセージ本文。
`name`	`"ChartRendererError"`	このチャートレンダラーエラーの表示名。
`phase`	`RendererFailurePhase`	チャートレンダラーエラーのフェーズ。
`stack?`	`string \| undefined`	スタックテキスト。

`StockChart`

集約されたOHLCVのキャンドル、出来高、分析、プロファイル、価格線、マーカーを備えた命令型ブラウザチャート。

インポート @sixtyfold/stockクラス

class StockChart

メンバー	定義	説明
`addCandle`	`(timestamp: number, open: number, high: number, low: number, close: number, volume: number) => void`	キューに入れられた、または追加された各キャンドルよりも厳密に後の有限タイムスタンプを持つ OHLCV キャンドルを1つキューします。短時間の連続呼び出しは1フレームのアニメーション内でまとめられます；タイムスタンプを繰り返しても更新操作とは見なされません。
`addCandleBatches`	`(batches: readonly StockCandleBatch[], options?: StockAddCandlesOptions) => void`	キューをフラッシュする前、またはバッファを転送する前に、すべてのOHLCVチャンクが列長一致およびチャンク間と以前の追加を通じた有限かつ厳密に増加するタイムスタンプを満たしているか検証します。Workerモードでは有効なバッファを転送します；メインスレッドモードでは配列を参照渡しで保持します。
`addCandles`	`(timestamps: Float64Array, opens: Float64Array, highs: Float64Array, lows: Float64Array, closes: Float64Array, volumes: Float64Array, options?: StockAddCandlesOptions) => void`	キューに溜まっている、または追加された全てのローソク足後に、等幅の6つのOHLCV列と有限で厳密に増加するタイムスタンプを検証してからキューをフラッシュします。無効な入力はキュー内のローソク足と呼び出し元のバッファを保持します；Workerモードでは有効なバッファを転送し、メインスレッドモードでは配列を参照で保持します。
`batch`	`(fn: () => void) => void`	同期的な外観とビューポートの変更を1回の更新にまとめます。ネストしたバッチは統合され、データ読み込みは直ちに実行されます。
`destroy`	`() => void`	チャートとそれが所有するリソースを解放します。
`getAppearance`	`() => DeepReadonly<StockAppearanceOptions>`	可変の外観サブセットの読み取り専用スナップショットを返します。
`getOptions`	`() => DeepReadonly<StockChartOptions>`	すべてのオプション（構築時設定と現在の表示）の完全に正規化された読み取り専用スナップショットを返します。
`getRenderMode`	`() => "worker" \| "main"`	レンダリングモード（"Worker"または"メイン"）の解決結果を返します。
`getViewport`	`() => Viewport`	現在のビューポートのスナップショットを返します。
`initialize`	`() => Promise<void>`	レンダラーがデータおよびランタイムコマンドの受け入れ準備ができるまで待機します。構築時初期化ウォッチドッグは、Workerまたはメインスレッドのフォールバックが設定された間隔内に準備完了とならない場合、`ChartRendererError` でこのプロミスを拒否します。アプリケーションは最初のデータセットを設定する前にこのメソッドを await するべきです。
`initStreaming`	`(maxCandles?: number) => void`	ライブ更新のために正の整数の OHLCV リングバッファ容量を割り当てます。保留中のキャンドルとタイムスタンプ順序状態をリセットし、以前のデータセットの保留中ビューポートアニメーションをキャンセルします。
`reset`	`(options?: { animated?: boolean; }) => void`	ビューポートをデータ全体の範囲にリセットします。
`resize`	`() => void`	レンダラーをキャンバスサイズと同期します。
`setData`	`(data: OHLCVData) => void`	同じサイズの OHLCV 列を6つ読み込み、有限で単調に昇順または降順のタイムスタンプ（同一タイムスタンプを含む）で順序を正規化します。Worker モードでは正規化されたバッファを転送し、メインスレッドモードでは配列を参照で保持します。保留中のストリーミングサンプルを置換し、古いビューポートアニメーションをキャンセルします。
`setIndicators`	`(indicators: StockIndicator[]) => void`	組み込みのテクニカル指標定義を置き換えます。
`setKeyboardAnnouncements`	`(messages: false \| KeyboardAnnouncementMessages) => void`	ローカライズされたキーボード操作のアナウンスを実行時に置換または無効化します。既存の保留中のアナウンスはキャンセルされます。
`setLabels`	`(labels: ChartLabels) => void`	チャートラベルを実行時に更新します。既存のラベルにマージします（updateAppearanceと同じ意味）。不正なラベルや疎な/オブジェクトでない`custom`エントリの場合は、TypeErrorをスローします。
`setMarkers`	`(markers: StockMarker[]) => void`	すべての疎なタイムスタンプ/価格マーカーを置き換えます。
`setOverlay`	`(overlay: OverlayOptions) => Promise<void>`	実行時に宣言型オーバーレイ原始要素を更新します。有効な原始要素と正常にデコードされた画像は、別の画像が失敗した場合でもインストールされます。要求された全ての項目が失敗した場合は、以前にレンダリングされたオーバーレイがそのまま残ります。解像度やレンダラー配信の失敗は`ChartOverlayError`で拒否されます。アプリケーションが非同期通知も必要とする場合は`setOverlayErrorCallback`を登録してください。遅延レンダラーが準備できていない状態で呼び出された場合、このプロミスには準備完了待ちが含まれます。上書きされた更新とチャートの破棄は通常のキャンセルであり、インストールせずに解決します。
`setOverlayErrorCallback`	`(callback: OverlayErrorCallback \| null) => void`	致命的でないオーバーレイの解決または配信失敗に対するコールバックを登録します。成功したオーバーレイ項目は引き続きインストールされます。一致する`setOverlay`プロミスも同じエラーで拒否されます。
`setPriceLines`	`(priceLines: StockPriceLine[]) => void`	水平データアンカー付きの価格レベルをすべて置換します。
`setRendererErrorCallback`	`(callback: RendererErrorCallback \| null) => void`	ワンショットのレンダラー失敗コールバックを登録します。初期化またはランタイムの失敗時にテアダウン前に一度呼ばれます。コールバックがない場合、エラーは`console.error`を使用します。キャンセルするには`null`を渡してください；`destroy`の呼び出しはこれを呼び出しません。
`setStatsCallback`	`(callback: ((stats: StockChartStats) => void) \| null, options?: StockChartStatsOptions) => void`	レンダラーの統計を有効にし、スロットルされたスナップショットを受け取ります。無効化するには`null`を渡してください。
`setTimeRange`	`(range: TimeRange) => void`	エクスポートされたカレンダー／セッションのプリセットのいずれかを適用します。チャートはコントロールをレンダリングしません。アプリケーション所有のコントロールはプリセットに対してこのメソッドを呼び出すか、任意のタイムスタンプ範囲には`setViewport()`を呼んでください。
`setViewport`	`(viewport: Partial<Viewport>, options?: { animated?: boolean; }) => void`	タイムスタンプ範囲を設定します。マーケット時間では、省略された端点は以前のリクエスト後にレンダラー内で解決され、承認された範囲同期の後にgetViewport()が続きます。
`setVolumeProfile`	`(volumeProfile: VolumeProfileOptions \| false) => void`	推定されたローソク足由来の可視範囲ボリュームプロファイルを置き換えるか無効にします。
`updateAppearance`	`(patch: DeepPartial<BaseAppearanceOptions>) => void`	実行時に可変の外観オプションをパッチ適用します。例外: ラベルが不正、または疎/オブジェクトでない `custom` エントリの場合は TypeError を投げます。