Class: ReportVisualization

@nginstack/web-framework/lib/dsv/ReportVisualization~ ReportVisualization

new ReportVisualization(definition)

Classe que monta um SimpleLayout para exibir os dados de um DSV.

Parameters:
Name Type Description
definition Object

Objeto contendo as definições de filtros, colunas e demais propriedades da visualização.
See:
  • ReportVisualizationDef

Extends

Members

<constant> COLUMN_VALUE_PREFIX :string

Prefixo utilizado nos relatórios para fazer referência ao valor contido em uma coluna.

Type:
  • string

canExport :boolean

Indica se a visualização pode realizar exportação. Esta propriedade deve ser utilizada quando se deseja desabilitar a exportação, sendo setada para false; setá-la para true não dará a capacidade de exportação para uma visualização que não possa ser exportada por padrão.

Type:
  • boolean
Inherited From:
Default Value:
  • true

canExportToPdf :boolean

Indica se os dados do relatório podem ser exportados para PDF.

Type:
  • boolean
See:
  • ReportVisualizationDef#canExportToPdf

columns :module:@nginstack/web-framework/lib/dsv/ReportVisualizationColumns~ReportVisualizationColumns

Coleção contendo as definições de colunas para o SimpleLayout.

Type:

dataSourceQuery :!Record.<*, *>|number

A chave do DataSourceQuery ou objeto literal que contém as definições do DataSourceQuery associado à visualização.

Type:
  • !Record.<*, *>| number
Overrides:

dataSourceQueryKey :number

A chave do DataSourceQuery associado à visualização.

Type:
  • number
Deprecated:

extraExportFormats :Array.<{name: string, processKey: number, useRawData: boolean}>

Formatos de exportação adicionais que a visualização suporta. Seus elementos são objetos literais que contêm o nome do formato de exportação, a chave do processo correspondente e uma flag que indica se devem ser exportados os dados da visualização conforme obtidos da fonte de dados.

Type:
  • Array.<{name: string, processKey: number, useRawData: boolean}>
Inherited From:

filters :module:@nginstack/web-framework/lib/dsv/VisualizationFilters~VisualizationFilters

Coleção de filtros da visualização composta. Contém os filtros também de seus itens.

Type:
Inherited From:

O rodapé do relatório.

Type:

<nullable> footerComplement :string

Texto que servirá de complemento ao rodapé. Esta propriedade aceita texto em HTML.

Type:
  • string
Deprecated:
  • Use a propriedade complement da propriedade #footer.
See:
  • ReportVisualization#showFooter

<nullable> groupExpansionLevel :number

O nível de expansão que deve ser utilizado pelo SimpleLayout.

Type:
  • number

O cabeçalho do relatório.

Type:

headerComplement :string

Texto que servirá de complemento ao cabeçalho. Esta propriedade aceita texto em HTML.

Type:
  • string
Deprecated:
  • Use a propriedade complement da propriedade #header.
See:
  • ReportVisualization#showHeader

help :string

Ajuda que será exibida para o usuário quando ele solicitar ajuda desta visualização.

Type:
  • string
Inherited From:

includeCss :boolean

Determina se uma tag "style" contendo os estilos CSS necessários por esta visualização deve ser incluída no HTML gerado.

A inclusão dos estilos CSS é desnecessária em relatórios exibidos nas interfaces do Web Framework, pois esses estilos são carregados automaticamente pelo sistema.

Type:
  • boolean
Inherited From:

includes :Array.<(number|string)>

Scripts a serem inclusos pela visualização, quando ela for instanciada.

Type:
  • Array.<(number|string)>
Inherited From:

initialized :boolean

Indica se a visualização se encontra inicializada.

Type:
  • boolean
Inherited From:

noResultsMessage :string

Mensagem que será exibida para o usuário quando não há dados a serem exibidos.

Type:
  • string
Inherited From:

onCreate :module:@nginstack/engine/lib/event/Event~Event

Evento executado na criação da visualização. Quando disparado, passa como parâmetro a instância da visualização sendo criada.

Type:
Inherited From:

<nullable> orderBy :string

Os nomes das colunas pelas quais a visualização deve ser ordenada, separados por ponto-e-vírgula. Para ordenar uma coluna em ordem descendente, utilize um sinal negativo ('-') precedendo o nome da coluna.

Type:
  • string

path :string|null

Indica o caminho utilizado pelo usuário para acessar esta visualização.

Type:
  • string| null
Inherited From:

rankingColumnLabel :string

O texto da coluna de ranking.

Type:
  • string
Default Value:
  • 'Ranking'

showDateTime :boolean

Indica se deverá ser apresentada a data e hora em que o relatório foi gerado. Esta informação se encontra na parte superior direita do relatório.

