Class: DataSourceQueryColumnDef

@nginstack/datasource/lib/DataSourceQueryColumnDef~ DataSourceQueryColumnDef

new DataSourceQueryColumnDef()

Representa um objeto literal utilizado para a construção de uma coluna do DataSourceQuery.

Extends

Members

aggregate :string

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

Type:
  • string
Inherited From:

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
Inherited From:

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
Inherited From:
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.

<nullable> classKey :number

Quando a definição da coluna ou filtro possui a propriedade name informada, indica que a coluna ou filtro é um lookup para classKey. Quando name não é informado, indica que deve ser importadas colunas ou filtros a partir da classe informada. Para melhor controle dessa importação podem ser utilizadas as propriedades options, para determinar quais os campos que devem ser importados, e prefix, para adicionar um prefixo nos nomes das colunas ou filtros criados na importação.

Type:
  • number
Inherited From:
See:
  • DataSourceFieldDef#options
  • DataSourceFieldDef#prefix

coalesceValue :*

Valor que substitui os valores nulos na consulta dos dados.

Type:
  • *
Inherited From:

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
Inherited From:
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.

displayFormat :DateFormat|LatitudeFormat|LongitudeFormat|AngleFormat|NumberFormat

Formato de exibição dos valores do campo.

Valores possíveis:

  • DateFormat.DDMMYYYY: dia/mês/ano(4 dígitos)
  • DateFormat.DDMMYY: dia/mês/ano(2 dígitos)
  • DateFormat.MMYYYY: mês/ano(4 dígitos)
  • DateFormat.WWYYYY: semana/ano(4 dígitos)
  • LatitudeFormat.DDD_DDDDD: graus decimais°
  • LatitudeFormat.DDD_MM_MMM_DIR: graus° minutos' {N|S}
  • LatitudeFormat.DDD_MM_SS_S_DIR: graus° minutos' segundos" {N|S}
  • LongitudeFormat.DDD_DDDDD: graus°
  • LongitudeFormat.DDD_MM_MMM_DIR: graus° minutos' {E|W}
  • LongitudeFormat.DDD_MM_SS_S_DIR: graus° minutos' segundos" {E|W}
  • AngleFormat.DDD: graus°
  • AngleFormat.DDD_DD: graus decimais°
  • NumberFormat.DECIMAL: número com separador de milhar e decimal
  • NumberFormat.INTEGER: número inteiro com separador de milhar
  • NumberFormat.DBKEY: número inteiro sem separador de milhar
  • NumberFormat.FILE_SIZE: tamanho em bytes em potências de 1024, como 1,5K, 20M ou 2G. Utiliza sempre no máximo 2 casas decimais, ignorando a precisão decimal configurada

Para fins de compatibilidade, também são suportados strings de template no formato definido pela API goog.i18n.NumberFormat, sendo '##0.##' e ##0 os padrões mais comuns, normalmente utilizados para formatar chaves sem separador de milhar. Para esse uso, é recomendado que os códigos sejam revistos para passarem a utilizar o formato NumberFormat.DBKEY.

Atenção: esta propriedade possui apenas o controle da visão em interfaces do sistema e não acontecerá a formatação durante a fase de consumo do DataSource.

Type:
  • DateFormat| LatitudeFormat| LongitudeFormat| AngleFormat| NumberFormat
Inherited From:

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
Inherited From:

help :string

A ajuda associada a coluna.

Type:
  • string
Inherited From:

lookupType :number

Determina o tipo de relacionamento lookup desta coluna ou filtro. 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
Inherited From:
See:

name :string

O nome da coluna ou filtro.

Type:
  • string
Inherited From:

options :Object

Opções da importação de filtros ou colunas. Um filtro ou uma coluna declarada sem nome e com classKey é tratado como uma operação de importação, onde será criado um filtro ou coluna para cada campo da classe informada. Esta propriedade permite indicar quais campos devem ser importados e as opções disponíveis são:

  • onlyVisible: importa apenas os campos visíveis da classe informada.

  • children: indica que também devem ser importados os campos das classes filhas.

  • excludeFieldNames: indica a lista de campos que não devem ser importados.

  • includeFieldNames: indica a lista de campos que devem ser importados. Importante: a princípio, todos os campos são importados mesmo que não estejam relacionados na lista includeFieldNames. Esta propriedade é útil quando utilizada com a opção onlyVisible, para indicar campos não visíveis que também devem ser importados, ou com a onlyIncludedFieldNames, para indicar a lista dos campos que devem ser importados.

  • onlyIncludedFieldNames: indica que apenas os campos informados na opção includeFieldNames devem ser importados.

Type:
  • Object
Inherited From:
See:
  • DataSourceFieldDef#classKey
  • DataSourceFieldDef#prefix

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
Inherited From:
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
Inherited From:
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
Inherited From:

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
Inherited From:
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
Inherited From:
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
Inherited From:

type :string

Tipo de dados do filtro ou coluna. Os valores possíveis são declarados no enumerado module:@nginstack/datasource/lib/DataSourceDataType.

Type:
  • string
Inherited From:
See:

<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
Inherited From: