nginstack

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

  • DataSourceField

Members

group :string

Agrupamento ao qual o filtro pertence.

Type:
  • string

onAfterLoadDefaultValue :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:
  • Event

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

rangeLimit :Limit

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

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

size :number

Tamanho do filtro

Type:
  • number

value :*

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

Type:
  • *

Methods

<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 DataSourceFilter | Field

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

True se os filtros auxiliares de faixa devem ser criados.

Type
boolean

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 Field

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

getCanonicalName()

Obtém o 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

getDefaultValue()

Obtém o valor padrão do filtro.

Returns:

Valor padrão do filtro

Type
number | string | Date

getFieldName()

Obtém o nome do campo associado a este filtro.

Returns:

Nome do campo associado ao filtro.

Type
string

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

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
DataSourceFilter

setDefaultValue(value)

Define o valor padrão do filtro.

Parameters:
Name Type Description
value number | string | Date

Valor padrão do filtro