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`	1本のOHLCVキャンドルをストリーミングバッファに追加し、連続した呼び出しを1つのアニメーションフレームにまとめます。
`addCandleBatches`	`(batches: readonly StockCandleBatch[], options?: StockAddCandlesOptions) => void`	複数の OHLCV チャンクを 1 回のレンダラー更新でインストールします。Worker モードでは各チャンクのバッファが転送されて切り離され、メインスレッドモードでは配列への参照が保持されます。
`addCandles`	`(timestamps: Float64Array, opens: Float64Array, highs: Float64Array, lows: Float64Array, closes: Float64Array, volumes: Float64Array, options?: StockAddCandlesOptions) => void`	整列した OHLCV 列を 1 回のレンダラー更新で追加します。Worker モードでは指定したバッファが転送されて切り離され、メインスレッドモードでは配列への参照が保持されます。
`batch`	`(fn: () => void) => void`	同期的な外観とビューポートの変更を1回の更新にまとめます。ネストしたバッチは統合され、データ読み込みは直ちに実行されます。
`destroy`	`() => void`	チャートとその所有リソースを解放します。
`getAppearance`	`() => DeepReadonly<StockAppearanceOptions>`	変更可能な表示サブセットの読み取り専用スナップショットを返します。
`getOptions`	`() => DeepReadonly<StockChartOptions>`	すべてのオプション（構築時設定＋現在の表示）を正規化した読み取り専用のスナップショットを返します。
`getRenderMode`	`() => "worker" \| "main"`	解決されたレンダリングモード（"worker" または "main"）を返します。
`getViewport`	`() => Viewport`	現在のビューポートのスナップショットを返します。
`initialize`	`() => Promise<void>`	レンダラーがデータとランタイムコマンドの受け付け準備が整うまで待機します。ワーカーまたはメインスレッドのフォールバックが設定された間隔内に準備できない場合、構築時の初期化ウォッチドッグはこのプロミスを`ChartRendererError`で拒否します。アプリケーションは最初のデータセットをインストールする前にこのメソッドをawaitするべきです。
`initStreaming`	`(maxCandles?: number) => void`	ライブ更新用の固定容量OHLCVリングバッファを割り当てます。
`reset`	`(options?: { animated?: boolean; }) => void`	ビューポートをデータの全範囲にリセットします。
`resize`	`() => void`	レンダラーをキャンバスサイズと同期させます。
`setData`	`(data: OHLCVData) => void`	整列した OHLCV 列を読み込み、正規化された配列の所有権をレンダラーに渡します。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`	ビューポート範囲をプログラム的に設定します。提供する必要があるのは `xMin` および／または `xMax` のみで、省略されたフィールドは現在の値を維持します。
`setVolumeProfile`	`(volumeProfile: VolumeProfileOptions \| false) => void`	推定されたローソク足由来の可視範囲ボリュームプロファイルを置換または無効化します。
`updateAppearance`	`(patch: DeepPartial<BaseAppearanceOptions>) => void`	実行時に変更可能な外観オプションをパッチします。例外: ラベルの形式不正、またはスパース／オブジェクト以外の`custom`エントリの場合はTypeErrorをスローします。