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

  • DataVisualization

Members


<constant> COLUMN_VALUE_PREFIX :string

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

Type:
  • string

columns :ReportVisualizationColumns

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

Type:
  • ReportVisualizationColumns

dataSourceQuery :Object|number

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

Type:
  • Object | number

dataSourceQueryKey :number

A chave do DataSourceQuery associado à visualização.

Type:
  • number
Deprecated:
  • Use #dataSourceQuery

<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

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

<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

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

totalLabel :string

O texto exibido na linha com os totais.

Type:
  • string
Default Value:
  • 'Total'

Methods


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


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
ReportVisualizationColumn

getExportableData()


queryData()


render()