Module: @nginstack/web-framework/lib/grid/Grid

Classes

Grid

Methods


<inner> get()

This:
  • {Grid}

<inner> get()

This:
  • {Grid}

<inner> get()

This:
  • Grid

<inner> get()

This:
  • Grid

<inner> persist(grids)

Realiza persistência para DataSets de um conjunto de grades e das suas filhas.

Parameters:
Name Type Description
grids Grid | Array.<Grid>

Grades cujos DataSets serão persistidos.

Returns:

Versão das alterações.

Type
number

<inner> set()

This:
  • {Grid}

<inner> set()

This:
  • {Grid}

<inner> set()

This:
  • Grid
Parameters:
Type Description
Array.<(string|Button)>

<inner> set()

This:
  • Grid
Parameters:
Type Description
Array.<(string|Button)>

<inner> set()

This:
  • Grid
Parameters:
Type Description
Array.<(string|Button)>

Type Definitions


AggregatesSyncResponse

Type:
  • Object
Properties:
Name Type Description
aggregates Array.<module:@nginstack/web-framework/lib/grid/AggregateBar~AggregateState>

Estado dos agregadores da grade.

gridName string

Nome da grade.


ExportRequest

Type:
  • Object
Properties:
Name Type Description
exportType number

Chave do script de exportação a ser realizada.


FieldFocusRequest

Type:
  • Object
Properties:
Name Type Description
fieldName string

Nome do campo que receberá o foco.


FieldServerState

Type:
  • Object
Properties:
Name Type Argument Description
readOnly boolean <optional>

Indica se o campo está em modo somente leitura.

required boolean <optional>

Indica se o campo é obrigatório.

width number <optional>

Largura do campo.

tableViewWidth number <optional>

Largura do campo no modo tabela.


FieldSync

Type:
  • Object
Properties:
Name Type Argument Description
fieldName string

Nome do campo.

state FieldServerState <optional>

Estado do campo.

linkSet module:@nginstack/web-framework/lib/anchor/LinkSet~FieldLinkSetData <optional>

Dados do conjunto de links.

value string <optional>

Valor serializado do campo.

informed boolean <optional>

Indica se o campo foi informado.

style Object <optional>

Dados de estilo do campo.

Properties
Name Type Argument Description
css Record.<string, string> <optional>

Propriedades de estilo do campo.

error string <optional>

Mensagem de erro ao carregar o estilo do campo.

thumbnail Object <optional>

Dados da miniatura do campo.

Properties
Name Type Argument Description
urls Array.<string> <optional>

lista de URL das miniaturas do campo.

error boolean <optional>

Mensagem de erro ao carregar a miniatura do campo.

lookupDisplay string <optional>

Valor de exibição do campo lookup.

syncCalculus Object <optional>

Dados de cálculo do campo.

Properties
Name Type Argument Description
showError boolean <optional>

Indica se deve exibir erro de cálculo do campo.

error string <optional>

Mensagem de erro ao calcular o campo.


FocusOptions

Opções de foco da grade.

Type:
  • Object
Properties:
Name Type Argument Description
fieldName string <optional>

Nome do campo que receberá o foco.

firstEditable boolean <optional>

Caso não seja informado o nome do campo a ser focado, essa opção indica que deve focar no primeiro campo editável disponível.


FormViewSync

Type:
  • Object
Properties:
Name Type Description
type string

Indica qual o tipo de visualização.

fields Array.<FieldSync>

Dados dos campos do formulário.


GridActionRequest

Type:
  • Object
Properties:
Name Type Description
action string

Ação a ser executada na seleção dos registros.


GridClientState

Type:
  • Object
Properties:
Name Type Argument Description
title string

Título da grade

readOnly boolean

Indica se a grade está em modo somente leitura

viewMode string

Modo de visualização da grade ('FORM_VIEW' ou 'TABLE_VIEW')

hasTableView boolean

Indica se a grade possui visualização em tabela

hasFormView boolean

Indica se a grade possui visualização em formulário

hasDetailField boolean

Indica se a grade possui campos de detalhe

hasValidatePermission boolean

Indica se a grade valida permissões do usuário

hasHintFieldNames boolean

Indica se a grade possui campos com dicas

hasAggregateBar boolean

Indica se a grade possui barra de agregação

collapsed boolean

Indica se a grade está recolhida

width number

Largura da grade

hasButtonsBar boolean

Indica se a grade possui barra de botões

trapArrowFocus boolean

Indica se a grade captura o foco das setas

exportOptions Object

Opções de exportação da grade

maxRecordCount number

Número máximo de registros

visible boolean <optional>

Indica se a grade está visível

hasScrollEvents boolean <optional>

Indica se a grade possui eventos de rolagem

hasSelectEvents boolean <optional>

Indica se a grade possui eventos de seleção

hasDataSet boolean <optional>

Indica se a grade possui um DataSet associado

hasKey boolean <optional>

Indica se a grade possui o campo chave


GridClientStructure

Type:
  • Object
Properties:
Name Type Description
name string

Nome da grade

parentName string | null

Nome da grade pai, ou null se não tiver

state GridClientState

Estado da grade no cliente

fields Array.<module:@nginstack/web-framework/lib/grid/GridField~FieldClientStructure>

Estrutura dos campos da grade


GridServerState

Type:
  • Object
Properties:
Name Type Argument Description
recordCount number

Número de registros na grade.

bookmark string

Bookmark do registro posicionado na grade.

recNo number

