nginstack

Class: VisualizationDef

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

new VisualizationDef()

Classe abstrata que contém as configurações comuns a todas as formas de visualização de data sources.
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 ou um código JavaScript que deixa a definição da visualização na pilha. Para exemplos de definição de visualizações, veja ReportVisualizationDef, HighchartsVisualizationDef e CompositeVisualizationDef.

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

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)}>
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.<VisualizationFilterDef>

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

Type:
  • Array.<VisualizationFilterDef>

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

Type:
  • VisualizationFooterDef

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

Type:
  • VisualizationHeaderDef

help :string

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

Type:
  • string

includes :Array.<(number|string)>

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

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

noResultsMessage :string

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

Type:
  • string

<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

title :string

Título desta visualização.

Type:
  • string

type :string

O tipo desta visualização.

Type:
  • string