XLS

Criar e ler ficheiros Excel, suporta para ficheiros XLS como ficheiros XLSX. Este recurso utiliza a biblioteca Apache POI.

const excel = _xls.create();
const titulos = _val.init()
    .add(
        _val.init()
            .set('value', 'Nome')
    ).add(
        _val.init()
            .set('value', 'Idade')
    );
const endPosition = excel.addDataTable(1, 1, titulos)
const dados = _val.init()
    .add(
        _val.init()
            .add(
                 _val.init()
                     .set('value', 'Maria')
            ).add(
                 _val.init()
                     .set('value', 24)
            )
    ).add(
        _val.init()
            .add(
                 _val.init()
                     .set('value', 'Ricardo')
            ).add(
                 _val.init()
                     .set('value', 22)
            )
    );
endPosition = excel.addDataTable(endPosition.row, 1, data)
excel.output("idades.xls");

---

activeSheet

---

_xls.create().activeSheet(index: int) : XLS

Descrição

Define a folha de cálculos que fica ativa.

Atributos

NOME	TIPO	DESCRIÇÃO
index	int	Número da folha de cálculos.

Retorno

( XLS )

A instância atual do recurso XLS.

---

_xls.create().activeSheet(index: org.apache.poi.hssf.usermodel.HSSFSheet) : XLS

Descrição

Define a folha de cálculos que fica ativa.

Atributos

NOME	TIPO	DESCRIÇÃO
index	org.apache.poi.hssf.usermodel.HSSFSheet	Objeto de referência da folha de cálculos.

Retorno

( XLS )

A instância atual do recurso XLS.

---

addDataTable

---

_xls.create().addDataTable(linha: int, coluna: int, dados: java.util.List) : XLSPosition

Descrição

Adiciona uma tabela de dados na folha de cálculos.

Atributos

NOME	TIPO	DESCRIÇÃO
linha	int	Número da linha.
coluna	int	Número da coluna.
dados	java.util.List	Lista de dados que serão inseridos.

Retorno

( XLSPosition )

Referência da posição da última célula com dados inserida.

---

_xls.create().addDataTable(linha: int, coluna: int, dados: java.util.List, vertical: boolean) : XLSPosition

Descrição

Adiciona uma tabela de dados na folha de cálculos.

Atributos

NOME	TIPO	DESCRIÇÃO
linha	int	Número da linha.
coluna	int	Número da coluna.
dados	java.util.List	Lista de dados que serão inseridos.
vertical	boolean	Inserir dados na vertical.

Retorno

( XLSPosition )

Referência da posição da última célula com dados inserida.

---

_xls.create().addDataTable(linha: int, coluna: int, dados: Values) : XLSPosition

Descrição

Adiciona uma tabela de dados na folha de cálculos.

Atributos

NOME	TIPO	DESCRIÇÃO
linha	int	Número da linha.
coluna	int	Número da coluna.
dados	Values	Lista de dados que serão inseridos.

Retorno

( XLSPosition )

Referência da posição da última célula com dados inserida.

---

_xls.create().addDataTable(linha: int, coluna: int, dados: Values, vertical: boolean) : XLSPosition

Descrição

Adiciona uma tabela de dados na folha de cálculos.

Atributos

NOME	TIPO	DESCRIÇÃO
linha	int	Número da linha.
coluna	int	Número da coluna.
dados	Values	Lista de dados que serão inseridos.
vertical	boolean	Inserir dados na vertical.

Retorno

( XLSPosition )

Referência da posição da última célula com dados inserida.

---

_xls.create().addDataTable(config: Config | Exec | Header | Req | Res | Values | DataSchema, dados: java.util.List) : XLSPosition

Descrição

Adiciona uma tabela de dados na folha de cálculos.

Atributos

NOME	TIPO	DESCRIÇÃO
config	Config | Exec | Header | Req | Res | Values | DataSchema	Configuração da tabela de dados.
dados	java.util.List	Lista de dados que serão inseridos.

Retorno

( XLSPosition )

Referência da posição da última célula com dados inserida.

---

_xls.create().addDataTable(folhaCalculos: org.apache.poi.ss.usermodel.Sheet, linha: int, coluna: int, dados: java.util.List) : XLSPosition

Descrição

Adiciona uma tabela de dados na folha de cálculos.

Atributos

NOME	TIPO	DESCRIÇÃO
folhaCalculos	org.apache.poi.ss.usermodel.Sheet	Objeto da folha de cálculos.
linha	int	Número da linha.
coluna	int	Número da coluna.
dados	java.util.List	Lista de dados que serão inseridos.

Retorno

( XLSPosition )

Referência da posição da última célula com dados inserida.

---

_xls.addDataTable(sheet: org.apache.poi.ss.usermodel.Sheet, rowIndex: int, colIndex: int, data: java.util.List, vertical: boolean) : XLSPosition

Atributos

NOME	TIPO	DESCRIÇÃO
sheet	org.apache.poi.ss.usermodel.Sheet
rowIndex	int
colIndex	int
data	java.util.List
vertical	boolean

Retorno

( XLSPosition )

---

_xls.create().addDataTable(folhaCalculos: org.apache.poi.ss.usermodel.Sheet, linha: int, coluna: int, dados: Values) : XLSPosition

