nginstack

Class: DataExporter

@nginstack/web-framework/lib/export/DataExporter~ DataExporter

new DataExporter()

Objeto que define a estrutura comum a todos os objetos auxiliares de exportação de dados do Web Framework. Ao invés de utilizar este objeto, faça uso de um dos seus filhos.

See:
  • GridExporter
  • DataSetExporter
  • SimpleLayoutExporter

Members

<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

dataSet :DataSet

DataSet com os dados que serão exportados.

Type:

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

Methods

<static> purgeExpiredExportedFiles()

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

addField(field)

Adiciona um campo a ser exportado.

Parameters:
Name Type Description
field DataExporterFieldDef

Campo a ser exportado.
See:
  • DataExporter#fields

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 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

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
DataExporterFieldDef

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}>