Class: DataSetExporter

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

new DataSetExporter(dataSet)

Objeto responsável por realizar a exportação dos dados de um DataSet através da ferramenta de exportação de dados do Web Framework.

Parameters:
Name Type Description
dataSet module:@nginstack/engine/lib/dataset/DataSet~DataSet

DataSet que será exportado.
See:
  • GridExporter
  • SimpleLayoutExporter

Extends

Members

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

DataSet com os dados que serão exportados.

Type:
Inherited From:
Overrides:

fields :Array

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

Type:
  • Array
Inherited From:
See:
  • DataExporter#addField

title :string

Titulo dos dados a serem exportados.

Type:
  • string
Inherited From:

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.
Inherited From:
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 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.
Inherited From:
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.
Inherited From:
Returns:

Configuração do campo a ser exportado.

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

orderedGroupFields()

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

Inherited From:
Returns:

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

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