StockChart API

Importar

import { StockChart } from "@sixtyfold/stock";

Usa el punto de entrada público indicado arriba. Las importaciones solo de tipos se eliminan del JavaScript de la aplicación.

`ChartOverlayError`

Error informado cuando una o más fuentes de superposición declarativas no se pueden aplicar.

Import @sixtyfold/stockclass

class ChartOverlayError extends Error

Miembro	Definición	Descripción
`cause?`	`Error \| undefined`	Causa del error de superposición del gráfico.
`message`	`string`	Texto del mensaje.
`name`	`"ChartOverlayError"`	Nombre para mostrar de este error de superposición del gráfico.
`sources`	`readonly string[]`	Fuentes del error de superposición del gráfico.
`stack?`	`string \| undefined`	Texto de la pila.

`ChartRendererError`

Error informado cuando un renderer de gráfico falla durante el arranque o en uso posterior.

Import @sixtyfold/stockclass

class ChartRendererError extends Error

Miembro	Definición	Descripción
`cause?`	`Error \| undefined`	Causa del error del renderizador de gráficos.
`message`	`string`	Texto del mensaje.
`name`	`"ChartRendererError"`	Nombre para mostrar de este error del renderizador de gráficos.
`phase`	`RendererFailurePhase`	Fase del error del renderizador de gráficos.
`stack?`	`string \| undefined`	Texto de pila.

`StockChart`

Gráfico imperativo para navegador que muestra velas OHLCV agregadas, volumen, analíticas, perfiles, líneas de precio y marcadores.

Import @sixtyfold/stockclass

class StockChart

