StockChart API

Importar

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

Use o ponto de entrada público acima. As importações apenas de tipos são removidas do JavaScript da aplicação.

`ChartOverlayError`

Erro reportado quando uma ou mais fontes de sobreposição declarativa não podem ser aplicadas.

Importar @sixtyfold/stockclasse

class ChartOverlayError extends Error

Membro	Definição	Descrição
`cause?`	`Error \| undefined`	Causa do erro de sobreposição do gráfico.
`message`	`string`	Texto da mensagem.
`name`	`"ChartOverlayError"`	Nome exibido para este erro de sobreposição do gráfico.
`sources`	`readonly string[]`	Fontes para o erro de sobreposição do gráfico.
`stack?`	`string \| undefined`	Texto da stack.

`ChartRendererError`

Erro reportado quando um renderer de gráfico falha durante a inicialização ou durante uso posterior.

Importar @sixtyfold/stockclasse

class ChartRendererError extends Error

Membro	Definição	Descrição
`cause?`	`Error \| undefined`	Causa do erro do renderizador de gráficos.
`message`	`string`	Texto da mensagem.
`name`	`"ChartRendererError"`	Nome de apresentação para este erro do renderer do gráfico.
`phase`	`RendererFailurePhase`	Fase do erro do renderer do gráfico.
`stack?`	`string \| undefined`	Texto da stack.

`StockChart`

Gráfico imperativo no browser para velas OHLCV agregadas, volume, análises, perfis, linhas de preço e marcadores.

Import @sixtyfold/stockclass

class StockChart