Descrição

Adiciona uma tabela de dados na folha de cálculos.

Atributos

NOME	TIPO	DESCRIÇÃO
folhaCalculos	org.apache.poi.ss.usermodel.Sheet	Objeto da folha de cálculos.
linha	int	Número da linha.
coluna	int	Número da coluna.
dados	Values	Lista de dados que serão inseridos.

Retorno

( XLSPosition )

Referência da posição da última célula com dados inserida.

---

_xls.addDataTable(sheet: org.apache.poi.ss.usermodel.Sheet, rowIndex: int, colIndex: int, data: Values, vertical: boolean) : XLSPosition

Atributos

NOME	TIPO	DESCRIÇÃO
sheet	org.apache.poi.ss.usermodel.Sheet
rowIndex	int
colIndex	int
data	Values
vertical	boolean

Retorno

( XLSPosition )

---

anchorType

---

_xls.anchorType(tipo: string) : org.apache.poi.ss.usermodel.ClientAnchor$AnchorType

Descrição

Gera o tipo de âncora.

Atributos

NOME	TIPO	DESCRIÇÃO
tipo	string	Nome do tipo de âncora, suporta: move-and-resize dont-move-do-resize move-dont-resize dont-move-and-resize

Retorno

( org.apache.poi.ss.usermodel.ClientAnchor$AnchorType )

O tipo de âncora configurado com o tipo definido.

---

borderStyle

---

_xls.borderStyle(tipo: string) : org.apache.poi.ss.usermodel.BorderStyle

Descrição

Gera o estilo de contorno das bordas das células.

Atributos

NOME	TIPO	DESCRIÇÃO
tipo	string	Nome do tipo de estilo de bordas, suporta: none thin medium dashed dotted thick double hair medium-dashed dash-dot medium-dash-dot

Retorno

( org.apache.poi.ss.usermodel.BorderStyle )

O estilo de contorno de borda configurado com o tipo definido.

---

cell

---

_xls.create().cell(linha: int, coluna: int) : org.apache.poi.ss.usermodel.Cell

Descrição

Obtém uma célula da folha de cálculos e caso não exista então será criada.

Atributos

NOME	TIPO	DESCRIÇÃO
linha	int	Número da linha.
coluna	int	Número da coluna.

Retorno

( org.apache.poi.ss.usermodel.Cell )

Objeto de representação da célula.

---

_xls.create().cell(linha: org.apache.poi.ss.usermodel.Sheet, linha: int, coluna: int) : org.apache.poi.ss.usermodel.Cell

Descrição

Obtém uma célula da folha de cálculos e caso não exista então será criada.

Atributos

NOME	TIPO	DESCRIÇÃO
linha	org.apache.poi.ss.usermodel.Sheet	Objeto da folha de cálculos.
linha	int	Número da linha da folha.
coluna	int	Número da coluna.

Retorno

( org.apache.poi.ss.usermodel.Cell )

Objeto de representação da célula.

---

cellRangeAddress

---

_xls.cellRangeAddress(primeiraLinha: int, ultimaLinha: int, primeiraColuna: int, ultimaColuna: int) : org.apache.poi.ss.util.CellRangeAddress

Descrição

Gera o endereço de região da área das células.

Atributos

NOME	TIPO	DESCRIÇÃO
primeiraLinha	int	Número da primeira linha.
ultimaLinha	int	Número da última linha.
primeiraColuna	int	Número da primeira coluna.
ultimaColuna	int	Número da última coluna.

Retorno

( org.apache.poi.ss.util.CellRangeAddress )

A referência do endereço da área das células.

---

cellStyle

---

_xls.cellStyle() : org.apache.poi.ss.usermodel.CellStyle

Descrição

Cria um novo estilo de célula no workbook.

Retorno

( org.apache.poi.ss.usermodel.CellStyle )

O novo estilo de célula criado.

---

cellStyleFormat

---

_xls.cellStyleFormat(formato: string) : org.apache.poi.ss.usermodel.CellStyle

Descrição

Cria um novo estilo de célula com um formato associado no workbook.

Atributos

NOME	TIPO	DESCRIÇÃO
formato	string	Definição do padrão do formato.

Retorno

( org.apache.poi.ss.usermodel.CellStyle )

O novo estilo de célula criado com o formato configurado.

---

color

---

_xls.color(nome: string) : short

Descrição

Gera o código da cor baseado em nomes pré definidos.

Atributos

NOME	TIPO	DESCRIÇÃO
nome	string	Nome da cor, suporta: black brown olive_green dark_green dark_teal dark_blue indigo grey_80_percent orange dark_yellow green teal blue blue_grey grey_50_percent red light_orange lime sea_green aqua light_blue violet grey_40_percent pink gold yellow bright_green turquoise dark_red sky_blue plum grey_25_percent rose light_yellow light_green light_turquoise pale_blue lavender white cornflower_blue lemon_chiffon maroon orchid coral royal_blue light_cornflower_blue tan automatic

Retorno

( short )

A referência da cor.

---

columnReference

---

_xls.columnReference(index: int) : string

Descrição

Obtém a referência da coluna (letras) com base na sua posição numérico.

