Class: DataExporter

Members

---

dataSet :module:@nginstack/engine/lib/dataset/DataSet~DataSet

DataSet com os dados que serão exportados.

Type:

• module:@nginstack/engine/lib/dataset/DataSet~DataSet

---

fields :Array

Coleção de definições dos campos que devem exportados.

Type:

• Array

See:

• DataExporter#addField

---

title :string

Titulo dos dados a serem exportados.

Type:

• string

---

totalLabel :string|null|undefined

Rótulo do total geral quando os dados são exportados em formato de relatório. O valor null indica que o total geral não deve ser exibido. Se não for definido, será utilizado o rótulo padrão.

Type:

• string| null| undefined

---

<static> exportedFileLifetime :number

Tempo em milissegundos no qual os arquivos exportados serão mantidos disponíveis para download. Após o tempo informado, os arquivos serão automaticamente excluídos pelo sistema.

Type:

• number

---

<static> tempExportDir :string

Diretório temporário onde serão gravados os arquivos exportados pelo Web Framework.

Type:

• string

Methods

---

addField(field)

Adiciona um campo a ser exportado.

Parameters:

Name	Type	Description
field	module:@nginstack/web-framework/lib/export/DataExporterFieldDef~DataExporterFieldDef	Campo a ser exportado.

See:

• DataExporter#fields

---

configureReportColumn(column, field)

Aplica em uma coluna de relatório as configurações de exibição e totalização do campo.

Parameters:

Name	Type	Description
column	module:@nginstack/web-framework/lib/simple-layout/Column~Column	Coluna do relatório.
field	module:@nginstack/web-framework/lib/export/DataExporterFieldDef~DataExporterFieldDef	Campo que será escrito na coluna.

---

formatFieldValue(field [, showLookupKeys])

Obtém o valor do campo em um formato adequado para a exportação de dados.

Parameters:

Name	Type	Argument	Description
field	module:@nginstack/web-framework/lib/export/DataExporterFieldDef~DataExporterFieldDef		Campo cujo valor deve ser formatado.
showLookupKeys	boolean	<optional>	Indica que os campos lookup devem exibir a chave ao invés do valor retornado pela operação de lookup.

Returns:

Valor do campo formatado para ser exportado.

Type

string

---

formatReportFieldValue(field [, showLookupKeys])

Obtém o valor do campo para ser escrito em uma coluna de relatório. Diferentemente de #formatFieldValue, valores escritos como números no relatório original são retornados como números, permitindo que o novo relatório os formate e alinhe como tal.

Parameters:

Name	Type	Argument	Description
field	module:@nginstack/web-framework/lib/export/DataExporterFieldDef~DataExporterFieldDef		Campo cujo valor deve ser obtido.
showLookupKeys	boolean	<optional>	Indica que os campos lookup devem exibir a chave ao invés do valor retornado pela operação de lookup.

Returns:

Valor a ser escrito no relatório.

Type

*

---

getField(fieldIdxOrName)

Obtém as configurações de exportação de um campo.

Parameters:

Name	Type	Description
fieldIdxOrName	number| string	Índice ou nome do campo.

Returns:

Configuração do campo a ser exportado.

Type

module:@nginstack/web-framework/lib/export/DataExporterFieldDef~DataExporterFieldDef

---

getReportTotalOptions(field)

Obtém as opções de escrita que preservam a totalização do campo em uma coluna de relatório.

Parameters:

Name	Type	Description
field	module:@nginstack/web-framework/lib/export/DataExporterFieldDef~DataExporterFieldDef	Campo cujo valor será escrito.

Returns:

Opções a serem informadas a SimpleLayout#writeColumn.

Type

Object

---

orderedGroupFields()

Retorna a listagem de fields de agrupamento antes dos fields de dados.

Returns:

Listagem de fields ordenadas com os grupos primeiro seguido dos dados, com os índices originais.

Type

Array.<{fieldName: string, originalIndex: number}>

---

<static> purgeExpiredExportedFiles()

Remove os arquivos exportados que ultrapassam o tempo de expiração definido por