StockChart API

Import

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/stockclass

class ChartOverlayError extends Error

Membre	Définition	Description
`cause?`	`Error \| undefined`	Cause for chart overlay error.
`message`	`string`	Message text.
`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 moteur de rendu de graphique échoue au démarrage ou lors d’une utilisation ultérieure.

Import @sixtyfold/stockclass

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 rendu du graphique.
`phase`	`RendererFailurePhase`	Phase pour l'erreur du rendu du graphique.
`stack?`	`string \| undefined`	Texte de la pile.

`StockChart`

Graphique impératif pour navigateur affichant des chandeliers OHLCV agrégés, le volume, des analytics, des profils, des lignes de prix et des marqueurs.

Import @sixtyfold/stockclasse

class StockChart

Membre	Définition	Description
`addCandle`	`(timestamp: number, open: number, high: number, low: number, close: number, volume: number) => void`	Ajoute une bougie OHLCV au tampon de streaming et regroupe les appels rapides en une seule frame d’animation.
`addCandleBatches`	`(batches: readonly StockCandleBatch[], options?: StockAddCandlesOptions) => void`	Installe plusieurs segments OHLCV en une mise à jour du moteur de rendu. En mode worker, tous les buffers sont transférés puis détachés ; sur le thread principal, les arrays sont conservés par référence.
`addCandles`	`(timestamps: Float64Array, opens: Float64Array, highs: Float64Array, lows: Float64Array, closes: Float64Array, volumes: Float64Array, options?: StockAddCandlesOptions) => void`	Ajoute des colonnes OHLCV alignées en une mise à jour du moteur de rendu. En mode worker, les buffers fournis sont transférés puis détachés ; sur le thread principal, les arrays 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 les ressources qui lui appartiennent.
`getAppearance`	`() => DeepReadonly<StockAppearanceOptions>`	Retourne un instantané en lecture seule du sous-ensemble mutable d'apparence.
`getOptions`	`() => DeepReadonly<StockChartOptions>`	Renvoie un instantané normalisé complet en lecture seule de toutes les options (construction + apparence actuelle).
`getRenderMode`	`() => "worker" \| "main"`	Renvoie le mode de rendu résolu ("worker" ou "main").
`getViewport`	`() => Viewport`	Renvoie un instantané du viewport actuel.
`initialize`	`() => Promise<void>`	Attendez que le renderer soit prêt pour les données et les commandes d'exécution. La surveillance d'initialisation au moment de la construction rejette cette promesse avec une `ChartRendererError` lorsque le worker ou le 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.
`initStreaming`	`(maxCandles?: number) => void`	Alloue un tampon circulaire OHLCV à capacité fixe pour les mises à jour en direct.
`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.
`setData`	`(data: OHLCVData) => void`	Charge des colonnes OHLCV alignées et cède au moteur de rendu la propriété des arrays normalisés. En mode worker, les buffers sont transférés puis détachés ; sur le thread principal, les arrays sont conservés par référence.
`setIndicators`	`(indicators: StockIndicator[]) => void`	Remplace les définitions d'indicateurs techniques intégrées.
`setKeyboardAnnouncements`	`(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.
`setLabels`	`(labels: ChartLabels) => void`	Met à jour les étiquettes du graphique à l'exécution. Fusionne avec les étiquettes existantes (mêmes sémantiques que updateAppearance). Lève : TypeError pour les étiquettes malformées ou des entrées `custom` clairsemées/non-objet.
`setMarkers`	`(markers: StockMarker[]) => void`	Remplace tous les marqueurs clairsemés timestamp/prix.
`setOverlay`	`(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 moteur rejettent avec `ChartOverlayError` ; enregistrez `setOverlayErrorCallback` lorsque l'application a aussi besoin d'une notification asynchrone. Lorsqu'il est appelé avant que le renderer paresseux soit prêt, cette promesse inclut l'attente de préparation. Les mises à jour supplantées et la destruction du graphique sont des annulations routinières et se résolvent sans installation.
`setOverlayErrorCallback`	`(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.
`setPriceLines`	`(priceLines: StockPriceLine[]) => void`	Remplacer tous les niveaux de prix horizontaux ancrés aux données.
`setRendererErrorCallback`	`(callback: RendererErrorCallback \| null) => void`	Enregistrez un rappel de défaillance du renderer exécutable une seule fois. Appelé une fois avant le démontage 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.
`setStatsCallback`	`(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.
`setTimeRange`	`(range: TimeRange) => void`	Applique l’un des préréglages de calendrier/session exportés. Le graphique n’affiche pas de contrôles. Les contrôles appartenant à l’application peuvent appeler cette méthode pour un préréglage ou `setViewport()` pour tout intervalle de timestamps.
`setViewport`	`(viewport: Partial<Viewport>, options?: { animated?: boolean; }) => void`	Définit programmatiquement la plage du viewport. Seuls `xMin` et/ou `xMax` doivent être fournis ; les champs omis conservent les valeurs actuelles.
`setVolumeProfile`	`(volumeProfile: VolumeProfileOptions \| false) => void`	Remplace ou désactive le profile de volume visible estimé à partir des chandeliers.
`updateAppearance`	`(patch: DeepPartial<BaseAppearanceOptions>) => void`	Patch des 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.