Class: DataExporterFieldDef

@nginstack/web-framework/lib/export/DataExporterFieldDef~ DataExporterFieldDef


new DataExporterFieldDef()

Classe que descreve uma coluna para ser exportada

See:
  • DataExporter

Members


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:

  • DateFormatsDDMMYYYY: dia/mês/ano(4 dígitos)
  • DateFormatsDDMMYY: dia/mês/ano(2 dígitos)
  • DateFormatsMMYYYY: mês/ano(4 dígitos)
  • DateFormatsWWYYYY: 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

isGroup :Boolean

Indica se é um campo de agrupamento.

Type:
  • Boolean
Default Value:
  • false

label :string

Nome de exibição do campo.

Type:
  • string

lookupType :number

Define o tipo de "lookup" do campo. Valores possíveis: LookupType.NONE, LookupType.RECORD, LookupType.CLASS ou LookupType.FILE.

Type:
  • number
See:
  • Field#lookupType

name :string

Nome do campo que será exportado.

Type:
  • string

onCalculate :LegacyEvent

Evento que será usado para se obter o valor do campo.

Type:
  • LegacyEvent
Example
fieldDef.onCalculate.set(function (fieldDef, dataSet) {
   return ds.recNo;
});

onLookupDisplay :LegacyEvent

Evento que será usado para se obter o valor de exibição das chaves deste campo lookup.

Type:
  • LegacyEvent
Example
fieldDef.onLookupDisplay.set(function (fieldDef, key) {
   return key.iname;
});

type :string

Tipo do campo que será exportado.

Type:
  • string
See:

Methods


<static> newFromField(field)

Cria uma instância de DataExporterFieldDef copiando as configurações do campo informado.

Parameters:
Name Type Description
field Field

Campo base, cujas configurações serão copiadas.

Returns:

Instância criada a partir das configurações do campo.

Type
DataExporterFieldDef