LineChart API

インポート

import { LineChart } from "@sixtyfold/line";

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

`ChartOverlayError`

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

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

class ChartOverlayError extends Error

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

`ChartRendererError`

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

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

class ChartRendererError extends Error

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

`LineChart`

線、ステップ、範囲、散布、棒、および積み上げ面系列のための命令型ブラウザチャート。

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

class LineChart

メンバー	定義	説明
`addVector`	`(timestamp: number, values: number[]) => void`	各シリーズに対してストリーミングバッファにタイムスタンプ1件と値1件を追加します。
`addVectors`	`(timestamps: Float64Array, valuesBySeries: Float64Array[]) => void`	整列されたタイムスタンプとシリーズ列をストリーミングバッファに追加します。
`batch`	`(fn: () => void) => void`	同期的な外観とビューポートの変更を1回の更新にまとめます。ネストしたバッチは統合され、データ読み込みは直ちに実行されます。
`destroy`	`() => void`	チャートとその所有リソースを解放します。
`getAppearance`	`() => DeepReadonly<LineAppearanceOptions>`	変更可能な外観サブセットの読み取り専用スナップショットを返します。
`getOptions`	`() => DeepReadonly<LineChartOptions>`	全てのオプション（構築時 + 現在の外観）の正規化された読み取り専用スナップショットを返します。
`getRenderMode`	`() => "worker" \| "main"`	解決されたレンダリングモード（"Worker" または "メイン"）を返します。
`getSeriesVisibility`	`() => boolean[]`	シリーズの表示状態を返します。
`getViewport`	`() => Viewport`	現在のビューポートのスナップショットを返します。
`initialize`	`() => Promise<void>`	レンダラーがデータとランタイムコマンドの受け入れ準備が整うまで待ちます。構築時の初期化ウォッチドッグは、Worker またはメインスレッドのフォールバックが設定された間隔内に準備できない場合、`ChartRendererError` でこのプロミスを拒否します。アプリケーションは最初のデータセットをインストールする前にこのメソッドをawaitする必要があります。
`initStreaming`	`(seriesCount: number, maxPoints?: number) => void`	設定された系列数分の固定容量ストリーミングバッファを割り当てます。
`reset`	`(options?: { animated?: boolean; }) => void`	ビューポートをデータの全範囲にリセットします。
`resize`	`() => void`	レンダラーをキャンバスサイズに同期させます。
`setData`	`(data: TimeSeriesData, options?: LineDataUpdateOptions) => number`	1 系列を読み込み、その typed array の所有権をレンダラーに渡します。Worker モードではバッファが転送されて切り離され、メインスレッドモードではレンダラーが配列への参照を保持します。データ世代番号を返します。
`setKeyboardAnnouncements`	`(messages: false \| KeyboardAnnouncementMessages) => void`	ローカライズされたキーボード操作のアナウンスを実行時に置き換えるか無効化します。既存の保留中のアナウンスはキャンセルされます。
`setLabels`	`(labels: ChartLabels) => void`	ランタイムにチャートのラベルを更新します。既存ラベルにマージされます（updateAppearanceと同じ意味）。不正なラベル、または疎な／オブジェクトでない`custom`エントリの場合はTypeErrorをスローします。
`setLODOptions`	`(patch: LineLODOptions) => void`	モード、密度、リベース比率、またはグリッド量子化に対して、チャートの再作成や階層の再構築を行わずに部分的な更新を適用します。
`setMultiSeriesData`	`(data: MultiSeriesData, options?: LineDataUpdateOptions) => number`	共通の X 列を持つ整列系列を読み込み、その typed array の所有権をレンダラーに渡します。Worker モードではバッファが転送されて切り離され、メインスレッドモードではレンダラーが配列への参照を保持します。データ世代番号を返します。
`setOverlay`	`(overlay: OverlayOptions) => Promise<void>`	ランタイムで宣言的オーバーレイプリミティブを更新します。有効なプリミティブと正常にデコードされた画像は、別の画像が失敗してもインストールされます。要求されたすべての項目が失敗した場合、以前にレンダリングされたオーバーレイが引き続きインストールされたままになります。解像度またはレンダラー配信の失敗は`ChartOverlayError`で拒否されます。アプリケーションが非同期通知を必要とする場合は`setOverlayErrorCallback`を登録してください。レイジーレンダラーが準備完了する前に呼び出された場合、このプロミスは準備待ちを含みます。上書きされた更新とチャート破棄は通常のキャンセルであり、インストールせずに解決します。
`setOverlayErrorCallback`	`(callback: OverlayErrorCallback \| null) => void`	非致命のオーバーレイ解決または配信失敗に対するコールバックを登録します。成功したオーバーレイ項目は引き続きインストールされます。対応する`setOverlay`プロミスも同じエラーで拒否されます。
`setRendererErrorCallback`	`(callback: RendererErrorCallback \| null) => void`	ワンショットのレンダラー故障コールバックを登録します。初期化またはランタイムの故障でテアダウン前に一度呼び出されます。コールバックがない場合、エラーは`console.error`を使用します。キャンセルするには`null`を渡してください；`destroy`の呼び出しはこれを呼び出しません。
`setSeriesVisibilityCallback`	`(callback: ((event: SeriesVisibilityChangeEvent) => void) \| null) => void`	API またはインタラクティブ凡例を介した表示状態の変更を受信します。
`setSeriesVisible`	`(index: number, visible: boolean) => void`	インデックスで指定したシリーズを表示または非表示にします。
`setStatsCallback`	`(callback: ((stats: LineChartStats) => void) \| null, options?: LineChartStatsOptions) => void`	レンダラー統計を有効にし、スロットルされたスナップショットを受信します。無効にするには `null` を渡してください。
`setViewport`	`(viewport: Partial<Viewport>, options?: { animated?: boolean; }) => void`	ビューポート範囲をプログラムで設定します。`xMin` および／または `xMax` のみを指定すれば十分です。省略されたフィールドは現在の値を保持します。
`setVisibleSeries`	`(indices: number[]) => void`	表示されるのは列挙されたシリーズのインデックスのみです。
`toggleSeriesVisibility`	`(index: number) => void`	シリーズの表示/非表示を切り替えます。
`updateAppearance`	`(patch: DeepPartial<LineAppearanceOptions>) => void`	実行時に変更可能な外観オプションをパッチします。例外: ラベルが不正、またはスパース/オブジェクトでない`custom`エントリの場合はTypeErrorをスローします。
`updateSeriesAppearance`	`(index: number, patch: DeepPartial<SeriesAppearanceOptions>) => void`	単一シリーズの視覚設定をインデックスでパッチします。