@sankhyalabs/sankhyablocks 9.2.0-dev.3 → 9.2.0-dev.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -178,11 +178,18 @@ const SnkGrid = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
178
178
  btns.unshift(TaskbarElement.UPDATE_MULTIPLE);
179
179
  return btns;
180
180
  }
181
+ /**
182
+ * Recarrega a configuração da grade.
183
+ * @description Este método força o recarregamento da configuração da grade a partir do `ConfigStorage`. A operação é assíncrona, mas o método não aguarda sua conclusão.
184
+ */
181
185
  reloadConfig() {
182
186
  this.loadConfig();
183
187
  }
184
188
  /**
185
189
  * Exibe a janela de configurações da grade.
190
+ * @async
191
+ * @description Este método abre o pop-up de configuração de colunas da grade, permitindo ao usuário ajustar a visibilidade, ordem e largura das colunas.
192
+ * @returns {Promise<void>} Uma promessa que é resolvida quando a janela de configuração é exibida.
186
193
  */
187
194
  async showConfig() {
188
195
  if (this._grid == undefined) {
@@ -192,6 +199,9 @@ const SnkGrid = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
192
199
  }
193
200
  /**
194
201
  * Fecha a janela de configurações da grade.
202
+ * @async
203
+ * @description Este método fecha o pop-up de configuração de colunas da grade.
204
+ * @returns {Promise<void>} Uma promessa que é resolvida quando a janela de configuração é fechada.
195
205
  */
196
206
  async hideConfig() {
197
207
  if (this._grid == undefined) {
@@ -200,26 +210,42 @@ const SnkGrid = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
200
210
  this.closeGridConfig();
201
211
  }
202
212
  /**
203
- * Atribui o valor da configuração da grade.
213
+ * Define a configuração da grade.
214
+ * @async
215
+ * @description Aplica uma nova configuração de colunas e ordenação à grade.
216
+ * @param {IGridConfig} config O objeto de configuração a ser aplicado na grade.
217
+ * @returns {Promise<void>} Uma promessa que é resolvida quando a configuração é aplicada.
204
218
  */
205
219
  async setConfig(config) {
206
220
  this.setGridConfig(config);
207
221
  }
208
222
  /**
209
- * Faz o recarregamento da filter-bar da grade buscando o state no servidor.
223
+ * Recarrega a barra de filtros da grade, buscando o estado do servidor.
224
+ * @async
225
+ * @description Força o recarregamento da barra de filtros, atualizando suas configurações e filtros a partir do servidor.
226
+ * @returns {Promise<void>} Uma promessa que é resolvida quando a barra de filtros é recarregada.
210
227
  */
211
228
  async reloadFilterBar() {
212
229
  var _a;
213
230
  (_a = this._snkFilterBar) === null || _a === void 0 ? void 0 : _a.reload();
214
231
  }
215
232
  /**
216
- * Retorna o elemento da filter-bar da grade.
233
+ * Retorna o elemento da barra de filtros da grade.
234
+ * @async
235
+ * @description Este método permite acessar o elemento da barra de filtros, que pode ser útil para manipulações adicionais ou para obter o estado atual dos filtros aplicados.
236
+ * @returns {Promise<HTMLSnkFilterBarElement>} O elemento da barra de filtros.
217
237
  */
218
238
  async getFilterBar() {
219
239
  return this._snkFilterBar;
220
240
  }
221
241
  /**
222
- * Registra um editor customizado para campos da grade e formulário
242
+ * Registra um editor customizado para um campo da grade ou formulário.
243
+ * @async
244
+ * @description Adiciona um componente de edição personalizado para um campo específico. Este editor será usado tanto na edição em linha na grade quanto em formulários de detalhe.
245
+ * @param {string} fieldName O nome do campo que receberá o editor customizado.
246
+ * @param {ICustomEditor} customEditor A instância do editor customizado.
247
+ * @param {string} [detailContext] O contexto de detalhe onde o editor será aplicado (opcional).
248
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o editor é registrado.
223
249
  */
224
250
  async addCustomEditor(fieldName, customEditor, detailContext) {
225
251
  if (this._grid) {
@@ -231,7 +257,13 @@ const SnkGrid = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
231
257
  this._customEditors = newCustomEditors;
232
258
  }
233
259
  /**
234
- * Registra um render customizado para colunas da grid.
260
+ * Registra um renderizador customizado para uma coluna da grade.
261
+ * @async
262
+ * @description Adiciona um componente de renderização personalizado para uma coluna específica, permitindo a exibição de conteúdo customizado nas células.
263
+ * @param {string} fieldName O nome do campo (coluna) que receberá o renderizador customizado.
264
+ * @param {ICustomRender} customRender A instância do renderizador customizado.
265
+ * @param {string} [detailContext] O contexto de detalhe onde o renderizador será aplicado (opcional).
266
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o renderizador é registrado.
235
267
  */
236
268
  async addGridCustomRender(fieldName, customRender, detailContext) {
237
269
  if (this._grid) {
@@ -243,19 +275,31 @@ const SnkGrid = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
243
275
  this._customRenders = newCustomRenders;
244
276
  }
245
277
  /**
246
- * Registra um formatador de valores para uma coluna da grid.
278
+ * Registra um formatador de valor customizado para uma coluna da grade.
279
+ * @async
280
+ * @description Adiciona uma função de formatação personalizada para os valores de uma coluna específica, afetando como os dados são exibidos.
281
+ * @param {string} columnName O nome da coluna que receberá o formatador.
282
+ * @param {ICustomFormatter} customFormatter A instância do formatador de valor.
283
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o formatador é registrado.
247
284
  */
248
285
  async addCustomValueFormatter(columnName, customFormatter) {
249
286
  this._grid.addCustomValueFormatter(columnName, customFormatter);
250
287
  }
251
288
  /**
252
- * Remove o formatador de valores de uma coluna da grid.
289
+ * Remove um formatador de valor customizado de uma coluna da grade.
290
+ * @async
291
+ * @description Remove uma função de formatação personalizada previamente registrada para uma coluna.
292
+ * @param {string} columnName O nome da coluna da qual o formatador será removido.
293
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o formatador é removido.
253
294
  */
254
295
  async removeCustomValueFormatter(columnName) {
255
296
  this._grid.removeCustomValueFormatter(columnName);
256
297
  }
257
298
  /**
258
299
  * Atribui o foco para a grade.
300
+ * @async
301
+ * @description Move o foco do navegador para o componente da grade, permitindo a navegação por teclado.
302
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o foco é atribuído.
259
303
  */
260
304
  async setFocus() {
261
305
  this._grid.setFocus();
@@ -167,11 +167,18 @@ const SnkGrid = class {
167
167
  btns.unshift(TaskbarElement.UPDATE_MULTIPLE);
168
168
  return btns;
169
169
  }
170
+ /**
171
+ * Recarrega a configuração da grade.
172
+ * @description Este método força o recarregamento da configuração da grade a partir do `ConfigStorage`. A operação é assíncrona, mas o método não aguarda sua conclusão.
173
+ */
170
174
  reloadConfig() {
171
175
  this.loadConfig();
172
176
  }
173
177
  /**
174
178
  * Exibe a janela de configurações da grade.
179
+ * @async
180
+ * @description Este método abre o pop-up de configuração de colunas da grade, permitindo ao usuário ajustar a visibilidade, ordem e largura das colunas.
181
+ * @returns {Promise<void>} Uma promessa que é resolvida quando a janela de configuração é exibida.
175
182
  */
176
183
  async showConfig() {
177
184
  if (this._grid == undefined) {
@@ -181,6 +188,9 @@ const SnkGrid = class {
181
188
  }
182
189
  /**
183
190
  * Fecha a janela de configurações da grade.
191
+ * @async
192
+ * @description Este método fecha o pop-up de configuração de colunas da grade.
193
+ * @returns {Promise<void>} Uma promessa que é resolvida quando a janela de configuração é fechada.
184
194
  */
185
195
  async hideConfig() {
186
196
  if (this._grid == undefined) {
@@ -189,26 +199,42 @@ const SnkGrid = class {
189
199
  this.closeGridConfig();
190
200
  }
191
201
  /**
192
- * Atribui o valor da configuração da grade.
202
+ * Define a configuração da grade.
203
+ * @async
204
+ * @description Aplica uma nova configuração de colunas e ordenação à grade.
205
+ * @param {IGridConfig} config O objeto de configuração a ser aplicado na grade.
206
+ * @returns {Promise<void>} Uma promessa que é resolvida quando a configuração é aplicada.
193
207
  */
194
208
  async setConfig(config) {
195
209
  this.setGridConfig(config);
196
210
  }
197
211
  /**
198
- * Faz o recarregamento da filter-bar da grade buscando o state no servidor.
212
+ * Recarrega a barra de filtros da grade, buscando o estado do servidor.
213
+ * @async
214
+ * @description Força o recarregamento da barra de filtros, atualizando suas configurações e filtros a partir do servidor.
215
+ * @returns {Promise<void>} Uma promessa que é resolvida quando a barra de filtros é recarregada.
199
216
  */
200
217
  async reloadFilterBar() {
201
218
  var _a;
202
219
  (_a = this._snkFilterBar) === null || _a === void 0 ? void 0 : _a.reload();
203
220
  }
204
221
  /**
205
- * Retorna o elemento da filter-bar da grade.
222
+ * Retorna o elemento da barra de filtros da grade.
223
+ * @async
224
+ * @description Este método permite acessar o elemento da barra de filtros, que pode ser útil para manipulações adicionais ou para obter o estado atual dos filtros aplicados.
225
+ * @returns {Promise<HTMLSnkFilterBarElement>} O elemento da barra de filtros.
206
226
  */
207
227
  async getFilterBar() {
208
228
  return this._snkFilterBar;
209
229
  }
210
230
  /**
211
- * Registra um editor customizado para campos da grade e formulário
231
+ * Registra um editor customizado para um campo da grade ou formulário.
232
+ * @async
233
+ * @description Adiciona um componente de edição personalizado para um campo específico. Este editor será usado tanto na edição em linha na grade quanto em formulários de detalhe.
234
+ * @param {string} fieldName O nome do campo que receberá o editor customizado.
235
+ * @param {ICustomEditor} customEditor A instância do editor customizado.
236
+ * @param {string} [detailContext] O contexto de detalhe onde o editor será aplicado (opcional).
237
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o editor é registrado.
212
238
  */
213
239
  async addCustomEditor(fieldName, customEditor, detailContext) {
214
240
  if (this._grid) {
@@ -220,7 +246,13 @@ const SnkGrid = class {
220
246
  this._customEditors = newCustomEditors;
221
247
  }
222
248
  /**
223
- * Registra um render customizado para colunas da grid.
249
+ * Registra um renderizador customizado para uma coluna da grade.
250
+ * @async
251
+ * @description Adiciona um componente de renderização personalizado para uma coluna específica, permitindo a exibição de conteúdo customizado nas células.
252
+ * @param {string} fieldName O nome do campo (coluna) que receberá o renderizador customizado.
253
+ * @param {ICustomRender} customRender A instância do renderizador customizado.
254
+ * @param {string} [detailContext] O contexto de detalhe onde o renderizador será aplicado (opcional).
255
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o renderizador é registrado.
224
256
  */
225
257
  async addGridCustomRender(fieldName, customRender, detailContext) {
226
258
  if (this._grid) {
@@ -232,19 +264,31 @@ const SnkGrid = class {
232
264
  this._customRenders = newCustomRenders;
233
265
  }
234
266
  /**
235
- * Registra um formatador de valores para uma coluna da grid.
267
+ * Registra um formatador de valor customizado para uma coluna da grade.
268
+ * @async
269
+ * @description Adiciona uma função de formatação personalizada para os valores de uma coluna específica, afetando como os dados são exibidos.
270
+ * @param {string} columnName O nome da coluna que receberá o formatador.
271
+ * @param {ICustomFormatter} customFormatter A instância do formatador de valor.
272
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o formatador é registrado.
236
273
  */
237
274
  async addCustomValueFormatter(columnName, customFormatter) {
238
275
  this._grid.addCustomValueFormatter(columnName, customFormatter);
239
276
  }
240
277
  /**
241
- * Remove o formatador de valores de uma coluna da grid.
278
+ * Remove um formatador de valor customizado de uma coluna da grade.
279
+ * @async
280
+ * @description Remove uma função de formatação personalizada previamente registrada para uma coluna.
281
+ * @param {string} columnName O nome da coluna da qual o formatador será removido.
282
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o formatador é removido.
242
283
  */
243
284
  async removeCustomValueFormatter(columnName) {
244
285
  this._grid.removeCustomValueFormatter(columnName);
245
286
  }
246
287
  /**
247
288
  * Atribui o foco para a grade.
289
+ * @async
290
+ * @description Move o foco do navegador para o componente da grade, permitindo a navegação por teclado.
291
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o foco é atribuído.
248
292
  */
249
293
  async setFocus() {
250
294
  this._grid.setFocus();
@@ -44,9 +44,12 @@ export declare class SnkGrid {
44
44
  _showSnkFilterBar: boolean;
45
45
  _enableContinuousInsert: boolean;
46
46
  _application: SnkApplication;
47
+ /**
48
+ * Define o data source para o filtro de colunas.
49
+ */
47
50
  columnFilterDataSource: IMultiSelectionListDataSource;
48
51
  /**
49
- * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
52
+ * Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
50
53
  */
51
54
  enableLockManagerLoadingComp?: boolean;
52
55
  /**
@@ -54,45 +57,48 @@ export declare class SnkGrid {
54
57
  */
55
58
  enableLockManagerTaskbarClick?: boolean;
56
59
  /**
57
- * Nome usado para salvar/recuperar a configuração.
60
+ * Nome usado para salvar e recuperar a configuração da grade.
58
61
  */
59
62
  configName: string;
60
63
  /**
61
- * Título que será apresentado na barra de filtros
64
+ * Título que será apresentado na barra de filtros.
62
65
  */
63
66
  filterBarTitle: string;
64
67
  /**
65
- * Identificador de recursos como configurações e acesso.
68
+ * Identificador de recursos, como configurações e permissões de acesso.
66
69
  */
67
70
  resourceID: string;
68
71
  /**
69
- * Configuração da seleção de grade no toast.
72
+ * Configuração do toast de seleção da grade.
70
73
  */
71
74
  selectionToastConfig: ISelectionToastConfig;
72
75
  /**
73
- * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
76
+ * Lista de ações que devem ser usadas no botão "Mais opções" do `snk-taskbar`.
74
77
  */
75
78
  actionsList: Array<Action>;
76
79
  /**
77
- * Determina se a grade está vinculada a um detalhe.
80
+ * Determina se a grade está vinculada a um detalhe de outra tela.
78
81
  */
79
82
  isDetail: boolean;
80
83
  /**
81
- * Gerenciador das barras de tarefas. É possível determinar botões específicos
82
- * ou mesmo gerenciar o estado dos botões.
84
+ * Gerenciador das barras de tarefas. Permite determinar botões específicos
85
+ * ou gerenciar o estado dos botões.
83
86
  */
84
87
  taskbarManager: TaskbarManager;
85
88
  /**
86
- * Configuração do valor da coluna de status.
87
- * Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }'
89
+ * Define a configuração de cores para a coluna de status.
90
+ * @example
91
+ * ```json
92
+ * '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }'
93
+ * ```
88
94
  */
89
95
  statusResolver: IStatusResolver | StatusResolverFunction;
90
96
  /**
91
- * Determina se pode haver mais de uma linha selecionada.
97
+ * Determina se a seleção de múltiplas linhas é permitida.
92
98
  */
93
99
  multipleSelection: boolean;
94
100
  /**
95
- * Altera o modo de apresentação dos botões do snk-taskbar.
101
+ * Altera o modo de apresentação dos botões do `snk-taskbar`.
96
102
  */
97
103
  presentationMode: PresentationMode;
98
104
  /**
@@ -100,139 +106,187 @@ export declare class SnkGrid {
100
106
  */
101
107
  messagesBuilder: SnkMessageBuilder;
102
108
  /**
103
- * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
109
+ * Quando `true`, a tecla ENTER navega entre as células como a tecla TAB.
104
110
  */
105
111
  useEnterLikeTab: boolean;
106
112
  /**
107
- * Validador responsável por checar a integridade das informações do registro.
113
+ * Validador responsável por verificar a integridade dos dados de um registro.
108
114
  */
109
115
  recordsValidator: IRecordValidator;
110
116
  /**
111
- * Define se a edição está habilitada na grid.
117
+ * Define se a edição de dados na grade está habilitada.
112
118
  */
113
119
  canEdit: boolean;
114
120
  /**
115
- * Define o identificador do container de elementos customizados da Taskbar.
121
+ * Define o identificador do contêiner de elementos customizados da `Taskbar`.
116
122
  */
117
123
  taskbarCustomContainerId: string;
118
124
  /**
119
- * Nome do slot de elementos customizados da Taskbar do cabeçalho da grade.
125
+ * Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade.
120
126
  */
121
127
  gridHeaderCustomSlotId: string;
122
128
  /**
123
- * Nome do slot de elementos customizados da Taskbar principal do componente.
129
+ * Define o nome do slot para elementos customizados na `Taskbar` principal do componente.
124
130
  */
125
131
  topTaskbarCustomSlotId: string;
126
132
  /**
127
- * Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros)
128
- * e no modal lateral de filtros (container de filtros personalizados).
133
+ * Desabilita a apresentação da opção de filtros personalizados na barra de filtros (chip de filtros)
134
+ * e no modal lateral de filtros (contêiner de filtros personalizados).
129
135
  */
130
136
  disablePersonalizedFilter: boolean;
131
137
  /**
132
- * Chave da configuração legado da grade.
138
+ * Chave da configuração legada da grade.
133
139
  */
134
140
  gridLegacyConfigName: string;
135
141
  /**
136
- * Chave da configuração legado da barra de filtros.
142
+ * Chave da configuração legada da barra de filtros.
137
143
  */
138
144
  filterBarLegacyConfigName: string;
139
145
  /**
140
- * Define se a carga dos dados será feita assim que o componente for carregado.
146
+ * Define se os dados serão carregados automaticamente na inicialização do componente.
141
147
  */
142
148
  autoLoad?: boolean;
143
149
  /**
144
- * Define se a grid será focada ao ser carregada.
150
+ * Define se a grade receberá o foco automaticamente ao ser carregada.
145
151
  */
146
152
  autoFocus?: boolean;
147
153
  /**
148
- * Ativa inserção de registros no modo grade.
154
+ * Habilita a inserção de registros diretamente na grade.
149
155
  */
150
156
  enableGridInsert?: boolean;
151
157
  /**
152
- * Altera visualmente as sombras e bordas do componente
153
- * Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout)
154
- * Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up)
158
+ * Altera a aparência das bordas e sombras do componente.
159
+ * Se `false`, aplica o padrão de sombras (ideal para o elemento principal do layout).
160
+ * Se `true`, aplica um contorno (ideal para quando o componente está dentro de outro, como um painel ou pop-up).
155
161
  */
156
162
  outlineMode?: boolean;
157
163
  /**
158
- * Define se a grade deve suprimir o scroll horizontal.
164
+ * Define se a grade deve suprimir a barra de rolagem horizontal.
159
165
  */
160
166
  suppressHorizontalScroll: boolean;
161
167
  /**
162
- * Modo de exportação dos dados.
168
+ * Define o modo de exportação dos dados.
163
169
  */
164
170
  strategyExporter: IExporterStrategyMode;
165
171
  /**
166
- * Define se a grade deve exibir um buscador de coluna com uso do Ctrl+F
172
+ * Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`.
167
173
  */
168
174
  useSearchColumn: boolean;
169
175
  /**
170
- * Habilita a edição de múltiplos registros simultâneos.
176
+ * Habilita a edição de múltiplos registros simultaneamente.
171
177
  */
172
178
  multipleEditionEnabled: boolean;
173
179
  /**
174
- * Define se a grid será focada ao ser carregada.
180
+ * Define o modo de exibição do contador de paginação.
175
181
  */
176
182
  paginationCounterMode?: 'show' | 'hidden' | 'auto';
177
183
  /**
178
- * Informa se a coluna de chechbox deve ser suprimida
184
+ * Informa se a coluna de checkbox deve ser suprimida.
179
185
  */
180
186
  suppressCheckboxColumn: boolean;
181
187
  /**
182
- * Define se a grade deve ser exibida em modo compacto
188
+ * Define se a grade deve ser exibida em modo compacto.
183
189
  */
184
190
  compact: boolean;
185
191
  /**
186
- * Emitido sempre que houver click de botão ou ação.
192
+ * Emitido ao clicar em um botão de ação ou item de menu.
193
+ * @description Este evento é acionado quando o usuário clica em um botão de ação ou item de menu na grade, permitindo a execução de ações específicas.
194
+ * @param {string} detail - O identificador da ação clicada, que pode ser usado para determinar qual ação executar.
187
195
  */
188
196
  actionClick: EventEmitter<string>;
189
197
  /**
190
- * Emitido sempre que houver duplo click na grade.
198
+ * Emitido ao realizar um duplo clique em uma linha da grade.
199
+ * @description Este evento é acionado quando o usuário clica duas vezes em uma linha da grade, permitindo ações como edição rápida ou visualização de detalhes.
200
+ * @param {any} detail - Detalhes do evento, contendo a linha clicada.
191
201
  */
192
202
  gridDoubleClick: EventEmitter<any>;
193
203
  /**
194
- * Emitido quando o componente estiver completamente carregado.
204
+ * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
195
205
  */
196
206
  componentReady: EventEmitter<void>;
207
+ /**
208
+ * Recarrega a configuração da grade.
209
+ * @description Este método força o recarregamento da configuração da grade a partir do `ConfigStorage`. A operação é assíncrona, mas o método não aguarda sua conclusão.
210
+ */
197
211
  reloadConfig(): void;
198
212
  /**
199
213
  * Exibe a janela de configurações da grade.
214
+ * @async
215
+ * @description Este método abre o pop-up de configuração de colunas da grade, permitindo ao usuário ajustar a visibilidade, ordem e largura das colunas.
216
+ * @returns {Promise<void>} Uma promessa que é resolvida quando a janela de configuração é exibida.
200
217
  */
201
218
  showConfig(): Promise<void>;
202
219
  /**
203
220
  * Fecha a janela de configurações da grade.
221
+ * @async
222
+ * @description Este método fecha o pop-up de configuração de colunas da grade.
223
+ * @returns {Promise<void>} Uma promessa que é resolvida quando a janela de configuração é fechada.
204
224
  */
205
225
  hideConfig(): Promise<void>;
206
226
  /**
207
- * Atribui o valor da configuração da grade.
227
+ * Define a configuração da grade.
228
+ * @async
229
+ * @description Aplica uma nova configuração de colunas e ordenação à grade.
230
+ * @param {IGridConfig} config O objeto de configuração a ser aplicado na grade.
231
+ * @returns {Promise<void>} Uma promessa que é resolvida quando a configuração é aplicada.
208
232
  */
209
233
  setConfig(config: IGridConfig): Promise<void>;
210
234
  /**
211
- * Faz o recarregamento da filter-bar da grade buscando o state no servidor.
235
+ * Recarrega a barra de filtros da grade, buscando o estado do servidor.
236
+ * @async
237
+ * @description Força o recarregamento da barra de filtros, atualizando suas configurações e filtros a partir do servidor.
238
+ * @returns {Promise<void>} Uma promessa que é resolvida quando a barra de filtros é recarregada.
212
239
  */
213
240
  reloadFilterBar(): Promise<void>;
214
241
  /**
215
- * Retorna o elemento da filter-bar da grade.
242
+ * Retorna o elemento da barra de filtros da grade.
243
+ * @async
244
+ * @description Este método permite acessar o elemento da barra de filtros, que pode ser útil para manipulações adicionais ou para obter o estado atual dos filtros aplicados.
245
+ * @returns {Promise<HTMLSnkFilterBarElement>} O elemento da barra de filtros.
216
246
  */
217
247
  getFilterBar(): Promise<HTMLSnkFilterBarElement>;
218
248
  /**
219
- * Registra um editor customizado para campos da grade e formulário
249
+ * Registra um editor customizado para um campo da grade ou formulário.
250
+ * @async
251
+ * @description Adiciona um componente de edição personalizado para um campo específico. Este editor será usado tanto na edição em linha na grade quanto em formulários de detalhe.
252
+ * @param {string} fieldName O nome do campo que receberá o editor customizado.
253
+ * @param {ICustomEditor} customEditor A instância do editor customizado.
254
+ * @param {string} [detailContext] O contexto de detalhe onde o editor será aplicado (opcional).
255
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o editor é registrado.
220
256
  */
221
257
  addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string): Promise<void>;
222
258
  /**
223
- * Registra um render customizado para colunas da grid.
259
+ * Registra um renderizador customizado para uma coluna da grade.
260
+ * @async
261
+ * @description Adiciona um componente de renderização personalizado para uma coluna específica, permitindo a exibição de conteúdo customizado nas células.
262
+ * @param {string} fieldName O nome do campo (coluna) que receberá o renderizador customizado.
263
+ * @param {ICustomRender} customRender A instância do renderizador customizado.
264
+ * @param {string} [detailContext] O contexto de detalhe onde o renderizador será aplicado (opcional).
265
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o renderizador é registrado.
224
266
  */
225
267
  addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string): Promise<void>;
226
268
  /**
227
- * Registra um formatador de valores para uma coluna da grid.
269
+ * Registra um formatador de valor customizado para uma coluna da grade.
270
+ * @async
271
+ * @description Adiciona uma função de formatação personalizada para os valores de uma coluna específica, afetando como os dados são exibidos.
272
+ * @param {string} columnName O nome da coluna que receberá o formatador.
273
+ * @param {ICustomFormatter} customFormatter A instância do formatador de valor.
274
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o formatador é registrado.
228
275
  */
229
276
  addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter): Promise<void>;
230
277
  /**
231
- * Remove o formatador de valores de uma coluna da grid.
278
+ * Remove um formatador de valor customizado de uma coluna da grade.
279
+ * @async
280
+ * @description Remove uma função de formatação personalizada previamente registrada para uma coluna.
281
+ * @param {string} columnName O nome da coluna da qual o formatador será removido.
282
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o formatador é removido.
232
283
  */
233
284
  removeCustomValueFormatter(columnName: string): Promise<void>;
234
285
  /**
235
286
  * Atribui o foco para a grade.
287
+ * @async
288
+ * @description Move o foco do navegador para o componente da grade, permitindo a navegação por teclado.
289
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o foco é atribuído.
236
290
  */
237
291
  setFocus(): Promise<void>;
238
292
  handleClick(event: MouseEvent): Promise<void>;