Member	Definition	Description
`addCandle`	`(timestamp: number, open: number, high: number, low: number, close: number, volume: number) => void`	Añade una vela OHLCV al búfer de streaming y agrupa llamadas rápidas en un único frame de animación.
`addCandleBatches`	`(batches: readonly StockCandleBatch[], options?: StockAddCandlesOptions) => void`	Instala varios fragmentos OHLCV en una actualización del renderizador. En modo worker, todos los buffers se transfieren y se separan; en el hilo principal, los arrays se conservan por referencia.
`addCandles`	`(timestamps: Float64Array, opens: Float64Array, highs: Float64Array, lows: Float64Array, closes: Float64Array, volumes: Float64Array, options?: StockAddCandlesOptions) => void`	Añade columnas OHLCV alineadas en una actualización del renderizador. En modo worker, los buffers suministrados se transfieren y se separan; en el hilo principal, los arrays se conservan por referencia.
`batch`	`(fn: () => void) => void`	Agrupa cambios síncronos de apariencia y viewport en una actualización. Los lotes anidados se combinan; las cargas de datos se ejecutan de inmediato.
`destroy`	`() => void`	Libera el chart y sus recursos propiedad del mismo.
`getAppearance`	`() => DeepReadonly<StockAppearanceOptions>`	Devuelve una instantánea de solo lectura del subconjunto mutable de apariencia.
`getOptions`	`() => DeepReadonly<StockChartOptions>`	Devuelve una instantánea normalizada completa de solo lectura de todas las opciones (construcción + apariencia actual).
`getRenderMode`	`() => "worker" \| "main"`	Devuelve el modo de renderizado resuelto ("worker" o "main").
`getViewport`	`() => Viewport`	Devuelve una instantánea del viewport actual.
`initialize`	`() => Promise<void>`	Espere hasta que el renderizador esté listo para datos y comandos en tiempo de ejecución. El watchdog de inicialización en tiempo de construcción rechaza esta promesa con un `ChartRendererError` cuando el worker o la solución alternativa en el main thread no están listos en el intervalo configurado. Las aplicaciones deben await esta método antes de instalar su primer conjunto de datos.
`initStreaming`	`(maxCandles?: number) => void`	Asigna un búfer circular OHLCV de capacidad fija para actualizaciones en vivo.
`reset`	`(options?: { animated?: boolean; }) => void`	Restablece la vista a la extensión completa de los datos.
`resize`	`() => void`	Sincroniza el renderer con el tamaño del canvas.
`setData`	`(data: OHLCVData) => void`	Carga columnas OHLCV alineadas y entrega al renderizador la propiedad de los arrays normalizados. En modo worker, los buffers se transfieren y se separan; en el hilo principal, los arrays se conservan por referencia.
`setIndicators`	`(indicators: StockIndicator[]) => void`	Reemplaza las definiciones de indicadores técnicos integradas.
`setKeyboardAnnouncements`	`(messages: false \| KeyboardAnnouncementMessages) => void`	Reemplaza o desactiva los anuncios de acciones de teclado localizados en tiempo de ejecución. Los anuncios pendientes existentes se cancelan.
`setLabels`	`(labels: ChartLabels) => void`	Actualiza las etiquetas del gráfico en tiempo de ejecución. Se fusiona con las etiquetas existentes (mismas semánticas que updateAppearance). Lanza: TypeError para etiquetas malformadas o entradas `custom` dispersas/no objeto.
`setMarkers`	`(markers: StockMarker[]) => void`	Reemplaza todos los marcadores escasos de timestamp/precio.
`setOverlay`	`(overlay: OverlayOptions) => Promise<void>`	Actualiza primitivas declarativas de superposición en tiempo de ejecución. Las primitivas válidas y las imágenes decodificadas con éxito se instalan aunque otra imagen falle. Si todos los elementos solicitados fallan, se mantiene instalada la superposición previamente renderizada. Las fallas de resolución y entrega del renderer rechazan con `ChartOverlayError`; registre `setOverlayErrorCallback` cuando la aplicación necesite también notificación asincrónica. Cuando se llama antes de que el lazy renderer esté listo, esta promesa incluye la espera de disponibilidad. Las actualizaciones sustituidas y la destrucción del gráfico son cancelaciones rutinarias y se resuelven sin instalar.
`setOverlayErrorCallback`	`(callback: OverlayErrorCallback \| null) => void`	Registra una devolución de llamada para fallas no fatales de resolución o entrega de superposición. Los elementos de superposición que se resuelvan con éxito siguen instalándose. La promesa correspondiente `setOverlay` también rechaza con el mismo error.
`setPriceLines`	`(priceLines: StockPriceLine[]) => void`	Sustituye todos los niveles de precio horizontales anclados a datos.
`setRendererErrorCallback`	`(callback: RendererErrorCallback \| null) => void`	Registra una devolución de llamada de fallo del renderer de una sola ejecución. Se invoca una vez antes del desmontado por fallos de inicialización o en tiempo de ejecución. Sin callback, los errores usan `console.error`. Pase `null` para cancelarlo; las llamadas `destroy` no lo invocan.
`setStatsCallback`	`(callback: ((stats: StockChartStats) => void) \| null, options?: StockChartStatsOptions) => void`	Habilita las estadísticas del renderizador y recibe instantáneas limitadas. Pase `null` para desactivarlas.
`setTimeRange`	`(range: TimeRange) => void`	Aplica uno de los presets exportados de calendario/sesión. El gráfico no renderiza controles. Los controles gestionados por la aplicación pueden llamar a este método para un preset o `setViewport()` para cualquier rango de marcas de tiempo.
`setViewport`	`(viewport: Partial<Viewport>, options?: { animated?: boolean; }) => void`	Establece programáticamente el rango del viewport. Solo es necesario proporcionar `xMin` y/o `xMax`; los campos omitidos conservan los valores actuales.
`setVolumeProfile`	`(volumeProfile: VolumeProfileOptions \| false) => void`	Sustituye o desactiva el perfil de volumen visible estimado a partir de velas.
`updateAppearance`	`(patch: DeepPartial<BaseAppearanceOptions>) => void`	Parchea opciones de apariencia mutables en tiempo de ejecución. Lanza: TypeError por etiquetas mal formadas o entradas `custom` dispersas/no-objeto.