Class: VisualizationFilterDef

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


new VisualizationFilterDef()

Classe utilizada para definir um filtro de uma visualização.

Members


<nullable> canonicalName :string

O nome canônico do filtro. O nome canônico é semelhante ao nome propriamente dito da coluna, mas as ocorrências de ponto são substituídas por underscores. Esta propriedade é obtida do DataSource e do DSQ e não deve ser alterada.

Type:
  • string
See:
  • DataSourceColumn#canonicalName

<nullable> classKey :number

Determina que o filtro será um lookup para a classe cuja chave for informada.

Type:
  • number
See:
  • Field#classKey

<nullable> column :number

A coluna do filtro na grade de variáveis.

Type:
  • number

defaultValue :*

O valor padrão do filtro.

Type:
  • *

<nullable> group :string

O nome do grupo do filtro.

Type:
  • string
Deprecated:
  • Utilize #groupName.

<nullable> groupName :string

O nome do grupo do filtro.

Type:
  • string

help :string

A ajuda do filtro.

Type:
  • string

label :string

O título do filtro, que será usado como seu nome de exibição.
Caso não seja informado, o nome de exibição do filtro será o valor da propriedade name.

Type:
  • string

lookupType :LookupType

Determina o tipo de relacionamento lookup deste filtro. Quando é informada uma classe na propriedade #classKey, o relacionamento pode ser com os registros dessa classe, com as classes filhas dessa classe ou com os arquivos do Sistema de Arquivos Virtual contidos nessa classe. Os valores possíveis são: LookupType.NONE, LookupType.RECORD, LookupType.CLASS e LookupType.FILE.

Type:
  • LookupType

name :string

O nome do filtro.

Type:
  • string

options :Array.<Array>

As opções do filtro. Esta propriedade tem o mesmo comportamento que a propriedade de mesmo nome do Field, e é utilizada para montar combos.

Type:
  • Array.<Array>
See:
  • Field#options

order :number

A ordem de exibição do filtro.

Type:
  • number

readOnly :boolean

Indica se o filtro é somente leitura. Essa propriedade pode ser utilizada em conjunto com #defaultValue para indicar um valor do filtro que não pode ser modificado pelo usuário.

Type:
  • boolean

required :boolean

Indica se o filtro é de preenchimento obrigatório.

Type:
  • boolean
Default Value:
  • false

<nullable> size :number

Quantidade máxima de caracteres no valor do filtro. Obrigatório e utilizado apenas quando o filtro for do tipo string ou password.

Type:
  • number

targets :Array.<string>

O identificador da visualização à qual o filtro se refere, quando for um filtro de visualização composta.

Type:
  • Array.<string>

type :string

O tipo do valor do filtro.

Type:
  • string
See:
  • Field#type