Membro	Definição	Descrição
`addCandle`	`(timestamp: number, open: number, high: number, low: number, close: number, volume: number) => void`	Enfila uma vela OHLCV com timestamp finito estritamente posterior a todas as velas enfileiradas ou anexadas. Chamadas rápidas são agrupadas por frame de animação; repetir um timestamp não é uma operação de atualização.
`addCandleBatches`	`(batches: readonly StockCandleBatch[], options?: StockAddCandlesOptions) => void`	Valida todos os blocos OHLCV quanto a comprimentos iguais das colunas e timestamps finitos, estritamente crescentes entre blocos e anexos anteriores antes de descarregar velas enfileiradas ou transferir qualquer buffer. Em modo worker, transfere buffers válidos; em modo thread principal, mantém os arrays por referência.
`addCandles`	`(timestamps: Float64Array, opens: Float64Array, highs: Float64Array, lows: Float64Array, closes: Float64Array, volumes: Float64Array, options?: StockAddCandlesOptions) => void`	Valida seis colunas OHLCV de tamanho igual e timestamps finitos e estritamente crescentes após todas as candles enfileiradas ou anexadas antes de esvaziar a fila. Entrada inválida preserva as candles enfileiradas e os buffers do chamador; em modo worker transfere buffers válidos e em thread principal retém os arrays por referência.
`batch`	`(fn: () => void) => void`	Agrupa alterações síncronas de aparência e viewport numa atualização. Batches aninhados são combinados; o carregamento de dados continua imediato.
`destroy`	`() => void`	Liberta o chart e os seus recursos pertencentes.
`getAppearance`	`() => DeepReadonly<StockAppearanceOptions>`	Retorna um instantâneo só de leitura do subconjunto mutável de aparência.
`getOptions`	`() => DeepReadonly<StockChartOptions>`	Retorna um instantâneo normalizado completo e só de leitura de todas as opções (construção + aparência atual).
`getRenderMode`	`() => "worker" \| "main"`	Retorna o modo de renderização resolvido ("worker" ou "main").
`getViewport`	`() => Viewport`	Retorna um instantâneo do viewport atual.
`initialize`	`() => Promise<void>`	Aguarde até que o renderer esteja pronto para dados e comandos de runtime. O watchdog de inicialização em tempo de construção rejeita esta promise com um `ChartRendererError` quando o worker ou fallback no thread principal não ficar pronto no intervalo configurado. As aplicações devem aguardar este método antes de definir o seu primeiro dataset.
`initStreaming`	`(maxCandles?: number) => void`	Aloca uma capacidade positiva inteira de ring-buffer OHLCV para atualizações em directo. Reinicia as candles encoladas e o estado de ordenação por timestamp e cancela a animação de viewport pendente do conjunto de dados anterior.
`reset`	`(options?: { animated?: boolean; }) => void`	Repor o viewport para a extensão completa dos dados.
`resize`	`() => void`	Sincroniza o renderer com o tamanho do canvas.
`setData`	`(data: OHLCVData) => void`	Carrega seis colunas OHLCV de mesmo tamanho com timestamps finitos e monotonicamente ascendentes ou descendentes, incluindo timestamps iguais, e normaliza a ordem. Em modo worker, transfere os buffers normalizados; em modo thread principal, mantém os arrays por referência. Substitui amostras de streaming pendentes e cancela a animação de viewport antiga.
`setIndicators`	`(indicators: StockIndicator[]) => void`	Substitui as definições internas de indicadores técnicos.
`setKeyboardAnnouncements`	`(messages: false \| KeyboardAnnouncementMessages) => void`	Substitua ou desative os anúncios de ações do teclado localizados em tempo de execução. Os anúncios pendentes existentes são cancelados.
`setLabels`	`(labels: ChartLabels) => void`	Atualize os rótulos do gráfico em tempo de execução. Faz merge com os rótulos existentes (mesma semântica que updateAppearance). Lança: TypeError para rótulos malformados ou entradas `custom` esparsas/não-objeto.
`setMarkers`	`(markers: StockMarker[]) => void`	Substitui todos os marcadores esparsos de timestamp/preço.
`setOverlay`	`(overlay: OverlayOptions) => Promise<void>`	Atualize primitivas declarativas de sobreposição em tempo de execução. Primitivas válidas e imagens decodificadas com sucesso são instaladas mesmo quando outra imagem falha. Se todos os elementos solicitados falharem, a sobreposição previamente renderizada permanece instalada. Falhas de resolução e de entrega do renderer rejeitam com `ChartOverlayError`; registe `setOverlayErrorCallback` quando a aplicação também necessitar de notificação assíncrona. Quando chamado antes do lazy renderer estar pronto, esta promise inclui a espera pela prontidão. Atualizações suplantadas e destruição do gráfico são cancelamento rotineiro e resolvem sem instalar.
`setOverlayErrorCallback`	`(callback: OverlayErrorCallback \| null) => void`	Registe um callback para falhas não-fatais de resolução ou entrega de sobreposição. Os itens de sobreposição bem-sucedidos são ainda instalados. A promise correspondente `setOverlay` também rejeita com o mesmo erro.
`setPriceLines`	`(priceLines: StockPriceLine[]) => void`	Substitua todos os níveis de preço horizontais ancorados a dados.
`setRendererErrorCallback`	`(callback: RendererErrorCallback \| null) => void`	Registe um callback de falha do renderer de disparo único. Chamado uma vez antes da desmontagem para falhas de inicialização ou de runtime. Sem callback, erros usam `console.error`. Passe `null` para o cancelar; chamadas `destroy` não o invocam.
`setStatsCallback`	`(callback: ((stats: StockChartStats) => void) \| null, options?: StockChartStatsOptions) => void`	Ativa estatísticas do renderer e recebe instantâneos com limitação. Passe `null` para desativá‑las.
`setTimeRange`	`(range: TimeRange) => void`	Aplica um dos predefinidos de calendário/sessão exportados. O gráfico não apresenta controlos. Controlos geridos pela aplicação podem chamar este método para um predefinido ou `setViewport()` para qualquer intervalo de timestamps.
`setViewport`	`(viewport: Partial<Viewport>, options?: { animated?: boolean; }) => void`	Defina um intervalo de timestamps. Em tempo de mercado, arestas omitidas são resolvidas no renderer após pedidos anteriores, e getViewport() sucede à sincronização do intervalo aceite.
`setVolumeProfile`	`(volumeProfile: VolumeProfileOptions \| false) => void`	Substitua ou desative o perfil de volume visível estimado a partir de candles.
`updateAppearance`	`(patch: DeepPartial<BaseAppearanceOptions>) => void`	Aplique correções a opções de aparência mutáveis em tempo de execução. Lança: TypeError para rótulos malformados ou entradas `custom` esparsas/não-objeto.