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`

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

Import @sixtyfold/lineclass

class ChartRendererError extends Error

Member	Definition	Description
`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`	フラッシュ前に、整列されたFloat64Arrayタイムスタンプおよびシリーズ列が有限のタイムスタンプであることを検証します。検証に失敗した場合はキューと呼び出し側バッファを保持します；有効なワーカーモードの追加ではバッファを転送しdetachします。投げる例外: 列が不正形態であるか任意のタイムスタンプが非有限の場合は Error を投げます。
`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`	正の整数の series count と capacity を用いて固定容量のストリーミングバッファを割り当てます。前のストリームからキューされたサンプルをリセットし、保留中のビューポートアニメーションをキャンセルします。
`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`	インデックスによる単一系列の視覚設定をパッチ適用します。