Type:
  • boolean
Deprecated:
  • Use a propriedade showDateTime da propriedade #header.
Default Value:
  • true

showEnterpriseName :boolean

Indica se o nome da empresa licenciada deve ser exibido no topo do relatório.

Type:
  • boolean
Deprecated:
  • Use a propriedade showEnterpriseName da propriedade #header.
Default Value:
  • true

showFooter :boolean

Indica se será exibido o rodapé do relatório.

Type:
  • boolean
Deprecated:
  • Use a propriedade visible da propriedade #footer.
Default Value:
  • true
See:
  • ReportVisualization#footerComplement

showHeader :boolean

Indica se será exibido o cabeçalho do relatório.

Type:
  • boolean
Deprecated:
  • Use a propriedade visible da propriedade #header.
Default Value:
  • true
See:
  • ReportVisualization#headerComplement

showOnlyFilledVariables :boolean

Indica se deverão ser apresentadas somente as variáveis preenchidas com algum valor pelo usuário quando da geração do Layout. Caso esta propriedade esteja marcada como "false", serão apresentadas todas as variáveis da grade que deu origem no Layout. Note que esta propriedade será ignorada se a propriedade showVariables estiver marcada como "false".

Type:
  • boolean
Deprecated:
  • Use a propriedade filtersDisplay da propriedade #header.
Default Value:
  • true
See:
  • ReportVisualization#showVariables

showPath :boolean

Indica se apresentará o caminho do relatório subjacente na hierarquia de classes do Sistema Virtual de Arquivos (Virtual File System).

Type:
  • boolean
Deprecated:
  • Use a propriedade showPath da propriedade #footer
Default Value:
  • true

showRankingColumn :boolean

Indica se o SimpleLayout deve exibir a coluna de ranking.

Type:
  • boolean
Default Value:
  • false

showUserAndDataBaseName :boolean

Indica se deverá ser exibido no relatório o código do usuário logado e o nome da base de dados. Esta informação se encontra na parte superior direita do relatório ("Usuário Logado / BASE").

Type:
  • boolean
Deprecated:
  • Use a propriedade showUserAndDatabaseName da propriedade #header
Default Value:
  • true

showVariables :boolean

Indica se deverão ser apresentadas as variáveis utilizadas para a geração do relatório.

Type:
  • boolean
Deprecated:
  • Use a propriedade filtersDisplay da propriedade #header.
Default Value:
  • true
See:
  • ReportVisualization#showOnlyFilledVariables

title :string

Título desta visualização.

Type:
  • string
Inherited From:

totalLabel :string

O texto exibido na linha com os totais.

Type:
  • string
Default Value:
  • 'Total'

Methods

getColumn(name)

Retorna a coluna que possui o nome, nome canônico, aliás ou nome de campo que corresponde ao nome informado.

Parameters:
Name Type Description
name string

O nome a procurar nas colunas deste renderizador.
Returns:

A coluna que corresponde ao nome informado.

Type
module:@nginstack/web-framework/lib/dsv/ReportVisualizationColumn~ReportVisualizationColumn

getDataToExport(filterValues)

Obtém um objeto com os dados para exportação.

Parameters:
Name Type Description
filterValues Record.<string, *>

Mapa contendo os nomes dos filtros da visualização como chaves, relacionando-lhes a seus valores.
Inherited From:

getExportableData()

Obtém um objeto relacionando a visualização aos processos de exportação.

Overrides:
Returns:
Type
Array.<{formats: Array.<{name: string, processKey: number}>, getExporter: function(): module:@nginstack/web-framework/lib/export/DataExporter~DataExporter, getRawDataExporter: function(): module:@nginstack/web-framework/lib/export/DataExporter~DataExporter, title: string}>

hasData()

Verifica se este DSV tem dados para serem exibidos.

Inherited From:
Returns:

Indica se o DSV tem dados.

Type
boolean

queryData(filterValues)

Gera os dados para a visualização.

Parameters:
Name Type Description
filterValues Record.<string, *>

Mapa contendo os nomes dos filtros da visualização como chaves, relacionando-lhes a seus valores.
Overrides:

render(outputObj)

Renderiza o DSV.

Parameters:
Name Type Description
outputObj Object

Objeto de saída no qual será montado o DSV.

Properties
Name Type Description
write function

Função invocada pela função render para a escrita do DSV.
Overrides:

<static> registerExportFormat(name, processKey)

Registra um formato de exportação (e seu processo associado) para o tipo ReportVisualization.

Parameters:
Name Type Description
name string

O nome do formato de exportação. O nome informado deverá ser único. Caso já exista um formato registrado com o nome informado, ele será sobrescrito pelo novo processo informado.
processKey number

A chave do processo que implementa o formato de exportação.