Class: ReportVisualizationColumns

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


new ReportVisualizationColumns()

Coleção de colunas de DSV.

Methods


<static> fromArray(arr)

Cria uma nova instância de coleção de ReportColumns a partir de um Array.

Parameters:
Name Type Description
arr Array.<ReportVisualizationColumn>

O array usado para popular a nova coleção.

Returns:

A coleção gerada a partir do array informado.

Type
ReportVisualizationColumns

add(column)

Adiciona uma coluna à coleção.

Parameters:
Name Type Description
column ReportVisualizationColumn

A coluna a adicionar à coleção.


find(f [, opt_obj])

Executa a função para cada coluna desta coleção seguindo a ordem de exibição e retorna a primeira coluna cuja execução da função retorne true.

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.

Returns:

Coluna encontrada ou null caso não seja encontrada nenhuma.

Type
ReportVisualizationColumn

forEach(f [, opt_obj])

Executa a função para cada coluna desta coleção seguindo a ordem de exibiçã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.


getColumn(name)

Recupera uma coluna da coleção, através de seu nome, alias, nome canônico ou nome do campo correspondente na fonte de dados. Caso não haja uma coluna correspondente ao nome informado, este método dispara um erro.

Parameters:
Name Type Description
name string

O nome a usar na pesquisa.

Returns:

A coluna correspondente ao nome informado.

Type
ReportVisualizationColumn

getColumnOrder(column)

Obtém a ordem da coluna informada em relação as demais colunas desta coleção. As primeiras colunas a serem exibidas são as de menor ordem.

Parameters:
Name Type Description
column string | ReportVisualizationColumn

Coluna ou nome da coluna da qual se deseja saber a ordem.

Returns:

Valor entre um e a quantidade de colunas contidas nesta coleção.

Type
number

toArray()

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

Returns:

Array contendo as colunas desta coleção.

Type
Array.<ReportVisualizationColumn>

tryGetColumn(name)

Recupera uma coluna da coleção, através de seu nome, alias, nome canônico ou nome do campo correspondente na fonte de dados. Caso não haja uma coluna correspondente ao nome informado, retorna nulo.

Parameters:
Name Type Description
name string

O nome a usar na pesquisa.

Returns:

A coluna correspondente ao nome informado, ou nulo caso não seja encontrada.

Type
ReportVisualizationColumn