LineChart API
méthodes LineChart pour charger des données, diffuser des échantillons, contrôler la fenêtre d’affichage et mettre à jour l’apparence.
import { LineChart } from "@sixtyfold/line";Utilisez le point d’entrée public ci-dessus. Les imports de types sont retirés du JavaScript de l’application.
ChartOverlayError
Erreur signalée lorsqu’une ou plusieurs sources de superposition déclaratives ne peuvent pas être appliquées.
Import @sixtyfold/line·class
class ChartOverlayError extends Error| Membre | Définition | Description |
|---|---|---|
cause? | Error | undefined | Cause d'erreur de superposition de graphique. |
message | string | Texte du message. |
name | "ChartOverlayError" | Nom d’affichage de cette erreur de superposition de graphique. |
sources | readonly string[] | Sources de l’erreur de superposition de graphique. |
stack? | string | undefined | Texte de la pile. |
ChartRendererError
Erreur signalée lorsqu’un moteur de rendu de graphique échoue au démarrage ou lors d’une utilisation ultérieure.
Import @sixtyfold/line·class
class ChartRendererError extends Error| Member | Definition | Description |
|---|---|---|
cause? | Error | undefined | Cause for chart renderer error. |
message | string | Message text. |
name | "ChartRendererError" | Nom d’affichage pour cette erreur du moteur de rendu de graphique. |
phase | RendererFailurePhase | Phase pour une erreur du moteur de rendu de graphique. |
stack? | string | undefined | Texte de la pile. |
LineChart
Graphique impératif pour navigateur pour les séries line, step, range, scatter, bar et stacked-area.
Importer @sixtyfold/line·classe
class LineChart| Membre | Définition | Description |
|---|---|---|
add | (timestamp: number, values: number[]) => void | Met en file d’attente un horodatage fini et une valeur par série configurée. Copie les valeurs avant la mise en file afin que l’appelant puisse réutiliser le tableau scalaire ; les appels scalaires et en masse valides conservent leur ordre. |
add | (timestamps: Float64Array, valuesBySeries: Float64Array[]) => void | Valide les colonnes alignées Float64Array d’horodatage et de séries avec des horodatages finis avant de vidanger les échantillons scalaires en file. Les échecs de validation préservent la file et les tampons de l’appelant ; les ajouts en mode worker valides transfèrent et détachent les tampons. Lève : Error si les colonnes sont mal formées ou si un horodatage est non fini. |
batch | (fn: () => void) => void | Regroupe les changements synchrones d’apparence et de viewport en une mise à jour. Les lots imbriqués sont combinés ; le chargement des données reste immédiat. |
destroy | () => void | Libère le chart et les ressources qui lui appartiennent. |
get | () => DeepReadonly<LineAppearanceOptions> | Renvoie un instantané en lecture seule du sous-ensemble modifiable d'apparence. |
get | () => DeepReadonly<LineChartOptions> | Renvoie un instantané normalisé et complet en lecture seule de toutes les options (construction + apparence actuelle). |
get | () => "worker" | "main" | Retourne le mode de rendu résolu ("worker" ou "thread principal"). |
get | () => boolean[] | Retourne la visibilité de la série. |
get | () => Viewport | Retourne un instantané du viewport actuel. |
initialize | () => Promise<void> | Attendez que le renderer soit prêt à recevoir des données et des commandes d’exécution. Le watchdog d’initialisation au moment de la construction rejette cette promesse avec un ChartRendererError lorsque le worker ou le fallback sur thread principal ne devient pas prêt dans l’intervalle configuré. Les applications doivent await cette méthode avant d’assigner leur premier jeu de données. |
init | (seriesCount: number, maxPoints?: number) => void | Alloue un tampon de streaming à capacité fixe en utilisant un entier positif pour le nombre de séries et la capacité. Réinitialise les échantillons en file d’attente du flux précédent et annule son animation de fenêtre d’affichage en attente. |
reset | (options?: { animated?: boolean; }) => void | Réinitialise la fenêtre d’affichage à l’étendue complète des données. |
resize | () => void | Synchronise le renderer avec la taille du canvas. |
set | (data: TimeSeriesData, options?: LineDataUpdateOptions) => number | Charge une série et cède au moteur de rendu la propriété de ses typed arrays. En mode worker, les buffers sont transférés puis détachés ; sur le thread principal, le moteur de rendu conserve des références. Renvoie la génération des données. |
set | (messages: false | KeyboardAnnouncementMessages) => void | Remplacez ou désactivez les annonces localisées des actions clavier à l’exécution. Les annonces en attente existantes sont annulées. |
set | (labels: ChartLabels) => void | Mettez à jour les libellés du graphique à l’exécution. Fusionne avec les libellés existants (mêmes sémantiques que updateAppearance). Lance : TypeError pour des libellés malformés ou des entrées custom clairsemées/non-objet. |
set | (patch: LineLODOptions) => void | Appliquez une mise à jour partielle du mode, de la densité, du ratio de rebase ou de la quantification de la grille sans recréer le graphique ni reconstruire sa hiérarchie. |
set | (data: MultiSeriesData, options?: LineDataUpdateOptions) => number | Charge des séries alignées partageant une colonne X et cède au moteur de rendu la propriété de leurs typed arrays. En mode worker, les buffers sont transférés puis détachés ; sur le thread principal, le moteur de rendu conserve des références. Renvoie la génération des données. |
set | (overlay: OverlayOptions) => Promise<void> | Mettre à jour les primitives de superposition déclaratives à l’exécution. Les primitives valides et les images correctement décodées sont installées même si une autre image échoue. Si chaque élément demandé échoue, la superposition précédemment rendue reste installée. Les échecs de résolution et de livraison du renderer rejettent avec ChartOverlayError ; enregistrez setOverlayErrorCallback lorsque l’application a également besoin d’une notification asynchrone. Lorsqu’elle est appelée avant que le renderer lazy soit prêt, cette promesse inclut l’attente de disponibilité. Les mises à jour supplantées et la destruction du chart sont des annulations routinières et se résolvent sans installation. |
set | (callback: OverlayErrorCallback | null) => void | Enregistrez un rappel pour les échecs non fatals de résolution ou de livraison de la superposition. Les éléments de superposition réussis sont toujours installés. La promesse correspondante setOverlay est également rejetée avec la même erreur. |
set | (callback: RendererErrorCallback | null) => void | Enregistrez un rappel one-shot pour les défaillances du renderer. Appelé une fois avant le teardown pour des échecs d’initialisation ou d’exécution. Sans rappel, les erreurs utilisent console.error. Passez null pour l’annuler ; les appels destroy ne l’invoquent pas. |
set | (callback: ((event: SeriesVisibilityChangeEvent) => void) | null) => void | Reçoit les changements de visibilité effectués via l’API ou la légende interactive. |
set | (index: number, visible: boolean) => void | Affiche ou masque une série par index. |
set | (callback: ((stats: LineChartStats) => void) | null, options?: LineChartStatsOptions) => void | Active les statistiques du renderer et reçoit des instantanés à fréquence limitée. Passez null pour les désactiver. |
set | (viewport: Partial<Viewport>, options?: { animated?: boolean; }) => void | Définissez la plage de la fenêtre d’affichage par programme. Seuls xMin et/ou xMax doivent être fournis ; les champs omis conservent leurs valeurs actuelles. |
set | (indices: number[]) => void | N’affiche que les indices de séries listés. |
toggle | (index: number) => void | Bascule la visibilité des séries. |
update | (patch: DeepPartial<LineAppearanceOptions>) => void | Applique un patch aux options d’apparence mutables à l’exécution. Lève : TypeError pour des étiquettes malformées ou des entrées custom clairsemées/non-objet. |
update | (index: number, patch: DeepPartial<SeriesAppearanceOptions>) => void | Applique un patch de configuration visuelle pour une seule série par index. |