nginstack

Module: @nginstack/engine/lib/xlsx/XLSXWriter

Classes

XLSXWriter

Type Definitions

FontScript

Define se o texto será sobrescrito ou subscrito.

Type:
  • 'superscript' | 'subscript'

FormatBorder

Estilos de borda de célula no Excel.

Type:
  • 'none' | 'thin' | 'medium' | 'dashed' | 'dotted' | 'thick' | 'double' | 'hair' | 'medium-dashed' | 'dash-dot' | 'medium-dash-dot' | 'dash-dot-dot' | 'medium-dash-dot-dot' | 'slant-dash-dot'

FormatOptions

Type:
  • Object
Properties:
Name Type Argument Description
numericFormat string <optional>

Um formato Excel personalizado que define como um valor será apresentado na célula. Por exemplo, "R$ #,##0.00;-R$ #,##0.00" para valores em reais com o símbolo de negativo antes do símbolo monetário, "0.00%" para porcentagens com duas casas decimais, "dd/mm/yyyy" para datas, "hh:mm:ss" para horários, etc.

Para verificar uma formatação numérica, abra a opção de formatação de uma célula no Excel, e depois que escolher o tipo de formatação, clique em "Personalizado" para ver o código utilizado. No entanto, fique atento pois a localização de código que deve ser utilizada nesta API é Inglês (EUA), e não a localização do usuário.
horizontalAlignment HorizontalAlignment <optional>

Alinhamento horizontal da célula.
verticalAlignment VerticalAlignment <optional>

Alinhamento vertical da célula.
textWrap boolean <optional>

Indica se o texto deve quebrar automaticamente.
indentation number <optional>

Nível de indentação (0–255). Indica o número de espaços a serem adicionados antes do texto na célula.
readingDirection ReadingDirection <optional>

Direção de leitura do texto. Utilizado em idiomas que possuem direções de leitura diferentes, como árabe ou hebraico.
shrinkToFit boolean <optional>

Reduz o texto para caber na célula.
fontType string <optional>

Nome da fonte, por exemplo "Calibri" ou "Arial".
fontSize number <optional>

Tamanho da fonte (em pontos).
fontColor string <optional>

Cor da fonte no formato hexadecimal, por exemplo "#FF0000" (vermelho) ou "#000000" (preto).
bold boolean <optional>

Define se o texto será negrito.
italic boolean <optional>

Define se o texto será itálico.
underline Underline <optional>

Tipo de sublinhado. Os estilos de sublinhado "accounting" são geralmente utilizados para valores monetários, ficam um pouco mais afastados do texto e percorrem toda a largura da célula.
strikethrough boolean <optional>

Define se o texto terá risco no meio.
fontScript FontScript <optional>

Define se o texto será sobrescrito ou subscrito.
cellBorder FormatBorder <optional>

Estilo da borda aplicada em todos os lados da célula. Pode ser sobrescrito por propriedades específicas de borda como topBorder, leftBorder, rightBorder e bottomBorder.
bottomBorder FormatBorder <optional>

Estilo da borda inferior da célula.
topBorder FormatBorder <optional>

Estilo da borda superior da célula.
leftBorder FormatBorder <optional>

Estilo da borda esquerda da célula.
rightBorder FormatBorder <optional>

Estilo da borda direita da célula.
borderColor string <optional>

Cor da borda em formato hexadecimal (ex: "#CCCCCC"). Aplica-se a todos os lados. Pode ser sobrescrito por propriedades específicas de borda como borderTopColor, borderLeftColor, borderRightColor e borderBottomColor.
borderTopColor string <optional>

Cor da borda superior em formato hexadecimal (ex: "#CCCCCC").
borderLeftColor string <optional>

Cor da borda esquerda em formato hexadecimal (ex: "#CCCCCC").
borderRightColor string <optional>

Cor da borda direita em formato hexadecimal (ex: "#CCCCCC").
borderBottomColor string <optional>

Cor da borda inferior em formato hexadecimal (ex: "#CCCCCC").
backgroundColor string <optional>

Cor de fundo da célula no formato hexadecimal (ex: "#FAFAFA").

HorizontalAlignment

Estilos de alinhamento horizontal da célula.

Type:
  • 'left' | 'center' | 'right' | 'fill' | 'justify' | 'center-across' | 'distributed'

ReadingDirection

Estilos de direção de leitura do texto dentro da célula.

Type:
  • 'left-to-right' | 'right-to-left'

Underline

Estilos inserir sublinhado em um texto.

Type:
  • 'single' | 'double' | 'single-accounting' | 'double-accounting'

VerticalAlignment

Estilos de alinhamento vertical da célula.

Type:
  • 'top' | 'center' | 'bottom' | 'justify' | 'distributed'