Atributos

NOME	TIPO	DESCRIÇÃO
index	int	Número da coluna.

Retorno

( string )

Referência em letras da coluna.

---

_xls.columnReference(index: string) : int

Descrição

Obtém a posição numérica da coluna com base na referência em letras.

Atributos

NOME	TIPO	DESCRIÇÃO
index	string	Referência em letras da coluna.

Retorno

( int )

Posição numérica da coluna.

---

create

---

_xls.create() : XLS

Descrição

Cria um novo documento Excel.

Como Usar

const excel = _xls.create();

Retorno

( XLS )

Nova instância do recurso XLS.

---

createSheet

---

_xls.create().createSheet() : org.apache.poi.ss.usermodel.Sheet

Descrição

Cria uma nova folha de cálculos.

Retorno

( org.apache.poi.ss.usermodel.Sheet )

Folha de cálculos criada.

---

_xls.create().createSheet(nome: string) : org.apache.poi.ss.usermodel.Sheet

Descrição

Cria uma nova folha de cálculos e define o seu nome.

Atributos

NOME	TIPO	DESCRIÇÃO
nome	string	Nome da folha de cálculos.

Retorno

( org.apache.poi.ss.usermodel.Sheet )

Folha de cálculos criada.

---

fillPattern

---

_xls.fillPattern(tipo: string) : org.apache.poi.ss.usermodel.FillPatternType

Descrição

Gera o padrão de preenchimento de fundo.

Atributos

NOME	TIPO	DESCRIÇÃO
tipo	string	Tipo do padrão de preenchimento, suporta: no-fill solid-foreground fine-dots alt-bars sparse-dots thick-horz-bands thick-vert-bands thick-backward-diag thick-forward-diag big-spots bricks thin-horz-bands thin-vert-bands thin-backward-diag thin-forward-diag squares diamonds less-dots least-dots

Retorno

( org.apache.poi.ss.usermodel.FillPatternType )

O padrão de preenchimento configurado com o tipo definido.

---

font

---

_xls.font() : org.apache.poi.ss.usermodel.Font

Descrição

Cria um novo estilo de fonte no workbook.

Retorno

( org.apache.poi.ss.usermodel.Font )

O novo estilo de fonte criado.

---

format

---

_xls.format(formato: string) : short

Descrição

Cria um novo formato de célula no workbook.

Atributos

NOME	TIPO	DESCRIÇÃO
formato	string	Definição do padrão do formato.

Retorno

( short )

Código identificador do novo formato.

---

getAllSheets

---

_xls.create().getAllSheets() : java.util.List

Descrição

Lista com todas as folhas de cálculos.

Retorno

( java.util.List )

Todas as folhas de cálculos existentes no documento.

---

getCellData

---

_xls.create().getCellData(linha: int, coluna: int) : Values

Descrição

Obtém um objeto com os dados de uma célula da folha de cálculos.

Atributos

NOME	TIPO	DESCRIÇÃO
linha	int	Número da linha.
coluna	int	Número da coluna.

Retorno

( Values )

Informações de dados da célula.

---

_xls.create().getCellData(celula: org.apache.poi.ss.usermodel.Cell) : Values

Descrição

Obtém um objeto com os dados de uma célula da folha de cálculos.

Atributos

NOME	TIPO	DESCRIÇÃO
celula	org.apache.poi.ss.usermodel.Cell	Objeto que representa a célula.

Retorno

( Values )

Informações de dados da célula.

---

_xls.create().getCellData(linha: org.apache.poi.ss.usermodel.Sheet, linha: int, coluna: int) : Values

Descrição

Obtém um objeto com os dados de uma célula da folha de cálculos.

Atributos

NOME	TIPO	DESCRIÇÃO
linha	org.apache.poi.ss.usermodel.Sheet	Objeto da folha de cálculos.
linha	int	Número da linha da folha.
coluna	int	Número da coluna.

Retorno

( Values )

Informações de dados da célula.

---

getNumberOfSheets

---

_xls.create().getNumberOfSheets() : int

Descrição

Obtém o número total de folhas de cálculos.

Retorno

( int )

O número total de folhas de cálculos existentes no documento.

---

getSheet

---

_xls.create().getSheet(index: int) : org.apache.poi.ss.usermodel.Sheet

Descrição

Obtém a folha de cálculos através do número (index).

Atributos

NOME	TIPO	DESCRIÇÃO
index	int	Número da folha de cálculos.

Retorno

( org.apache.poi.ss.usermodel.Sheet )

Folha de cálculos referente ao número (index).

---

_xls.create().getSheet(nome: string) : org.apache.poi.ss.usermodel.Sheet

Descrição

Obtém a folha de cálculos através do nome.

Atributos

NOME	TIPO	DESCRIÇÃO
nome	string	Nome da folha de cálculos.

Retorno

( org.apache.poi.ss.usermodel.Sheet )

Folha de cálculos referente ao nome.

---

horizontalAlignment

---

_xls.horizontalAlignment(tipo: string) : org.apache.poi.ss.usermodel.HorizontalAlignment

Descrição

Gera o alinhamento horizontal.

Atributos

NOME	TIPO	DESCRIÇÃO
tipo	string	Nome do tipo de alinhamento horizontal, suporta: general left center right fill justify center-selection distributed

Retorno

( org.apache.poi.ss.usermodel.HorizontalAlignment )

O alinhamento horizontal configurado com o tipo definido.

---

insertPicture

---

_xls.insertPicture(folhaCalculos: org.apache.poi.ss.usermodel.Sheet, file: File, ancora: org.apache.poi.ss.usermodel.ClientAnchor) : org.apache.poi.ss.usermodel.Picture

Descrição

Insere uma imagem associada à âncora em uma folha de cálculos específica.

Atributos

NOME	TIPO	DESCRIÇÃO
folhaCalculos	org.apache.poi.ss.usermodel.Sheet	Folha de cálculos que será utilizada para inserir a imagem.
file	File	Ficheiro de imagem.
ancora	org.apache.poi.ss.usermodel.ClientAnchor	Âncora para associar a imagem.

Retorno

( org.apache.poi.ss.usermodel.Picture )

O objeto de referência da imagem inserida.

---

_xls.insertPicture(folhaCalculos: org.apache.poi.ss.usermodel.Sheet, storage: Storage, ancora: org.apache.poi.ss.usermodel.ClientAnchor) : org.apache.poi.ss.usermodel.Picture

Descrição

Insere uma imagem associada à âncora em uma folha de cálculos específica.

Atributos

NOME	TIPO	DESCRIÇÃO
folhaCalculos	org.apache.poi.ss.usermodel.Sheet	Folha de cálculos que será utilizada para inserir a imagem.
storage	Storage	Referência do storage associado a um ficheiro de imagem.
ancora	org.apache.poi.ss.usermodel.ClientAnchor	Âncora para associar a imagem.

Retorno

( org.apache.poi.ss.usermodel.Picture )

O objeto de referência da imagem inserida.

---

_xls.create().insertPicture(file: File, linha: int, coluna: int) : org.apache.poi.ss.usermodel.Picture

Descrição

Insere a imagem na célula específicada.

Atributos

NOME	TIPO	DESCRIÇÃO
file	File	Ficheiro de imagem.
linha	int	Número da linha.
coluna	int	Número da coluna.

Retorno

( org.apache.poi.ss.usermodel.Picture )

O objeto de referência da imagem inserida.

---

_xls.create().insertPicture(file: File, ancora: org.apache.poi.ss.usermodel.ClientAnchor) : org.apache.poi.ss.usermodel.Picture

Descrição

Insere uma imagem associada à âncora.

Atributos

NOME	TIPO	DESCRIÇÃO
file	File	Ficheiro de imagem.
ancora	org.apache.poi.ss.usermodel.ClientAnchor	Âncora para associar a imagem.

Retorno

( org.apache.poi.ss.usermodel.Picture )

O objeto de referência da imagem inserida.

---

_xls.create().insertPicture(storage: Storage, linha: int, coluna: int) : org.apache.poi.ss.usermodel.Picture

Descrição

Insere a imagem na célula específicada.

Atributos

NOME	TIPO	DESCRIÇÃO
storage	Storage	Referência do storage associado a um ficheiro de imagem.
linha	int	Número da linha.
coluna	int	Número da coluna.

Retorno

( org.apache.poi.ss.usermodel.Picture )

O objeto de referência da imagem inserida.

---

_xls.create().insertPicture(storage: Storage, ancora: org.apache.poi.ss.usermodel.ClientAnchor) : org.apache.poi.ss.usermodel.Picture

Descrição

Insere uma imagem associada à âncora.

Atributos

NOME	TIPO	DESCRIÇÃO
storage	Storage	Referência do storage associado a um ficheiro de imagem.
ancora	org.apache.poi.ss.usermodel.ClientAnchor	Âncora para associar a imagem.

Retorno

( org.apache.poi.ss.usermodel.Picture )

O objeto de referência da imagem inserida.

---

mergedRegion

---

_xls.mergedRegion(primeiraLinha: int, ultimaLinha: int, primeiraColuna: int, ultimaColuna: int) : int

Descrição

Realiza a mesclagem de células na região.

Atributos

NOME	TIPO	DESCRIÇÃO
primeiraLinha	int	Número da primeira linha.
ultimaLinha	int	Número da última linha.
primeiraColuna	int	Número da primeira coluna.
ultimaColuna	int	Número da última coluna.

Retorno

( int )

A referência da região de células mesclada.

---

_xls.mergedRegion(folhaCalculos: org.apache.poi.ss.usermodel.Sheet, primeiraLinha: int, ultimaLinha: int, primeiraColuna: int, ultimaColuna: int) : int

Descrição

Realiza a mesclagem de células na região passada em uma folha de cálculos específica.

Atributos

NOME	TIPO	DESCRIÇÃO
folhaCalculos	org.apache.poi.ss.usermodel.Sheet	Folha de cálculos que será mesclada as células.
primeiraLinha	int	Número da primeira linha.
ultimaLinha	int	Número da última linha.
primeiraColuna	int	Número da primeira coluna.
ultimaColuna	int	Número da última coluna.

Retorno

( int )

A referência da região de células mesclada.

---

open

---

_xls.open(entrada: InputStream) : XLS

