nginstack

Class: ReportVisualizationColumnDef

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

new ReportVisualizationColumnDef()

Classe utilizada para a documentação do formato das colunas do DSV.

Members

<static> mergeDuplicatedValues :boolean

Indica se os registros com conteúdo duplicado, serão mesclados verticalmente.

Type:
  • boolean

<nullable> classKey :number

Chave da classe que esta coluna representa.

Type:
  • number

<nullable> columnGroup :string

O nome do grupo de colunas ao qual esta pertence. O nome do grupo de colunas é exibido sobre as colunas do relatório, com o objetivo exclusivamente visual de indicar um termo comum a todas elas. Ele é útil para organizar relatórios com uma quantidade elevada de colunas, permitindo o uso de nomes mais curtos ou repetidos.

Type:
  • string
Deprecated:
  • Utilize a propriedade #groupName.

displayFormat :string|number|null

Expressão de formatação para colunas com valores textuais e numéricos. Essa expressão tem o mesmo formato e segue as mesmas regras da propriedade de mesmo nome que existe nas colunas do SimpleLayout.

Type:
  • string | number | null
See:
  • Column#displayFormat

expression :string

Define o valor de uma expressão a ser calculada dinamicamente.

Type:
  • string
Default Value:
  • null

<nullable> groupName :string

O nome do grupo de colunas ao qual esta pertence. O nome do grupo de colunas é exibido sobre as colunas do relatório, com o objetivo exclusivamente visual de indicar um termo comum a todas elas. Ele é útil para organizar relatórios com uma quantidade elevada de colunas, permitindo o uso de nomes mais curtos ou repetidos.

Type:
  • string

groupType :string

O tipo do grupo ao qual a coluna pertence.

Type:
  • string
Default Value:
  • ReporteDef.Column.GroupType.BY_TOTAL_FIELD

height :number|string|null

Altura da célula em pixels.

Type:
  • number | string | null

help :string

A ajuda associada a coluna.

Type:
  • string

label :string

O nome de exibição da coluna.

Type:
  • string

O conjunto de links da coluna.

Ver module:@nginstack/web-framework/lib/dsv/ReportVisualizationColumnDef~ColumnLinkDef para mais detalhes das propriedades dos links.

Type:
  • Array.<ColumnLinkDef>
Example
{
  dataSourceQueryKey: -1891504223, // Usuarios habilitados.idsq
  type: "simpleLayout",

  filters: [
    {name: "begin", label: "Data inicial", required: true},
    {name: "end", label: "Data final", required: true}
  ],
  columns: [
    {name: "U_iClass.NOME", label: "Classe", useToGroup: true},
    {name: "U_iName", label: "Nome do usuário",
      links: [
        {label: 'Link com valores literais', target: 'teste', processKey: 123456, newTab: true, params: {
           teste: '3cpo'
        }},
        {label: 'Link com valores das colunas', dsvKey: 1234567, newTab: true, params: {
           'P_FILTER_NAME': 'column: U_iFullName'
        }}
      ]
    },
    {name: "U_iFullName", label: "Nome completo do usuário"},
    {name: "U_iBegin", label: "Início"},
    {name: "U_iEnd", label: "Fim", simpleLayoutAggregate: "count"}
  ]
}

lookupType :number

Determina o tipo de relacionamento lookup desta coluna. Quando é informada uma classe na propriedade #classKey, o relacionamento pode ser com os registros dessa classe, com as classes filhas dessa classe ou com os arquivos do Sistema de Arquivos Virtual contidos nessa classe. Os valores possíveis são: LookupType.NONE, LookupType.RECORD, LookupType.CLASS e LookupType.FILE.

Type:
  • number

name :string

O nome da coluna.

Type:
  • string

pathDepth :number

Limita a profundidade das classes a serem exibidas pela dimensão !PATH. Isso é limita o caminho exibido no sentido da classe raiz para a classe terminal.

Type:
  • number
Example
{
 columns: [{
   name: classe,
   pathRoot: Classes.DATA,
   pathDepth: 2
 }]
}

Ao exibir o caminho para a classe Classes.VIRTUAL_FILE_SYSTEM o
caminho será "Dados/Sistema" oriundo de "Dados/Sistema/Sistema de arquivos Virtuais"

pathHeight :number

Limita a altura das classes a serem exibidas pela dimensão !PATH. Isso é limita o caminho exibido no sentido da classe terminal para a classe raiz.

Type:
  • number
Example
{
 columns: [{
   name: classe,
   pathRoot: Classes.DATA,
   pathHeight: 2
 }]
}

Ao exibir o caminho para a classe Classes.VIRTUAL_FILE_SYSTEM o
caminho será "Sistema/Sistema de arquivos Virtuais" oriundo de
"Dados/Sistema/Sistema de arquivos Virtuais"

<nullable> pathRoot :number

Chave da classe que representa a raiz para derivação de caminho "!PATH" em colunas que possuem chave de relacionamento. Caso essa propriedade não seja informada, será considerada a propriedade #classKey.

Type:
  • number

pivot :boolean

Indica se esta coluna será pivoteada.

Type:
  • boolean
Default Value:
  • false

renderAsImage :boolean

Indica se deve ser renderizado a imagem correspondente ao cadastro em vez de o valor.

Type:
  • boolean
Default Value:
  • false

renderContentAsHtml :boolean

Indica se a coluna deve ser renderizada em HTML, ou seja, se as tags não devem sofrer escape e ainda ser interpretadas pelo navegador.
Importante: Ligar esta configuração não é recomendada, pois pode comprometer a segurança caso seja mal utilizada.

Type:
  • boolean
Default Value:
  • false

showGlobalActions :boolean

Define se esta coluna deve apresentar ações globais.

Type:
  • boolean
Default Value:
  • true

<nullable> showOutOfTree :boolean

Indica se a coluna deve ser mantida fora dos aninhamentos de grupo, quando utilizada em um relatório.

Type:
  • boolean
Deprecated:
  • Indique que a coluna não deve ser utilizada para agrupamento setando a propriedade #useToGroup com o valor false.

<nullable> simpleLayoutAggregate :string

A forma de agregação usada pelo totalizador da coluna. Seus valores possíveis estão na enumeração TotalAggregate.
Esta propriedade se comporta da mesma forma que a propriedade totalContent das colunas do SimpleLayout.

Type:
  • string
Deprecated:
  • Utilize a propriedade #totalAggregate.
See:
  • Column#totalContent

<nullable> simpleLayoutWeight :string

Nome da coluna que será utilizada como peso no cálculo de médias ponderadas.

Type:
  • string
Deprecated:
  • Utilize a propriedade #totalWeightColumn.

<nullable> totalAggregate :string

A forma de agregação usada pelo totalizador da coluna. Seus valores possíveis estão na enumeração TotalAggregate.
Esta propriedade se comporta da mesma forma que a propriedade totalContent das colunas do SimpleLayout.

Type:
  • string
See:
  • Column#totalContent

<nullable> totalWeightColumn :string

Nome da coluna que será utilizada como peso no cálculo de médias ponderadas.

Type:
  • string

<nullable> useToGroup :boolean

Indica se a coluna será usada para agrupamento por valor. Se essa propriedade não for definida explicitamente, a coluna será usada para agrupamentos se houver uso de pivot na visualização.

Type:
  • boolean

visible :boolean

Indica se a coluna é visível. Por padrão, as colunas utilizadas no DSV são visíveis.

Type:
  • boolean
Default Value:
  • true

width :number|string|null

Largura da célula em pixels.

Type:
  • number | string | null