Class: DataSourceColumn

@nginstack/engine/lib/datasource/DataSourceColumn~ DataSourceColumn


new DataSourceColumn(name, type)

Coluna de uma fonte de dados.

Parameters:
Name Type Description
name string

Nome da coluna.

type string

Tipo de dado que a coluna contém.

Extends

  • DataSourceField

Members


<static> aliasUniqueId_ :number

Contador compartilhado entre as instâncias de Column que garante que os alias gerados automaticamente por suggestAlias sejam únicos.

Type:
  • number

<static> DIMENSION_SEP :string

Separador entre o nome base da coluna e a dimensão solicitada dessa coluna. Exemplo: iDate!WEEK. iDate é o nome de uma coluna do tipo 'date' e WEEK é a dimensão desejada dessa coluna.

Type:
  • string

alias :string

O alias da coluna. O alias é um nome alternativo, pelo qual a coluna é identificada no resultado da consulta.

Type:
  • string

coalesceValue :*

Valor que substitui os valores nulos na consulta dos dados.

Type:
  • *

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

name :string

O nome da coluna. Para efeito de formato no valor da coluna, a propriedade pode terminar com:
"!URL" - Exibe diretório. (Somente quando valor da coluna é Diretório ou Arquivo)
"!IMAGE" - Exibe imagem principal associada ao registro. (Somente quando valor da coluna é uma chave da iVfs)
"!YEAR" - Apresenta ano formatado a partir de uma data.
"!MONTH" - Apresenta mês formatado a partir de uma data.
"!WEEK" - Apresenta semana formatada a partir de uma data.
"!DAY" - Apresenta dia formatado a partir de uma data.

Type:
  • string

onBeforeAliasChange :function

Callback que é executado quando a coluna tem o seu alias alterado. Evento disparado antes da modificação ser realizada. De uso restrito da coleção DataSourceColumns.

Type:
  • function

<nullable> 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: ngin.keys.Classes.DATA,
   pathDepth: 2
 }]
}

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

<nullable> 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: ngin.keys.Classes.DATA,
   pathHeight: 2
 }]
}

Ao exibir o caminho para a classe ngin.keys.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 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.

propertiesToAssign_


showGlobalActions :boolean

Indica se a coluna deve exibir as ações globais. Ações globais são links configurados em uma classe de dados, possibilitando configurar 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

sort

Deprecated:
  • Yes

<nullable> weight :string

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

Type:
  • string

Methods


<static> colNameFromField(fld, prefix)

Cria o nome de uma coluna do DataSource a partir de um campo(Field) e seu prefixo.

Parameters:
Name Type Description
fld Field

Campo que será usando como base para criação do nome.

prefix string

Prefixo do nome da coluna. Usado para evitar colisão de nomes das colunas.

Returns:

Nome da coluna de DataSource criado a partir do campo e prefixo.

Type
string

<static> fromField(fld, prefix)

Cria uma coluna de DataSource a partir de um campo(Field)

Parameters:
Name Type Description
fld Field

Campo que será usando como base para criação da coluna.

prefix string

Prefixo do nome da coluna. Usado para evitar colisão de nomes das colunas.

Returns:

Coluna de DataSource criado a partir do campo.

Type
DataSourceColumn

getAggregate()

Obtém a função de agregação da coluna, se houver.

Returns:

Função de agregação da coluna.

Type
String

getCanonicalName()

Obtém o nome canônico da coluna. O nome canônico da coluna é semelhante ao nome da coluna, a diferença é que no nome canônico as ocorrências de "." (ponto) são substituídas por "_"(underline).

Returns:

Nome canônico da coluna.

Type
String

getDimensionDataSize()

Retorna o tamanho do tipo de dados da dimensão.

Returns:

O tamanho do tipo de dados da dimensão.

Type
string

getDimensionDataType()

Retorna o tipo de dados da dimensão.

Returns:

Tipo de dados da dimensão

Type
string

getFieldName()

Obtém o nome do campo associado a coluna.

Returns:

Nome do campo associado a coluna.

Type
string

getLevel()

Retorna o nível da coluna quando a ela for uma coluna de dimensão.

Returns:

O nível da coluna.

Type
string

notifyNameChange_()


setAggregate(aggregate)

Define a função de agregação da coluna.

Parameters:
Name Type Description
aggregate string

Nome da função de agregação.


setFieldName(fieldName)

Seta o nome do campo associado a coluna.

Parameters:
Name Type Description
fieldName string

Nome do campo associado a coluna.


suggestAlias()

Sugere um alias a partir do nome corrente da coluna.


toString()