Descrição

Abre um arquivo do Excel.

Atributos

NOME	TIPO	DESCRIÇÃO
entrada	InputStream	Objeto de fluxo de entrada de dados do arquivo.

Retorno

( XLS )

Arquivo aberto em uma nova instância do recurso XLS.

---

_xls.open(entrada: InputStream, senha: string) : XLS

Descrição

Abre um arquivo do Excel.

Atributos

NOME	TIPO	DESCRIÇÃO
entrada	InputStream	Objeto de fluxo de entrada de dados do arquivo.
senha	string	Senha do arquivo.

Retorno

( XLS )

Arquivo aberto em uma nova instância do recurso XLS.

---

_xls.open(arquivo: File) : XLS

Descrição

Abre um arquivo do Excel.

Atributos

NOME	TIPO	DESCRIÇÃO
arquivo	File	Arquivo do tipo documento de Excel.

Retorno

( XLS )

Arquivo aberto em uma nova instância do recurso XLS.

---

_xls.open(arquivo: File, senha: string) : XLS

Descrição

Abre um arquivo do Excel.

Atributos

NOME	TIPO	DESCRIÇÃO
arquivo	File	Arquivo do tipo documento de Excel.
senha	string	Senha do arquivo.

Retorno

( XLS )

Arquivo aberto em uma nova instância do recurso XLS.

---

_xls.open(entrada: InputStream) : XLS

Descrição

Abre um arquivo do Excel.

Atributos

NOME	TIPO	DESCRIÇÃO
entrada	InputStream	Objeto de fluxo de entrada de dados do arquivo.

Retorno

( XLS )

Arquivo aberto em uma nova instância do recurso XLS.

---

_xls.open(entrada: InputStream, senha: string) : XLS

Descrição

Abre um arquivo do Excel.

Atributos

NOME	TIPO	DESCRIÇÃO
entrada	InputStream	Objeto de fluxo de entrada de dados do arquivo.
senha	string	Senha do arquivo.

Retorno

( XLS )

Arquivo aberto em uma nova instância do recurso XLS.

---

_xls.open(storage: Storage) : XLS

Descrição

Abre um arquivo do Excel.

Atributos

NOME	TIPO	DESCRIÇÃO
storage	Storage	Referência do storage onde está o arquivo que será aberto.

Retorno

( XLS )

Arquivo aberto em uma nova instância do recurso XLS.

---

_xls.open(storage: Storage, senha: string) : XLS

Descrição

Abre um arquivo do Excel.

Atributos

NOME	TIPO	DESCRIÇÃO
storage	Storage	Referência do storage onde está o arquivo que será aberto.
senha	string	Senha do arquivo.

Retorno

( XLS )

Arquivo aberto em uma nova instância do recurso XLS.

---

output

---

_xls.create().output(nomeFicheiro: string) : void

Descrição

Realiza o envio de dados do ficheiro final para o cliente realizar o download.

Atributos

NOME	TIPO	DESCRIÇÃO
nomeFicheiro	string	Nome do ficheiro.

Retorno

( void )

---

position

---

_xls.position(linha: int, coluna: int) : XLSPosition

Descrição

Obtém o objeto de posicionamento.

Atributos

NOME	TIPO	DESCRIÇÃO
linha	int	Número da linha.
coluna	int	Número da coluna.

Retorno

( XLSPosition )

Referência da posição com base nas coordenadas passadas.

---

read

---

_xls.read(input: InputStream) : Values

Descrição

Realiza a leitura de um ficheiro Excel, obtém todos os dados.

Atributos

NOME	TIPO	DESCRIÇÃO
input	InputStream	Referência do ficheiro Excel.

Retorno

( Values )

Estrutura com todos os dados obtidos através da leitura e processamento do ficheiros Excel.

---

_xls.read(input: InputStream, escondidas: boolean) : Values

Descrição

Realiza a leitura de um ficheiro Excel, obtém todos os dados.

Atributos

NOME	TIPO	DESCRIÇÃO
input	InputStream	Referência do ficheiro Excel.
escondidas	boolean	Processa também folhas de cálculos escondidas.

Retorno

( Values )

Estrutura com todos os dados obtidos através da leitura e processamento do ficheiros Excel.

---

_xls.read(input: InputStream, numero: int) : Values

Descrição

Realiza a leitura de um ficheiro Excel, obtém todos os dados.

Atributos

NOME	TIPO	DESCRIÇÃO
input	InputStream	Referência do ficheiro Excel.
numero	int	Número da folha de cálculos.

Retorno

( Values )

Estrutura com todos os dados obtidos através da leitura e processamento do ficheiros Excel.

---

_xls.read(input: InputStream, escondidas: string) : Values

Descrição

Realiza a leitura de um ficheiro Excel, obtém todos os dados.

Atributos

NOME	TIPO	DESCRIÇÃO
input	InputStream	Referência do ficheiro Excel.
escondidas	string	Processa também folhas de cálculos escondidas.

Retorno

( Values )

Estrutura com todos os dados obtidos através da leitura e processamento do ficheiros Excel.

---

_xls.read(input: InputStream, numero: string, escondidas: boolean) : Values

Descrição

