Class: DataSourceFilter

@nginstack/datasource/lib/DataSourceFilter~ DataSourceFilter

new DataSourceFilter(name, type)

Filtro de uma fonte de dados.

Parameters:
Name Type Description
name string

Nome do filtro da fonte de dados.
type string

Tipo do filtro da fonte de dados.

Extends

Members

canonicalName :string

Nome canônico do filtro. O nome canônico do filtro não possui "." (ponto).

Se o filtro se chamar PEDIDO_PESSOA.CLASSE.NOME, o seu nome canônico será PEDIDO_PESSOA_CLASSE_NOME.

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

defaultValue :number|string|Date

Valor padrão do filtro.

Type:
  • number| string| Date

fieldName :string

Nome do campo ao qual o filtro ou coluna está associado.

Type:
  • string

group :string

Agrupamento ao qual o filtro pertence.

Type:
  • string

help :string

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

Type:
  • string
Inherited From:
Overrides:

label :string

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

Type:
  • string
Inherited From:
Overrides:

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

lowerName :string

Nome da coluna ou filtro em caixa baixa.

Type:
  • string
Inherited From:

name :string

Nome da coluna ou filtro.

Type:
  • string
Inherited From:

onAfterLoadDefaultValue :module:@nginstack/engine/lib/event/Event~Event

Evento que ocorre no momento da chamada do método getDataSet(), no exato momento após o método getDataSet() setar a propriedade value do filtro com o valor 'default' do filtro.

Type:

operator :FilterOperator|string

Operação que será realizada para filtrar os registros. Valores possíveis: '=', '<>', 'like', '>', '<', '>=', '<=', 'exists' e 'not exists'.

Type:
  • FilterOperator| string
Default Value:
  • FilterOperator.EQUALITY

options :Array

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

Type:
  • Array
Inherited From:
Overrides:

rangeLimit :LimitType

Indica se o filtro representa início ou fim de um intervalo, atualmente "rangeLimit" só é suportado para filtros do tipo data.

Type:
  • LimitType
See:
  • ngin.range#Limits

size :number

Tamanho do filtro

Type:
  • number

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

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

upperName :string

Nome da coluna ou filtro em caixa alta.

Type:
  • string
Inherited From:

value :*

Valor do filtro. Além dos valores primitivos e datas, um filtro pode ser informado com um array de valores.

Type:
  • *

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

fromField(field)

Cria um filtro de DataSource a partir de um campo(Field). Este método não sobrescreve o nome do filtro.

Parameters:
Name Type Description
field module:@nginstack/engine/lib/classdef/Field~Field

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

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

newFilterToRange(rangeSuffix)

Cria um novo filtro que pode ser utilizado para informar um valor inicial ou final deste filtro.

Parameters:
Name Type Description
rangeSuffix string

Sufixo que indica o tipo de range desejado, podendo ser '_START' ou '_END'.
Returns:

Filtro criado para filtrar uma faixa.

Type
module:@nginstack/datasource/lib/DataSourceFilter~DataSourceFilter

newFiltersToRange()

Cria dois novos filtros que podem ser utilizados para informar um valor inicial e/ou final deste filtro.

Returns:

Filtros criados para filtrar uma faixa de valores.

Type
Array.<module:@nginstack/datasource/lib/DataSourceFilter~DataSourceFilter>

toString()

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

Inherited From:
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> removeRangeSuffix(name)

Remove os sufixos _START e _END do nome do filtro. Esses sufixos são adicionados nos filtros criados para fins de range.

Parameters:
Name Type Description
name string

Nome do filtro.
Returns:

Nome do filtro sem sufixos.

Type
string

<static> shouldCreateAuxiliaryRangeFilters(filter)

Indica se devem ser criados os filtros auxiliares _START e _END para permitir filtrar uma faixa de valores.

Parameters:
Name Type Description
filter module:@nginstack/datasource/lib/DataSourceFilter~DataSourceFilter| module:@nginstack/engine/lib/classdef/Field~Field

Filtro ou campo de uma definição de classe.
Returns:

True se os filtros auxiliares de faixa devem ser criados.

Type
boolean