nginstack

Class: FieldAggregator

@nginstack/web-framework/lib/field-aggregator/FieldAggregator~ FieldAggregator

new FieldAggregator()

Classe abstrata que implementa a interface esperada dos objetos responsáveis pela agregação dos campos da grade.

Essa classe não deve ser utilizada diretamente. Instancie uma das classes filhas especializadas com o algoritmo de agregação desejado.

Members

alignment :string

Alinhamento do valor totalizado. Caso não seja informado, será utilizado o mesmo alinhamento do campo totalizado.

Type:
  • string

dataSet :DataSet

Dados que serão agregados.

Essa propriedade é atualizada automaticamente pela grade de dados.

Type:

decimalPrecision :number|null

Precisão decimal do totalizador. Caso não seja informada, será utilizada a precisão do campo totalizado.

Type:
  • number | null

description :string

Descrição da totalização que será exibida na interface do sistema.

Type:
  • string

displayFormat :number|null

Formato de exibição do valor totalizado. Caso não seja informado, será utilizado o formato de exibição do campo totalizado.

São suportados os formatos definidos em NumberFormat, que são aplicados da mesma forma que nas células do campo totalizado, utilizando a precisão decimal do totalizador:

  • 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
  • NumberFormat.FILE_SIZE: tamanho em bytes, como 1,5K, 20M ou 2G. Utiliza sempre no máximo 2 casas decimais, ignorando a precisão decimal do totalizador

Também são suportados os formatos definidos em DateFormat para valores do tipo data, como DateFormat.MMYYYY (mês/ano) e DateFormat.WWYYYY (semana/ano).

Caso não seja utilizado um desses formatos, o valor numérico será exibido de acordo com a precisão decimal do totalizador e as datas serão exibidas no formato dia/mês/ano.

Type:
  • number | null

lastValue :number

Valor calculado na última edição dos dados.

Type:
  • number

readOnly :boolean

Determina se o valor totalizado pode ser modificado pelo usuário. Por padrão, as totalizações serão apenas para leitura.

Nem todas as classes de agregação permitem a alteração dos valores a partir de uma modificação do total calculado. Quando esse recurso é suportado, deve ser aplicado algum critério de rateio da diferença do total informado nos registros que foram agregados. Esse rateio é aplicado diretamente nos dados, sem emitir os eventos de alteração do campo e da grade de dados, sendo recomendado apenas para dados que serão posteriormente validados antes de serem gravados na base dados.

Type:
  • boolean

supportsCalculatedFields :boolean

Indica se este agregador de valores suporta campos calculados.

Para manter compatibilidade com o comportamento legado do sistema, o padrão dessa propriedade é true e as classes filhas que não suportem campos calculados devem alterar esta propriedade para false para indicar que essa restrição de uso.

Type:
  • boolean

type :string

Tipo do valor totalizado. Caso não seja informado, será considerado o tipo do campo totalizado.

Type:
  • string

value :number

Valor corrente da agregação.

Type:
  • number

Methods

assign(obj)

Copia os valores das propriedades de um objeto

Parameters:
Name Type Description
obj FieldAggregator

Objeto do qual se deseja obter os valores.

checkRecNo(recNo)

Verifica se a posição informada existe no DataSet totalizado. Será gerado um erro caso a posição não seja válida.

Parameters:
Name Type Description
recNo number

Posição a ser verificada.

formatValue(value [, displayFormat])

Formata o valor totalizado de acordo com o formato de exibição e a precisão decimal configurados. Nos formatos definidos em NumberFormat e DateFormat, o valor é formatado da mesma forma que nas células do campo totalizado.

Parameters:
Name Type Argument Description
value number | Date

Valor a ser formatado.
displayFormat number <optional>

Formato de exibição a ser utilizado. Caso não seja informado, será utilizado o valor da propriedade #displayFormat.
Returns:

Valor formatado.

Type
string

previewValue()

Atualiza o valor do aggregate

reset()

Restaura o valor totalizado na última edição da grade.

toString()

Cria uma representação textual do campo que está sendo agregado.

Returns:
Type
string