new HighchartsVisualization(definition)
Classe que monta e renderiza visualizações de gráficos.
Parameters:
| Name | Type | Description |
|---|---|---|
definition |
Object |
Objeto contendo as definições de filtros e demais propriedades da visualização. |
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:
- Default Value:
-
true
-
dataSourceQuery :module:@nginstack/datasource/lib/DataSourceQuery~DataSourceQuery
-
O DataSourceQuery associado à visualização.
Type:
-
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 :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:
-
help :string
-
Ajuda que será exibida para o usuário quando ele solicitar ajuda desta visualização.
Type:
- string
-
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
-
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
-
noResultsMessage :string
-
Mensagem que será exibida para o usuário quando não há dados a serem exibidos.
Type:
- string
-
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:
-
onGetOptions :module:@nginstack/engine/lib/event/Event~Event
-
Evento executado quando a visualização em gráfico é criada. O método invocado recebe a visualização e o DataSet obtido pelo DataSource, e deve retornar as opções de um gráfico, conforme documentado em module:@nginstack/web-framework/lib/chart/Highcharts.Chart
Type:
-
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 filterValuesRecord.<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.
- Inherited From:
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.
Returns:
Indica se o DSV tem dados.
- Type
- boolean
-
queryData(filterValues)
-
Gera os dados para a visualização.
Parameters:
Name Type Description filterValuesRecord.<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 outputObjObject Objeto de saída no qual será montado o DSV.
Properties
Name Type Description writefunction Função invocada pela função render para a escrita do DSV.