new SimpleLayoutExporter(simpleLayout)
Objeto responsável por realizar a exportação dos dados de um relatório gerado por um SimpleLayout.
Parameters:
| Name | Type | Description |
|---|---|---|
simpleLayout |
module:@nginstack/web-framework/lib/simple-layout/SimpleLayout~SimpleLayout |
Relatório que será exportado. |
- See:
-
- DataSetExporter
- GridExporter
Extends
Members
-
dataSet :module:@nginstack/engine/lib/dataset/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
- Inherited From:
- See:
-
- DataExporter#addField
-
<nullable> filters :Array.<{label: string, group: string, value: *}>
-
Filtros utilizados na obtenção dos dados, exibidos no cabeçalho quando os dados são exportados em formato de relatório. O valor
nullindica que não há filtros a serem exibidos, como nos dados exportados de uma grade.Type:
- Array.<{label: string, group: string, value: *}>
- Inherited From:
- See:
Example
exporter.filters = [ { label: 'Situação', group: 'Títulos', value: 'Pendente' } ]; -
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
nullindica 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
Methods
-
addField(field)
-
Adiciona um campo a ser exportado.
Parameters:
Name Type Description fieldmodule:@nginstack/web-framework/lib/export/DataExporterFieldDef~DataExporterFieldDef Campo a ser exportado.
- Inherited From:
- See:
-
- DataExporter#fields
-
configureReportColumn(column, field)
-
Aplica em uma coluna de relatório as configurações de exibição e totalização do campo, como o título, o grupo de colunas, os totais e a formatação numérica.
Parameters:
Name Type Description columnmodule:@nginstack/web-framework/lib/simple-layout/Column~Column Coluna do relatório.
fieldmodule:@nginstack/web-framework/lib/export/DataExporterFieldDef~DataExporterFieldDef Campo que será escrito na coluna.
-
formatFieldGroupName(index)
-
Retorna o nome do campo em dataSet utilizado para armazenar os dados do agrupamento informado.
Parameters:
Name Type Description indexnumber Índice do agrupamento.
Returns:
Nome do campo em dataSet utilizado para armazenar o agrupamento informado.
- Type
- string
-
formatFieldValue(field [, showLookupKeys])
-
Obtém o valor do campo em um formato adequado para a exportação de dados.
Parameters:
Name Type Argument Description fieldmodule:@nginstack/web-framework/lib/export/DataExporterFieldDef~DataExporterFieldDef Campo cujo valor deve ser formatado.
showLookupKeysboolean <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
-
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 fieldmodule:@nginstack/web-framework/lib/export/DataExporterFieldDef~DataExporterFieldDef Campo cujo valor deve ser obtido.
showLookupKeysboolean <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 a ser escrito no relatório.
- Type
- *
-
getField(fieldIdxOrName)
-
Obtém as configurações de exportação de um campo.
Parameters:
Name Type Description fieldIdxOrNamenumber| string Índice ou nome do campo.
Returns:
Configuração do campo a ser exportado.
-
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 fieldmodule:@nginstack/web-framework/lib/export/DataExporterFieldDef~DataExporterFieldDef Campo cujo valor será escrito.
- Inherited From:
Returns:
Opções a serem informadas a SimpleLayout#writeColumn.
- Type
- Object
-
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}>