Class: ReportVisualizationDef

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

new ReportVisualizationDef()

Classe que representa as configurações de visualizações de data sources em formato de um relatório.
Há duas formas de declarar uma visualização de uma fonte de dados. O conteúdo do arquivo pode ser um objeto literal com as propriedades documentadas nesta classe, como demonstrado no primeiro exemplo, ou um código JavaScript que deixa a definição da visualização na pilha, segundo exemplo.
O formato de objeto literal é mais compacto e é útil quando a configuração da visualização é gerada programaticamente. A segunda forma é mais interessante quando utilizada em uma IDE, pois permite que essa faça sugestões e validações das propriedades disponíveis. Ela também permite o uso de lints.
Modo 1:

{
  type: 'report',
  dataSourceQuery: dsqKey,
  filters: [{name: 'MyFilter', type: 'int64'}],
  noResultsMessage: 'Não há dados a serem exibidos.',
  columns: [
    {name: "U_iClass.NOME", label: ""},
    {name: "U_iFullName", label: "Nome completo do usuário"},
    {name: "U_iBegin", label: "Início"},
    {name: "U_iEnd", label: "Fim"}
  ]
}

Modo 2:

__includeOnce('ufs:/uwi/dsv/reportDef.js');

var def = new ReportVisualizationDef();
def.dataSourceQuery = dsqKey;
def.filters = [{name: 'MyFilter', type: 'int64'}];
def.columns = [
  {name: "U_iClass.NOME", label: ""},
  {name: "U_iFullName", label: "Nome completo do usuário"},
  {name: "U_iBegin", label: "Início"},
  {name: "U_iEnd", label: "Fim"}
];
var r = def;

Extends

Members

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:

columns :Array.<module:@nginstack/web-framework/lib/dsv/ReportVisualizationColumnDef~ReportVisualizationColumnDef>

Coleção contendo as definições de colunas que serão montadas pela visualização.

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

dataSourceQueryKey :number

A chave do DataSourceQuery associado à visualização.

Type:
  • number
Deprecated:

extraExportFormats :Array.<{name: string, processKey: number, useRawData: (boolean|undefined)}>

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.

Caso essa propriedade seja declarada na definição de uma visualização, as opções declaradas serão exibidas junto às opções padrão quando o usuário solicitar uma exportação. Quando o usuário selecionar uma dessas opções, será redirecionado ao processo correspondente.

Cada objeto possui:

  • name - O nome do formato de exportação, que será exibido em tela quando o usuário for selecionar um formato.
  • processKey - A chave do processo que implementa a exportação para aquele formato.
  • useRawData - Indica se o formato de exportação deve utilizar os dados "crus" da visualização, isto é, aqueles utilizados para a montagem da exibição. É opcional, e seu valor padrão é false.
Type:
  • Array.<{name: string, processKey: number, useRawData: (boolean|undefined)}>
Inherited From:
Example
{
  dataSourceQueryKey: -1892603784, //./Users.idsq
  type: "report",

  filters: [
    {name: "U_iName", label: "Nome de usuário"}
  ],

  columns: [
    {name: "U_iName", label: "Nome"}
  ],

  extraExportFormats: [
    {name: 'Formato customizado', processKey: 123456, useRawData: true}
  ]
}

filters :Array.<module:@nginstack/web-framework/lib/dsv/VisualizationFilterDef~VisualizationFilterDef>

Coleção de filtros que serão utilizados para filtrar os dados a serem exibidos.

Type:
Inherited From:

Definições a serem usadas para o cabeçalho da visualização.

Type:
Inherited From:

<nullable> footerComplement :string

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

Type:
  • string
See:
  • ReportVisualizationDef#showFooter

<nullable> groupExpansionLevel :number

O nível de expansão em árvore que o relatório montado pela visualização deve utilizar.

Type:
  • number
See:
  • SimpleLayout#groupExpansionLevel

Definições a serem usadas para o cabeçalho da visualização.

Type:
Inherited From:

<nullable> 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:
  • ReportVisualizationDef#showHeader

help :string

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

Type:
  • string
Inherited From:

includes :Array.<(number|string)>

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

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

noResultsMessage :string

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

Type:
  • string
Inherited From:

<nullable> onCreate :function

Se a visualização for instanciada pelo criador de visualizações e este método for declarado, ele será executado após a criação da visualização. Recebe a visualização criada como único parâmetro.

Type:
  • function
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

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
Default Value:
  • true

showEnterpriseName :boolean

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

Type:
  • boolean
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:
  • ReportVisualizationDef#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:
  • ReportVisualizationDef#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
Default Value:
  • true
See:
  • ReportVisualizationDef#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
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
Default Value:
  • true

showVariables :boolean

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

Type:
  • boolean
Default Value:
  • true
See:
  • ReportVisualizationDef#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'

type :string

O tipo desta visualização. Deve ser obrigatoriamente preenchido com o valor 'report'.
Por compatibilidade com versões anteriores, também é suportado o valor 'simpleLayout'.

Type:
  • string
Overrides:
Default Value:
  • 'report'