Class: CompositeVisualizationDef

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

new CompositeVisualizationDef()

Classe abstrata que contém as configurações de visualizações de data sources com a utilização do SimpleLayout.
Exemplo de definição de uma visualização composta:

{
  help: 'Visualização composta, com três relatórios.',
  layout: [
    'ab',
    '.c'
  ],
  items: [
    a: {key: 123},
    b: {key: 234},
    c: {
      type: 'simpleLayout',
       columns: [{name: "U_iClass.NOME", label: ""}],
       filters: [{name: 'MyFilter', type: 'int64'}]
    }
  ],
  type: 'composite'
}

Extends

Members

adjustItemHeaders :boolean

Indica se o Composite deve ajustar os cabeçalhos de seus itens, para ocultar os elementos de cabeçalho cuja exibição não tenha sido indicada explicitamente.

Type:
  • boolean
Default Value:
  • true

autoCreateFilters :boolean

Indica se a composição deve criar seus filtros automaticamente, a partir de seus itens. Nesse caso, o composite cria para si filtros correspondentes a todos os filtros de seus itens. Caso o composite tenha filtros próprios declarados, ele também associa esses filtros a filtros com os mesmos nomes que pertençam aos seus itens.

Type:
  • boolean
Default Value:
  • true

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:

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:

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

Type:
Inherited From:

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:

items :Object.<string, Object>

Mapa que associa caracteres identificadores as visualizações contidas nesta composição. Os valores do mapa são objetos literais que contém chaves de scripts .idsv, ou definições literais de visualizações. Caso o valor seja de um item do mapa seja um objeto literal com a chave de um script .idsv a carregar, essa chave deve estar preenchida na propriedade "key".

Type:
  • Object.<string, Object>

layout :Array.<string>

Array de strings que, em conjunto com o mapa de caracteres em #items, determina a posição de cada visualização na renderização. O array forma um plano cartesiano, onde cada string é uma linha, e cada ocorrência de um caractere possui uma unidade de área (1x1). Cada caractere associado a um item da visualização deve formar um quadrilátero (completamente preenchido) nesse plano. As posições dos caracteres no plano determinam a posição de cada item da visualização quando ela for renderizada.

Type:
  • Array.<string>
Example
layout: [
  'aabc',
  'aabc',
  'dddd'
]

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:

title :string

Título desta visualização.

Type:
  • string
Inherited From:

type :string

O tipo desta visualização. Deve ser obrigatoriamente preenchido com o valor 'composite'.

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