nginstack

Class: VisualizationFilters

@nginstack/web-framework/lib/dsv/VisualizationFilters~ VisualizationFilters

new VisualizationFilters()

Coleção de filtros de DSV.

Members

<static, constant> DATE_EXPRESSION_PREFIX :string

Prefixo utilizado para indicar que o valor de um filtro é uma expressão de data.

Type:
  • string

Methods

<static> createFilterFields(grid, dsv [, opt_options])

Cria campos em uma grade com a finalidade de preencher os filtros do dsv informado.

Parameters:
Name Type Argument Description
grid Grid

A grade na qual serão criados os campos.
dsv Visualization

DSV que proverá os filtros que serão utilizados para definir os campos.
opt_options Object <optional>

Esse objeto vai passar opções de construção para os fields da grid.

Properties
Name Type Argument Description
callback function <optional>

Função que será executada para cada field após a sua construção na grade.
datesAsExpressions boolean <optional>

Filtros do tipo date poderão ser informados como expressões. Também será exibido um campo adicional para auxiliar no preenchimento das expressões.

<static> evaluateFilterExpressions(filterValues)

Retorna os valores dos filtros informados, convertendo todos os filtros gravados na forma de expressões nos valores resultantes destas expressões.

Ele é util para eliminar as expressões que possam ter sido inseridas nos mapa de valores de filtros retornado pela função VisualizationFilters.getFilterValuesFromGrid, quando utilizada a opção preserveDateExpressions.

Parameters:
Name Type Description
filterValues Record.<string, *>

Valores dos filtros que serão utilizados para atualizar os campos.

<static> getFilterValuesFromGrid(dsv, grid [, opt_options])

Obtém os valores dos filtros que devem ser passados para o método Visualization#queryData a partir de uma grade cujos campos foram configurados previamente pela função VisualizationFilters.createFilterFields.

Parameters:
Name Type Argument Description
dsv Visualization

Visualização que define os filtros que devem ser preenchidos.
grid Grid

Grade preenchida pelo usuário.
opt_options Object <optional>

Conjunto de opções para a geração dos valores.

Properties
Name Type Argument Description
preserveExpressions boolean <optional>

Indica se os filtros que são representados por expressões devem ser preservados neste formado ao invés de retornar o resultado da expressão. Esta opção terá utilidade apenas se no momento da criação dos campos da grade foi informada a opção datesAsExpressions para a função VisualizationFilters.createFilterFields. As expressões de datas serão preservadas com o prefixo VisualizationFilters.DATE_EXPRESSION_PREFIX.
Returns:

Mapa associando os nomes dos filtros aos seus valores.

Type
Record.<string, *>

<static> updateFilterFields(grid, filterValues)

Atualiza os valores dos campos de uma grade que são utilizados para preenchimento dos filtros de um DSV.

Parameters:
Name Type Description
grid Grid

Grade cujos campos serão atualizados.
filterValues Record.<string, *>

Valores dos filtros que serão utilizados para atualizar os campos.

addFilter(filter)

Adiciona um filtro à coleção.

Parameters:
Name Type Description
filter VisualizationFilter

O filtro a adicionar à coleção.

forEach(f [, opt_obj])

Executa uma função para cada filtro da coleção.

Parameters:
Name Type Argument Description
f function

A função que será executada para cada elemento. Esta função irá receber a coluna como argumento.
opt_obj Object <optional>

O objeto que será utilizado como o valor de 'this' dentro de f.

getFilter(name)

Recupera um filtro da coleção, através de seu nome. Caso não haja um filtro correspondente ao nome informado, este método dispara um erro.

Parameters:
Name Type Description
name string

O nome (ou nome canônico) do filtro.
Returns:

O filtro correspondente ao nome informado.

Type
VisualizationFilter

orderedForEach(f [, opt_obj])

Executa uma função para cada filtro da coleção, levando em consideração a ordem dos filtros.

Parameters:
Name Type Argument Description
f function

A função que será executada para cada elemento. Esta função irá receber a coluna como argumento.
opt_obj Object <optional>

O objeto que será utilizado como o valor de 'this' dentro de f.

toArray()

Retorna um array contendo todos os itens desta coleção.

Returns:

Array contendo os filtros desta coleção.

Type
Array.<VisualizationFilter>

toLayoutHeader()

Monta os filtros que serão exibidos no header do SimpleLayout.

Returns:

Objetos que representam os filtros utilizados na consulta.

Type
Array.<FilterDef>

tryGetFilter(name)

Recupera um filtro da coleção, através de seu nome. Caso não haja um filtro correspondente ao nome informado, retorna nulo.

Parameters:
Name Type Description
name string

O nome (ou nome canônico) do filtro.
Returns:

O filtro correspondente ao nome informado, ou nulo caso não seja encontrado.

Type
VisualizationFilter