Class: ReportVisualizationColumn

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


new ReportVisualizationColumn(name)

Classe responsável pela criação das colunas do DSV.

Parameters:
Name Type Description
name string

O nome da coluna.

Members


<nullable> aggregate :string

Indica a função de agrupamento que deve ser aplicada nesta coluna durante a consulta dos dados. Quando utilizada, todas as demais colunas sem #aggregate serão utilizadas para agrupar os dados que serão agregados.
Valores possíveis:

  • DataSourceColumn.AGGREGATE_NONE;
  • DataSourceColumn.AGGREGATE_SUM;
  • DataSourceColumn.AGGREGATE_COUNT;
  • DataSourceColumn.AGGREGATE_AVG;
  • DataSourceColumn.AGGREGATE_MAX;
  • DataSourceColumn.AGGREGATE_MIN;

    Importante: a agregação deve ser configurada na definição do DataSourceQuery. Esta propriedade apenas herda o valor configurado na definição do DataSourceQuery para simplificar a leitura desta propriedade.
Type:
  • string
See:
  • ReportVisualization#weight
  • DataSourceColumn#aggregate
  • DataSourceColumn#weight

alias :string

Nome alternativo para referenciar esta coluna. Esta propriedade é obtida a partir das definições do DataSource e não deve ser alterada.

Importante: o alias deve ser configurado na definição do DataSourceQuery ou do DataSource. Esta propriedade apenas herda o valor configurado nessas camadas para simplificar a leitura desta propriedade.

Type:
  • string
See:
  • DataSourceColumn#alias

canonicalName :string

O nome canônico da coluna. É obtido das definições do DataSource e utilizado para busca e tratamento de agrupamento. Não deve ser alterado.
Importante: o nome canônico é gerado pelo DataSource. Esta propriedade apenas herda o valor gerado nessa camada para simplificar a leitura desta propriedade.

Type:
  • string
See:
  • DataSourceColumn#canonicalName

displayFormat :DateFormat|LatitudeFormat|LongitudeFormat|AngleFormat|string|number|null

Template a ser utilizado para a formatação da coluna.
São aceitos vários tipos de template: para textos, números, datas e formatos de geolocalização. Para dados textuais, o template utiliza a sintaxe da função sprintf, comum a diversas linguagens. Para dados numéricos, o template é um padrão semelhante ao utilizado em aplicações de planilhas, como o Excel. A sintaxe é a mesma do GWT (http://google-web-toolkit.googlecode.com/svn/ javadoc/2.1/com/google/gwt/i18n/client/NumberFormat.html). Também é possível passar um valor da enumeração NumberFormat.Format para se utilizar valores padrão. Os valores suportados atualmente são NumberFormat.Format.DECIMAL, NumberFormat.Format.PERCENT e NumberFormat.Format.CURRENCY.
Caso seja utilizada esta propriedade, a propriedade decimalPrecision será ignorada. Abaixo também são detalhados os formato de exibição para os tipos "date", "longitude", "latitude", "angle". Valores possíveis:

  • DateFormat.DDMMYYYY: dia/mês/ano(4 dígitos)
  • DateFormat.DDMMYY: dia/mês/ano(2 dígitos)
  • DateFormat.MMYYYY: mês/ano(4 dígitos)
  • DateFormat.WWYYYY: semana/ano(4 dígitos)
  • LatitudeFormat.DDD_DDDDD: graus decimais°
  • LatitudeFormat.DDD_MM_MMM_DIR: graus° minutos' {N|S}
  • LatitudeFormat.DDD_MM_SS_S_DIR: graus° minutos' segundos" {N|S}
  • LongitudeFormat.DDD_DDDDD: graus°
  • LongitudeFormat.DDD_MM_MMM_DIR: graus° minutos' {E|W}
  • LongitudeFormat.DDD_MM_SS_S_DIR: graus° minutos' segundos" {E|W}
  • AngleFormat.DDD: graus°
  • AngleFormat.DDD_DD: graus decimais°
  • NumberFormat.Format.DECIMAL: decimal
  • NumberFormat.Format.CURRENCY: moeda
  • '##0.##': número decimal sem separador de milhar
  • 'Sr(a). %-20s' texto com padding a direitas
Type:
  • DateFormat | LatitudeFormat | LongitudeFormat | AngleFormat | string | number | null
See:
  • Column#decimalPrecision

<nullable> fieldName :string

O nome do campo correspondente à coluna, na fonte de dados.
Importante: o nome do campo é gerado pelo DataSource. Esta propriedade apenas herda o valor gerado nessa camada para simplificar a leitura desta propriedade.

Type:
  • string
See:
  • DataSourceColumn#fieldName

pathDepth :number

Essa propriedade é obtida a partir do DataSource ou DataSourceQuery, não deve ser alterada direto no DSV. Limita a profundidade das classes a serem exibidas pela dimensão !PATH. Isso é limita o caminho exibido no sentido da classe raiz para a classe terminal.

Type:
  • number
Example
{
 columns: [{
   name: classe,
   pathRoot: Classes.DATA,
   pathDepth: 2
 }]
}

Ao exibir o caminho para a classe Classes.VIRTUAL_FILE_SYSTEM o
caminho será "Dados/Sistema" oriundo de
"Dados/Sistema/Sistema de arquivos Virtuais"

pathHeight :number

Essa propriedade é obtida a partir do DataSource ou DataSourceQuery, não deve ser alterada direto no DSV. Limita a profundidade das classes a serem exibidas pela dimensão !PATH. Isso é limita o caminho exibido no sentido da classe raiz para a classe terminal.

Type:
  • number
Example
{
 columns: [{
   name: classe,
   pathRoot: Classes.DATA,
   pathHeight: 2
 }]
}

Ao exibir o caminho para a classe Classes.VIRTUAL_FILE_SYSTEM, o caminho será
"Sistema/Sistema de arquivos Virtuais" oriundo de "Dados/Sistema/Sistema de arquivos Virtuais"

slColumnAssignMap

Mapa que relaciona as propriedades da coluna do Report às suas contrapartes na coluna do SimpleLayout.


type :string

O tipo da coluna fornecida pela fonte de dados.

Type:
  • string

<nullable> weight :string

Esta propriedade indica que a agregação de média deve utilizar uma coluna de peso, fazendo assim uma média ponderada. Deve ser informado o nome da coluna que será utilizado como peso.
Ela é ignorada em colunas sem ou com outros tipos de agregação.

Importante: a agregação deve ser configurada na definição do DataSourceQuery. Esta propriedade apenas herda o valor configurado na definição do DataSourceQuery para simplificar a leitura desta propriedade.

Type:
  • string
See:
  • ReportVisualization#aggregate
  • DataSourceColumn#aggregate
  • DataSourceColumn#weight

Methods


<static> hasPathDimension(col)

Verifica se uma coluna do dsv report tem dimensão de caminho.

Parameters:
Name Type Description
col ReportVisualizationColumn

Coluna do DSV.

Returns:

True se for coluna com dimensão de caminho.

Type
boolean

assignFrom(obj)

Recebe e valida valores de uma definição de coluna e os associa a esta instância.

Parameters:
Name Type Description
obj Object.<string, *>

Uma definição de coluna.


toString()

Retorna o alias da coluna. Caso não esteja definido, retorna o nome da coluna.

Returns:

O alias da coluna, ou em sua ausência, o nome da coluna.

Type
string