@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.
@@ -96,11 +96,18 @@ export class SnkGrid {
96
96
  btns.unshift(TaskbarElement.UPDATE_MULTIPLE);
97
97
  return btns;
98
98
  }
99
+ /**
100
+ * Recarrega a configuração da grade.
101
+ * @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.
102
+ */
99
103
  reloadConfig() {
100
104
  this.loadConfig();
101
105
  }
102
106
  /**
103
107
  * Exibe a janela de configurações da grade.
108
+ * @async
109
+ * @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.
110
+ * @returns {Promise<void>} Uma promessa que é resolvida quando a janela de configuração é exibida.
104
111
  */
105
112
  async showConfig() {
106
113
  if (this._grid == undefined) {
@@ -110,6 +117,9 @@ export class SnkGrid {
110
117
  }
111
118
  /**
112
119
  * Fecha a janela de configurações da grade.
120
+ * @async
121
+ * @description Este método fecha o pop-up de configuração de colunas da grade.
122
+ * @returns {Promise<void>} Uma promessa que é resolvida quando a janela de configuração é fechada.
113
123
  */
114
124
  async hideConfig() {
115
125
  if (this._grid == undefined) {
@@ -118,26 +128,42 @@ export class SnkGrid {
118
128
  this.closeGridConfig();
119
129
  }
120
130
  /**
121
- * Atribui o valor da configuração da grade.
131
+ * Define a configuração da grade.
132
+ * @async
133
+ * @description Aplica uma nova configuração de colunas e ordenação à grade.
134
+ * @param {IGridConfig} config O objeto de configuração a ser aplicado na grade.
135
+ * @returns {Promise<void>} Uma promessa que é resolvida quando a configuração é aplicada.
122
136
  */
123
137
  async setConfig(config) {
124
138
  this.setGridConfig(config);
125
139
  }
126
140
  /**
127
- * Faz o recarregamento da filter-bar da grade buscando o state no servidor.
141
+ * Recarrega a barra de filtros da grade, buscando o estado do servidor.
142
+ * @async
143
+ * @description Força o recarregamento da barra de filtros, atualizando suas configurações e filtros a partir do servidor.
144
+ * @returns {Promise<void>} Uma promessa que é resolvida quando a barra de filtros é recarregada.
128
145
  */
129
146
  async reloadFilterBar() {
130
147
  var _a;
131
148
  (_a = this._snkFilterBar) === null || _a === void 0 ? void 0 : _a.reload();
132
149
  }
133
150
  /**
134
- * Retorna o elemento da filter-bar da grade.
151
+ * Retorna o elemento da barra de filtros da grade.
152
+ * @async
153
+ * @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.
154
+ * @returns {Promise<HTMLSnkFilterBarElement>} O elemento da barra de filtros.
135
155
  */
136
156
  async getFilterBar() {
137
157
  return this._snkFilterBar;
138
158
  }
139
159
  /**
140
- * Registra um editor customizado para campos da grade e formulário
160
+ * Registra um editor customizado para um campo da grade ou formulário.
161
+ * @async
162
+ * @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.
163
+ * @param {string} fieldName O nome do campo que receberá o editor customizado.
164
+ * @param {ICustomEditor} customEditor A instância do editor customizado.
165
+ * @param {string} [detailContext] O contexto de detalhe onde o editor será aplicado (opcional).
166
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o editor é registrado.
141
167
  */
142
168
  async addCustomEditor(fieldName, customEditor, detailContext) {
143
169
  if (this._grid) {
@@ -149,7 +175,13 @@ export class SnkGrid {
149
175
  this._customEditors = newCustomEditors;
150
176
  }
151
177
  /**
152
- * Registra um render customizado para colunas da grid.
178
+ * Registra um renderizador customizado para uma coluna da grade.
179
+ * @async
180
+ * @description Adiciona um componente de renderização personalizado para uma coluna específica, permitindo a exibição de conteúdo customizado nas células.
181
+ * @param {string} fieldName O nome do campo (coluna) que receberá o renderizador customizado.
182
+ * @param {ICustomRender} customRender A instância do renderizador customizado.
183
+ * @param {string} [detailContext] O contexto de detalhe onde o renderizador será aplicado (opcional).
184
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o renderizador é registrado.
153
185
  */
154
186
  async addGridCustomRender(fieldName, customRender, detailContext) {
155
187
  if (this._grid) {
@@ -161,19 +193,31 @@ export class SnkGrid {
161
193
  this._customRenders = newCustomRenders;
162
194
  }
163
195
  /**
164
- * Registra um formatador de valores para uma coluna da grid.
196
+ * Registra um formatador de valor customizado para uma coluna da grade.
197
+ * @async
198
+ * @description Adiciona uma função de formatação personalizada para os valores de uma coluna específica, afetando como os dados são exibidos.
199
+ * @param {string} columnName O nome da coluna que receberá o formatador.
200
+ * @param {ICustomFormatter} customFormatter A instância do formatador de valor.
201
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o formatador é registrado.
165
202
  */
166
203
  async addCustomValueFormatter(columnName, customFormatter) {
167
204
  this._grid.addCustomValueFormatter(columnName, customFormatter);
168
205
  }
169
206
  /**
170
- * Remove o formatador de valores de uma coluna da grid.
207
+ * Remove um formatador de valor customizado de uma coluna da grade.
208
+ * @async
209
+ * @description Remove uma função de formatação personalizada previamente registrada para uma coluna.
210
+ * @param {string} columnName O nome da coluna da qual o formatador será removido.
211
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o formatador é removido.
171
212
  */
172
213
  async removeCustomValueFormatter(columnName) {
173
214
  this._grid.removeCustomValueFormatter(columnName);
174
215
  }
175
216
  /**
176
217
  * Atribui o foco para a grade.
218
+ * @async
219
+ * @description Move o foco do navegador para o componente da grade, permitindo a navegação por teclado.
220
+ * @returns {Promise<void>} Uma promessa que é resolvida quando o foco é atribuído.
177
221
  */
178
222
  async setFocus() {
179
223
  this._grid.setFocus();
@@ -533,7 +577,7 @@ export class SnkGrid {
533
577
  "optional": false,
534
578
  "docs": {
535
579
  "tags": [],
536
- "text": ""
580
+ "text": "Define o data source para o filtro de colunas."
537
581
  },
538
582
  "defaultValue": "new SnkMultiSelectionListDataSource()"
539
583
  },
@@ -549,7 +593,7 @@ export class SnkGrid {
549
593
  "optional": true,
550
594
  "docs": {
551
595
  "tags": [],
552
- "text": "Define se o componente deve usar o LockManager para controle de carregamento da aplica\u00E7\u00E3o"
596
+ "text": "Define se o componente deve usar o LockManager para controle de carregamento da aplica\u00E7\u00E3o."
553
597
  },
554
598
  "attribute": "enable-lock-manager-loading-comp",
555
599
  "reflect": false,
@@ -585,7 +629,7 @@ export class SnkGrid {
585
629
  "optional": false,
586
630
  "docs": {
587
631
  "tags": [],
588
- "text": "Nome usado para salvar/recuperar a configura\u00E7\u00E3o."
632
+ "text": "Nome usado para salvar e recuperar a configura\u00E7\u00E3o da grade."
589
633
  },
590
634
  "attribute": "config-name",
591
635
  "reflect": false
@@ -602,7 +646,7 @@ export class SnkGrid {
602
646
  "optional": false,
603
647
  "docs": {
604
648
  "tags": [],
605
- "text": "T\u00EDtulo que ser\u00E1 apresentado na barra de filtros"
649
+ "text": "T\u00EDtulo que ser\u00E1 apresentado na barra de filtros."
606
650
  },
607
651
  "attribute": "filter-bar-title",
608
652
  "reflect": false
@@ -619,7 +663,7 @@ export class SnkGrid {
619
663
  "optional": false,
620
664
  "docs": {
621
665
  "tags": [],
622
- "text": "Identificador de recursos como configura\u00E7\u00F5es e acesso."
666
+ "text": "Identificador de recursos, como configura\u00E7\u00F5es e permiss\u00F5es de acesso."
623
667
  },
624
668
  "attribute": "resource-i-d",
625
669
  "reflect": false
@@ -641,7 +685,7 @@ export class SnkGrid {
641
685
  "optional": false,
642
686
  "docs": {
643
687
  "tags": [],
644
- "text": "Configura\u00E7\u00E3o da sele\u00E7\u00E3o de grade no toast."
688
+ "text": "Configura\u00E7\u00E3o do toast de sele\u00E7\u00E3o da grade."
645
689
  }
646
690
  },
647
691
  "actionsList": {
@@ -664,7 +708,7 @@ export class SnkGrid {
664
708
  "optional": false,
665
709
  "docs": {
666
710
  "tags": [],
667
- "text": "Lista de a\u00E7\u00F5es que devem ser usadas no bot\u00E3o \"Mais op\u00E7\u00F5es\" do componente snk-taskbar."
711
+ "text": "Lista de a\u00E7\u00F5es que devem ser usadas no bot\u00E3o \"Mais op\u00E7\u00F5es\" do `snk-taskbar`."
668
712
  }
669
713
  },
670
714
  "isDetail": {
@@ -679,7 +723,7 @@ export class SnkGrid {
679
723
  "optional": false,
680
724
  "docs": {
681
725
  "tags": [],
682
- "text": "Determina se a grade est\u00E1 vinculada a um detalhe."
726
+ "text": "Determina se a grade est\u00E1 vinculada a um detalhe de outra tela."
683
727
  },
684
728
  "attribute": "is-detail",
685
729
  "reflect": false
@@ -701,7 +745,7 @@ export class SnkGrid {
701
745
  "optional": false,
702
746
  "docs": {
703
747
  "tags": [],
704
- "text": "Gerenciador das barras de tarefas. \u00C9 poss\u00EDvel determinar bot\u00F5es espec\u00EDficos\nou mesmo gerenciar o estado dos bot\u00F5es."
748
+ "text": "Gerenciador das barras de tarefas. Permite determinar bot\u00F5es espec\u00EDficos\nou gerenciar o estado dos bot\u00F5es."
705
749
  }
706
750
  },
707
751
  "statusResolver": {
@@ -724,8 +768,11 @@ export class SnkGrid {
724
768
  "required": false,
725
769
  "optional": false,
726
770
  "docs": {
727
- "tags": [],
728
- "text": "Configura\u00E7\u00E3o do valor da coluna de status.\nExemplo: '{ \"RECDESP\": { \"-1\" : \"#BD0025\", \"1\" : \"#157A00\" } }'"
771
+ "tags": [{
772
+ "name": "example",
773
+ "text": "```json\n'{ \"RECDESP\": { \"-1\" : \"#BD0025\", \"1\" : \"#157A00\" } }'\n```"
774
+ }],
775
+ "text": "Define a configura\u00E7\u00E3o de cores para a coluna de status."
729
776
  }
730
777
  },
731
778
  "multipleSelection": {
@@ -740,7 +787,7 @@ export class SnkGrid {
740
787
  "optional": false,
741
788
  "docs": {
742
789
  "tags": [],
743
- "text": "Determina se pode haver mais de uma linha selecionada."
790
+ "text": "Determina se a sele\u00E7\u00E3o de m\u00FAltiplas linhas \u00E9 permitida."
744
791
  },
745
792
  "attribute": "multiple-selection",
746
793
  "reflect": false
@@ -762,7 +809,7 @@ export class SnkGrid {
762
809
  "optional": false,
763
810
  "docs": {
764
811
  "tags": [],
765
- "text": "Altera o modo de apresenta\u00E7\u00E3o dos bot\u00F5es do snk-taskbar."
812
+ "text": "Altera o modo de apresenta\u00E7\u00E3o dos bot\u00F5es do `snk-taskbar`."
766
813
  },
767
814
  "attribute": "presentation-mode",
768
815
  "reflect": false,
@@ -800,7 +847,7 @@ export class SnkGrid {
800
847
  "optional": false,
801
848
  "docs": {
802
849
  "tags": [],
803
- "text": "Quando verdadeiro, o ENTER far\u00E1 a navega\u00E7\u00E3o como se fosse a tecla TAB na grade."
850
+ "text": "Quando `true`, a tecla ENTER navega entre as c\u00E9lulas como a tecla TAB."
804
851
  },
805
852
  "attribute": "use-enter-like-tab",
806
853
  "reflect": false,
@@ -823,7 +870,7 @@ export class SnkGrid {
823
870
  "optional": false,
824
871
  "docs": {
825
872
  "tags": [],
826
- "text": "Validador respons\u00E1vel por checar a integridade das informa\u00E7\u00F5es do registro."
873
+ "text": "Validador respons\u00E1vel por verificar a integridade dos dados de um registro."
827
874
  }
828
875
  },
829
876
  "canEdit": {
@@ -838,7 +885,7 @@ export class SnkGrid {
838
885
  "optional": false,
839
886
  "docs": {
840
887
  "tags": [],
841
- "text": "Define se a edi\u00E7\u00E3o est\u00E1 habilitada na grid."
888
+ "text": "Define se a edi\u00E7\u00E3o de dados na grade est\u00E1 habilitada."
842
889
  },
843
890
  "attribute": "can-edit",
844
891
  "reflect": false,
@@ -856,7 +903,7 @@ export class SnkGrid {
856
903
  "optional": false,
857
904
  "docs": {
858
905
  "tags": [],
859
- "text": "Define o identificador do container de elementos customizados da Taskbar."
906
+ "text": "Define o identificador do cont\u00EAiner de elementos customizados da `Taskbar`."
860
907
  },
861
908
  "attribute": "taskbar-custom-container-id",
862
909
  "reflect": false
@@ -873,7 +920,7 @@ export class SnkGrid {
873
920
  "optional": false,
874
921
  "docs": {
875
922
  "tags": [],
876
- "text": "Nome do slot de elementos customizados da Taskbar do cabe\u00E7alho da grade."
923
+ "text": "Define o nome do slot para elementos customizados na `Taskbar` do cabe\u00E7alho da grade."
877
924
  },
878
925
  "attribute": "grid-header-custom-slot-id",
879
926
  "reflect": false,
@@ -891,7 +938,7 @@ export class SnkGrid {
891
938
  "optional": false,
892
939
  "docs": {
893
940
  "tags": [],
894
- "text": "Nome do slot de elementos customizados da Taskbar principal do componente."
941
+ "text": "Define o nome do slot para elementos customizados na `Taskbar` principal do componente."
895
942
  },
896
943
  "attribute": "top-taskbar-custom-slot-id",
897
944
  "reflect": false,
@@ -909,7 +956,7 @@ export class SnkGrid {
909
956
  "optional": false,
910
957
  "docs": {
911
958
  "tags": [],
912
- "text": "Desabilita a apresenta\u00E7\u00E3o da op\u00E7\u00E3o de filtros personalizados na filter bar (chip de filtros)\ne no modal lateral de filtros (container de filtros personalizados)."
959
+ "text": "Desabilita a apresenta\u00E7\u00E3o da op\u00E7\u00E3o de filtros personalizados na barra de filtros (chip de filtros)\ne no modal lateral de filtros (cont\u00EAiner de filtros personalizados)."
913
960
  },
914
961
  "attribute": "disable-personalized-filter",
915
962
  "reflect": false
@@ -926,7 +973,7 @@ export class SnkGrid {
926
973
  "optional": false,
927
974
  "docs": {
928
975
  "tags": [],
929
- "text": "Chave da configura\u00E7\u00E3o legado da grade."
976
+ "text": "Chave da configura\u00E7\u00E3o legada da grade."
930
977
  },
931
978
  "attribute": "grid-legacy-config-name",
932
979
  "reflect": false
@@ -943,7 +990,7 @@ export class SnkGrid {
943
990
  "optional": false,
944
991
  "docs": {
945
992
  "tags": [],
946
- "text": "Chave da configura\u00E7\u00E3o legado da barra de filtros."
993
+ "text": "Chave da configura\u00E7\u00E3o legada da barra de filtros."
947
994
  },
948
995
  "attribute": "filter-bar-legacy-config-name",
949
996
  "reflect": false
@@ -960,7 +1007,7 @@ export class SnkGrid {
960
1007
  "optional": true,
961
1008
  "docs": {
962
1009
  "tags": [],
963
- "text": "Define se a carga dos dados ser\u00E1 feita assim que o componente for carregado."
1010
+ "text": "Define se os dados ser\u00E3o carregados automaticamente na inicializa\u00E7\u00E3o do componente."
964
1011
  },
965
1012
  "attribute": "auto-load",
966
1013
  "reflect": false
@@ -977,7 +1024,7 @@ export class SnkGrid {
977
1024
  "optional": true,
978
1025
  "docs": {
979
1026
  "tags": [],
980
- "text": "Define se a grid ser\u00E1 focada ao ser carregada."
1027
+ "text": "Define se a grade receber\u00E1 o foco automaticamente ao ser carregada."
981
1028
  },
982
1029
  "attribute": "auto-focus",
983
1030
  "reflect": false,
@@ -995,7 +1042,7 @@ export class SnkGrid {
995
1042
  "optional": true,
996
1043
  "docs": {
997
1044
  "tags": [],
998
- "text": "Ativa inser\u00E7\u00E3o de registros no modo grade."
1045
+ "text": "Habilita a inser\u00E7\u00E3o de registros diretamente na grade."
999
1046
  },
1000
1047
  "attribute": "enable-grid-insert",
1001
1048
  "reflect": false,
@@ -1013,7 +1060,7 @@ export class SnkGrid {
1013
1060
  "optional": true,
1014
1061
  "docs": {
1015
1062
  "tags": [],
1016
- "text": "Altera visualmente as sombras e bordas do componente\nQuando false, aplica o padr\u00E3o de sombras ao componente (Utilizar quando for o elemento principal do layout)\nQuando true, aplica o padr\u00E3o de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up)"
1063
+ "text": "Altera a apar\u00EAncia das bordas e sombras do componente.\nSe `false`, aplica o padr\u00E3o de sombras (ideal para o elemento principal do layout).\nSe `true`, aplica um contorno (ideal para quando o componente est\u00E1 dentro de outro, como um painel ou pop-up)."
1017
1064
  },
1018
1065
  "attribute": "outline-mode",
1019
1066
  "reflect": false,
@@ -1031,7 +1078,7 @@ export class SnkGrid {
1031
1078
  "optional": false,
1032
1079
  "docs": {
1033
1080
  "tags": [],
1034
- "text": "Define se a grade deve suprimir o scroll horizontal."
1081
+ "text": "Define se a grade deve suprimir a barra de rolagem horizontal."
1035
1082
  },
1036
1083
  "attribute": "suppress-horizontal-scroll",
1037
1084
  "reflect": false,
@@ -1054,7 +1101,7 @@ export class SnkGrid {
1054
1101
  "optional": false,
1055
1102
  "docs": {
1056
1103
  "tags": [],
1057
- "text": "Modo de exporta\u00E7\u00E3o dos dados."
1104
+ "text": "Define o modo de exporta\u00E7\u00E3o dos dados."
1058
1105
  },
1059
1106
  "attribute": "strategy-exporter",
1060
1107
  "reflect": false,
@@ -1072,7 +1119,7 @@ export class SnkGrid {
1072
1119
  "optional": false,
1073
1120
  "docs": {
1074
1121
  "tags": [],
1075
- "text": "Define se a grade deve exibir um buscador de coluna com uso do Ctrl+F"
1122
+ "text": "Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`."
1076
1123
  },
1077
1124
  "attribute": "use-search-column",
1078
1125
  "reflect": false,
@@ -1090,7 +1137,7 @@ export class SnkGrid {
1090
1137
  "optional": false,
1091
1138
  "docs": {
1092
1139
  "tags": [],
1093
- "text": "Habilita a edi\u00E7\u00E3o de m\u00FAltiplos registros simult\u00E2neos."
1140
+ "text": "Habilita a edi\u00E7\u00E3o de m\u00FAltiplos registros simultaneamente."
1094
1141
  },
1095
1142
  "attribute": "multiple-edition-enabled",
1096
1143
  "reflect": false,
@@ -1108,7 +1155,7 @@ export class SnkGrid {
1108
1155
  "optional": true,
1109
1156
  "docs": {
1110
1157
  "tags": [],
1111
- "text": "Define se a grid ser\u00E1 focada ao ser carregada."
1158
+ "text": "Define o modo de exibi\u00E7\u00E3o do contador de pagina\u00E7\u00E3o."
1112
1159
  },
1113
1160
  "attribute": "pagination-counter-mode",
1114
1161
  "reflect": false,
@@ -1126,7 +1173,7 @@ export class SnkGrid {
1126
1173
  "optional": false,
1127
1174
  "docs": {
1128
1175
  "tags": [],
1129
- "text": "Informa se a coluna de chechbox deve ser suprimida"
1176
+ "text": "Informa se a coluna de checkbox deve ser suprimida."
1130
1177
  },
1131
1178
  "attribute": "suppress-checkbox-column",
1132
1179
  "reflect": false
@@ -1143,7 +1190,7 @@ export class SnkGrid {
1143
1190
  "optional": false,
1144
1191
  "docs": {
1145
1192
  "tags": [],
1146
- "text": "Define se a grade deve ser exibida em modo compacto"
1193
+ "text": "Define se a grade deve ser exibida em modo compacto."
1147
1194
  },
1148
1195
  "attribute": "compact",
1149
1196
  "reflect": false
@@ -1168,8 +1215,14 @@ export class SnkGrid {
1168
1215
  "cancelable": true,
1169
1216
  "composed": true,
1170
1217
  "docs": {
1171
- "tags": [],
1172
- "text": "Emitido sempre que houver click de bot\u00E3o ou a\u00E7\u00E3o."
1218
+ "tags": [{
1219
+ "name": "description",
1220
+ "text": "Este evento \u00E9 acionado quando o usu\u00E1rio clica em um bot\u00E3o de a\u00E7\u00E3o ou item de menu na grade, permitindo a execu\u00E7\u00E3o de a\u00E7\u00F5es espec\u00EDficas."
1221
+ }, {
1222
+ "name": "param",
1223
+ "text": "detail - O identificador da a\u00E7\u00E3o clicada, que pode ser usado para determinar qual a\u00E7\u00E3o executar."
1224
+ }],
1225
+ "text": "Emitido ao clicar em um bot\u00E3o de a\u00E7\u00E3o ou item de menu."
1173
1226
  },
1174
1227
  "complexType": {
1175
1228
  "original": "string",
@@ -1183,8 +1236,14 @@ export class SnkGrid {
1183
1236
  "cancelable": true,
1184
1237
  "composed": true,
1185
1238
  "docs": {
1186
- "tags": [],
1187
- "text": "Emitido sempre que houver duplo click na grade."
1239
+ "tags": [{
1240
+ "name": "description",
1241
+ "text": "Este evento \u00E9 acionado quando o usu\u00E1rio clica duas vezes em uma linha da grade, permitindo a\u00E7\u00F5es como edi\u00E7\u00E3o r\u00E1pida ou visualiza\u00E7\u00E3o de detalhes."
1242
+ }, {
1243
+ "name": "param",
1244
+ "text": "detail - Detalhes do evento, contendo a linha clicada."
1245
+ }],
1246
+ "text": "Emitido ao realizar um duplo clique em uma linha da grade."
1188
1247
  },
1189
1248
  "complexType": {
1190
1249
  "original": "any",
@@ -1198,8 +1257,11 @@ export class SnkGrid {
1198
1257
  "cancelable": true,
1199
1258
  "composed": true,
1200
1259
  "docs": {
1201
- "tags": [],
1202
- "text": "Emitido quando o componente estiver completamente carregado."
1260
+ "tags": [{
1261
+ "name": "deprecated",
1262
+ "text": "Esta propriedade foi descontinuada. Ela n\u00E3o tem mais efeito sobre o componente."
1263
+ }],
1264
+ "text": ""
1203
1265
  },
1204
1266
  "complexType": {
1205
1267
  "original": "void",
@@ -1218,8 +1280,11 @@ export class SnkGrid {
1218
1280
  "return": "Promise<void>"
1219
1281
  },
1220
1282
  "docs": {
1221
- "text": "",
1222
- "tags": []
1283
+ "text": "Recarrega a configura\u00E7\u00E3o da grade.",
1284
+ "tags": [{
1285
+ "name": "description",
1286
+ "text": "Este m\u00E9todo for\u00E7a o recarregamento da configura\u00E7\u00E3o da grade a partir do `ConfigStorage`. A opera\u00E7\u00E3o \u00E9 ass\u00EDncrona, mas o m\u00E9todo n\u00E3o aguarda sua conclus\u00E3o."
1287
+ }]
1223
1288
  }
1224
1289
  },
1225
1290
  "showConfig": {
@@ -1235,7 +1300,16 @@ export class SnkGrid {
1235
1300
  },
1236
1301
  "docs": {
1237
1302
  "text": "Exibe a janela de configura\u00E7\u00F5es da grade.",
1238
- "tags": []
1303
+ "tags": [{
1304
+ "name": "async",
1305
+ "text": undefined
1306
+ }, {
1307
+ "name": "description",
1308
+ "text": "Este m\u00E9todo abre o pop-up de configura\u00E7\u00E3o de colunas da grade, permitindo ao usu\u00E1rio ajustar a visibilidade, ordem e largura das colunas."
1309
+ }, {
1310
+ "name": "returns",
1311
+ "text": "Uma promessa que \u00E9 resolvida quando a janela de configura\u00E7\u00E3o \u00E9 exibida."
1312
+ }]
1239
1313
  }
1240
1314
  },
1241
1315
  "hideConfig": {
@@ -1251,15 +1325,27 @@ export class SnkGrid {
1251
1325
  },
1252
1326
  "docs": {
1253
1327
  "text": "Fecha a janela de configura\u00E7\u00F5es da grade.",
1254
- "tags": []
1328
+ "tags": [{
1329
+ "name": "async",
1330
+ "text": undefined
1331
+ }, {
1332
+ "name": "description",
1333
+ "text": "Este m\u00E9todo fecha o pop-up de configura\u00E7\u00E3o de colunas da grade."
1334
+ }, {
1335
+ "name": "returns",
1336
+ "text": "Uma promessa que \u00E9 resolvida quando a janela de configura\u00E7\u00E3o \u00E9 fechada."
1337
+ }]
1255
1338
  }
1256
1339
  },
1257
1340
  "setConfig": {
1258
1341
  "complexType": {
1259
1342
  "signature": "(config: IGridConfig) => Promise<void>",
1260
1343
  "parameters": [{
1261
- "tags": [],
1262
- "text": ""
1344
+ "tags": [{
1345
+ "name": "param",
1346
+ "text": "config O objeto de configura\u00E7\u00E3o a ser aplicado na grade."
1347
+ }],
1348
+ "text": "O objeto de configura\u00E7\u00E3o a ser aplicado na grade."
1263
1349
  }],
1264
1350
  "references": {
1265
1351
  "Promise": {
@@ -1273,8 +1359,20 @@ export class SnkGrid {
1273
1359
  "return": "Promise<void>"
1274
1360
  },
1275
1361
  "docs": {
1276
- "text": "Atribui o valor da configura\u00E7\u00E3o da grade.",
1277
- "tags": []
1362
+ "text": "Define a configura\u00E7\u00E3o da grade.",
1363
+ "tags": [{
1364
+ "name": "async",
1365
+ "text": undefined
1366
+ }, {
1367
+ "name": "description",
1368
+ "text": "Aplica uma nova configura\u00E7\u00E3o de colunas e ordena\u00E7\u00E3o \u00E0 grade."
1369
+ }, {
1370
+ "name": "param",
1371
+ "text": "config O objeto de configura\u00E7\u00E3o a ser aplicado na grade."
1372
+ }, {
1373
+ "name": "returns",
1374
+ "text": "Uma promessa que \u00E9 resolvida quando a configura\u00E7\u00E3o \u00E9 aplicada."
1375
+ }]
1278
1376
  }
1279
1377
  },
1280
1378
  "reloadFilterBar": {
@@ -1289,8 +1387,17 @@ export class SnkGrid {
1289
1387
  "return": "Promise<void>"
1290
1388
  },
1291
1389
  "docs": {
1292
- "text": "Faz o recarregamento da filter-bar da grade buscando o state no servidor.",
1293
- "tags": []
1390
+ "text": "Recarrega a barra de filtros da grade, buscando o estado do servidor.",
1391
+ "tags": [{
1392
+ "name": "async",
1393
+ "text": undefined
1394
+ }, {
1395
+ "name": "description",
1396
+ "text": "For\u00E7a o recarregamento da barra de filtros, atualizando suas configura\u00E7\u00F5es e filtros a partir do servidor."
1397
+ }, {
1398
+ "name": "returns",
1399
+ "text": "Uma promessa que \u00E9 resolvida quando a barra de filtros \u00E9 recarregada."
1400
+ }]
1294
1401
  }
1295
1402
  },
1296
1403
  "getFilterBar": {
@@ -1308,22 +1415,40 @@ export class SnkGrid {
1308
1415
  "return": "Promise<HTMLSnkFilterBarElement>"
1309
1416
  },
1310
1417
  "docs": {
1311
- "text": "Retorna o elemento da filter-bar da grade.",
1312
- "tags": []
1418
+ "text": "Retorna o elemento da barra de filtros da grade.",
1419
+ "tags": [{
1420
+ "name": "async",
1421
+ "text": undefined
1422
+ }, {
1423
+ "name": "description",
1424
+ "text": "Este m\u00E9todo permite acessar o elemento da barra de filtros, que pode ser \u00FAtil para manipula\u00E7\u00F5es adicionais ou para obter o estado atual dos filtros aplicados."
1425
+ }, {
1426
+ "name": "returns",
1427
+ "text": "O elemento da barra de filtros."
1428
+ }]
1313
1429
  }
1314
1430
  },
1315
1431
  "addCustomEditor": {
1316
1432
  "complexType": {
1317
1433
  "signature": "(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>",
1318
1434
  "parameters": [{
1319
- "tags": [],
1320
- "text": ""
1435
+ "tags": [{
1436
+ "name": "param",
1437
+ "text": "fieldName O nome do campo que receber\u00E1 o editor customizado."
1438
+ }],
1439
+ "text": "O nome do campo que receber\u00E1 o editor customizado."
1321
1440
  }, {
1322
- "tags": [],
1323
- "text": ""
1441
+ "tags": [{
1442
+ "name": "param",
1443
+ "text": "customEditor A inst\u00E2ncia do editor customizado."
1444
+ }],
1445
+ "text": "A inst\u00E2ncia do editor customizado."
1324
1446
  }, {
1325
- "tags": [],
1326
- "text": ""
1447
+ "tags": [{
1448
+ "name": "param",
1449
+ "text": "detailContext O contexto de detalhe onde o editor ser\u00E1 aplicado (opcional)."
1450
+ }],
1451
+ "text": "O contexto de detalhe onde o editor ser\u00E1 aplicado (opcional)."
1327
1452
  }],
1328
1453
  "references": {
1329
1454
  "Promise": {
@@ -1337,22 +1462,49 @@ export class SnkGrid {
1337
1462
  "return": "Promise<void>"
1338
1463
  },
1339
1464
  "docs": {
1340
- "text": "Registra um editor customizado para campos da grade e formul\u00E1rio",
1341
- "tags": []
1465
+ "text": "Registra um editor customizado para um campo da grade ou formul\u00E1rio.",
1466
+ "tags": [{
1467
+ "name": "async",
1468
+ "text": undefined
1469
+ }, {
1470
+ "name": "description",
1471
+ "text": "Adiciona um componente de edi\u00E7\u00E3o personalizado para um campo espec\u00EDfico. Este editor ser\u00E1 usado tanto na edi\u00E7\u00E3o em linha na grade quanto em formul\u00E1rios de detalhe."
1472
+ }, {
1473
+ "name": "param",
1474
+ "text": "fieldName O nome do campo que receber\u00E1 o editor customizado."
1475
+ }, {
1476
+ "name": "param",
1477
+ "text": "customEditor A inst\u00E2ncia do editor customizado."
1478
+ }, {
1479
+ "name": "param",
1480
+ "text": "detailContext O contexto de detalhe onde o editor ser\u00E1 aplicado (opcional)."
1481
+ }, {
1482
+ "name": "returns",
1483
+ "text": "Uma promessa que \u00E9 resolvida quando o editor \u00E9 registrado."
1484
+ }]
1342
1485
  }
1343
1486
  },
1344
1487
  "addGridCustomRender": {
1345
1488
  "complexType": {
1346
1489
  "signature": "(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>",
1347
1490
  "parameters": [{
1348
- "tags": [],
1349
- "text": ""
1491
+ "tags": [{
1492
+ "name": "param",
1493
+ "text": "fieldName O nome do campo (coluna) que receber\u00E1 o renderizador customizado."
1494
+ }],
1495
+ "text": "O nome do campo (coluna) que receber\u00E1 o renderizador customizado."
1350
1496
  }, {
1351
- "tags": [],
1352
- "text": ""
1497
+ "tags": [{
1498
+ "name": "param",
1499
+ "text": "customRender A inst\u00E2ncia do renderizador customizado."
1500
+ }],
1501
+ "text": "A inst\u00E2ncia do renderizador customizado."
1353
1502
  }, {
1354
- "tags": [],
1355
- "text": ""
1503
+ "tags": [{
1504
+ "name": "param",
1505
+ "text": "detailContext O contexto de detalhe onde o renderizador ser\u00E1 aplicado (opcional)."
1506
+ }],
1507
+ "text": "O contexto de detalhe onde o renderizador ser\u00E1 aplicado (opcional)."
1356
1508
  }],
1357
1509
  "references": {
1358
1510
  "Promise": {
@@ -1366,19 +1518,43 @@ export class SnkGrid {
1366
1518
  "return": "Promise<void>"
1367
1519
  },
1368
1520
  "docs": {
1369
- "text": "Registra um render customizado para colunas da grid.",
1370
- "tags": []
1521
+ "text": "Registra um renderizador customizado para uma coluna da grade.",
1522
+ "tags": [{
1523
+ "name": "async",
1524
+ "text": undefined
1525
+ }, {
1526
+ "name": "description",
1527
+ "text": "Adiciona um componente de renderiza\u00E7\u00E3o personalizado para uma coluna espec\u00EDfica, permitindo a exibi\u00E7\u00E3o de conte\u00FAdo customizado nas c\u00E9lulas."
1528
+ }, {
1529
+ "name": "param",
1530
+ "text": "fieldName O nome do campo (coluna) que receber\u00E1 o renderizador customizado."
1531
+ }, {
1532
+ "name": "param",
1533
+ "text": "customRender A inst\u00E2ncia do renderizador customizado."
1534
+ }, {
1535
+ "name": "param",
1536
+ "text": "detailContext O contexto de detalhe onde o renderizador ser\u00E1 aplicado (opcional)."
1537
+ }, {
1538
+ "name": "returns",
1539
+ "text": "Uma promessa que \u00E9 resolvida quando o renderizador \u00E9 registrado."
1540
+ }]
1371
1541
  }
1372
1542
  },
1373
1543
  "addCustomValueFormatter": {
1374
1544
  "complexType": {
1375
1545
  "signature": "(columnName: string, customFormatter: ICustomFormatter) => Promise<void>",
1376
1546
  "parameters": [{
1377
- "tags": [],
1378
- "text": ""
1547
+ "tags": [{
1548
+ "name": "param",
1549
+ "text": "columnName O nome da coluna que receber\u00E1 o formatador."
1550
+ }],
1551
+ "text": "O nome da coluna que receber\u00E1 o formatador."
1379
1552
  }, {
1380
- "tags": [],
1381
- "text": ""
1553
+ "tags": [{
1554
+ "name": "param",
1555
+ "text": "customFormatter A inst\u00E2ncia do formatador de valor."
1556
+ }],
1557
+ "text": "A inst\u00E2ncia do formatador de valor."
1382
1558
  }],
1383
1559
  "references": {
1384
1560
  "Promise": {
@@ -1392,16 +1568,34 @@ export class SnkGrid {
1392
1568
  "return": "Promise<void>"
1393
1569
  },
1394
1570
  "docs": {
1395
- "text": "Registra um formatador de valores para uma coluna da grid.",
1396
- "tags": []
1571
+ "text": "Registra um formatador de valor customizado para uma coluna da grade.",
1572
+ "tags": [{
1573
+ "name": "async",
1574
+ "text": undefined
1575
+ }, {
1576
+ "name": "description",
1577
+ "text": "Adiciona uma fun\u00E7\u00E3o de formata\u00E7\u00E3o personalizada para os valores de uma coluna espec\u00EDfica, afetando como os dados s\u00E3o exibidos."
1578
+ }, {
1579
+ "name": "param",
1580
+ "text": "columnName O nome da coluna que receber\u00E1 o formatador."
1581
+ }, {
1582
+ "name": "param",
1583
+ "text": "customFormatter A inst\u00E2ncia do formatador de valor."
1584
+ }, {
1585
+ "name": "returns",
1586
+ "text": "Uma promessa que \u00E9 resolvida quando o formatador \u00E9 registrado."
1587
+ }]
1397
1588
  }
1398
1589
  },
1399
1590
  "removeCustomValueFormatter": {
1400
1591
  "complexType": {
1401
1592
  "signature": "(columnName: string) => Promise<void>",
1402
1593
  "parameters": [{
1403
- "tags": [],
1404
- "text": ""
1594
+ "tags": [{
1595
+ "name": "param",
1596
+ "text": "columnName O nome da coluna da qual o formatador ser\u00E1 removido."
1597
+ }],
1598
+ "text": "O nome da coluna da qual o formatador ser\u00E1 removido."
1405
1599
  }],
1406
1600
  "references": {
1407
1601
  "Promise": {
@@ -1411,8 +1605,20 @@ export class SnkGrid {
1411
1605
  "return": "Promise<void>"
1412
1606
  },
1413
1607
  "docs": {
1414
- "text": "Remove o formatador de valores de uma coluna da grid.",
1415
- "tags": []
1608
+ "text": "Remove um formatador de valor customizado de uma coluna da grade.",
1609
+ "tags": [{
1610
+ "name": "async",
1611
+ "text": undefined
1612
+ }, {
1613
+ "name": "description",
1614
+ "text": "Remove uma fun\u00E7\u00E3o de formata\u00E7\u00E3o personalizada previamente registrada para uma coluna."
1615
+ }, {
1616
+ "name": "param",
1617
+ "text": "columnName O nome da coluna da qual o formatador ser\u00E1 removido."
1618
+ }, {
1619
+ "name": "returns",
1620
+ "text": "Uma promessa que \u00E9 resolvida quando o formatador \u00E9 removido."
1621
+ }]
1416
1622
  }
1417
1623
  },
1418
1624
  "setFocus": {
@@ -1428,7 +1634,16 @@ export class SnkGrid {
1428
1634
  },
1429
1635
  "docs": {
1430
1636
  "text": "Atribui o foco para a grade.",
1431
- "tags": []
1637
+ "tags": [{
1638
+ "name": "async",
1639
+ "text": undefined
1640
+ }, {
1641
+ "name": "description",
1642
+ "text": "Move o foco do navegador para o componente da grade, permitindo a navega\u00E7\u00E3o por teclado."
1643
+ }, {
1644
+ "name": "returns",
1645
+ "text": "Uma promessa que \u00E9 resolvida quando o foco \u00E9 atribu\u00EDdo."
1646
+ }]
1432
1647
  }
1433
1648
  }
1434
1649
  };