LineChart API
LineChart méthodes 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.
Importer @sixtyfold/line·classe
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 pour cette superposition d’erreur de graphique. |
sources | readonly string[] | Sources de l’erreur de superposition du graphique. |
stack? | string | undefined | Texte de la pile. |
ChartRendererError
Erreur signalée lorsqu’un renderer de graphique échoue au démarrage ou lors d’une utilisation ultérieure.
Importer @sixtyfold/line·classe
class ChartRendererError extends Error| Membre | Définition | Description |
|---|---|---|
cause? | Error | undefined | Cause de l’erreur du moteur de rendu du graphique. |
message | string | Texte du message. |
name | "ChartRendererError" | Nom d'affichage pour cette erreur de renderer de graphique. |
phase | RendererFailurePhase | Phase pour l'erreur du renderer de graphique. |
stack? | string | undefined | Texte de la pile. |
LineChart
Graphique impératif pour navigateur pour séries de type line, step, range, scatter, bar et stacked-area.
Importer @sixtyfold/line·classe
class LineChart| Membre | Définition | Description |
|---|---|---|
add | (timestamp: number, values: number[]) => void | Ajoute un horodatage et une valeur par série au tampon de streaming. |
add | (timestamps: Float64Array, valuesBySeries: Float64Array[]) => void | Ajoute des colonnes alignées d’horodatage et de séries au tampon de streaming. |
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 graphique et les ressources qu'il possède. |
get | () => DeepReadonly<LineAppearanceOptions> | Retourne un instantané en lecture seule du sous-ensemble mutable d'apparence. |
get | () => DeepReadonly<LineChartOptions> | Retourne un instantané complet et normalisé en lecture seule de toutes les options (construction + apparence actuelle). |
get | () => "worker" | "main" | Renvoie le mode de rendu résolu ("worker" ou "thread principal"). |
get | () => boolean[] | Renvoie la visibilité de la série. |
get | () => Viewport | Renvoie 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 à la construction rejette cette promesse avec une ChartRendererError lorsque le worker ou le fallback sur thread principal ne devient pas prêt dans l'intervalle configuré. Les applications doivent awaiter cette méthode avant d'installer leur premier jeu de données. |
init | (seriesCount: number, maxPoints?: number) => void | Alloue un tampon de streaming à capacité fixe pour le nombre de séries configuré. |
reset | (options?: { animated?: boolean; }) => void | Réinitialise la fenêtre d’affichage sur 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 étiquettes du graphique à l’exécution. Fusionne avec les étiquettes existantes (mêmes sémantiques que updateAppearance). Lève : TypeError pour des étiquettes malformées ou des entrées clairsemées/non-objet custom. |
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> | Met à jour les primitives de superposition déclaratives à l’exécution. Les primitives valides et les images décodées avec succès sont installées même lorsqu’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 nécessite aussi une notification asynchrone. Lorsqu’appelée avant que le renderer paresseux soit prêt, cette promesse inclut l’attente de disponibilité. Les mises à jour supplantées et la destruction du graphique constituent 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 des superpositions. 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 de défaillance du renderer à usage unique. Appelé une fois avant le démontage pour les défaillances 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 throttlés. Passe null pour les désactiver. |
set | (viewport: Partial<Viewport>, options?: { animated?: boolean; }) => void | Définit programmatique le périmètre de la fenêtre d’affichage. Seuls xMin et/ou xMax doivent être fournis ; les champs omis conservent les 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 | Modifie par patch les options d’apparence mutables à l’exécution. Lève : TypeError pour des libellés mal formés ou des entrées custom clairsemées/non-objet. |
update | (index: number, patch: DeepPartial<SeriesAppearanceOptions>) => void | Modifie par patch la configuration visuelle d’une seule série par index. |