nginstack

Class: DataSourceColumnDef

@nginstack/datasource/lib/DataSourceColumnDef~ DataSourceColumnDef

new DataSourceColumnDef()

Representa um objeto literal utilizado para a construção de um DataSourceColumn.

Extends

  • DataSourceFieldDef

Members

<static> AggregateFunctions :string

As formas de agregação para as colunas do DataSource. Esse enumerado é comumente utilizado na propriedade DataSourceColumnDef.aggregate

Type:
  • string
Properties:
Name Type Default Description
NONE string none
SUM string sum
COUNT string count
AVG string avg
MAX string max
MIN string min

<static> Order :string

As formas de ordenação para as colunas do DataSource. Esse enumerado é comumente utilizado na propriedade DataSourceColumnDef.sort

Type:
  • string
Properties:
Name Type Default Description
NONE string none
ASC string asc
DESC string desc

aggregate :string

A forma de agregação da coluna. Seus valores possíveis estão definidos na enumeração DataSourceColumnDef#AggregateFunctions.

Type:
  • string

alias :string

Um nome alternativo pelo qual a coluna pode ser acessada. Será utilizado para representar a coluna no DataSet recuperado pelo DataSource.

Type:
  • string

backDepth :number

O número máximo de classes de um caminho a recuperar, da direita para a esquerda. Esta propriedade só é utilizada quando os valores da coluna são caminhos recuperados por derivação.

Type:
  • number
Deprecated:
  • Yes
See:
Example
Supondo o caminho "Raiz\Dados\Auxiliares\De Cadastros", obtido por derivação.
Caso o valor desta propriedade seja 2, o caminho contido no DataSet de
retorno seria alterado para \Auxiliares\De Cadastros.

coalesceValue :*

Valor que substitui os valores nulos na consulta dos dados.

Type:
  • *

depth :number

O número máximo de classes de um caminho a recuperar, da esquerda para a direita. Esta propriedade só é utilizada quando os valores da coluna são caminhos recuperados por derivação.

Type:
  • number
Deprecated:
  • Yes
See:
Example
Supondo o caminho "Raiz\Dados\Auxiliares\De Cadastros", obtido por derivação.
Caso o valor desta propriedade seja 2, o caminho contido no DataSet de
retorno seria alterado para Raiz\Dados.

distinct :boolean

Indica que devem ser obtidos os valores distintos da coluna informada nas operações de agregação que suportam essa variação, como o Count.

Type:
  • boolean

help :string

A ajuda associada a 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: -1898146248, // /Dados
   pathDepth: 2
 }]
}

Ao exibir o caminho para a classe bdo.keys.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: -1898146248, // /Dados
   pathHeight: 2
 }]
}

<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 a coluna será usada para pivoteamento. Quando uma coluna do DataSource é usada como pivot, ela é desdobrada em várias outras. Será criada uma coluna para cada combinação entre os valores distintos que a coluna teria sem o pivoteamento e os valores correspondentes nas demais colunas. Os nomes dessas colunas ficam no formato [coluna totalizadora][coluna pivoteada][valor na coluna pivoteada], onde "coluna totalizadora" são as demais colunas do DataSource além da pivoteada.

Type:
  • boolean
Deprecated:
  • O pivot deve ser declarado nas colunas das visualizações do tipo report.

<nullable> prefix :string

Prefixo para o nome da coluna. Um underscore ("_") é inserido automaticamente no fim do prefixo.

Type:
  • string
See:
  • DataSourceFieldDef#classKey
  • DataSourceColumnDef#options

showGlobalActions :boolean

Indica se a coluna deve exibir as ações globais. Ações globais são links configurados em uma classe de dados, que representam ações que podem ser realizadas com o registro dessa classe. Por padrão, ao exibir um registro de uma classe, o sistema exibe as ações globais configuradas na classe desse registro. Esta propriedade permite desativar esse comportamento.

Type:
  • boolean

<nullable> weight :string

O nome da coluna que contém o valor do peso empregado na agregação por média (AVG, definido em DataSourceColumnDef#AggregateFunctions) quando se deseja utilizar média ponderada.

Type:
  • string