Class: DataSourceColumn

@nginstack/datasource/lib/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

Members

aggregate :string

Agregação que deve ser aplicada aos valores da 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

canonicalName :string

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).

Type:
  • string

<nullable> classKey :number

Chave da classe de dados que contém os registros informados neste filtro ou coluna. Utilizada para definir filtros ou colunas lookup.

Type:
  • number
Inherited From:

coalesceValue :*

Valor que substitui os valores nulos na consulta dos dados.

Type:
  • *

dimensionDataSize

Tamanho do tipo de dados da dimensão.

dimensionDataType

Tipo de dados da dimensão.

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

fieldName

Nome do campo associado a coluna.

help :string

Ajuda sobre o uso e o propósito desta coluna ou filtro para o usuário final.

Type:
  • string
Inherited From:

label :string

Nome de exibição para o usuário final.

Type:
  • string
Inherited From:

level :string

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

Type:
  • string

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:

lowerName :string

Nome da coluna ou filtro em caixa baixa.

Type:
  • string
Inherited From:

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
Overrides:

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

options :Array

Opções que podem ser selecionadas pelo usuário, caso este filtro ou coluna seja do tipo 'combo'.

Type:
  • Array
Inherited From:

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

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

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

stringIfTrue :string

String que representa o valor true de um campo booleano. Caso seja definido um valor para esta propriedade, este valor será considerado como true nas validações de campos booleanos.

Type:
  • string
Inherited From:

type :module:@nginstack/datasource/lib/DataSourceDataType~DataSourceDataType

Tipo de dados do filtro ou coluna. Os valores possíveis são declarados no enumerado DataSourceDataType.
Importante: campos do modelo de dados do tipo "masterdetail" ou "grid" podem ser utilizados como filtros de uma fonte de dados, mas não como colunas. Esses campos estabelecem uma relação de 1xN com uma outra tabela. Enquanto a aplicação de filtros é trivial, a obtenção dos valores da tabela relacionada requer uma junção que altera a cardinalidade do resultado. Por esse motivo, a obtenção desses valores deve ser realizada manualmente por meio de uma junção na construção da query.

Type:
  • module:@nginstack/datasource/lib/DataSourceDataType~DataSourceDataType
Inherited From:
See:
  • DataSourceDataType

upperName :string

Nome da coluna ou filtro em caixa alta.

Type:
  • string
Inherited From:

<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

<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

Methods

assignFrom(src)

Atribui a todas as propriedades desta instância os valores das propriedades da instância informada, tornando as duas instâncias iguais. O nome da coluna ou filtro não será copiado, pois é o identificador único da instância.

Parameters:
Name Type Description
src module:@nginstack/datasource/lib/DataSourceField~DataSourceField| Record.<string, *>

Coluna ou filtro que terá as propriedades copiadas para esta instância. Também poderá ser informado um objeto literal contendo as propriedades.
Inherited From:

clone()

Cria uma cópia deste filtro ou coluna.

Inherited From:
Returns:
Type
module:@nginstack/datasource/lib/DataSourceField~DataSourceField

isCombo()

Indica se esta coluna ou filtro é do tipo "combo" ou se as opções de preenchimento foram configuradas pela propriedade #options.

Inherited From:
Returns:
Type
boolean

isDate()

Indica se esta coluna ou filtro é do tipo data.

Inherited From:
Returns:
Type
boolean

isDerivable()

Indica se este filtro ou coluna pode ser derivado por meio do operador ".", para obter os valores do campos de uma chave, ou do operador "!", para obter dimensões de datas ou classes.

Inherited From:

isInteger()

Indica se esta coluna ou filtro é do tipo inteiro.

Inherited From:
Returns:
Type
boolean

suggestAlias()

Sugere um alias a partir do nome corrente da coluna.

toString()

Cria uma representação textual desta coluna.

Overrides:
Returns:
Type
string

unshare()

Caso este filtro ou coluna seja compartilhada, retorna uma cópia única, caso contrário retorna a própria instância.

Inherited From:
Returns:
Type
module:@nginstack/datasource/lib/DataSourceField~DataSourceField

<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 module:@nginstack/engine/lib/classdef/Field~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 module:@nginstack/engine/lib/classdef/Field~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
module:@nginstack/datasource/lib/DataSourceColumn~DataSourceColumn

<static> getRootFromLeafNode(leafNode, suggestedRoot)

Obtém uma classe raiz a partir de uma classe terminal, se houver uma classe raiz sugerida que seja mãe da classe terminal na hierarquia, a sugestão é obtida, caso contrário, é derivado uma classe raiz de mesmo nível da sugestão.

Parameters:
Name Type Description
leafNode number

Classe terminal de onde se deseja obter a classe raiz.
suggestedRoot number

Classe raiz sugerida de onde é obtido o nível para derivação da classe raiz real, caso a sugerida não seja uma classe raiz real.
Returns:

Classe raiz

Type
number