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 declarativas 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 de exibição 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 do stack.

`ChartRendererError`

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

Import @sixtyfold/stockclass

class ChartRendererError extends Error

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

`StockChart`

Gráfico imperativo para browser de candles OHLCV agregados, volume, analytics, perfis, linhas de preço e marcadores.

Import @sixtyfold/stockclass

class StockChart

Member	Definição	Descrição
`addCandle`	`(timestamp: number, open: number, high: number, low: number, close: number, volume: number) => void`	Acrescenta uma vela OHLCV ao buffer de streaming e agrupa chamadas rápidas numa única frame de animação.
`addCandleBatches`	`(batches: readonly StockCandleBatch[], options?: StockAddCandlesOptions) => void`	Instala vários fragmentos OHLCV numa atualização do renderer. Em modo worker, todos os buffers são transferidos e destacados; na thread principal, os arrays ficam retidos por referência.
`addCandles`	`(timestamps: Float64Array, opens: Float64Array, highs: Float64Array, lows: Float64Array, closes: Float64Array, volumes: Float64Array, options?: StockAddCandlesOptions) => void`	Adiciona colunas OHLCV alinhadas numa atualização do renderer. Em modo worker, os buffers fornecidos são transferidos e destacados; na thread principal, os arrays ficam retidos 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 gráfico e os recursos que este possui.
`getAppearance`	`() => DeepReadonly<StockAppearanceOptions>`	Retorna um snapshot só de leitura do subconjunto mutável da aparência.
`getOptions`	`() => DeepReadonly<StockChartOptions>`	Retorna uma cópia de leitura só de um instantâneo normalizado completo de todas as opções (construção + aparência atual).
`getRenderMode`	`() => "worker" \| "main"`	Retorna o modo de renderização resolvido ("worker" ou "thread principal").
`getViewport`	`() => Viewport`	Retorna um instantâneo da viewport atual.
`initialize`	`() => Promise<void>`	Aguarda até que o renderer esteja pronto para dados e comandos em tempo de execução. O watchdog de inicialização em tempo de construção rejeita esta promise com um `ChartRendererError` quando o worker ou o fallback em thread principal não fica pronto no intervalo configurado. As aplicações devem aguardar este método antes de instalar o primeiro conjunto de dados.
`initStreaming`	`(maxCandles?: number) => void`	Aloca um buffer circular OHLCV de capacidade fixa para atualizações em tempo real.
`reset`	`(options?: { animated?: boolean; }) => void`	Repor a vista de visualização para a extensão completa dos dados.
`resize`	`() => void`	Sincroniza o renderer com o tamanho do canvas.
`setData`	`(data: OHLCVData) => void`	Carrega colunas OHLCV alinhadas e entrega ao renderer a propriedade dos arrays normalizados. Em modo worker, os buffers são transferidos e destacados; na thread principal, os arrays ficam retidos por referência.
`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 nos rótulos existentes (mesma semântica que updateAppearance). Lança: TypeError para rótulos inválidos ou entradas `custom` esparsas/não-objetos.
`setMarkers`	`(markers: StockMarker[]) => void`	Substitui todos os marcadores esparsos de timestamp/preço.
`setOverlay`	`(overlay: OverlayOptions) => Promise<void>`	Atualiza primitivas de sobreposição declarativas em tempo de execução. Primitivas válidas e imagens decodificadas com sucesso são instaladas mesmo quando outra imagem falha. Se todos os itens solicitados falharem, a sobreposição previamente renderizada permanece instalada. Falhas de resolução e entrega pelo renderer rejeitam com `ChartOverlayError`; registe `setOverlayErrorCallback` quando a aplicação também necessitar de notificação assíncrona. Quando chamado antes do renderer lazy estar pronto, esta promessa 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 críticas de resolução ou entrega de sobreposições. Itens de sobreposição bem-sucedidos são ainda instalados. A promessa 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 utilização única. É chamado uma vez antes do teardown por falhas de inicialização ou runtime. Sem um callback, os erros usam `console.error`. Passe `null` para 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 throttling. Passe `null` para as desativar.
`setTimeRange`	`(range: TimeRange) => void`	Aplica um dos presets exportados de calendário/sessão. O gráfico não apresenta controlos. Os controlos geridos pela aplicação podem chamar este método para um preset ou `setViewport()` para qualquer intervalo de timestamps.
`setViewport`	`(viewport: Partial<Viewport>, options?: { animated?: boolean; }) => void`	Defina programaticamente o intervalo de viewport. Só é necessário fornecer `xMin` e/ou `xMax`; campos omitidos mantêm os valores atuais.
`setVolumeProfile`	`(volumeProfile: VolumeProfileOptions \| false) => void`	Substitua ou desative o perfil de volume visível estimado a partir de candles.
`updateAppearance`	`(patch: DeepPartial<BaseAppearanceOptions>) => void`	Atualiza (patch) opções de aparência mutáveis em tempo de execução. Lança: TypeError para etiquetas malformadas ou entradas `custom` esparsas/não-objeto.