nginstack

Class: DataSourceField

@nginstack/datasource/lib/DataSourceField~ DataSourceField

<abstract> new DataSourceField(name, type)

Representação abstrata de um dado que pode ser filtrado ou consultado em uma fonte de dados. Essa classe não deve ser utilizada diretamente. Em vez, utilize as especializações DataSourceFilter e DataSourceColumn.

Parameters:
Name Type Description
name string

Nome do filtro ou coluna na fonte de dados.
type string

Tipo do filtro ou coluna na fonte de dados.
See:
  • DataSourceFilter
  • DataSourceColumn

Members

<static> PREFIX_SEPARATOR :string

Separador entre o prefixo do filtro e o restante do nome. Exemplo: P_PESSOA. P é o prefixo e PESSOA é o nome do filtro ou da coluna.

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

help :string

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

Type:
  • string

label :string

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

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

lowerName :string

Nome da coluna ou filtro em caixa baixa.

Type:
  • string

name :string

Nome da coluna ou filtro.

Type:
  • string

options :Array

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

Type:
  • Array

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

type :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:
  • DataSourceDataType
See:
  • DataSourceDataType

upperName :string

Nome da coluna ou filtro em caixa alta.

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

clone()

Cria uma cópia deste filtro ou coluna.

Returns:
Type
DataSourceField

isCombo()

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

Returns:
Type
boolean

isDate()

Indica se esta coluna ou filtro é do tipo data.

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.

isInteger()

Indica se esta coluna ou filtro é do tipo inteiro.

Returns:
Type
boolean

toString()

Cria uma representação textual desta coluna ou filtro.

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.

Returns:
Type
DataSourceField