StockChart API

StockChart métodos para cargar datos OHLCV, transmitir velas, controlar rangos y añadir capas de mercado.

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.

Importar @sixtyfold/stockclase

class ChartOverlayError extends Error
MiembroDefiniciónDescripción
cause?Error | undefinedCausa del error de superposición del gráfico.
messagestringTexto del mensaje.
name"ChartOverlayError"Nombre para mostrar de este error de superposición del gráfico.
sourcesreadonly string[]Orígenes del error de superposición del gráfico.
stack?string | undefinedTexto del stack.

ChartRendererError

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

Importar @sixtyfold/stockclase

class ChartRendererError extends Error
MiembroDefiniciónDescripción
cause?Error | undefinedCausa del error del renderizador de gráficos.
messagestringTexto del mensaje.
name"ChartRendererError"Nombre para mostrar de este error del renderizador de gráficos.
phaseRendererFailurePhaseFase del error del renderizador de gráficos.
stack?string | undefinedTexto de la pila.

StockChart

Gráfico imperativo para navegador de velas OHLCV agregadas, volumen, análisis, perfiles, líneas de precio y marcadores.

Importar @sixtyfold/stockclase

class StockChart
MiembroDefiniciónDescripción
addCandle(timestamp: number, open: number, high: number, low: number, close: number, volume: number) => voidEncola una vela OHLCV con una marca de tiempo finita estrictamente posterior a cada vela encolada o anexada. Las llamadas rápidas se agrupan en un solo frame de animación; repetir una marca de tiempo no constituye una operación de actualización.
addCandleBatches(batches: readonly StockCandleBatch[], options?: StockAddCandlesOptions) => voidValida todos los chunks OHLCV para asegurar longitudes iguales de columnas y marcas de tiempo finitas y estrictamente crecientes entre chunks y anexos previos antes de vaciar las velas encoladas o transferir cualquier buffer. El modo worker transfiere buffers válidos; el modo hilo principal conserva las matrices por referencia.
addCandles(timestamps: Float64Array, opens: Float64Array, highs: Float64Array, lows: Float64Array, closes: Float64Array, volumes: Float64Array, options?: StockAddCandlesOptions) => voidValida seis columnas OHLCV de tamaño igual y marcas de tiempo finitas y estrictamente crecientes tras todas las velas encoladas o añadidas antes de vaciar la cola. La entrada inválida conserva las velas encoladas y los búferes del llamador; en modo worker se transfieren los búferes válidos y en el hilo principal se mantienen las matrices por referencia.
batch(fn: () => void) => voidAgrupa 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() => voidLibera el gráfico y sus recursos propiedad.
getAppearance() => DeepReadonly<StockAppearanceOptions>Devuelve una instantánea de solo lectura del subconjunto mutable de apariencia.
getOptions() => DeepReadonly<StockChartOptions>Devuelve una instantánea normalizada y de solo lectura de todas las opciones (construcción + apariencia actual).
getRenderMode() => "worker" | "main"Devuelve el modo de representación resuelto ("worker" o "main").
getViewport() => ViewportDevuelve 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 alternativa en el hilo principal no se prepara en el intervalo configurado. Las aplicaciones deberían await esta método antes de asignar su primer conjunto de datos.
initStreaming(maxCandles?: number) => voidReserva una capacidad entera positiva de buffer circular OHLCV para actualizaciones en vivo. Descarta las velas en cola, restablece el estado de ordenación por marca temporal y cancela la animación pendiente de la ventana de visualización del conjunto de datos anterior.
reset(options?: { animated?: boolean; }) => voidRestablece la ventana de visualización al alcance completo de los datos.
resize() => voidSincroniza el renderizador con el tamaño del lienzo.
setData(data: OHLCVData) => voidCarga seis columnas OHLCV de igual tamaño con marcas temporales finitas y monótonamente ascendentes o descendentes, incluidas marcas temporales iguales, y normaliza el orden. En modo worker se transfieren los buffers normalizados; en modo hilo principal sus matrices se conservan por referencia. Sustituye las muestras de streaming pendientes y cancela la animación anterior de la ventana de visualización.
setIndicators(indicators: StockIndicator[]) => voidSustituye las definiciones integradas de indicadores técnicos.
setKeyboardAnnouncements(messages: false | KeyboardAnnouncementMessages) => voidSustituya o desactive los anuncios localizados de acciones del teclado en tiempo de ejecución. Se cancelan los anuncios pendientes existentes.
setLabels(labels: ChartLabels) => voidActualice las etiquetas del gráfico en tiempo de ejecución. Se fusionan con las etiquetas existentes (mismas semánticas que updateAppearance). Lanza: TypeError por etiquetas malformadas o entradas de custom escasas/no objetuales.
setMarkers(markers: StockMarker[]) => voidSustituya todos los marcadores escasos de timestamp/precio.
setOverlay(overlay: OverlayOptions) => Promise<void>Actualice primitivas superpuestas declarativas en tiempo de ejecución. Las primitivas válidas y las imágenes decodificadas con éxito se instalan incluso cuando otra imagen falla. Si todos los elementos solicitados fallan, la superposición previamente renderizada permanece instalada. Los fallos de resolución y entrega del renderizador rechazan con ChartOverlayError; registre setOverlayErrorCallback cuando la aplicación también necesite notificación asíncrona. Si se invoca antes de que el renderizador perezoso esté listo, esta promesa incluye la espera de preparación. Las actualizaciones sustituidas y la destrucción del gráfico son cancelaciones rutinarias y resuelven sin instalar.
setOverlayErrorCallback(callback: OverlayErrorCallback | null) => voidRegistre un callback para fallos no fatales de resolución o entrega de superposiciones. Los elementos de superposición que se resuelven con éxito siguen instalándose. La promesa correspondiente setOverlay también se rechaza con el mismo error.
setPriceLines(priceLines: StockPriceLine[]) => voidReemplace todos los niveles de precio anclados a datos horizontales.
setRendererErrorCallback(callback: RendererErrorCallback | null) => voidRegistre un callback de fallo del renderizador de una sola ejecución. Se llama una vez antes de la limpieza por fallos de inicialización o en tiempo de ejecución. Sin un callback, los errores usan console.error. Pase null para cancelarlo; las llamadas destroy no lo invocan.
setStatsCallback(callback: ((stats: StockChartStats) => void) | null, options?: StockChartStatsOptions) => voidActiva estadísticas del renderizador y recibe instantáneas con limitación. Pase null para desactivarlas.
setTimeRange(range: TimeRange) => voidAplica uno de los presets exportados de calendario/sesión. El gráfico no renderiza controles. Los controles propiedad de la aplicación pueden llamar a este método para un preset o a setViewport() para cualquier rango de marcas temporales.
setViewport(viewport: Partial<Viewport>, options?: { animated?: boolean; }) => voidEstablece un rango de marcas temporales. En tiempo de mercado, los extremos omitidos se resuelven en el renderizador tras solicitudes anteriores, y getViewport() sigue su sincronización de rango aceptada.
setVolumeProfile(volumeProfile: VolumeProfileOptions | false) => voidSustituya o desactive el perfil de volumen visible estimado derivado de las velas.
updateAppearance(patch: DeepPartial<BaseAppearanceOptions>) => voidModifica por parche las opciones de apariencia mutables en tiempo de ejecución. Lanza: TypeError por etiquetas malformadas o entradas custom escasas/no objeto.