Realiza a leitura de um ficheiro Excel, obtém todos os dados.

Atributos

NOME	TIPO	DESCRIÇÃO
input	InputStream	Referência do ficheiro Excel.
numero	string	Número da folha de cálculos.
escondidas	boolean	Processa também folhas de cálculos escondidas.

Retorno

( Values )

Estrutura com todos os dados obtidos através da leitura e processamento do ficheiros Excel.

---

_xls.read(input: InputStream, numero: string, escondidas: int) : Values

Descrição

Realiza a leitura de um ficheiro Excel, obtém todos os dados.

Atributos

NOME	TIPO	DESCRIÇÃO
input	InputStream	Referência do ficheiro Excel.
numero	string	Número da folha de cálculos.
escondidas	int	Processa também folhas de cálculos escondidas.

Retorno

( Values )

Estrutura com todos os dados obtidos através da leitura e processamento do ficheiros Excel.

---

_xls.read(in: InputStream, password: string, sheetNumber: int, hiddenSheets: boolean) : Values

Atributos

NOME	TIPO	DESCRIÇÃO
in	InputStream
password	string
sheetNumber	int
hiddenSheets	boolean

Retorno

( Values )

---

_xls.read(input: File) : Values

Descrição

Realiza a leitura de um ficheiro Excel, obtém todos os dados.

Atributos

NOME	TIPO	DESCRIÇÃO
input	File	Referência do ficheiro Excel.

Retorno

( Values )

Estrutura com todos os dados obtidos através da leitura e processamento do ficheiros Excel.

---

_xls.read(input: File, escondidas: boolean) : Values

Descrição

Realiza a leitura de um ficheiro Excel, obtém todos os dados.

Atributos

NOME	TIPO	DESCRIÇÃO
input	File	Referência do ficheiro Excel.
escondidas	boolean	Processa também folhas de cálculos escondidas.

Retorno

( Values )

Estrutura com todos os dados obtidos através da leitura e processamento do ficheiros Excel.

---

_xls.read(input: File, numero: int) : Values

Descrição

Realiza a leitura de um ficheiro Excel, obtém todos os dados.

Atributos

NOME	TIPO	DESCRIÇÃO
input	File	Referência do ficheiro Excel.
numero	int	Número da folha de cálculos.

Retorno

( Values )

Estrutura com todos os dados obtidos através da leitura e processamento do ficheiros Excel.

---

_xls.read(input: File, numero: int, escondidas: boolean) : Values

Descrição

Realiza a leitura de um ficheiro Excel, obtém todos os dados.

Atributos

NOME	TIPO	DESCRIÇÃO
input	File	Referência do ficheiro Excel.
numero	int	Número da folha de cálculos.
escondidas	boolean	Processa também folhas de cálculos escondidas.

Retorno

( Values )

Estrutura com todos os dados obtidos através da leitura e processamento do ficheiros Excel.

---

_xls.read(input: File, escondidas: string) : Values

Descrição

Realiza a leitura de um ficheiro Excel, obtém todos os dados.

Atributos

NOME	TIPO	DESCRIÇÃO
input	File	Referência do ficheiro Excel.
escondidas	string	Processa também folhas de cálculos escondidas.

Retorno

( Values )

Estrutura com todos os dados obtidos através da leitura e processamento do ficheiros Excel.

---

_xls.read(input: File, numero: string, escondidas: boolean) : Values

Descrição

Realiza a leitura de um ficheiro Excel, obtém todos os dados.

Atributos

NOME	TIPO	DESCRIÇÃO
input	File	Referência do ficheiro Excel.
numero	string	Número da folha de cálculos.
escondidas	boolean	Processa também folhas de cálculos escondidas.

Retorno

( Values )

Estrutura com todos os dados obtidos através da leitura e processamento do ficheiros Excel.

---

_xls.read(input: File, numero: string, escondidas: int) : Values

Descrição

Realiza a leitura de um ficheiro Excel, obtém todos os dados.

Atributos

NOME	TIPO	DESCRIÇÃO
input	File	Referência do ficheiro Excel.
numero	string	Número da folha de cálculos.
escondidas	int	Processa também folhas de cálculos escondidas.

Retorno

( Values )

Estrutura com todos os dados obtidos através da leitura e processamento do ficheiros Excel.

---

_xls.read(file: File, password: string, sheetNumber: int, hiddenSheets: boolean) : Values

Atributos

NOME	TIPO	DESCRIÇÃO
file	File
password	string
sheetNumber	int
hiddenSheets	boolean

Retorno

( Values )

---

_xls.read(input: Storage) : Values

Descrição

Realiza a leitura de um ficheiro Excel, obtém todos os dados.

Atributos

NOME	TIPO	DESCRIÇÃO
input	Storage	Referência do ficheiro Excel.

Retorno

( Values )

Estrutura com todos os dados obtidos através da leitura e processamento do ficheiros Excel.

---

_xls.read(input: Storage, escondidas: boolean) : Values

Descrição

Realiza a leitura de um ficheiro Excel, obtém todos os dados.

Atributos

NOME	TIPO	DESCRIÇÃO
input	Storage	Referência do ficheiro Excel.
escondidas	boolean	Processa também folhas de cálculos escondidas.