Posição do registro do DataSet na grade.

viewState string <optional>

Estado dos dados da grade.

allSelected boolean <optional>

Indica se todos os registros estão selecionados.

readOnly boolean <optional>

Indica se a grade está em modo somente leitura.

canInsert boolean <optional>

Indica se o usuário pode inserir novos registros na grade.

canDelete boolean <optional>

Indica se o usuário pode excluir registros na grade.

canConfirm boolean <optional>

Indica se o usuário pode confirmar registros na grade.

canDuplicate boolean <optional>

Indica se o usuário pode duplicar registros na grade.

canInvertSelection boolean <optional>

Indica se o usuário pode inverter a seleção de registros.

canShowLog boolean <optional>

Indica se o usuário pode exibir o log de alterações da grade.

canExport boolean <optional>

Indica se o usuário pode exportar os dados da grade.

canToggleKey boolean <optional>

Indica se o usuário pode alternar a exibição do campo chave.

hasSelectEvents boolean <optional>

Indica se a grade possui eventos de seleção de registros.

selectedRecords Array.<string> <optional>

Array com os bookmarks dos registros selecionados na grade.


GridSyncResponse

Type:
  • Object
Properties:
Name Type Argument Description
gridName string

Nome da grade.

state GridServerState

Estado da grade.

syncButtons Object <optional>

Botões da grade que foram sincronizados.

Properties
Name Type Argument Description
enabled Array.<string> <optional>

Nome dos botões que foram habilitados.

disabled Array.<string> <optional>

Nome dos botões que foram desabilitados.

linkFields boolean <optional>

Indica se o vínculo dos campos deve ser reprocessado.

pendingFocus FocusOptions <optional>

Opções de foco da grade.

view FormViewSync | TableViewSync <optional>

Sincronização da visualização da grade.

complementarySync GridSyncResponse <optional>

Sincronização complementar da grade, enviado em situações muito específicas em decorrência de uma execução atrasada do afterScroll que resultou em novas alterações da grade.


IndexRequest

Type:
  • Object
Properties:
Name Type Argument Description
fieldName string

Nome do campo que será utilizado como índice.

composite boolean <optional>

Indica se o índice será composto por mais de um campo.


LookupRequest

Type:
  • Object
Properties:
Name Type Description
fieldName string

Nome do campo que será utilizado na pesquisa.

value string

Valor a ser pesquisado.

openLookup boolean

Indica se o lookup deve ser aberto após a pesquisa.


LookupResponse

Type:
  • Object
Properties:
Name Type Argument Description
gridName string

Nome da grade que solicitou o lookup.

fieldName string

Nome do campo que solicitou o lookup.

empty boolean <optional>

Indica se o resultado do lookup está vazio.

emptyMessage string <optional>

Mensagem a ser exibida quando o resultado do lookup estiver vazio.

fastSelect boolean <optional>

Indica que o lookup não deve abrir a janela de seleção.

limited boolean <optional>

Indica que o lookup foi limitado a um número máximo de resultados.

limit number <optional>

Número máximo de resultados que o lookup pode retornar.


OpenKeyRequest

Type:
  • Object
Properties:
Name Type Description
fieldName string

Nome do campo que será utilizado como índice.


RecordServerState

Type:
  • Object
Properties:
Name Type Argument Description
editing boolean

Indica se o registro está em edição ou não.

locked boolean

Indica se o registro está bloqueado ou não.

bookmark number <optional>

Posição única do registro no dataset no servidor.

recNo number <optional>

Posição visual do registro.

checked boolean <optional>

Indica se o registro está marcado ou não.

enabled boolean <optional>

Indica se o registro está habilitado ou não.


RecordSync

Type:
  • Object
Properties:
Name Type Argument Description
dataIndex number

Índice do registro na grade

state RecordServerState

Estado do registro.

fields Array.<FieldSync>

Dados dos campos do registro.

tooltip string <optional>

Tooltip do registro.

isCurrentRecord boolean <optional>

Indica se o registro é o posicionado na grade.


RefreshResponse

Type:
  • Object
Properties:
Name Type Description
gridName string

Nome da grade que foi atualizada.

grids Array.<GridClientStructure>

Estrutura das grades atualizadas.


SearchRequest

Type:
  • Object
Properties:
Name Type Argument Description
value string

Valor a ser pesquisado.

fieldName string

Nome do campo que será utilizado na pesquisa, informar vazio corresponde a pesquisar no campo posicionado.

allFields boolean <optional>

Indica se a pesquisa deve ser realizada em todos os campos.


SelectRecordRequest

Type:
  • Object
Properties:
Name Type Argument Description
bookmark string

Bookmark do registro a ser selecionado.

rangeSelection boolean <optional>

Indica se a seleção deve ser feita como um intervalo de registros.


TableViewSync

Type:
  • Object
Properties:
Name Type Argument Description
type string

Indica qual o tipo de visualização.

records Array.<RecordSync>

Comandos de sincronização dos registros

maxRecordsDelta number <optional>

Delta de registros que foram adicionados ou removidos.

lastIndex number <optional>

Último índice de registro que deve ser sincronizado.


TreeToggleRequest

Type:
  • Object
Properties:
Name Type Description
node number

Id Identificador do nó que será expandido ou recolhido.


UpdateAggregateRequest

Type:
  • Object
Properties:
Name Type Description
fieldName string

Nome do campo que terá o agregador atualizado.

value string

Valor serializado a ser atribuído ao aggregate.