@sankhyalabs/sankhyablocks-docs 9.1.3-rc.3 → 9.1.3
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.
- package/components/snk-application/readme.md +25 -89
- package/components/snk-configurator/readme.md +1 -1
- package/components/snk-crud/readme.md +9 -9
- package/components/snk-crud/subcomponents/readme.md +4 -4
- package/components/snk-crud/subcomponents/snk-detail-view/readme.md +4 -4
- package/components/snk-data-exporter/exporter-email-sender/readme.md +1 -1
- package/components/snk-data-unit/readme.md +2 -10
- package/components/snk-filter-bar/filter-item/readme.md +1 -1
- package/components/snk-filter-bar/readme.md +4 -6
- package/components/snk-filter-field-search/readme.md +1 -1
- package/components/snk-form/readme.md +3 -3
- package/components/snk-grid/readme.md +51 -69
- package/components/snk-personalized-filter/subcomponents/snk-filter-param-config/readme.md +1 -1
- package/components/snk-simple-crud/readme.md +11 -11
- package/components/snk-taskbar/elements/taskbar-actions-button/readme.md +2 -2
- package/package.json +1 -1
@@ -35,7 +35,7 @@ Registra um client event para o DataFetcher da aplicação.
|
|
35
35
|
|
36
36
|
Type: `Promise<void>`
|
37
37
|
|
38
|
-
|
38
|
+
|
39
39
|
|
40
40
|
### `addLoadingLock(forceReady?: boolean, templateSkeletonType?: TEMPLATES_SKELETON) => Promise<() => void>`
|
41
41
|
|
@@ -47,8 +47,6 @@ Type: `Promise<() => void>`
|
|
47
47
|
|
48
48
|
O ID do bloqueio adicionado.
|
49
49
|
|
50
|
-
---
|
51
|
-
|
52
50
|
### `addPendingAction(actionsLocker: string, action: Function) => Promise<void>`
|
53
51
|
|
54
52
|
Adiciona uma ação pendente que deve ser executada por um determinado locker.
|
@@ -57,7 +55,7 @@ Adiciona uma ação pendente que deve ser executada por um determinado locker.
|
|
57
55
|
|
58
56
|
Type: `Promise<void>`
|
59
57
|
|
60
|
-
|
58
|
+
|
61
59
|
|
62
60
|
### `addSearchListener(entityName: string, dataUnit: DataUnit, listener: ISearchListener) => Promise<IRemoveSearchListener>`
|
63
61
|
|
@@ -69,8 +67,6 @@ Type: `Promise<IRemoveSearchListener>`
|
|
69
67
|
|
70
68
|
Uma função para remover o listener.
|
71
69
|
|
72
|
-
---
|
73
|
-
|
74
70
|
### `alert(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
|
75
71
|
|
76
72
|
Exibe o diálogo de alerta de acordo com os parâmetros passados.
|
@@ -79,7 +75,7 @@ Exibe o diálogo de alerta de acordo com os parâmetros passados.
|
|
79
75
|
|
80
76
|
Type: `Promise<boolean>`
|
81
77
|
|
82
|
-
|
78
|
+
|
83
79
|
|
84
80
|
### `callServiceBroker(serviceName: string, payload: string | Object, options?: Options) => Promise<any>`
|
85
81
|
|
@@ -91,8 +87,6 @@ Type: `Promise<any>`
|
|
91
87
|
|
92
88
|
A resposta do Service Broker.
|
93
89
|
|
94
|
-
---
|
95
|
-
|
96
90
|
### `clearPopUpTitle() => Promise<void>`
|
97
91
|
|
98
92
|
|
@@ -101,7 +95,7 @@ A resposta do Service Broker.
|
|
101
95
|
|
102
96
|
Type: `Promise<void>`
|
103
97
|
|
104
|
-
|
98
|
+
|
105
99
|
|
106
100
|
### `closeModal() => Promise<void>`
|
107
101
|
|
@@ -111,7 +105,7 @@ Fecha o Modal e limpa o conteúdo.
|
|
111
105
|
|
112
106
|
Type: `Promise<void>`
|
113
107
|
|
114
|
-
|
108
|
+
|
115
109
|
|
116
110
|
### `closePopUp() => Promise<void>`
|
117
111
|
|
@@ -121,7 +115,7 @@ Fecha o Popup e limpa o conteúdo.
|
|
121
115
|
|
122
116
|
Type: `Promise<void>`
|
123
117
|
|
124
|
-
|
118
|
+
|
125
119
|
|
126
120
|
### `confirm(title: string, message: string, icon?: string, dialogType?: DialogType, options?: MessageOptions) => Promise<boolean>`
|
127
121
|
|
@@ -133,8 +127,6 @@ Type: `Promise<boolean>`
|
|
133
127
|
|
134
128
|
`true` se confirmado, `false` caso contrário.
|
135
129
|
|
136
|
-
---
|
137
|
-
|
138
130
|
### `createDataunit(entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
|
139
131
|
|
140
132
|
Cria o DataUnit a partir do nome da entidade. É possível armazená-lo no cache
|
@@ -146,8 +138,6 @@ Type: `Promise<DataUnit>`
|
|
146
138
|
|
147
139
|
O DataUnit criado ou obtido do cache.
|
148
140
|
|
149
|
-
---
|
150
|
-
|
151
141
|
### `error(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
|
152
142
|
|
153
143
|
Exibe o diálogo de erro de acordo com os parâmetros passados.
|
@@ -156,7 +146,7 @@ Exibe o diálogo de erro de acordo com os parâmetros passados.
|
|
156
146
|
|
157
147
|
Type: `Promise<boolean>`
|
158
148
|
|
159
|
-
|
149
|
+
|
160
150
|
|
161
151
|
### `executePreparedSearch(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
|
162
152
|
|
@@ -169,8 +159,6 @@ Type: `Promise<IOption | IOption[]>`
|
|
169
159
|
|
170
160
|
Uma lista de opções ou uma única opção.
|
171
161
|
|
172
|
-
---
|
173
|
-
|
174
162
|
### `executePreparedSearchPlus(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
|
175
163
|
|
176
164
|
Realiza a pesquisa de registros
|
@@ -182,8 +170,6 @@ Type: `Promise<IOption | IOption[]>`
|
|
182
170
|
|
183
171
|
Uma lista de opções ou uma única opção.
|
184
172
|
|
185
|
-
---
|
186
|
-
|
187
173
|
### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: ISearchCtxOptions) => Promise<Array<IOption> | IOption>`
|
188
174
|
|
189
175
|
Obtém as opções em componentes de pesquisa.
|
@@ -195,8 +181,6 @@ Type: `Promise<IOption | IOption[]>`
|
|
195
181
|
|
196
182
|
Uma lista de opções ou uma única opção.
|
197
183
|
|
198
|
-
---
|
199
|
-
|
200
184
|
### `executeSelectDistinct(dataUnit: DataUnit, fieldName: string, argument: string) => Promise<Array<any>>`
|
201
185
|
|
202
186
|
Com base em um campo realiza um "select distinct" respeitando os
|
@@ -209,8 +193,6 @@ Type: `Promise<any[]>`
|
|
209
193
|
|
210
194
|
Uma lista de valores distintos.
|
211
195
|
|
212
|
-
---
|
213
|
-
|
214
196
|
### `getAllAccess(resourceID?: string) => Promise<any>`
|
215
197
|
|
216
198
|
Obtém todos os acessos do usuário logado para um recurso específico ou para a aplicação.
|
@@ -221,8 +203,6 @@ Type: `Promise<any>`
|
|
221
203
|
|
222
204
|
Um objeto contendo todos os tipos de acesso e se o usuário os possui.
|
223
205
|
|
224
|
-
---
|
225
|
-
|
226
206
|
### `getAppLabel() => Promise<string>`
|
227
207
|
|
228
208
|
Obtém o nome (label) da aplicação.
|
@@ -233,8 +213,6 @@ Type: `Promise<string>`
|
|
233
213
|
|
234
214
|
O nome da aplicação.
|
235
215
|
|
236
|
-
---
|
237
|
-
|
238
216
|
### `getApplicationPath() => Promise<string>`
|
239
217
|
|
240
218
|
Retorna o path relativo da aplicação.
|
@@ -245,8 +223,6 @@ Type: `Promise<string>`
|
|
245
223
|
|
246
224
|
O caminho relativo da aplicação.
|
247
225
|
|
248
|
-
---
|
249
|
-
|
250
226
|
### `getAttributeFromHTMLWrapper(attribName: string) => Promise<string>`
|
251
227
|
|
252
228
|
Acessa informações de contexto "empurrados" na abertura da tela.
|
@@ -257,8 +233,6 @@ Type: `Promise<string>`
|
|
257
233
|
|
258
234
|
O valor do atributo.
|
259
235
|
|
260
|
-
---
|
261
|
-
|
262
236
|
### `getBooleanParam(name: string) => Promise<boolean>`
|
263
237
|
|
264
238
|
Obtém o valor de um parâmetro do tipo booleano.
|
@@ -269,8 +243,6 @@ Type: `Promise<boolean>`
|
|
269
243
|
|
270
244
|
O valor do parâmetro como booleano.
|
271
245
|
|
272
|
-
---
|
273
|
-
|
274
246
|
### `getConfig(key: string) => Promise<any>`
|
275
247
|
|
276
248
|
Obtém a configuração de um recurso por service broker.
|
@@ -281,8 +253,6 @@ Type: `Promise<any>`
|
|
281
253
|
|
282
254
|
Os dados da configuração.
|
283
255
|
|
284
|
-
---
|
285
|
-
|
286
256
|
### `getDataFetcher() => Promise<DataFetcher>`
|
287
257
|
|
288
258
|
Retorna a instância do DataFetcher utilizado pelo application.
|
@@ -293,8 +263,6 @@ Type: `Promise<DataFetcher>`
|
|
293
263
|
|
294
264
|
O DataFetcher da aplicação.
|
295
265
|
|
296
|
-
---
|
297
|
-
|
298
266
|
### `getDataUnit(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
|
299
267
|
|
300
268
|
Obtém um DataUnit do cache ou cria um caso ainda não tenha sido criado.
|
@@ -305,8 +273,6 @@ Type: `Promise<DataUnit>`
|
|
305
273
|
|
306
274
|
O DataUnit obtido do cache ou recém-criado.
|
307
275
|
|
308
|
-
---
|
309
|
-
|
310
276
|
### `getDateParam(name: string) => Promise<Date>`
|
311
277
|
|
312
278
|
Obtém o valor de um parâmetro do tipo data.
|
@@ -317,8 +283,6 @@ Type: `Promise<Date>`
|
|
317
283
|
|
318
284
|
O valor do parâmetro como objeto Date.
|
319
285
|
|
320
|
-
---
|
321
|
-
|
322
286
|
### `getFloatParam(name: string) => Promise<number>`
|
323
287
|
|
324
288
|
Obtém o valor de um parâmetro do tipo Decimal.
|
@@ -329,8 +293,6 @@ Type: `Promise<number>`
|
|
329
293
|
|
330
294
|
O valor do parâmetro como número decimal.
|
331
295
|
|
332
|
-
---
|
333
|
-
|
334
296
|
### `getIntParam(name: string) => Promise<number>`
|
335
297
|
|
336
298
|
Obtém o valor de um parâmetro do tipo Inteiro.
|
@@ -341,8 +303,6 @@ Type: `Promise<number>`
|
|
341
303
|
|
342
304
|
O valor do parâmetro como número inteiro.
|
343
305
|
|
344
|
-
---
|
345
|
-
|
346
306
|
### `getKeyboardManager() => Promise<KeyboardManager>`
|
347
307
|
|
348
308
|
Obtém o controlador de teclado.
|
@@ -353,8 +313,6 @@ Type: `Promise<KeyboardManager>`
|
|
353
313
|
|
354
314
|
O gerenciador de teclado.
|
355
315
|
|
356
|
-
---
|
357
|
-
|
358
316
|
### `getLayoutFormConfig() => Promise<LayoutFormConfig>`
|
359
317
|
|
360
318
|
Obtém o notificador de Layout de formulário.
|
@@ -365,8 +323,6 @@ Type: `Promise<LayoutFormConfig>`
|
|
365
323
|
|
366
324
|
O configurador de Layout do Formulário.
|
367
325
|
|
368
|
-
---
|
369
|
-
|
370
326
|
### `getResourceID() => Promise<string>`
|
371
327
|
|
372
328
|
Obtém o resourceID da tela em questão.
|
@@ -377,8 +333,6 @@ Type: `Promise<string>`
|
|
377
333
|
|
378
334
|
O ID do recurso da aplicação.
|
379
335
|
|
380
|
-
---
|
381
|
-
|
382
336
|
### `getStringParam(name: string) => Promise<string>`
|
383
337
|
|
384
338
|
Obtém o valor de um parâmetro do tipo string.
|
@@ -389,8 +343,6 @@ Type: `Promise<string>`
|
|
389
343
|
|
390
344
|
O valor do parâmetro como string.
|
391
345
|
|
392
|
-
---
|
393
|
-
|
394
346
|
### `getUserID() => Promise<string>`
|
395
347
|
|
396
348
|
Obtém o UserId do usuário logado.
|
@@ -401,8 +353,6 @@ Type: `Promise<string>`
|
|
401
353
|
|
402
354
|
O ID do usuário.
|
403
355
|
|
404
|
-
---
|
405
|
-
|
406
356
|
### `hasAccess(access: AutorizationType, resourceID?: string) => Promise<boolean>`
|
407
357
|
|
408
358
|
Obtém `true` caso o usuário logado tenha permissão para determinada ação.
|
@@ -413,8 +363,6 @@ Type: `Promise<boolean>`
|
|
413
363
|
|
414
364
|
`true` se o usuário tiver acesso, `false` caso contrário.
|
415
365
|
|
416
|
-
---
|
417
|
-
|
418
366
|
### `hasClientEvent(eventID: String) => Promise<boolean>`
|
419
367
|
|
420
368
|
Verifica se um client event está registrado no DataFetcher da aplicação.
|
@@ -425,8 +373,6 @@ Type: `Promise<boolean>`
|
|
425
373
|
|
426
374
|
`true` se o evento estiver registrado, `false` caso contrário.
|
427
375
|
|
428
|
-
---
|
429
|
-
|
430
376
|
### `importScript(relativePath: string | Array<string>) => Promise<void>`
|
431
377
|
|
432
378
|
Realiza o import de um JavaScript que está disponível dentro da pasta /public da aplicação.
|
@@ -435,7 +381,7 @@ Realiza o import de um JavaScript que está disponível dentro da pasta /public
|
|
435
381
|
|
436
382
|
Type: `Promise<void>`
|
437
383
|
|
438
|
-
|
384
|
+
|
439
385
|
|
440
386
|
### `info(message: string, options?: MessageOptions) => Promise<void>`
|
441
387
|
|
@@ -445,7 +391,7 @@ Exibe uma informação efêmera (de segundo plano).
|
|
445
391
|
|
446
392
|
Type: `Promise<void>`
|
447
393
|
|
448
|
-
|
394
|
+
|
449
395
|
|
450
396
|
### `initOnboarding(onboardingKey: string) => Promise<void>`
|
451
397
|
|
@@ -455,7 +401,7 @@ Inicializa o onboarding para uma chave específica.
|
|
455
401
|
|
456
402
|
Type: `Promise<void>`
|
457
403
|
|
458
|
-
|
404
|
+
|
459
405
|
|
460
406
|
### `isDebugMode() => Promise<boolean>`
|
461
407
|
|
@@ -465,7 +411,7 @@ Obtém `true` caso a tela esteja em modo de debug.
|
|
465
411
|
|
466
412
|
Type: `Promise<boolean>`
|
467
413
|
|
468
|
-
|
414
|
+
|
469
415
|
|
470
416
|
### `isLoadedByPk() => Promise<boolean>`
|
471
417
|
|
@@ -477,8 +423,6 @@ Type: `Promise<boolean>`
|
|
477
423
|
|
478
424
|
`true` se foi carregado por PK, `false` caso contrário.
|
479
425
|
|
480
|
-
---
|
481
|
-
|
482
426
|
### `isUserSup() => Promise<boolean>`
|
483
427
|
|
484
428
|
Obtém `true` caso o usuário logado seja o SUP.
|
@@ -489,8 +433,6 @@ Type: `Promise<boolean>`
|
|
489
433
|
|
490
434
|
`true` se o usuário for SUP, `false` caso contrário.
|
491
435
|
|
492
|
-
---
|
493
|
-
|
494
436
|
### `loadTotals(name: string, resourceID: string, filters: Array<Filter>) => Promise<Map<string, number>>`
|
495
437
|
|
496
438
|
Obtém os totalizadores da grade.
|
@@ -501,8 +443,6 @@ Type: `Promise<Map<string, number>>`
|
|
501
443
|
|
502
444
|
Um mapa com os nomes dos totalizadores e seus valores.
|
503
445
|
|
504
|
-
---
|
505
|
-
|
506
446
|
### `markToReload(templateSkeletonType?: TEMPLATES_SKELETON) => Promise<void>`
|
507
447
|
|
508
448
|
Marca a aplicação para recarregar, opcionalmente especificando um tipo de esqueleto de carregamento.
|
@@ -511,7 +451,7 @@ Marca a aplicação para recarregar, opcionalmente especificando um tipo de esqu
|
|
511
451
|
|
512
452
|
Type: `Promise<void>`
|
513
453
|
|
514
|
-
|
454
|
+
|
515
455
|
|
516
456
|
### `message(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
|
517
457
|
|
@@ -521,7 +461,7 @@ Exibe um diálogo de mensagem comum.
|
|
521
461
|
|
522
462
|
Type: `Promise<boolean>`
|
523
463
|
|
524
|
-
|
464
|
+
|
525
465
|
|
526
466
|
### `openApp(resourceId: string, pkObject: Object) => Promise<void>`
|
527
467
|
|
@@ -531,7 +471,7 @@ Abre determinada tela, repassando pkObject.
|
|
531
471
|
|
532
472
|
Type: `Promise<void>`
|
533
473
|
|
534
|
-
|
474
|
+
|
535
475
|
|
536
476
|
### `preloadMangerRemoveRecord(dataUnit: DataUnit, recordsIDs: Array<string>) => Promise<void>`
|
537
477
|
|
@@ -542,7 +482,7 @@ Deve ser usado quando existe um dataunit usando loader do application, mas o rem
|
|
542
482
|
|
543
483
|
Type: `Promise<void>`
|
544
484
|
|
545
|
-
|
485
|
+
|
546
486
|
|
547
487
|
### `removeClientEvent(eventID: String) => Promise<void>`
|
548
488
|
|
@@ -552,7 +492,7 @@ Remove um client event do DataFetcher da aplicação.
|
|
552
492
|
|
553
493
|
Type: `Promise<void>`
|
554
494
|
|
555
|
-
|
495
|
+
|
556
496
|
|
557
497
|
### `saveConfig(key: string, data: Object) => Promise<any>`
|
558
498
|
|
@@ -564,8 +504,6 @@ Type: `Promise<any>`
|
|
564
504
|
|
565
505
|
O resultado da operação de salvamento.
|
566
506
|
|
567
|
-
---
|
568
|
-
|
569
507
|
### `setPopUpTitle(title: string) => Promise<void>`
|
570
508
|
|
571
509
|
|
@@ -574,7 +512,7 @@ O resultado da operação de salvamento.
|
|
574
512
|
|
575
513
|
Type: `Promise<void>`
|
576
514
|
|
577
|
-
|
515
|
+
|
578
516
|
|
579
517
|
### `setSearchFilterContext(name: string, value: string) => Promise<void>`
|
580
518
|
|
@@ -584,7 +522,7 @@ Atribui valor para parâmetros de contexto no componente de pesquisa.
|
|
584
522
|
|
585
523
|
Type: `Promise<void>`
|
586
524
|
|
587
|
-
|
525
|
+
|
588
526
|
|
589
527
|
### `showAlerts(alerts: Array<AlertItem>) => Promise<void>`
|
590
528
|
|
@@ -595,7 +533,7 @@ Geralmente é utilizado para apresentar resultados de processamentos em lote.
|
|
595
533
|
|
596
534
|
Type: `Promise<void>`
|
597
535
|
|
598
|
-
|
536
|
+
|
599
537
|
|
600
538
|
### `showModal(content: HTMLElement) => Promise<void>`
|
601
539
|
|
@@ -605,7 +543,7 @@ Exibe o conteúdo passado em um Modal.
|
|
605
543
|
|
606
544
|
Type: `Promise<void>`
|
607
545
|
|
608
|
-
|
546
|
+
|
609
547
|
|
610
548
|
### `showPopUp(content: HTMLElement, size?: "auto" | "full", useHeader?: boolean, onCloseCallback?: Function) => Promise<void>`
|
611
549
|
|
@@ -615,7 +553,7 @@ Exibe o conteúdo passado em um Popup.
|
|
615
553
|
|
616
554
|
Type: `Promise<void>`
|
617
555
|
|
618
|
-
|
556
|
+
|
619
557
|
|
620
558
|
### `showScrimApp(active: boolean) => Promise<void>`
|
621
559
|
|
@@ -625,7 +563,7 @@ Type: `Promise<void>`
|
|
625
563
|
|
626
564
|
Type: `Promise<void>`
|
627
565
|
|
628
|
-
|
566
|
+
|
629
567
|
|
630
568
|
### `success(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
|
631
569
|
|
@@ -635,7 +573,7 @@ Exibe o diálogo de sucesso de acordo com os parâmetros passados.
|
|
635
573
|
|
636
574
|
Type: `Promise<boolean>`
|
637
575
|
|
638
|
-
|
576
|
+
|
639
577
|
|
640
578
|
### `temOpcional(opcional: string) => Promise<boolean>`
|
641
579
|
|
@@ -647,8 +585,6 @@ Type: `Promise<boolean>`
|
|
647
585
|
|
648
586
|
`true` se o cliente tiver o opcional, `false` caso contrário.
|
649
587
|
|
650
|
-
---
|
651
|
-
|
652
588
|
### `updateDataunitCache(oldName: string, dataUnitName: string, dataUnit: DataUnit) => Promise<void>`
|
653
589
|
|
654
590
|
Atualiza o cache de dataunits da aplicação.
|
@@ -657,7 +593,7 @@ Atualiza o cache de dataunits da aplicação.
|
|
657
593
|
|
658
594
|
Type: `Promise<void>`
|
659
595
|
|
660
|
-
|
596
|
+
|
661
597
|
|
662
598
|
### `webConnection(keyPort: string, methodName: string, params: IAppletCallerParams) => Promise<void>`
|
663
599
|
|
@@ -667,7 +603,7 @@ Realiza a chamada do WebConnection para realizar a exportação de arquivo.
|
|
667
603
|
|
668
604
|
Type: `Promise<void>`
|
669
605
|
|
670
|
-
|
606
|
+
|
671
607
|
|
672
608
|
### `whenApplicationReady() => Promise<SnkApplication>`
|
673
609
|
|
@@ -60,7 +60,7 @@ Registra um editor customizado para campos da grade e formulário.
|
|
60
60
|
|
61
61
|
Type: `Promise<void>`
|
62
62
|
|
63
|
-
|
63
|
+
|
64
64
|
|
65
65
|
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
66
66
|
|
@@ -70,7 +70,7 @@ Registra um formatador de valores para uma coluna da grid.
|
|
70
70
|
|
71
71
|
Type: `Promise<void>`
|
72
72
|
|
73
|
-
|
73
|
+
|
74
74
|
|
75
75
|
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
76
76
|
|
@@ -80,7 +80,7 @@ Registra um render customizado para colunas da grid.
|
|
80
80
|
|
81
81
|
Type: `Promise<void>`
|
82
82
|
|
83
|
-
|
83
|
+
|
84
84
|
|
85
85
|
### `closeConfigurator() => Promise<void>`
|
86
86
|
|
@@ -90,7 +90,7 @@ Usado para fechar o configurator do CRUD
|
|
90
90
|
|
91
91
|
Type: `Promise<void>`
|
92
92
|
|
93
|
-
|
93
|
+
|
94
94
|
|
95
95
|
### `getFilterBar() => Promise<HTMLSnkFilterBarElement>`
|
96
96
|
|
@@ -100,7 +100,7 @@ Retorna o elemento da filter-bar da grade.
|
|
100
100
|
|
101
101
|
Type: `Promise<HTMLSnkFilterBarElement>`
|
102
102
|
|
103
|
-
|
103
|
+
|
104
104
|
|
105
105
|
### `goToView(mode: string) => Promise<void>`
|
106
106
|
|
@@ -110,7 +110,7 @@ Usado para alternar a visão entre GRID e FORM externamente.
|
|
110
110
|
|
111
111
|
Type: `Promise<void>`
|
112
112
|
|
113
|
-
|
113
|
+
|
114
114
|
|
115
115
|
### `openConfigurator() => Promise<void>`
|
116
116
|
|
@@ -120,7 +120,7 @@ Usado para abrir o configurator do CRUD
|
|
120
120
|
|
121
121
|
Type: `Promise<void>`
|
122
122
|
|
123
|
-
|
123
|
+
|
124
124
|
|
125
125
|
### `reloadFilterBar() => Promise<void>`
|
126
126
|
|
@@ -130,7 +130,7 @@ Faz o recarregamento da filter-bar do crud, buscando o state no servidor.
|
|
130
130
|
|
131
131
|
Type: `Promise<void>`
|
132
132
|
|
133
|
-
|
133
|
+
|
134
134
|
|
135
135
|
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
136
136
|
|
@@ -140,7 +140,7 @@ Remove o formatador de valores de uma coluna da grid.
|
|
140
140
|
|
141
141
|
Type: `Promise<void>`
|
142
142
|
|
143
|
-
|
143
|
+
|
144
144
|
|
145
145
|
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
146
146
|
|
@@ -49,7 +49,7 @@ Registra um editor customizado para campos da grade e formulário
|
|
49
49
|
|
50
50
|
Type: `Promise<void>`
|
51
51
|
|
52
|
-
|
52
|
+
|
53
53
|
|
54
54
|
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
55
55
|
|
@@ -59,7 +59,7 @@ Registra um render customizado para colunas da grid.
|
|
59
59
|
|
60
60
|
Type: `Promise<void>`
|
61
61
|
|
62
|
-
|
62
|
+
|
63
63
|
|
64
64
|
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
65
65
|
|
@@ -69,7 +69,7 @@ Altera/adiciona uma propriedade nos metadados do campo.
|
|
69
69
|
|
70
70
|
Type: `Promise<void>`
|
71
71
|
|
72
|
-
|
72
|
+
|
73
73
|
|
74
74
|
### `setFocus() => Promise<void>`
|
75
75
|
|
@@ -79,7 +79,7 @@ Atribui o foco para o componente.
|
|
79
79
|
|
80
80
|
Type: `Promise<void>`
|
81
81
|
|
82
|
-
|
82
|
+
|
83
83
|
|
84
84
|
### `showFormConfig(detail?: boolean) => Promise<void>`
|
85
85
|
|
@@ -46,7 +46,7 @@ Registra um editor customizado para campos da grade e formulário.
|
|
46
46
|
|
47
47
|
Type: `Promise<void>`
|
48
48
|
|
49
|
-
|
49
|
+
|
50
50
|
|
51
51
|
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
52
52
|
|
@@ -56,7 +56,7 @@ Registra um render customizado para colunas da grid.
|
|
56
56
|
|
57
57
|
Type: `Promise<void>`
|
58
58
|
|
59
|
-
|
59
|
+
|
60
60
|
|
61
61
|
### `changeViewMode(mode: VIEW_MODE) => Promise<void>`
|
62
62
|
|
@@ -66,7 +66,7 @@ Muda o modo de visualização do componente entre VIEW_MODE.GRID e VIEW_MODE.FOR
|
|
66
66
|
|
67
67
|
Type: `Promise<void>`
|
68
68
|
|
69
|
-
|
69
|
+
|
70
70
|
|
71
71
|
### `configGrid() => Promise<void>`
|
72
72
|
|
@@ -76,7 +76,7 @@ Abre o configurador de grid.
|
|
76
76
|
|
77
77
|
Type: `Promise<void>`
|
78
78
|
|
79
|
-
|
79
|
+
|
80
80
|
|
81
81
|
### `showUp() => Promise<void>`
|
82
82
|
|
@@ -33,7 +33,7 @@
|
|
33
33
|
| `dataUnitFieldsHidded` | Emitido quando há campos no DataUnit que devem ser ocultados. | `CustomEvent<void>` |
|
34
34
|
| `dataUnitReady` | Emitido quando o DataUnit está pronto. | `CustomEvent<DataUnit>` |
|
35
35
|
| `insertionMode` | Emitido quando um registro é adicionado ou copiado. | `CustomEvent<void>` |
|
36
|
-
| `messagesBuilderUpdated` | Emitido quando o
|
36
|
+
| `messagesBuilderUpdated` | Emitido quando o DataUnit está pronto. | `CustomEvent<SnkMessageBuilder>` |
|
37
37
|
|
38
38
|
|
39
39
|
## Methods
|
@@ -46,9 +46,7 @@ Obtém o dataUnit.
|
|
46
46
|
|
47
47
|
Type: `Promise<DataUnit>`
|
48
48
|
|
49
|
-
Uma promessa que resolve com a instância do DataUnit.
|
50
49
|
|
51
|
-
---
|
52
50
|
|
53
51
|
### `getFieldsWithRmPrecision() => Promise<string[]>`
|
54
52
|
|
@@ -58,9 +56,7 @@ Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precisi
|
|
58
56
|
|
59
57
|
Type: `Promise<string[]>`
|
60
58
|
|
61
|
-
Uma promessa que resolve com um array de nomes de campos.
|
62
59
|
|
63
|
-
---
|
64
60
|
|
65
61
|
### `getFieldsWithRmp() => Promise<string[]>`
|
66
62
|
|
@@ -70,9 +66,7 @@ Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
|
|
70
66
|
|
71
67
|
Type: `Promise<string[]>`
|
72
68
|
|
73
|
-
Uma promessa que resolve com um array de nomes de campos.
|
74
69
|
|
75
|
-
---
|
76
70
|
|
77
71
|
### `getRowMetadata(record?: Record | string) => Promise<RowMetadata>`
|
78
72
|
|
@@ -82,9 +76,7 @@ Busca os metadados da linha selecionada.
|
|
82
76
|
|
83
77
|
Type: `Promise<RowMetadata>`
|
84
78
|
|
85
|
-
Uma promessa que resolve com os metadados da linha.
|
86
79
|
|
87
|
-
---
|
88
80
|
|
89
81
|
### `getSelectedRecordsIDsInfo() => Promise<Array<IRecordID>>`
|
90
82
|
|
@@ -94,7 +86,7 @@ Método que retorna a lista de IDs dos registros selecionados.
|
|
94
86
|
|
95
87
|
Type: `Promise<IRecordID[]>`
|
96
88
|
|
97
|
-
Retorna
|
89
|
+
Retorna a lista de IDs dos registros selecionados.
|
98
90
|
|
99
91
|
|
100
92
|
## Dependencies
|
@@ -41,7 +41,7 @@ Adiciona um item de filtro.
|
|
41
41
|
|
42
42
|
Type: `Promise<void>`
|
43
43
|
|
44
|
-
|
44
|
+
|
45
45
|
|
46
46
|
### `getFilterItem(id: string) => Promise<SnkFilterItemConfig | undefined>`
|
47
47
|
|
@@ -51,7 +51,7 @@ Retorna um item de filtro pelo ID.
|
|
51
51
|
|
52
52
|
Type: `Promise<SnkFilterItemConfig>`
|
53
53
|
|
54
|
-
|
54
|
+
|
55
55
|
|
56
56
|
### `reload() => Promise<void>`
|
57
57
|
|
@@ -61,7 +61,7 @@ Faz o recarregamento da filterbar buscando o state no servidor.
|
|
61
61
|
|
62
62
|
Type: `Promise<void>`
|
63
63
|
|
64
|
-
|
64
|
+
|
65
65
|
|
66
66
|
### `removeFilterItem(filterID: string) => Promise<SnkFilterItemConfig | undefined>`
|
67
67
|
|
@@ -73,8 +73,6 @@ Type: `Promise<SnkFilterItemConfig>`
|
|
73
73
|
|
74
74
|
- Retorna o item de filtro removido, ou undefined caso não encontrado.
|
75
75
|
|
76
|
-
---
|
77
|
-
|
78
76
|
### `showFilterModal() => Promise<void>`
|
79
77
|
|
80
78
|
Abre o modal de filtros
|
@@ -83,7 +81,7 @@ Abre o modal de filtros
|
|
83
81
|
|
84
82
|
Type: `Promise<void>`
|
85
83
|
|
86
|
-
|
84
|
+
|
87
85
|
|
88
86
|
### `updateFilterItem(newFilterItem: SnkFilterItemConfig) => Promise<void>`
|
89
87
|
|
@@ -35,7 +35,7 @@ Registra um editor customizado para campos da grade e formulário.
|
|
35
35
|
|
36
36
|
Type: `Promise<void>`
|
37
37
|
|
38
|
-
|
38
|
+
|
39
39
|
|
40
40
|
### `hideConfig() => Promise<void>`
|
41
41
|
|
@@ -45,7 +45,7 @@ Fecha a janela de configurações do formulário.
|
|
45
45
|
|
46
46
|
Type: `Promise<void>`
|
47
47
|
|
48
|
-
|
48
|
+
|
49
49
|
|
50
50
|
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
51
51
|
|
@@ -55,7 +55,7 @@ Altera/adiciona uma propriedade nos metadados do campo.
|
|
55
55
|
|
56
56
|
Type: `Promise<void>`
|
57
57
|
|
58
|
-
|
58
|
+
|
59
59
|
|
60
60
|
### `showConfig() => Promise<void>`
|
61
61
|
|
@@ -7,102 +7,94 @@
|
|
7
7
|
|
8
8
|
## Properties
|
9
9
|
|
10
|
-
| Property | Attribute | Description
|
11
|
-
| ------------------------------- | ----------------------------------- |
|
12
|
-
| `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do
|
13
|
-
| `autoFocus` | `auto-focus` | Define se a
|
14
|
-
| `autoLoad` | `auto-load` | Define se
|
15
|
-
| `canEdit` | `can-edit` | Define se a edição
|
16
|
-
| `columnFilterDataSource` | -- |
|
17
|
-
| `compact` | `compact` | Define se a grade deve ser exibida em modo compacto
|
18
|
-
| `configName` | `config-name` | Nome usado para salvar
|
19
|
-
| `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na
|
20
|
-
| `enableGridInsert` | `enable-grid-insert` |
|
21
|
-
| `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação
|
22
|
-
| `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar.
|
23
|
-
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração
|
24
|
-
| `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros
|
25
|
-
| `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` |
|
26
|
-
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração
|
27
|
-
| `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe
|
28
|
-
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
|
29
|
-
| `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros
|
30
|
-
| `multipleSelection` | `multiple-selection` | Determina se
|
31
|
-
| `outlineMode` | `outline-mode` | Altera
|
32
|
-
| `paginationCounterMode` | `pagination-counter-mode` | Define
|
33
|
-
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do
|
34
|
-
| `recordsValidator` | -- | Validador responsável por
|
35
|
-
| `resourceID` | `resource-i-d` | Identificador de recursos
|
36
|
-
| `selectionToastConfig` | -- | Configuração
|
37
|
-
| `statusResolver` | -- |
|
38
|
-
| `strategyExporter` | `strategy-exporter` |
|
39
|
-
| `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de
|
40
|
-
| `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir
|
41
|
-
| `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do
|
42
|
-
| `taskbarManager` | -- | Gerenciador das barras de tarefas.
|
43
|
-
| `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` |
|
44
|
-
| `useEnterLikeTab` | `use-enter-like-tab` | Quando
|
45
|
-
| `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
11
|
+
| ------------------------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------- |
|
12
|
+
| `actionsList` | -- | Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. | `Action[]` | `undefined` |
|
13
|
+
| `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
|
14
|
+
| `autoLoad` | `auto-load` | Define se a carga dos dados será feita assim que o componente for carregado. | `boolean` | `undefined` |
|
15
|
+
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
|
16
|
+
| `columnFilterDataSource` | -- | | `IMultiSelectionListDataSource` | `new SnkMultiSelectionListDataSource()` |
|
17
|
+
| `compact` | `compact` | Define se a grade deve ser exibida em modo compacto | `boolean` | `undefined` |
|
18
|
+
| `configName` | `config-name` | Nome usado para salvar/recuperar a configuração. | `string` | `undefined` |
|
19
|
+
| `disablePersonalizedFilter` | `disable-personalized-filter` | Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados). | `boolean` | `undefined` |
|
20
|
+
| `enableGridInsert` | `enable-grid-insert` | Ativa inserção de registros no modo grade. | `boolean` | `false` |
|
21
|
+
| `enableLockManagerLoadingComp` | `enable-lock-manager-loading-comp` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `false` |
|
22
|
+
| `enableLockManagerTaskbarClick` | `enable-lock-manager-taskbar-click` | Ativa o gerenciamento de locks na grade pela Taskbar. | `boolean` | `false` |
|
23
|
+
| `filterBarLegacyConfigName` | `filter-bar-legacy-config-name` | Chave da configuração legado da barra de filtros. | `string` | `undefined` |
|
24
|
+
| `filterBarTitle` | `filter-bar-title` | Título que será apresentado na barra de filtros | `string` | `undefined` |
|
25
|
+
| `gridHeaderCustomSlotId` | `grid-header-custom-slot-id` | Nome do slot de elementos customizados da Taskbar do cabeçalho da grade. | `string` | `'GRID_HEADER_CUSTOM_ELEMENTS'` |
|
26
|
+
| `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
|
27
|
+
| `isDetail` | `is-detail` | Determina se a grade está vinculada a um detalhe. | `boolean` | `undefined` |
|
28
|
+
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
29
|
+
| `multipleEditionEnabled` | `multiple-edition-enabled` | Habilita a edição de múltiplos registros simultâneos. | `boolean` | `true` |
|
30
|
+
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada. | `boolean` | `undefined` |
|
31
|
+
| `outlineMode` | `outline-mode` | Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up) | `boolean` | `false` |
|
32
|
+
| `paginationCounterMode` | `pagination-counter-mode` | Define se a grid será focada ao ser carregada. | `"auto" \| "hidden" \| "show"` | `'auto'` |
|
33
|
+
| `presentationMode` | `presentation-mode` | Altera o modo de apresentação dos botões do snk-taskbar. | `PresentationMode.PRIMARY \| PresentationMode.SECONDARY \| PresentationMode.SINGLE_TASKBAR` | `PresentationMode.PRIMARY` |
|
34
|
+
| `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
|
35
|
+
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
36
|
+
| `selectionToastConfig` | -- | Configuração da seleção de grade no toast. | `ISelectionToastConfig` | `undefined` |
|
37
|
+
| `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
|
38
|
+
| `strategyExporter` | `strategy-exporter` | Modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
|
39
|
+
| `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de chechbox deve ser suprimida | `boolean` | `undefined` |
|
40
|
+
| `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir o scroll horizontal. | `boolean` | `false` |
|
41
|
+
| `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
|
42
|
+
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
43
|
+
| `topTaskbarCustomSlotId` | `top-taskbar-custom-slot-id` | Nome do slot de elementos customizados da Taskbar principal do componente. | `string` | `'GRID_TASKBAR_CUSTOM_ELEMENTS'` |
|
44
|
+
| `useEnterLikeTab` | `use-enter-like-tab` | Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. | `boolean` | `false` |
|
45
|
+
| `useSearchColumn` | `use-search-column` | Define se a grade deve exibir um buscador de coluna com uso do Ctrl+F | `boolean` | `true` |
|
46
46
|
|
47
47
|
|
48
48
|
## Events
|
49
49
|
|
50
|
-
| Event | Description
|
51
|
-
| ----------------- |
|
52
|
-
| `actionClick` | Emitido
|
53
|
-
| `componentReady` |
|
54
|
-
| `gridDoubleClick` | Emitido
|
50
|
+
| Event | Description | Type |
|
51
|
+
| ----------------- | ------------------------------------------------------------ | --------------------- |
|
52
|
+
| `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
|
53
|
+
| `componentReady` | Emitido quando o componente estiver completamente carregado. | `CustomEvent<void>` |
|
54
|
+
| `gridDoubleClick` | Emitido sempre que houver duplo click na grade. | `CustomEvent<any>` |
|
55
55
|
|
56
56
|
|
57
57
|
## Methods
|
58
58
|
|
59
59
|
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
|
60
60
|
|
61
|
-
Registra um editor customizado para
|
61
|
+
Registra um editor customizado para campos da grade e formulário
|
62
62
|
|
63
63
|
#### Returns
|
64
64
|
|
65
65
|
Type: `Promise<void>`
|
66
66
|
|
67
|
-
Uma promessa que é resolvida quando o editor é registrado.
|
68
67
|
|
69
|
-
---
|
70
68
|
|
71
69
|
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
72
70
|
|
73
|
-
Registra um formatador de
|
71
|
+
Registra um formatador de valores para uma coluna da grid.
|
74
72
|
|
75
73
|
#### Returns
|
76
74
|
|
77
75
|
Type: `Promise<void>`
|
78
76
|
|
79
|
-
Uma promessa que é resolvida quando o formatador é registrado.
|
80
77
|
|
81
|
-
---
|
82
78
|
|
83
79
|
### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
|
84
80
|
|
85
|
-
Registra um
|
81
|
+
Registra um render customizado para colunas da grid.
|
86
82
|
|
87
83
|
#### Returns
|
88
84
|
|
89
85
|
Type: `Promise<void>`
|
90
86
|
|
91
|
-
Uma promessa que é resolvida quando o renderizador é registrado.
|
92
87
|
|
93
|
-
---
|
94
88
|
|
95
89
|
### `getFilterBar() => Promise<HTMLSnkFilterBarElement>`
|
96
90
|
|
97
|
-
Retorna o elemento da
|
91
|
+
Retorna o elemento da filter-bar da grade.
|
98
92
|
|
99
93
|
#### Returns
|
100
94
|
|
101
95
|
Type: `Promise<HTMLSnkFilterBarElement>`
|
102
96
|
|
103
|
-
O elemento da barra de filtros.
|
104
97
|
|
105
|
-
---
|
106
98
|
|
107
99
|
### `hideConfig() => Promise<void>`
|
108
100
|
|
@@ -112,55 +104,47 @@ Fecha a janela de configurações da grade.
|
|
112
104
|
|
113
105
|
Type: `Promise<void>`
|
114
106
|
|
115
|
-
Uma promessa que é resolvida quando a janela de configuração é fechada.
|
116
107
|
|
117
|
-
---
|
118
108
|
|
119
109
|
### `reloadConfig() => Promise<void>`
|
120
110
|
|
121
|
-
|
111
|
+
|
122
112
|
|
123
113
|
#### Returns
|
124
114
|
|
125
115
|
Type: `Promise<void>`
|
126
116
|
|
127
|
-
|
117
|
+
|
128
118
|
|
129
119
|
### `reloadFilterBar() => Promise<void>`
|
130
120
|
|
131
|
-
|
121
|
+
Faz o recarregamento da filter-bar da grade buscando o state no servidor.
|
132
122
|
|
133
123
|
#### Returns
|
134
124
|
|
135
125
|
Type: `Promise<void>`
|
136
126
|
|
137
|
-
Uma promessa que é resolvida quando a barra de filtros é recarregada.
|
138
127
|
|
139
|
-
---
|
140
128
|
|
141
129
|
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
142
130
|
|
143
|
-
Remove
|
131
|
+
Remove o formatador de valores de uma coluna da grid.
|
144
132
|
|
145
133
|
#### Returns
|
146
134
|
|
147
135
|
Type: `Promise<void>`
|
148
136
|
|
149
|
-
Uma promessa que é resolvida quando o formatador é removido.
|
150
137
|
|
151
|
-
---
|
152
138
|
|
153
139
|
### `setConfig(config: IGridConfig) => Promise<void>`
|
154
140
|
|
155
|
-
|
141
|
+
Atribui o valor da configuração da grade.
|
156
142
|
|
157
143
|
#### Returns
|
158
144
|
|
159
145
|
Type: `Promise<void>`
|
160
146
|
|
161
|
-
Uma promessa que é resolvida quando a configuração é aplicada.
|
162
147
|
|
163
|
-
---
|
164
148
|
|
165
149
|
### `setFocus() => Promise<void>`
|
166
150
|
|
@@ -170,9 +154,7 @@ Atribui o foco para a grade.
|
|
170
154
|
|
171
155
|
Type: `Promise<void>`
|
172
156
|
|
173
|
-
Uma promessa que é resolvida quando o foco é atribuído.
|
174
157
|
|
175
|
-
---
|
176
158
|
|
177
159
|
### `showConfig() => Promise<void>`
|
178
160
|
|
@@ -182,7 +164,7 @@ Exibe a janela de configurações da grade.
|
|
182
164
|
|
183
165
|
Type: `Promise<void>`
|
184
166
|
|
185
|
-
|
167
|
+
|
186
168
|
|
187
169
|
|
188
170
|
## Dependencies
|
@@ -63,7 +63,7 @@ Registra um editor customizado para campos da grade e formulário.
|
|
63
63
|
|
64
64
|
Type: `Promise<void>`
|
65
65
|
|
66
|
-
|
66
|
+
|
67
67
|
|
68
68
|
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
69
69
|
|
@@ -73,7 +73,7 @@ Registra um formatador de valores para uma coluna da grid.
|
|
73
73
|
|
74
74
|
Type: `Promise<void>`
|
75
75
|
|
76
|
-
|
76
|
+
|
77
77
|
|
78
78
|
### `addGridCustomRender(fieldName: string, customRender: ICustomRender) => Promise<void>`
|
79
79
|
|
@@ -83,7 +83,7 @@ Registra um render customizado para colunas da grid.
|
|
83
83
|
|
84
84
|
Type: `Promise<void>`
|
85
85
|
|
86
|
-
|
86
|
+
|
87
87
|
|
88
88
|
### `closeConfigurator() => Promise<void>`
|
89
89
|
|
@@ -93,7 +93,7 @@ Usado para fechar o configurator do CRUD
|
|
93
93
|
|
94
94
|
Type: `Promise<void>`
|
95
95
|
|
96
|
-
|
96
|
+
|
97
97
|
|
98
98
|
### `getRecords() => Promise<Array<Record>>`
|
99
99
|
|
@@ -103,7 +103,7 @@ Type: `Promise<void>`
|
|
103
103
|
|
104
104
|
Type: `Promise<Record[]>`
|
105
105
|
|
106
|
-
|
106
|
+
|
107
107
|
|
108
108
|
### `goToView(view: VIEW_MODE) => Promise<void>`
|
109
109
|
|
@@ -113,7 +113,7 @@ Usado para alternar a visão entre GRID e FORM externamente.
|
|
113
113
|
|
114
114
|
Type: `Promise<void>`
|
115
115
|
|
116
|
-
|
116
|
+
|
117
117
|
|
118
118
|
### `openConfigurator() => Promise<void>`
|
119
119
|
|
@@ -123,7 +123,7 @@ Usado para abrir o configurator do CRUD
|
|
123
123
|
|
124
124
|
Type: `Promise<void>`
|
125
125
|
|
126
|
-
|
126
|
+
|
127
127
|
|
128
128
|
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
129
129
|
|
@@ -133,7 +133,7 @@ Remove o formatador de valores de uma coluna da grid.
|
|
133
133
|
|
134
134
|
Type: `Promise<void>`
|
135
135
|
|
136
|
-
|
136
|
+
|
137
137
|
|
138
138
|
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
139
139
|
|
@@ -143,7 +143,7 @@ Altera/adiciona uma propriedade nos metadados do campo.
|
|
143
143
|
|
144
144
|
Type: `Promise<void>`
|
145
145
|
|
146
|
-
|
146
|
+
|
147
147
|
|
148
148
|
### `setMetadata(metadata: UnitMetadata) => Promise<void>`
|
149
149
|
|
@@ -153,7 +153,7 @@ Type: `Promise<void>`
|
|
153
153
|
|
154
154
|
Type: `Promise<void>`
|
155
155
|
|
156
|
-
|
156
|
+
|
157
157
|
|
158
158
|
### `setRecords(records: Array<Record>) => Promise<void>`
|
159
159
|
|
@@ -163,7 +163,7 @@ Type: `Promise<void>`
|
|
163
163
|
|
164
164
|
Type: `Promise<void>`
|
165
165
|
|
166
|
-
|
166
|
+
|
167
167
|
|
168
168
|
### `updateConfig() => Promise<void>`
|
169
169
|
|
@@ -33,7 +33,7 @@ Esaconde a lista de ações.
|
|
33
33
|
|
34
34
|
Type: `Promise<void>`
|
35
35
|
|
36
|
-
|
36
|
+
|
37
37
|
|
38
38
|
### `isOpened() => Promise<boolean>`
|
39
39
|
|
@@ -43,7 +43,7 @@ Informa se a lista de ações está aberta.
|
|
43
43
|
|
44
44
|
Type: `Promise<boolean>`
|
45
45
|
|
46
|
-
|
46
|
+
|
47
47
|
|
48
48
|
### `showActions() => Promise<void>`
|
49
49
|
|