nginstack

Class: Visualization

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

new Visualization(definition)

Classe abstrata responsável pela montagem de dados para visualização de dados de DataSource Visualizations.

Parameters:
Name Type Description
definition Object

Objeto contendo as definições de filtros e demais propriedades da visualização.

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

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

filters :VisualizationFilters

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

Type:
  • VisualizationFilters

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

initialized :boolean

Indica se a visualização se encontra inicializada.

Type:
  • boolean

messageWhenEmpty :string

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

Type:
  • string
Default Value:
  • 'A consulta não retornou resultados.'

mustIncludeCssFiles :boolean

Determina se a visualização deve incluir as tags link ou style, carregando os arquivos CSS. Utilizado quando a visualização precisa utilizar alguma folha de estilo além das folhas padrão do tema (por exemplo, a folha de estilo do SimpleLayout).

Type:
  • boolean
Default Value:
  • true

onCreate :Event

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

Type:
  • Event

path :string|null

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

Type:
  • string | null

title :string

Título desta visualização.

Type:
  • string

Methods

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.

getExportableData()

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

Returns:
Type
Array.<{formats: Array.<{name: string, processKey: number}>, getExporter: function(): DataExporter, getRawDataExporter: function(): DataExporter, title: string}>

hasData()

Verifica se este DSV tem dados para serem exibidos.

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.

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.