Retorno

( Values )

Estrutura com todos os dados obtidos através da leitura e processamento do ficheiros Excel.

---

_xls.read(input: Storage, numero: int) : Values

Descrição

Realiza a leitura de um ficheiro Excel, obtém todos os dados.

Atributos

NOME	TIPO	DESCRIÇÃO
input	Storage	Referência do ficheiro Excel.
numero	int	Número da folha de cálculos.

Retorno

( Values )

Estrutura com todos os dados obtidos através da leitura e processamento do ficheiros Excel.

---

_xls.read(input: Storage, numero: int, escondidas: boolean) : Values

Descrição

Realiza a leitura de um ficheiro Excel, obtém todos os dados.

Atributos

NOME	TIPO	DESCRIÇÃO
input	Storage	Referência do ficheiro Excel.
numero	int	Número da folha de cálculos.
escondidas	boolean	Processa também folhas de cálculos escondidas.

Retorno

( Values )

Estrutura com todos os dados obtidos através da leitura e processamento do ficheiros Excel.

---

_xls.read(input: Storage, escondidas: string) : Values

Descrição

Realiza a leitura de um ficheiro Excel, obtém todos os dados.

Atributos

NOME	TIPO	DESCRIÇÃO
input	Storage	Referência do ficheiro Excel.
escondidas	string	Processa também folhas de cálculos escondidas.

Retorno

( Values )

Estrutura com todos os dados obtidos através da leitura e processamento do ficheiros Excel.

---

_xls.read(input: Storage, numero: string, escondidas: boolean) : Values

Descrição

Realiza a leitura de um ficheiro Excel, obtém todos os dados.

Atributos

NOME	TIPO	DESCRIÇÃO
input	Storage	Referência do ficheiro Excel.
numero	string	Número da folha de cálculos.
escondidas	boolean	Processa também folhas de cálculos escondidas.

Retorno

( Values )

Estrutura com todos os dados obtidos através da leitura e processamento do ficheiros Excel.

---

_xls.read(input: Storage, numero: string, escondidas: int) : Values

Descrição

Realiza a leitura de um ficheiro Excel, obtém todos os dados.

Atributos

NOME	TIPO	DESCRIÇÃO
input	Storage	Referência do ficheiro Excel.
numero	string	Número da folha de cálculos.
escondidas	int	Processa também folhas de cálculos escondidas.

Retorno

( Values )

Estrutura com todos os dados obtidos através da leitura e processamento do ficheiros Excel.

---

_xls.read(storage: Storage, password: string, sheetNumber: int, hiddenSheets: boolean) : Values

Atributos

NOME	TIPO	DESCRIÇÃO
storage	Storage
password	string
sheetNumber	int
hiddenSheets	boolean

Retorno

( Values )

---

row

---

_xls.create().row(linha: int) : org.apache.poi.ss.usermodel.Row

Descrição

Obtém uma linha da folha de cálculos e caso não exista então será criada.

Atributos

NOME	TIPO	DESCRIÇÃO
linha	int	Número da linha.

Retorno

( org.apache.poi.ss.usermodel.Row )

Objeto de representação da linha.

---

_xls.create().row(folhaCalculos: org.apache.poi.ss.usermodel.Sheet, linha: int) : org.apache.poi.ss.usermodel.Row

Descrição

Obtém uma linha da folha de cálculos e caso não exista então será criada.

Atributos

NOME	TIPO	DESCRIÇÃO
folhaCalculos	org.apache.poi.ss.usermodel.Sheet	Objeto de folha de cálculos.
linha	int	Número da linha.

Retorno

( org.apache.poi.ss.usermodel.Row )

Objeto de representação da linha.

---

safeSheetName

---

_xls.safeSheetName(nome: string) : string

Descrição

Transforma o texto passado para ser um nome válido de folha de cálculos cumprindo as regras do Excel.

Atributos

NOME	TIPO	DESCRIÇÃO
nome	string	Nome que deverá ser transformado.

Retorno

( string )

Nome válido para ser utilizado como nome da folha de cálculos.

---

_xls.safeSheetName(nome: string, caracter: char) : string

Descrição

Transforma o texto passado para ser um nome válido de folha de cálculos cumprindo as regras do Excel.

Atributos

NOME	TIPO	DESCRIÇÃO
nome	string	Nome que deverá ser transformado.
caracter	char	Carácter de substituição.

Retorno

( string )

Nome válido para ser utilizado como nome da folha de cálculos.

---

save

---

_xls.create().save(output: OutputStream) : void

Descrição

Realiza a escrita dos dados do ficheiro final para o output.

Atributos

NOME	TIPO	DESCRIÇÃO
output	OutputStream	Output onde o ficheiro será guardado.

Retorno

( void )

---

_xls.create().save(file: File) : void

Descrição

Realiza a escrita dos dados do ficheiro final.

Atributos

NOME	TIPO	DESCRIÇÃO
file	File	Ficheiro que será guardado.

Retorno

( void )

---

_xls.create().save(output: OutputStream) : void

Descrição

Realiza a escrita dos dados do ficheiro final para o output.

Atributos

NOME	TIPO	DESCRIÇÃO
output	OutputStream	Output onde o ficheiro será guardado.

