@sankhyalabs/sankhyablocks-docs 0.0.0-hotfix-ga-kb-106013.3 → 0.0.0-hotfix-ga-KB-107374.0

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.
@@ -9,12 +9,12 @@
9
9
 
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ----------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | ----------- |
12
- | `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
13
- | `enableLockManagerLoadingApp` | `enable-lock-manager-loading-app` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação | `boolean` | `undefined` |
14
- | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
15
- | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legado da grade. | `string` | `undefined` |
12
+ | `configName` | `config-name` | Nome da configuração utilizada para salvar as preferências dos blocos de construção. | `string` | `undefined` |
13
+ | `enableLockManagerLoadingApp` | `enable-lock-manager-loading-app` | Define se o componente deve usar o LockManager para controle de carregamento da aplicação. | `boolean` | `undefined` |
14
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legada do formulário, utilizada para migração de configurações antigas. | `string` | `undefined` |
15
+ | `gridLegacyConfigName` | `grid-legacy-config-name` | Chave da configuração legada da grade, utilizada para migração de configurações antigas. | `string` | `undefined` |
16
16
  | `loadByPK` | -- | Usado para receber um parâmetro na inicialização da tela, e utilizá-lo conforme necessário caso a tela receba um parâmetro, e, esta propriedade não seja informada é criado um filtro de forma automática através do método defaultLoadByPk | `(objPK: { pk: any; }, redirectFrom?: string) => void` | `undefined` |
17
- | `messagesBuilder` | -- | | `SnkMessageBuilder` | `undefined` |
17
+ | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
18
18
 
19
19
 
20
20
  ## Events
@@ -35,17 +35,17 @@ Registra um client event para o DataFetcher da aplicação.
35
35
 
36
36
  Type: `Promise<void>`
37
37
 
38
- ---
39
38
 
40
- ### `addLoadingLock(forceReady?: boolean, templateSkeletonType?: TEMPLATES_SKELETON) => Promise<() => void>`
41
39
 
40
+ ### `addLoadingLock(forceReady?: boolean, templateSkeletonType?: TEMPLATES_SKELETON) => Promise<() => void>`
42
41
 
42
+ Adiciona um bloqueio de carregamento à aplicação.
43
43
 
44
44
  #### Returns
45
45
 
46
46
  Type: `Promise<() => void>`
47
47
 
48
- ---
48
+ O ID do bloqueio adicionado.
49
49
 
50
50
  ### `addPendingAction(actionsLocker: string, action: Function) => Promise<void>`
51
51
 
@@ -55,17 +55,17 @@ Adiciona uma ação pendente que deve ser executada por um determinado locker.
55
55
 
56
56
  Type: `Promise<void>`
57
57
 
58
- ---
58
+
59
59
 
60
60
  ### `addSearchListener(entityName: string, dataUnit: DataUnit, listener: ISearchListener) => Promise<IRemoveSearchListener>`
61
61
 
62
- Adiciona um listener no fetcher de Pesquisa
62
+ Adiciona um listener no fetcher de Pesquisa.
63
63
 
64
64
  #### Returns
65
65
 
66
66
  Type: `Promise<IRemoveSearchListener>`
67
67
 
68
- ---
68
+ Uma função para remover o listener.
69
69
 
70
70
  ### `alert(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
71
71
 
@@ -75,7 +75,7 @@ Exibe o diálogo de alerta de acordo com os parâmetros passados.
75
75
 
76
76
  Type: `Promise<boolean>`
77
77
 
78
- ---
78
+
79
79
 
80
80
  ### `callServiceBroker(serviceName: string, payload: string | Object, options?: Options) => Promise<any>`
81
81
 
@@ -85,7 +85,7 @@ Realiza a chamada ao Service Broker conforme o nome do serviço.
85
85
 
86
86
  Type: `Promise<any>`
87
87
 
88
- ---
88
+ A resposta do Service Broker.
89
89
 
90
90
  ### `clearPopUpTitle() => Promise<void>`
91
91
 
@@ -95,7 +95,7 @@ Type: `Promise<any>`
95
95
 
96
96
  Type: `Promise<void>`
97
97
 
98
- ---
98
+
99
99
 
100
100
  ### `closeModal() => Promise<void>`
101
101
 
@@ -105,7 +105,7 @@ Fecha o Modal e limpa o conteúdo.
105
105
 
106
106
  Type: `Promise<void>`
107
107
 
108
- ---
108
+
109
109
 
110
110
  ### `closePopUp() => Promise<void>`
111
111
 
@@ -115,17 +115,17 @@ Fecha o Popup e limpa o conteúdo.
115
115
 
116
116
  Type: `Promise<void>`
117
117
 
118
- ---
118
+
119
119
 
120
120
  ### `confirm(title: string, message: string, icon?: string, dialogType?: DialogType, options?: MessageOptions) => Promise<boolean>`
121
121
 
122
- Exibe um diálogo de confirmação
122
+ Exibe um diálogo de confirmação.
123
123
 
124
124
  #### Returns
125
125
 
126
126
  Type: `Promise<boolean>`
127
127
 
128
- ---
128
+ `true` se confirmado, `false` caso contrário.
129
129
 
130
130
  ### `createDataunit(entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
131
131
 
@@ -136,7 +136,7 @@ passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUn
136
136
 
137
137
  Type: `Promise<DataUnit>`
138
138
 
139
- ---
139
+ O DataUnit criado ou obtido do cache.
140
140
 
141
141
  ### `error(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
142
142
 
@@ -146,18 +146,18 @@ Exibe o diálogo de erro de acordo com os parâmetros passados.
146
146
 
147
147
  Type: `Promise<boolean>`
148
148
 
149
- ---
149
+
150
150
 
151
151
  ### `executePreparedSearch(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
152
152
 
153
- Obtém as opções em componentes de pesquisa
153
+ Obtém as opções em componentes de pesquisa com base em opções preparadas.
154
154
  Ex.: snk-config-options
155
155
 
156
156
  #### Returns
157
157
 
158
158
  Type: `Promise<IOption | IOption[]>`
159
159
 
160
- ---
160
+ Uma lista de opções ou uma única opção.
161
161
 
162
162
  ### `executePreparedSearchPlus(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>`
163
163
 
@@ -168,18 +168,18 @@ Ex.: snk-config-options
168
168
 
169
169
  Type: `Promise<IOption | IOption[]>`
170
170
 
171
- ---
171
+ Uma lista de opções ou uma única opção.
172
172
 
173
- ### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: any) => Promise<Array<IOption> | IOption>`
173
+ ### `executeSearch(searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: ISearchCtxOptions) => Promise<Array<IOption> | IOption>`
174
174
 
175
- Obtém as opções em componentes de pesquisa
175
+ Obtém as opções em componentes de pesquisa.
176
176
  Ex.: snk-config-options
177
177
 
178
178
  #### Returns
179
179
 
180
180
  Type: `Promise<IOption | IOption[]>`
181
181
 
182
- ---
182
+ Uma lista de opções ou uma única opção.
183
183
 
184
184
  ### `executeSelectDistinct(dataUnit: DataUnit, fieldName: string, argument: string) => Promise<Array<any>>`
185
185
 
@@ -191,27 +191,27 @@ coluna.
191
191
 
192
192
  Type: `Promise<any[]>`
193
193
 
194
- ---
194
+ Uma lista de valores distintos.
195
195
 
196
196
  ### `getAllAccess(resourceID?: string) => Promise<any>`
197
197
 
198
- Obtém todos os acessos do usuário logado.
198
+ Obtém todos os acessos do usuário logado para um recurso específico ou para a aplicação.
199
199
 
200
200
  #### Returns
201
201
 
202
202
  Type: `Promise<any>`
203
203
 
204
- ---
204
+ Um objeto contendo todos os tipos de acesso e se o usuário os possui.
205
205
 
206
206
  ### `getAppLabel() => Promise<string>`
207
207
 
208
- Obtém o nome das telas da aplicação
208
+ Obtém o nome (label) da aplicação.
209
209
 
210
210
  #### Returns
211
211
 
212
212
  Type: `Promise<string>`
213
213
 
214
- ---
214
+ O nome da aplicação.
215
215
 
216
216
  ### `getApplicationPath() => Promise<string>`
217
217
 
@@ -221,7 +221,7 @@ Retorna o path relativo da aplicação.
221
221
 
222
222
  Type: `Promise<string>`
223
223
 
224
- ---
224
+ O caminho relativo da aplicação.
225
225
 
226
226
  ### `getAttributeFromHTMLWrapper(attribName: string) => Promise<string>`
227
227
 
@@ -231,7 +231,7 @@ Acessa informações de contexto "empurrados" na abertura da tela.
231
231
 
232
232
  Type: `Promise<string>`
233
233
 
234
- ---
234
+ O valor do atributo.
235
235
 
236
236
  ### `getBooleanParam(name: string) => Promise<boolean>`
237
237
 
@@ -241,39 +241,37 @@ Obtém o valor de um parâmetro do tipo booleano.
241
241
 
242
242
  Type: `Promise<boolean>`
243
243
 
244
- ---
244
+ O valor do parâmetro como booleano.
245
245
 
246
246
  ### `getConfig(key: string) => Promise<any>`
247
247
 
248
- Obtém a configuração de um recurso por service broker
248
+ Obtém a configuração de um recurso por service broker.
249
249
 
250
250
  #### Returns
251
251
 
252
252
  Type: `Promise<any>`
253
253
 
254
- ---
254
+ Os dados da configuração.
255
255
 
256
256
  ### `getDataFetcher() => Promise<DataFetcher>`
257
257
 
258
- Retorna a instancia do DataFetcher utilizado pelo application
258
+ Retorna a instância do DataFetcher utilizado pelo application.
259
259
 
260
260
  #### Returns
261
261
 
262
262
  Type: `Promise<DataFetcher>`
263
263
 
264
- DataFetcher do application
265
-
266
- ---
264
+ O DataFetcher da aplicação.
267
265
 
268
266
  ### `getDataUnit(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
269
267
 
270
- Obtem um DataUnit do cache ou cria um caso ainda não tenha sido criado.
268
+ Obtém um DataUnit do cache ou cria um caso ainda não tenha sido criado.
271
269
 
272
270
  #### Returns
273
271
 
274
272
  Type: `Promise<DataUnit>`
275
273
 
276
- ---
274
+ O DataUnit obtido do cache ou recém-criado.
277
275
 
278
276
  ### `getDateParam(name: string) => Promise<Date>`
279
277
 
@@ -283,7 +281,7 @@ Obtém o valor de um parâmetro do tipo data.
283
281
 
284
282
  Type: `Promise<Date>`
285
283
 
286
- ---
284
+ O valor do parâmetro como objeto Date.
287
285
 
288
286
  ### `getFloatParam(name: string) => Promise<number>`
289
287
 
@@ -293,7 +291,7 @@ Obtém o valor de um parâmetro do tipo Decimal.
293
291
 
294
292
  Type: `Promise<number>`
295
293
 
296
- ---
294
+ O valor do parâmetro como número decimal.
297
295
 
298
296
  ### `getIntParam(name: string) => Promise<number>`
299
297
 
@@ -303,7 +301,7 @@ Obtém o valor de um parâmetro do tipo Inteiro.
303
301
 
304
302
  Type: `Promise<number>`
305
303
 
306
- ---
304
+ O valor do parâmetro como número inteiro.
307
305
 
308
306
  ### `getKeyboardManager() => Promise<KeyboardManager>`
309
307
 
@@ -313,21 +311,17 @@ Obtém o controlador de teclado.
313
311
 
314
312
  Type: `Promise<KeyboardManager>`
315
313
 
316
- the keyboard manager
317
-
318
- ---
314
+ O gerenciador de teclado.
319
315
 
320
316
  ### `getLayoutFormConfig() => Promise<LayoutFormConfig>`
321
317
 
322
- Obtém o notificador de Layout de formulario.
318
+ Obtém o notificador de Layout de formulário.
323
319
 
324
320
  #### Returns
325
321
 
326
322
  Type: `Promise<LayoutFormConfig>`
327
323
 
328
- the Configurador de Layout do Formulario
329
-
330
- ---
324
+ O configurador de Layout do Formulário.
331
325
 
332
326
  ### `getResourceID() => Promise<string>`
333
327
 
@@ -337,7 +331,7 @@ Obtém o resourceID da tela em questão.
337
331
 
338
332
  Type: `Promise<string>`
339
333
 
340
- ---
334
+ O ID do recurso da aplicação.
341
335
 
342
336
  ### `getStringParam(name: string) => Promise<string>`
343
337
 
@@ -347,47 +341,47 @@ Obtém o valor de um parâmetro do tipo string.
347
341
 
348
342
  Type: `Promise<string>`
349
343
 
350
- ---
344
+ O valor do parâmetro como string.
351
345
 
352
346
  ### `getUserID() => Promise<string>`
353
347
 
354
- Obtém o UserId da tela em questão.
348
+ Obtém o UserId do usuário logado.
355
349
 
356
350
  #### Returns
357
351
 
358
352
  Type: `Promise<string>`
359
353
 
360
- ---
354
+ O ID do usuário.
361
355
 
362
356
  ### `hasAccess(access: AutorizationType, resourceID?: string) => Promise<boolean>`
363
357
 
364
- Obtém `true` caso o usuário logado tem permissão pra determinada ação.
358
+ Obtém `true` caso o usuário logado tenha permissão para determinada ação.
365
359
 
366
360
  #### Returns
367
361
 
368
362
  Type: `Promise<boolean>`
369
363
 
370
- ---
364
+ `true` se o usuário tiver acesso, `false` caso contrário.
371
365
 
372
366
  ### `hasClientEvent(eventID: String) => Promise<boolean>`
373
367
 
374
- Verfica se um client event está registrado no DataFetcher da aplicação.
368
+ Verifica se um client event está registrado no DataFetcher da aplicação.
375
369
 
376
370
  #### Returns
377
371
 
378
372
  Type: `Promise<boolean>`
379
373
 
380
- ---
374
+ `true` se o evento estiver registrado, `false` caso contrário.
381
375
 
382
376
  ### `importScript(relativePath: string | Array<string>) => Promise<void>`
383
377
 
384
- Realiza o import de um JavaScript que está disponivel dentro da pasta /public da aplicação.
378
+ Realiza o import de um JavaScript que está disponível dentro da pasta /public da aplicação.
385
379
 
386
380
  #### Returns
387
381
 
388
382
  Type: `Promise<void>`
389
383
 
390
- ---
384
+
391
385
 
392
386
  ### `info(message: string, options?: MessageOptions) => Promise<void>`
393
387
 
@@ -397,17 +391,17 @@ Exibe uma informação efêmera (de segundo plano).
397
391
 
398
392
  Type: `Promise<void>`
399
393
 
400
- ---
401
394
 
402
- ### `initOnboarding(onboardingKey: string) => Promise<void>`
403
395
 
396
+ ### `initOnboarding(onboardingKey: string) => Promise<void>`
404
397
 
398
+ Inicializa o onboarding para uma chave específica.
405
399
 
406
400
  #### Returns
407
401
 
408
402
  Type: `Promise<void>`
409
403
 
410
- ---
404
+
411
405
 
412
406
  ### `isDebugMode() => Promise<boolean>`
413
407
 
@@ -417,19 +411,17 @@ Obtém `true` caso a tela esteja em modo de debug.
417
411
 
418
412
  Type: `Promise<boolean>`
419
413
 
420
- ---
414
+
421
415
 
422
416
  ### `isLoadedByPk() => Promise<boolean>`
423
417
 
424
- Obtém a informação se o último carregamento do dataunit foi feito através de um loadByPk
418
+ Obtém a informação se o último carregamento do dataunit foi feito através de um loadByPk.
425
419
 
426
420
  #### Returns
427
421
 
428
422
  Type: `Promise<boolean>`
429
423
 
430
- boolean
431
-
432
- ---
424
+ `true` se foi carregado por PK, `false` caso contrário.
433
425
 
434
426
  ### `isUserSup() => Promise<boolean>`
435
427
 
@@ -439,7 +431,7 @@ Obtém `true` caso o usuário logado seja o SUP.
439
431
 
440
432
  Type: `Promise<boolean>`
441
433
 
442
- ---
434
+ `true` se o usuário for SUP, `false` caso contrário.
443
435
 
444
436
  ### `loadTotals(name: string, resourceID: string, filters: Array<Filter>) => Promise<Map<string, number>>`
445
437
 
@@ -449,27 +441,27 @@ Obtém os totalizadores da grade.
449
441
 
450
442
  Type: `Promise<Map<string, number>>`
451
443
 
452
- ---
444
+ Um mapa com os nomes dos totalizadores e seus valores.
453
445
 
454
446
  ### `markToReload(templateSkeletonType?: TEMPLATES_SKELETON) => Promise<void>`
455
447
 
456
-
448
+ Marca a aplicação para recarregar, opcionalmente especificando um tipo de esqueleto de carregamento.
457
449
 
458
450
  #### Returns
459
451
 
460
452
  Type: `Promise<void>`
461
453
 
462
- ---
454
+
463
455
 
464
456
  ### `message(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
465
457
 
466
- Exibe um diálogo de mensagem comum
458
+ Exibe um diálogo de mensagem comum.
467
459
 
468
460
  #### Returns
469
461
 
470
462
  Type: `Promise<boolean>`
471
463
 
472
- ---
464
+
473
465
 
474
466
  ### `openApp(resourceId: string, pkObject: Object) => Promise<void>`
475
467
 
@@ -479,7 +471,7 @@ Abre determinada tela, repassando pkObject.
479
471
 
480
472
  Type: `Promise<void>`
481
473
 
482
- ---
474
+
483
475
 
484
476
  ### `preloadMangerRemoveRecord(dataUnit: DataUnit, recordsIDs: Array<string>) => Promise<void>`
485
477
 
@@ -490,17 +482,17 @@ Deve ser usado quando existe um dataunit usando loader do application, mas o rem
490
482
 
491
483
  Type: `Promise<void>`
492
484
 
493
- ---
485
+
494
486
 
495
487
  ### `removeClientEvent(eventID: String) => Promise<void>`
496
488
 
497
- Remove um client event para o DataFetcher da aplicação.
489
+ Remove um client event do DataFetcher da aplicação.
498
490
 
499
491
  #### Returns
500
492
 
501
493
  Type: `Promise<void>`
502
494
 
503
- ---
495
+
504
496
 
505
497
  ### `saveConfig(key: string, data: Object) => Promise<any>`
506
498
 
@@ -510,7 +502,7 @@ Salva a configuração de determinado recurso.
510
502
 
511
503
  Type: `Promise<any>`
512
504
 
513
- ---
505
+ O resultado da operação de salvamento.
514
506
 
515
507
  ### `setPopUpTitle(title: string) => Promise<void>`
516
508
 
@@ -520,7 +512,7 @@ Type: `Promise<any>`
520
512
 
521
513
  Type: `Promise<void>`
522
514
 
523
- ---
515
+
524
516
 
525
517
  ### `setSearchFilterContext(name: string, value: string) => Promise<void>`
526
518
 
@@ -530,19 +522,18 @@ Atribui valor para parâmetros de contexto no componente de pesquisa.
530
522
 
531
523
  Type: `Promise<void>`
532
524
 
533
- ---
525
+
534
526
 
535
527
  ### `showAlerts(alerts: Array<AlertItem>) => Promise<void>`
536
528
 
537
- Apresenta uma lista de alertas,
538
- geralmente é utilizado para apresentar resultados
539
- de processamentos em lote.
529
+ Apresenta uma lista de alertas.
530
+ Geralmente é utilizado para apresentar resultados de processamentos em lote.
540
531
 
541
532
  #### Returns
542
533
 
543
534
  Type: `Promise<void>`
544
535
 
545
- ---
536
+
546
537
 
547
538
  ### `showModal(content: HTMLElement) => Promise<void>`
548
539
 
@@ -552,7 +543,7 @@ Exibe o conteúdo passado em um Modal.
552
543
 
553
544
  Type: `Promise<void>`
554
545
 
555
- ---
546
+
556
547
 
557
548
  ### `showPopUp(content: HTMLElement, size?: "auto" | "full", useHeader?: boolean, onCloseCallback?: Function) => Promise<void>`
558
549
 
@@ -562,7 +553,7 @@ Exibe o conteúdo passado em um Popup.
562
553
 
563
554
  Type: `Promise<void>`
564
555
 
565
- ---
556
+
566
557
 
567
558
  ### `showScrimApp(active: boolean) => Promise<void>`
568
559
 
@@ -572,7 +563,7 @@ Type: `Promise<void>`
572
563
 
573
564
  Type: `Promise<void>`
574
565
 
575
- ---
566
+
576
567
 
577
568
  ### `success(title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>`
578
569
 
@@ -582,17 +573,17 @@ Exibe o diálogo de sucesso de acordo com os parâmetros passados.
582
573
 
583
574
  Type: `Promise<boolean>`
584
575
 
585
- ---
576
+
586
577
 
587
578
  ### `temOpcional(opcional: string) => Promise<boolean>`
588
579
 
589
- Verifica se a licença do cliente tem determinado opcional (produto)
580
+ Verifica se a licença do cliente tem determinado opcional (produto).
590
581
 
591
582
  #### Returns
592
583
 
593
584
  Type: `Promise<boolean>`
594
585
 
595
- ---
586
+ `true` se o cliente tiver o opcional, `false` caso contrário.
596
587
 
597
588
  ### `updateDataunitCache(oldName: string, dataUnitName: string, dataUnit: DataUnit) => Promise<void>`
598
589
 
@@ -602,7 +593,7 @@ Atualiza o cache de dataunits da aplicação.
602
593
 
603
594
  Type: `Promise<void>`
604
595
 
605
- ---
596
+
606
597
 
607
598
  ### `webConnection(keyPort: string, methodName: string, params: IAppletCallerParams) => Promise<void>`
608
599
 
@@ -612,17 +603,17 @@ Realiza a chamada do WebConnection para realizar a exportação de arquivo.
612
603
 
613
604
  Type: `Promise<void>`
614
605
 
615
- ---
606
+
616
607
 
617
608
  ### `whenApplicationReady() => Promise<SnkApplication>`
618
609
 
619
- Retorna uma promise que sera resolvida quando o snk-application estiver carregado e registrado no ApplicationContext
610
+ Retorna uma promise que será resolvida quando o snk-application estiver carregado e registrado no ApplicationContext.
620
611
 
621
612
  #### Returns
622
613
 
623
614
  Type: `Promise<SnkApplication>`
624
615
 
625
- SnkApplication carregado.
616
+ O componente SnkApplication carregado.
626
617
 
627
618
 
628
619
  ## Dependencies
@@ -38,7 +38,7 @@ Fecha a janela de configuração.
38
38
 
39
39
  Type: `Promise<void>`
40
40
 
41
- ---
41
+
42
42
 
43
43
  ### `open() => Promise<void>`
44
44
 
@@ -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
 
@@ -22,7 +22,7 @@
22
22
 
23
23
  Type: `Promise<IExportResult>`
24
24
 
25
- ---
25
+
26
26
 
27
27
  ### `open(config: IExportConfig) => Promise<IExportResult>`
28
28
 
@@ -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 DataUnit está pronto. | `CustomEvent<SnkMessageBuilder>` |
36
+ | `messagesBuilderUpdated` | Emitido quando o messagesBuilder é atualizado. | `CustomEvent<SnkMessageBuilder>` |
37
37
 
38
38
 
39
39
  ## Methods
@@ -46,7 +46,7 @@ Obtém o dataUnit.
46
46
 
47
47
  Type: `Promise<DataUnit>`
48
48
 
49
- ---
49
+ Uma promessa que resolve com a instância do DataUnit.
50
50
 
51
51
  ### `getFieldsWithRmPrecision() => Promise<string[]>`
52
52
 
@@ -56,7 +56,7 @@ Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precisi
56
56
 
57
57
  Type: `Promise<string[]>`
58
58
 
59
- ---
59
+ Uma promessa que resolve com um array de nomes de campos.
60
60
 
61
61
  ### `getFieldsWithRmp() => Promise<string[]>`
62
62
 
@@ -66,7 +66,7 @@ Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
66
66
 
67
67
  Type: `Promise<string[]>`
68
68
 
69
- ---
69
+ Uma promessa que resolve com um array de nomes de campos.
70
70
 
71
71
  ### `getRowMetadata(record?: Record | string) => Promise<RowMetadata>`
72
72
 
@@ -76,7 +76,7 @@ Busca os metadados da linha selecionada.
76
76
 
77
77
  Type: `Promise<RowMetadata>`
78
78
 
79
- ---
79
+ Uma promessa que resolve com os metadados da linha.
80
80
 
81
81
  ### `getSelectedRecordsIDsInfo() => Promise<Array<IRecordID>>`
82
82
 
@@ -86,7 +86,7 @@ Método que retorna a lista de IDs dos registros selecionados.
86
86
 
87
87
  Type: `Promise<IRecordID[]>`
88
88
 
89
- Retorna a lista de IDs dos registros selecionados.
89
+ Retorna uma promessa que resolve com a lista de IDs dos registros selecionados.
90
90
 
91
91
 
92
92
  ## Dependencies
@@ -32,7 +32,7 @@ Oculta os detalhes de um item da lista.
32
32
 
33
33
  Type: `Promise<void>`
34
34
 
35
- ---
35
+
36
36
 
37
37
  ### `showUp(open?: boolean) => Promise<void>`
38
38
 
@@ -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
 
@@ -30,7 +30,7 @@ Filtra a fonte de dados do componente.
30
30
 
31
31
  Type: `Promise<void>`
32
32
 
33
- ---
33
+
34
34
 
35
35
  ### `show(element?: HTMLElement, options?: IEzPopoverAnchorOptions) => Promise<void>`
36
36
 
@@ -10,7 +10,7 @@
10
10
  | Property | Attribute | Description | Type | Default |
11
11
  | ---------------------- | ------------------------- | -------------------------------------------------------------------------------------- | ------------------- | ----------- |
12
12
  | `configName` | `config-name` | Nome usado para guardar/recuperar as configurações do formulário. | `string` | `undefined` |
13
- | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legada do formulário. | `string` | `undefined` |
13
+ | `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
14
14
  | `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
15
15
  | `recordsValidator` | -- | Validador responsável por checar a integridade das informações do registro. | `IRecordValidator` | `undefined` |
16
16
  | `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
@@ -18,24 +18,24 @@
18
18
 
19
19
  ## Events
20
20
 
21
- | Event | Description | Type |
22
- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
23
- | `actionClick` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente. | `CustomEvent<string>` |
24
- | `exit` | ⚠️ **[DEPRECATED]** Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente. | `CustomEvent<void>` |
25
- | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. OBS: Emitido no subcomponente snk-form-view | `CustomEvent<HTMLElement[]>` |
21
+ | Event | Description | Type |
22
+ | ---------------- | ------------------------------------------------------------------------------- | ---------------------------- |
23
+ | `actionClick` | Emitido sempre que houver click de botão ou ação. | `CustomEvent<string>` |
24
+ | `exit` | Emitido quando o botão de voltar é acionado. | `CustomEvent<void>` |
25
+ | `formItemsReady` | Responsável por notificar quando ocorrer a renderização de itens do formulário. | `CustomEvent<HTMLElement[]>` |
26
26
 
27
27
 
28
28
  ## Methods
29
29
 
30
30
  ### `addCustomEditor(fieldName: string, customEditor: ICustomEditor) => Promise<void>`
31
31
 
32
- Registra um editor customizado para campos do formulário.
32
+ Registra um editor customizado para campos da grade e formulário.
33
33
 
34
34
  #### Returns
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
 
@@ -65,16 +65,6 @@ Exibe a janela de configurações do formulário.
65
65
 
66
66
  Type: `Promise<void>`
67
67
 
68
- ---
69
-
70
- ### `validate() => Promise<void>`
71
-
72
- Valida o formulário.
73
-
74
- #### Returns
75
-
76
- Type: `Promise<void>`
77
-
78
68
 
79
69
 
80
70
 
@@ -37,6 +37,7 @@
37
37
  | `statusResolver` | -- | Configuração do valor da coluna de status. Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' | `((data: object) => string) \| IStatusResolver` | `undefined` |
38
38
  | `strategyExporter` | `strategy-exporter` | Modo de exportação dos dados. | `"ClientSideExporterStrategy" \| "ServerSideExporterStrategy"` | `ExporterStrategy.SERVER_SIDE` |
39
39
  | `suppressCheckboxColumn` | `suppress-checkbox-column` | Informa se a coluna de chechbox deve ser suprimida | `boolean` | `undefined` |
40
+ | `suppressFilterColumn` | `suppress-filter-column` | Informa se a grade deve suprimir o filtro de coluna. | `boolean` | `false` |
40
41
  | `suppressHorizontalScroll` | `suppress-horizontal-scroll` | Define se a grade deve suprimir o scroll horizontal. | `boolean` | `false` |
41
42
  | `taskbarCustomContainerId` | `taskbar-custom-container-id` | Define o identificador do container de elementos customizados da Taskbar. | `string` | `undefined` |
42
43
  | `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
@@ -64,7 +65,7 @@ Registra um editor customizado para campos da grade e formulário
64
65
 
65
66
  Type: `Promise<void>`
66
67
 
67
- ---
68
+
68
69
 
69
70
  ### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
70
71
 
@@ -74,7 +75,7 @@ Registra um formatador de valores para uma coluna da grid.
74
75
 
75
76
  Type: `Promise<void>`
76
77
 
77
- ---
78
+
78
79
 
79
80
  ### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
80
81
 
@@ -84,7 +85,7 @@ Registra um render customizado para colunas da grid.
84
85
 
85
86
  Type: `Promise<void>`
86
87
 
87
- ---
88
+
88
89
 
89
90
  ### `getFilterBar() => Promise<HTMLSnkFilterBarElement>`
90
91
 
@@ -94,7 +95,7 @@ Retorna o elemento da filter-bar da grade.
94
95
 
95
96
  Type: `Promise<HTMLSnkFilterBarElement>`
96
97
 
97
- ---
98
+
98
99
 
99
100
  ### `hideConfig() => Promise<void>`
100
101
 
@@ -104,7 +105,7 @@ Fecha a janela de configurações da grade.
104
105
 
105
106
  Type: `Promise<void>`
106
107
 
107
- ---
108
+
108
109
 
109
110
  ### `reloadConfig() => Promise<void>`
110
111
 
@@ -114,7 +115,7 @@ Type: `Promise<void>`
114
115
 
115
116
  Type: `Promise<void>`
116
117
 
117
- ---
118
+
118
119
 
119
120
  ### `reloadFilterBar() => Promise<void>`
120
121
 
@@ -124,7 +125,7 @@ Faz o recarregamento da filter-bar da grade buscando o state no servidor.
124
125
 
125
126
  Type: `Promise<void>`
126
127
 
127
- ---
128
+
128
129
 
129
130
  ### `removeCustomValueFormatter(columnName: string) => Promise<void>`
130
131
 
@@ -134,7 +135,7 @@ Remove o formatador de valores de uma coluna da grid.
134
135
 
135
136
  Type: `Promise<void>`
136
137
 
137
- ---
138
+
138
139
 
139
140
  ### `setConfig(config: IGridConfig) => Promise<void>`
140
141
 
@@ -144,7 +145,7 @@ Atribui o valor da configuração da grade.
144
145
 
145
146
  Type: `Promise<void>`
146
147
 
147
- ---
148
+
148
149
 
149
150
  ### `setFocus() => Promise<void>`
150
151
 
@@ -154,7 +155,7 @@ Atribui o foco para a grade.
154
155
 
155
156
  Type: `Promise<void>`
156
157
 
157
- ---
158
+
158
159
 
159
160
  ### `showConfig() => Promise<void>`
160
161
 
@@ -22,7 +22,7 @@ Fecha o modal de configuração de valor variável
22
22
 
23
23
  Type: `Promise<IExpressionItem>`
24
24
 
25
- ---
25
+
26
26
 
27
27
  ### `open(expressionItem: IExpressionItem) => Promise<IExpressionItem>`
28
28
 
@@ -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
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/sankhyablocks-docs",
3
- "version": "0.0.0-hotfix-ga-kb-106013.3",
3
+ "version": "0.0.0-hotfix-ga-KB-107374.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [