Class: DataSourceFieldDef

Members

---

<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

See:

• DataSourceFieldDef#options
• DataSourceFieldDef#prefix

---

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

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

---

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:

• module:@nginstack/engine/lib/classdef/LookupType

---

name :string

O nome da coluna ou filtro.

Type:

• string

---

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

See:

• DataSourceFieldDef#classKey
• DataSourceFieldDef#prefix

---

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

See:

• module:@nginstack/datasource/lib/DataSourceDataType