Retorno

( void )

---

_xls.create().save(storage: Storage) : void

Descrição

Realiza a escrita dos dados do ficheiro final para o storage interno da aplicação.

Atributos

NOME	TIPO	DESCRIÇÃO
storage	Storage	Referência do storage onde o ficheiro será guardado.

Retorno

( void )

---

setCellData

---

_xls.setCellData(linha: int, coluna: int, dados: Config | Exec | Header | Req | Res | Values | DataSchema) : XLS

Descrição

Insere dados numa célula específica.

Atributos

NOME	TIPO	DESCRIÇÃO
linha	int	Número da linha.
coluna	int	Número da coluna.
dados	Config | Exec | Header | Req | Res | Values | DataSchema	Dados que serão inseridos.

Retorno

( XLS )

A instância atual do recurso XLS.

---

_xls.setCellData(linha: int, coluna: int, dados: Values) : XLS

Descrição

Insere dados numa célula específica.

Atributos

NOME	TIPO	DESCRIÇÃO
linha	int	Número da linha.
coluna	int	Número da coluna.
dados	Values	Dados que serão inseridos.

Retorno

( XLS )

A instância atual do recurso XLS.

---

_xls.setCellData(celula: org.apache.poi.ss.usermodel.Cell, dados: Config | Exec | Header | Req | Res | Values | DataSchema) : XLS

Descrição

Insere dados numa célula específica.

Atributos

NOME	TIPO	DESCRIÇÃO
celula	org.apache.poi.ss.usermodel.Cell	Objeto da célula.
dados	Config | Exec | Header | Req | Res | Values | DataSchema	Dados que serão inseridos.

Retorno

( XLS )

A instância atual do recurso XLS.

---

_xls.setCellData(celula: org.apache.poi.ss.usermodel.Cell, dados: Values) : XLS

Descrição

Insere dados numa célula específica.

Atributos

NOME	TIPO	DESCRIÇÃO
celula	org.apache.poi.ss.usermodel.Cell	Objeto da célula.
dados	Values	Dados que serão inseridos.

Retorno

( XLS )

A instância atual do recurso XLS.

---

_xls.setCellData(folhaCalculos: org.apache.poi.ss.usermodel.Sheet, linha: int, coluna: int, dados: Config | Exec | Header | Req | Res | Values | DataSchema) : XLS

Descrição

Insere dados numa célula específica em uma planilha de cálculos.

Atributos

NOME	TIPO	DESCRIÇÃO
folhaCalculos	org.apache.poi.ss.usermodel.Sheet	Objeto da folha de cálculos.
linha	int	Número da linha.
coluna	int	Número da coluna.
dados	Config | Exec | Header | Req | Res | Values | DataSchema	Dados que serão inseridos.

Retorno

( XLS )

A instância atual do recurso XLS.

---

_xls.setCellData(folhaCalculos: org.apache.poi.ss.usermodel.Sheet, linha: int, coluna: int, dados: Values) : XLS

Descrição

Insere dados numa célula específica em uma planilha de cálculos.

Atributos

NOME	TIPO	DESCRIÇÃO
folhaCalculos	org.apache.poi.ss.usermodel.Sheet	Objeto da folha de cálculos.
linha	int	Número da linha.
coluna	int	Número da coluna.
dados	Values	Dados que serão inseridos.

Retorno

( XLS )

A instância atual do recurso XLS.

---

sheet

---

_xls.create().sheet() : org.apache.poi.ss.usermodel.Sheet

Descrição

Para obter a folha de cálculos atual que está sendo utilizada para manipular os dados.

Como Usar

const folhaDeCalculos = _xls.create().sheet();

Retorno

( org.apache.poi.ss.usermodel.Sheet )

Obtém a folha de cálculos atual.

---

units

---

_xls.units() : java.lang.Class

Descrição

Obtém os tipos de unidades pré definidos no Excel, útil para realizar a conversão entre pixeis e pontos.

Retorno

( java.lang.Class )

A classe do Apache POI que ajuda a manipular as unidades do Excel.

---

validSheetName

---

_xls.validSheetName(nome: string) : boolean

Descrição

Verifica se o texto passado é um nome válido de folha de cálculos que cumpre as regras do Excel.

Atributos

NOME	TIPO	DESCRIÇÃO
nome	string	Nome que deverá ser validado.

Retorno

( boolean )

Se é válido para ser utilizado como nome da folha de cálculos.

---

verticalAlignment

---

_xls.verticalAlignment(tipo: string) : org.apache.poi.ss.usermodel.VerticalAlignment

Descrição

Gera o alinhamento vertical.

Atributos

NOME	TIPO	DESCRIÇÃO
tipo	string	Nome do tipo de alinhamento vertical, suporta: top center bottom justify distributed

Retorno

( org.apache.poi.ss.usermodel.VerticalAlignment )

O alinhamento vertical configurado com o tipo definido.

---

workbook

---

_xls.create().workbook() : org.apache.poi.ss.usermodel.Workbook

Descrição

Cria um novo documento Excel.

Como Usar

const workbook = _xls.create().workbook();

Retorno

( org.apache.poi.ss.usermodel.Workbook )

Obtém o workbook.

---