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) : org.apache.poi.hssf.usermodel.HSSFSheet
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
( org.apache.poi.hssf.usermodel.HSSFSheet )
Folha de cálculos ativa.
add
_xls.add(linha: int, coluna: int, dados: java.util.Map) : 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 | java.util.Map | Dados que serão inseridos. |
Retorno
( XLS )
A instância atual do recurso XLS.
_xls.add(celula: org.apache.poi.hssf.usermodel.HSSFCell, dados: java.util.Map) : XLS
Descrição
Insere dados numa célula específica.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
celula | org.apache.poi.hssf.usermodel.HSSFCell | Objeto da célula. |
dados | java.util.Map | Dados que serão inseridos. |
Retorno
( XLS )
A instância atual do recurso XLS.
_xls.add(celula: org.apache.poi.hssf.usermodel.HSSFCell, dados: Values) : XLS
Descrição
Insere dados numa célula específica.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
celula | org.apache.poi.hssf.usermodel.HSSFCell | Objeto da célula. |
dados | Values | Dados que serão inseridos. |
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: java.util.Map, dados: java.util.List) : XLSPosition
Descrição
Adiciona uma tabela de dados na folha de cálculos.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
config | java.util.Map | 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.hssf.usermodel.HSSFSheet, 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 |
---|---|---|
folhaCalculos | org.apache.poi.hssf.usermodel.HSSFSheet | 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. |
vertical | boolean | Inserir os dados na vertical. |
Retorno
( XLSPosition )
Referência da posição da última célula com dados inserida.
_xls.create()
.addDataTable(folhaCalculos: org.apache.poi.hssf.usermodel.HSSFSheet, 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 |
---|---|---|
folhaCalculos | org.apache.poi.hssf.usermodel.HSSFSheet | 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. |
vertical | boolean | Inserir os dados na vertical. |
Retorno
( XLSPosition )
Referência da posição da última célula com dados inserida.
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:
|
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:
|
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.hssf.usermodel.HSSFCell
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.hssf.usermodel.HSSFCell )
Objeto de representação da célula.
_xls.create()
.cell(linha: org.apache.poi.hssf.usermodel.HSSFSheet, linha: int, coluna: int) : org.apache.poi.hssf.usermodel.HSSFCell
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.hssf.usermodel.HSSFSheet | Objeto da folha de cálculos. |
linha | int | Número da linha da folha. |
coluna | int | Número da coluna. |
Retorno
( org.apache.poi.hssf.usermodel.HSSFCell )
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.hssf.usermodel.HSSFCellStyle
Descrição
Cria um novo estilo de célula no workbook.
Retorno
( org.apache.poi.hssf.usermodel.HSSFCellStyle )
O novo estilo de célula criado.
cellStyleFormat
_xls.cellStyleFormat(formato: string) : org.apache.poi.hssf.usermodel.HSSFCellStyle
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.hssf.usermodel.HSSFCellStyle )
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:
|
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.hssf.usermodel.HSSFSheet
Descrição
Cria uma nova folha de cálculos.
Retorno
( org.apache.poi.hssf.usermodel.HSSFSheet )
Folha de cálculos criada.
_xls.create()
.createSheet(nome: string) : org.apache.poi.hssf.usermodel.HSSFSheet
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.hssf.usermodel.HSSFSheet )
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:
|
Retorno
( org.apache.poi.ss.usermodel.FillPatternType )
O padrão de preenchimento configurado com o tipo definido.
font
_xls.font() : org.apache.poi.hssf.usermodel.HSSFFont
Descrição
Cria um novo estilo de fonte no workbook.
Retorno
( org.apache.poi.hssf.usermodel.HSSFFont )
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.
getSheet
_xls.create()
.getSheet(index: int) : org.apache.poi.hssf.usermodel.HSSFSheet
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.hssf.usermodel.HSSFSheet )
Folha de cálculos referente ao número (index).
_xls.create()
.getSheet(nome: string) : org.apache.poi.hssf.usermodel.HSSFSheet
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.hssf.usermodel.HSSFSheet )
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:
|
Retorno
( org.apache.poi.ss.usermodel.HorizontalAlignment )
O alinhamento horizontal configurado com o tipo definido.
insertPicture
_xls.insertPicture(folhaCalculos: org.apache.poi.hssf.usermodel.HSSFSheet, 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.hssf.usermodel.HSSFSheet | 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.hssf.usermodel.HSSFSheet, 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.hssf.usermodel.HSSFSheet | 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.hssf.usermodel.HSSFSheet, 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.hssf.usermodel.HSSFSheet | 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.
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: java.io.InputStream) : Values
Descrição
Realiza a leitura de um ficheiro Excel, obtém todos os dados.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
input | java.io.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: java.io.InputStream, escondidas: boolean) : Values
Descrição
Realiza a leitura de um ficheiro Excel, obtém todos os dados.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
input | java.io.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: java.io.InputStream, numero: int) : Values
Descrição
Realiza a leitura de um ficheiro Excel, obtém todos os dados.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
input | java.io.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: java.io.InputStream, 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 | java.io.InputStream | 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) : 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: 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, 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 | InputStream | 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) : 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.
row
_xls.create()
.row(linha: int) : org.apache.poi.hssf.usermodel.HSSFRow
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.hssf.usermodel.HSSFRow )
Objeto de representação da linha.
_xls.create()
.row(folhaCalculos: org.apache.poi.hssf.usermodel.HSSFSheet, linha: int) : org.apache.poi.hssf.usermodel.HSSFRow
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.hssf.usermodel.HSSFSheet | Objeto de folha de cálculos. |
linha | int | Número da linha. |
Retorno
( org.apache.poi.hssf.usermodel.HSSFRow )
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: java.io.OutputStream) : void
Descrição
Realiza a escrita dos dados do ficheiro final para o output.
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
output | java.io.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 )
sheet
_xls.create()
.sheet() : org.apache.poi.hssf.usermodel.HSSFSheet
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.hssf.usermodel.HSSFSheet )
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:
|
Retorno
( org.apache.poi.ss.usermodel.VerticalAlignment )
O alinhamento vertical configurado com o tipo definido.
workbook
_xls.create()
.workbook() : org.apache.poi.hssf.usermodel.HSSFWorkbook
Descrição
Cria um novo documento Excel.
Como Usar
const workbook = _xls.create().workbook();
Retorno
( org.apache.poi.hssf.usermodel.HSSFWorkbook )
Obtém o workbook.