StockChart API
StockChart méthodes pour charger des données OHLCV, diffuser des chandeliers, contrôler les plages et ajouter des couches de marché.
import { StockChart } from "@sixtyfold/stock";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/stock·class
class ChartOverlayError extends Error| Membre | Définition | Description |
|---|---|---|
cause? | Error | undefined | Cause de l'erreur de superposition du graphique. |
message | string | Texte du message. |
name | "ChartOverlayError" | Nom d’affichage pour 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 rendu de graphique échoue au démarrage ou lors d’une utilisation ultérieure.
Importer @sixtyfold/stock·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 du moteur de rendu de graphique. |
phase | RendererFailurePhase | Phase pour l’erreur du moteur de rendu de graphique. |
stack? | string | undefined | Texte de la pile. |
StockChart
Graphique impératif pour navigateur affichant des chandeliers OHLCV agrégés, le volume, des analyses, des profils, des lignes de prix et des marqueurs.
Import @sixtyfold/stock·class
class StockChart| Membre | Définition | Description |
|---|---|---|
add | (timestamp: number, open: number, high: number, low: number, close: number, volume: number) => void | Met en file une bougie OHLCV avec un horodatage fini strictement postérieur à chaque bougie en file ou appendue. Les appels rapides sont regroupés sur une seule frame d’animation ; répéter un horodatage n’est pas une opération de mise à jour. |
add | (batches: readonly StockCandleBatch[], options?: StockAddCandlesOptions) => void | Valide tous les chunks OHLCV pour l’égalité des longueurs de colonnes et des horodatages finis et strictement croissants à travers les chunks et les append précédents avant de vider les bougies en file ou de transférer tout buffer. En mode worker, les buffers valides sont transférés ; en mode thread principal, les tableaux sont conservés par référence. |
add | (timestamps: Float64Array, opens: Float64Array, highs: Float64Array, lows: Float64Array, closes: Float64Array, volumes: Float64Array, options?: StockAddCandlesOptions) => void | Valide six colonnes OHLCV de taille égale et des horodatages finis et strictement croissants après toutes les chandelles mises en file d’attente ou ajoutées avant la vidange de la file. Les données d’entrée invalides préservent les chandelles en file et les tampons de l’appelant ; en mode worker les tampons valides sont transférés et en mode thread principal les tableaux sont conservés par référence. |
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 ses ressources détenues. |
get | () => DeepReadonly<StockAppearanceOptions> | Renvoie un instantané en lecture seule du sous-ensemble mutable d’apparence. |
get | () => DeepReadonly<StockChartOptions> | Renvoie un instantané normalisé complet et en lecture seule de toutes les options (construction + apparence actuelle). |
get | () => "worker" | "main" | Renvoie le mode de rendu résolu (« worker » ou « main »). |
get | () => Viewport | Renvoie un instantané de la fenêtre d’affichage actuelle. |
initialize | () => Promise<void> | Attendez que le moteur de rendu soit prêt pour les données et les commandes d’exécution. Le watchdog d’initialisation au moment de la construction rejette cette promesse avec une ChartRendererError lorsque le worker ou la solution de repli sur le 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 | (maxCandles?: number) => void | Alloue une capacité de tampon circulaire OHLCV entière positive pour les mises à jour en direct. Réinitialise les chandelles en file d'attente et l'état de l'ordonnancement des horodatages et annule l'animation de zone de visualisation en attente du jeu de données précédent. |
reset | (options?: { animated?: boolean; }) => void | Réinitialise la vue à l'étendue complète des données. |
resize | () => void | Synchronise le rendu avec la taille du canvas. |
set | (data: OHLCVData) => void | Charge six colonnes OHLCV de taille égale avec des horodatages finis, monotoniquement croissants ou décroissants, y compris des horodatages égaux, et normalise l'ordre. En mode worker, les tampons normalisés sont transférés ; en mode thread principal, leurs tableaux sont conservés par référence. Remplace les échantillons de streaming en attente et annule l'ancienne animation de la zone de visualisation. |
set | (indicators: StockIndicator[]) => void | Remplace les définitions d'indicateurs techniques intégrées. |
set | (messages: false | KeyboardAnnouncementMessages) => void | Remplace ou désactive les annonces d'actions clavier localisées à l'exécution. Les annonces en attente existantes sont annulées. |
set | (labels: ChartLabels) => void | Met à 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 | (markers: StockMarker[]) => void | Remplace tous les marqueurs clairsemés de timestamp/price. |
set | (overlay: OverlayOptions) => Promise<void> | Mettre à 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 a aussi besoin d’une notification asynchrone. Lorsqu’elle est 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 sont des annulations routinières et résolvent sans installation. |
set | (callback: OverlayErrorCallback | null) => void | Enregistrez un rappel pour les échecs non fatals de résolution ou de livraison de 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 | (priceLines: StockPriceLine[]) => void | Remplacez tous les niveaux de prix horizontaux ancrés aux données. |
set | (callback: RendererErrorCallback | null) => void | Enregistrez un rappel d'échec du moteur de rendu exécutable une seule fois. Appelé une fois avant le démantèlement pour les é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: ((stats: StockChartStats) => void) | null, options?: StockChartStatsOptions) => void | Active les statistiques du renderer et reçoit des instantanés régulés. Passez null pour les désactiver. |
set | (range: TimeRange) => void | Applique l’un des presets de calendrier/session exportés. Le chart ne rend pas de contrôles. Les contrôles gérés par l’application peuvent appeler cette méthode pour un preset ou setViewport() pour toute plage de timestamps. |
set | (viewport: Partial<Viewport>, options?: { animated?: boolean; }) => void | Définit une plage de timestamps. En market time, les bords omis sont résolus dans le renderer après des requêtes antérieures, et getViewport() suit sa synchronisation de plage acceptée. |
set | (volumeProfile: VolumeProfileOptions | false) => void | Remplace ou désactive le profil de volume estimé dérivé des candles visible-range. |
update | (patch: DeepPartial<BaseAppearanceOptions>) => void | Appliquez des options d'apparence mutables à l'exécution. Lève : TypeError pour des libellés malformés ou des entrées custom clairsemées/non-objets. |