@sankhyalabs/sankhyablocks 9.2.0-dev.1 → 9.2.0-dev.11
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/dist/cjs/loader.cjs.js +1 -1
- package/dist/cjs/sankhyablocks.cjs.js +1 -1
- package/dist/cjs/snk-application.cjs.entry.js +6 -4
- package/dist/cjs/snk-data-exporter.cjs.entry.js +1 -1
- package/dist/cjs/{snk-data-unit-448fce74.js → snk-data-unit-72715da9.js} +11 -1
- package/dist/cjs/snk-data-unit.cjs.entry.js +1 -1
- package/dist/cjs/snk-filter-bar_4.cjs.entry.js +22 -15
- package/dist/cjs/snk-form_2.cjs.entry.js +27 -1
- package/dist/cjs/snk-grid.cjs.entry.js +52 -7
- package/dist/collection/components/snk-application/snk-application.js +39 -21
- package/dist/collection/components/snk-data-unit/snk-data-unit.js +173 -28
- package/dist/collection/components/snk-filter-bar/snk-filter-bar.js +187 -63
- package/dist/collection/components/snk-form/snk-form.js +133 -22
- package/dist/collection/components/snk-grid/snk-grid.js +314 -83
- package/dist/collection/components/snk-taskbar/snk-taskbar.js +102 -36
- package/dist/components/snk-application2.js +6 -4
- package/dist/components/snk-data-unit2.js +11 -1
- package/dist/components/snk-filter-bar2.js +22 -15
- package/dist/components/snk-form.js +29 -2
- package/dist/components/snk-grid2.js +53 -7
- package/dist/esm/loader.js +1 -1
- package/dist/esm/sankhyablocks.js +1 -1
- package/dist/esm/snk-application.entry.js +6 -4
- package/dist/esm/snk-data-exporter.entry.js +1 -1
- package/dist/esm/{snk-data-unit-b7e6e7a6.js → snk-data-unit-d31619fb.js} +11 -1
- package/dist/esm/snk-data-unit.entry.js +1 -1
- package/dist/esm/snk-filter-bar_4.entry.js +22 -15
- package/dist/esm/snk-form_2.entry.js +27 -1
- package/dist/esm/snk-grid.entry.js +52 -7
- package/dist/sankhyablocks/p-49436976.entry.js +1 -0
- package/dist/sankhyablocks/p-665dd170.entry.js +11 -0
- package/dist/sankhyablocks/{p-8d1508aa.entry.js → p-69b815ab.entry.js} +1 -1
- package/dist/sankhyablocks/p-6fa3d474.entry.js +1 -0
- package/dist/sankhyablocks/{p-158adf33.entry.js → p-a2e8c7a7.entry.js} +1 -1
- package/dist/sankhyablocks/sankhyablocks.esm.js +1 -1
- package/dist/types/components/snk-application/search-strategy/exec-prepared-search-plus.d.ts +2 -2
- package/dist/types/components/snk-application/snk-application.d.ts +9 -14
- package/dist/types/components/snk-data-unit/snk-data-unit.d.ts +46 -3
- package/dist/types/components/snk-filter-bar/snk-filter-bar.d.ts +44 -28
- package/dist/types/components/snk-form/snk-form.d.ts +29 -4
- package/dist/types/components/snk-grid/snk-grid.d.ts +103 -45
- package/dist/types/components/snk-taskbar/snk-taskbar.d.ts +23 -21
- package/dist/types/components.d.ts +330 -151
- package/package.json +4 -3
- package/dist/collection/lib/licenses/sankhyalicense.module.js +0 -1
- package/dist/sankhyablocks/p-81769310.entry.js +0 -11
- package/dist/sankhyablocks/p-a86eee47.entry.js +0 -1
- package/dist/sankhyablocks/p-fa18530e.entry.js +0 -1
- /package/dist/sankhyablocks/{p-0e495575.js → p-8b601472.js} +0 -0
@@ -9,7 +9,7 @@ import AuthFetcher, { AutorizationType } from "../../lib/http/data-fetcher/fetch
|
|
9
9
|
import DataUnitFetcher from "../../lib/http/data-fetcher/fetchers/data-unit/dataunit-fetcher";
|
10
10
|
import GridConfigFetcher from "../../lib/http/data-fetcher/fetchers/grid-config-fetcher";
|
11
11
|
import ParametersFetcher from "../../lib/http/data-fetcher/fetchers/parameters-fecher";
|
12
|
-
import { IRemoveSearchListener, ISearchListener, PesquisaFetcher
|
12
|
+
import { IRemoveSearchListener, ISearchListener, PesquisaFetcher } from "../../lib/http/data-fetcher/fetchers/pesquisa-fetcher";
|
13
13
|
import { TotalsFetcher } from "../../lib/http/data-fetcher/fetchers/totals-fetcher";
|
14
14
|
import { IClientEventResponse } from "../../lib/http/data-fetcher/interfaces/IClientEventResponse";
|
15
15
|
import { IDataFetcherRecaller } from "../../lib/http/data-fetcher/recaller/IDataFetcherRecaller";
|
@@ -451,18 +451,23 @@ export declare class SnkApplication {
|
|
451
451
|
/**
|
452
452
|
* Realiza a pesquisa de registros
|
453
453
|
* Ex.: snk-config-options
|
454
|
+
* @param {string} mode - O modo da pesquisa ("ADVANCED" ou outro).
|
455
|
+
* @param {string} argument - O argumento da pesquisa.
|
456
|
+
* @param {any} options - Opções preparadas para a pesquisa.
|
457
|
+
* @returns {Promise<Array<IOption> | IOption>} Uma lista de opções ou uma única opção.
|
458
|
+
* @async
|
454
459
|
*/
|
455
|
-
executePreparedSearchPlus(mode: string, argument: string, options:
|
460
|
+
executePreparedSearchPlus(mode: string, argument: string, options: any): Promise<Array<IOption> | IOption>;
|
456
461
|
/**
|
457
462
|
* Obtém as opções em componentes de pesquisa com base em opções preparadas.
|
458
463
|
* Ex.: snk-config-options
|
459
464
|
* @param {string} mode - O modo da pesquisa ("ADVANCED" ou outro).
|
460
465
|
* @param {string} argument - O argumento da pesquisa.
|
461
|
-
* @param {
|
466
|
+
* @param {any} options - Opções preparadas para a pesquisa.
|
462
467
|
* @returns {Promise<Array<IOption> | IOption>} Uma lista de opções ou uma única opção.
|
463
468
|
* @async
|
464
469
|
*/
|
465
|
-
executePreparedSearch(mode: string, argument: string, options:
|
470
|
+
executePreparedSearch(mode: string, argument: string, options: any): Promise<Array<IOption> | IOption>;
|
466
471
|
/**
|
467
472
|
* Obtém `true` caso a tela esteja em modo de debug.
|
468
473
|
*/
|
@@ -590,16 +595,6 @@ declare class PendingPromise {
|
|
590
595
|
reject: Function;
|
591
596
|
constructor(resolve: Function, reject: Function);
|
592
597
|
}
|
593
|
-
export interface IPreparedSearchOptions {
|
594
|
-
entity: string;
|
595
|
-
entityDescription?: string;
|
596
|
-
criteria?: SearchCriteria;
|
597
|
-
searchOptions?: SearchOptions;
|
598
|
-
isHierarchyEntity?: boolean;
|
599
|
-
allowsNonAnalytic?: boolean;
|
600
|
-
useSearchPlus?: boolean;
|
601
|
-
[key: string]: any;
|
602
|
-
}
|
603
598
|
export interface ISearchCtxOptions {
|
604
599
|
allowsNonAnalytic?: boolean;
|
605
600
|
useSearchPlus?: boolean;
|
@@ -21,57 +21,73 @@ export declare class SnkDataUnit implements DUActionInterceptor {
|
|
21
21
|
fieldsToLink: Array<string>;
|
22
22
|
/**
|
23
23
|
* Controla o estado atual dos dados.
|
24
|
+
* @type {DataState}
|
24
25
|
*/
|
25
26
|
dataState: DataState;
|
26
27
|
/**
|
27
28
|
* Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
|
29
|
+
* @type {SnkMessageBuilder}
|
28
30
|
*/
|
29
31
|
messagesBuilder: SnkMessageBuilder;
|
30
32
|
/**
|
31
33
|
* Usado para criar o dataUnit uma única vez.
|
32
34
|
* Se omitido, será usado o próprio nome da entidade.
|
35
|
+
* @type {string}
|
33
36
|
*/
|
34
37
|
dataUnitName: string;
|
35
38
|
/**
|
36
39
|
* Determina qual a entidade que representa os dados em questão.
|
40
|
+
* @type {string}
|
37
41
|
*/
|
38
42
|
entityName: string;
|
39
43
|
/**
|
40
44
|
* Determina quantas linhas são retornadas por página.
|
45
|
+
* @type {number}
|
46
|
+
* @default 150
|
41
47
|
*/
|
42
48
|
pageSize: number;
|
43
49
|
/**
|
44
50
|
* Uma vez instanciado, pode-se obter o dataUnit por esta propriedade.
|
51
|
+
* @type {DataUnit}
|
45
52
|
*/
|
46
53
|
dataUnit: DataUnit;
|
47
54
|
/**
|
48
55
|
* Executado imediatamente antes da ação de salvar as alterações. Útil no caso de validações por exemplo.
|
49
56
|
* Caso retorne "false" (ou a promessa se resolva como false), cancela a ação.
|
57
|
+
* @param {DataUnit} dataUnit - A instância do DataUnit.
|
58
|
+
* @returns {boolean | Promise<boolean>} `false` para cancelar a ação, `true` para continuar.
|
50
59
|
*/
|
51
60
|
beforeSave: (dataUnit: DataUnit) => boolean | Promise<boolean>;
|
52
61
|
/**
|
53
62
|
* Executado após a ação de salvar.
|
63
|
+
* @param {DataUnit} dataUnit - A instância do DataUnit.
|
64
|
+
* @returns {void}
|
54
65
|
*/
|
55
66
|
afterSave: (dataUnit: DataUnit) => void;
|
56
67
|
/**
|
57
68
|
* Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição.
|
58
|
-
*
|
69
|
+
* @type {boolean}
|
70
|
+
* @default true
|
59
71
|
*/
|
60
72
|
useCancelConfirm: boolean;
|
61
73
|
/**
|
62
74
|
* Responsável por evitar a mensagem de sucesso ao salvar.
|
75
|
+
* @type {boolean}
|
63
76
|
*/
|
64
77
|
ignoreSaveMessage: boolean;
|
65
78
|
/**
|
66
79
|
* Usado para obter configuração de metadados.
|
80
|
+
* @type {string}
|
67
81
|
*/
|
68
82
|
configName: string;
|
69
83
|
/**
|
70
84
|
* Identificador de recursos como configurações e acesso.
|
85
|
+
* @type {string}
|
71
86
|
*/
|
72
87
|
resourceID: string;
|
73
88
|
/**
|
74
89
|
* Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
|
90
|
+
* @type {string}
|
75
91
|
*/
|
76
92
|
domainMessagesBuilder: string;
|
77
93
|
observePageSize(): void;
|
@@ -82,48 +98,75 @@ export declare class SnkDataUnit implements DUActionInterceptor {
|
|
82
98
|
observeMessagesBuilder(newValue: SnkMessageBuilder): void;
|
83
99
|
/**
|
84
100
|
* Emitido quando há qualquer mudança de estado no DataUnit.
|
101
|
+
* @event dataStateChange
|
102
|
+
* @type {CustomEvent<DataState>}
|
103
|
+
* @bubbles false
|
85
104
|
*/
|
86
105
|
dataStateChange: EventEmitter<DataState>;
|
87
106
|
/**
|
88
107
|
* Emitido quando o DataUnit está pronto.
|
108
|
+
* @event dataUnitReady
|
109
|
+
* @type {CustomEvent<DataUnit>}
|
110
|
+
* @bubbles false
|
89
111
|
*/
|
90
112
|
dataUnitReady: EventEmitter<DataUnit>;
|
91
113
|
/**
|
92
|
-
* Emitido quando o
|
114
|
+
* Emitido quando o messagesBuilder é atualizado.
|
115
|
+
* @event messagesBuilderUpdated
|
116
|
+
* @type {CustomEvent<SnkMessageBuilder>}
|
117
|
+
* @bubbles false
|
93
118
|
*/
|
94
119
|
messagesBuilderUpdated: EventEmitter<SnkMessageBuilder>;
|
95
120
|
/**
|
96
121
|
* Emitido quando há campos no DataUnit que devem ser ocultados.
|
122
|
+
* @event dataUnitFieldsHidded
|
123
|
+
* @type {CustomEvent<void>}
|
97
124
|
*/
|
98
125
|
dataUnitFieldsHidded: EventEmitter<void>;
|
99
126
|
/**
|
100
127
|
* Emitido quando um registro é adicionado ou copiado.
|
128
|
+
* @event insertionMode
|
129
|
+
* @type {CustomEvent<void>}
|
130
|
+
* @bubbles false
|
101
131
|
*/
|
102
132
|
insertionMode: EventEmitter<void>;
|
103
133
|
/**
|
104
134
|
* Emitido quando se cancela uma inserção ou cópia.
|
135
|
+
* @event cancelEdition
|
136
|
+
* @type {CustomEvent<void>}
|
137
|
+
* @bubbles false
|
105
138
|
*/
|
106
139
|
cancelEdition: EventEmitter<void>;
|
107
140
|
onMasterFormConfigChange({ detail }: CustomEvent): void;
|
108
141
|
/**
|
109
142
|
* Obtém o dataUnit.
|
143
|
+
* @returns {Promise<DataUnit>} Uma promessa que resolve com a instância do DataUnit.
|
144
|
+
* @async
|
110
145
|
*/
|
111
146
|
getDataUnit(): Promise<DataUnit>;
|
112
147
|
/**
|
113
148
|
* Método que retorna a lista de IDs dos registros selecionados.
|
114
|
-
* @returns Retorna a lista de IDs dos registros selecionados.
|
149
|
+
* @returns {Promise<Array<IRecordID>>} Retorna uma promessa que resolve com a lista de IDs dos registros selecionados.
|
150
|
+
* @async
|
115
151
|
*/
|
116
152
|
getSelectedRecordsIDsInfo(): Promise<Array<IRecordID>>;
|
117
153
|
/**
|
118
154
|
* Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
|
155
|
+
* @returns {Promise<string[]>} Uma promessa que resolve com um array de nomes de campos.
|
156
|
+
* @async
|
119
157
|
*/
|
120
158
|
getFieldsWithRmp(): Promise<string[]>;
|
121
159
|
/**
|
122
160
|
* Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision).
|
161
|
+
* @returns {Promise<string[]>} Uma promessa que resolve com um array de nomes de campos.
|
162
|
+
* @async
|
123
163
|
*/
|
124
164
|
getFieldsWithRmPrecision(): Promise<string[]>;
|
125
165
|
/**
|
126
166
|
* Busca os metadados da linha selecionada.
|
167
|
+
* @param {Record | string} [record] - O registro ou ID do registro para o qual buscar os metadados. Se omitido, usa o registro selecionado.
|
168
|
+
* @returns {Promise<RowMetadata>} Uma promessa que resolve com os metadados da linha.
|
169
|
+
* @async
|
127
170
|
*/
|
128
171
|
getRowMetadata(record?: Record | string): Promise<RowMetadata>;
|
129
172
|
private doGetRowMetadata;
|
@@ -23,60 +23,69 @@ export declare class SnkFilterBar implements FilterProvider {
|
|
23
23
|
private hasValidValue;
|
24
24
|
_filtersComparator: (a: SnkFilterItemConfig, b: SnkFilterItemConfig) => number;
|
25
25
|
/**
|
26
|
-
* Define se o componente deve usar o LockManager para controle de carregamento
|
26
|
+
* @description Define se o componente deve usar o LockManager para controle de carregamento.
|
27
27
|
*/
|
28
28
|
enableLockManagerLoadingComp?: boolean;
|
29
29
|
/**
|
30
|
-
* Loader customizado para carregar as configurações
|
30
|
+
* @description Loader customizado para carregar as configurações.
|
31
|
+
* @param {string} configName - Nome da configuração.
|
32
|
+
* @param {string} resourceId - ID do recurso.
|
33
|
+
* @param {any} options - Opções adicionais.
|
34
|
+
* @returns {Promise<Array<SnkFilterItemConfig>>} Retorna a configuração dos filtros.
|
31
35
|
*/
|
32
36
|
customFilterBarConfig?: (configName: string, resourceId: string, options: any) => Promise<Array<SnkFilterItemConfig>>;
|
33
37
|
/**
|
34
|
-
* Recebe o DataUnit do ambiente. Se não for informado, procura pela referência
|
38
|
+
* @description Recebe o DataUnit do ambiente. Se não for informado, procura pela referência
|
35
39
|
* do SnkDataUnit. Necessário para se registrar como provedor de filtros.
|
36
40
|
*/
|
37
41
|
dataUnit: DataUnit;
|
38
42
|
/**
|
39
|
-
* Título que será apresentado na barra de filtros
|
43
|
+
* @description Título que será apresentado na barra de filtros.
|
40
44
|
*/
|
41
45
|
title: string;
|
42
46
|
/**
|
43
|
-
* Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade
|
47
|
+
* @description Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade
|
44
48
|
* serve para separar a configuração de cada uma.
|
45
49
|
*/
|
46
50
|
configName: string;
|
47
51
|
/**
|
48
|
-
* Identificador de recursos como configurações e acesso.
|
52
|
+
* @description Identificador de recursos como configurações e acesso.
|
49
53
|
*/
|
50
54
|
resourceID: string;
|
51
55
|
/**
|
52
|
-
* Modo de apresentação da
|
56
|
+
* @description Modo de apresentação da barra de filtros.
|
53
57
|
*/
|
54
58
|
mode: "regular" | "button" | "hidden";
|
55
59
|
/**
|
56
|
-
* Lista todos os filtros disponíveis ao usuário.
|
60
|
+
* @description Lista todos os filtros disponíveis ao usuário.
|
57
61
|
*/
|
58
62
|
filterConfig: Array<SnkFilterItemConfig>;
|
59
63
|
/**
|
60
|
-
* Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
|
64
|
+
* @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
|
61
65
|
*/
|
62
66
|
messagesBuilder: SnkMessageBuilder;
|
63
67
|
/**
|
64
|
-
* Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros)
|
68
|
+
* @description Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros)
|
65
69
|
* e no modal lateral de filtros (container de filtros personalizados).
|
66
70
|
*/
|
67
71
|
disablePersonalizedFilter: boolean;
|
68
72
|
/**
|
69
|
-
* Chave da configuração
|
73
|
+
* @description Chave da configuração legada da barra de filtros.
|
70
74
|
*/
|
71
75
|
filterBarLegacyConfigName: string;
|
72
76
|
/**
|
73
|
-
* Define se a carga dos dados será feita assim que o componente for carregado.
|
77
|
+
* @description Define se a carga dos dados será feita assim que o componente for carregado.
|
74
78
|
*/
|
75
79
|
autoLoad?: boolean;
|
76
80
|
/**
|
77
|
-
* Função chamada depois de aplicar os filtros.
|
81
|
+
* @description Função chamada depois de aplicar os filtros.
|
78
82
|
*/
|
79
83
|
afterApplyConfig?: () => void;
|
84
|
+
/**
|
85
|
+
* @description Evento emitido quando a configuração dos filtros é atualizada.
|
86
|
+
* @param {SnkFilterItemConfig[]} configs - Lista de configurações de filtros atualizadas.
|
87
|
+
* @event
|
88
|
+
*/
|
80
89
|
configUpdated: EventEmitter<SnkFilterItemConfig[]>;
|
81
90
|
allowDefault: boolean;
|
82
91
|
scrollerLocked: boolean;
|
@@ -85,31 +94,37 @@ export declare class SnkFilterBar implements FilterProvider {
|
|
85
94
|
observeFilterConfig(newValue: Array<SnkFilterItemConfig>, oldValue: Array<SnkFilterItemConfig>): void;
|
86
95
|
private handleFilterConfigsChanged;
|
87
96
|
/**
|
88
|
-
* Faz o recarregamento da
|
97
|
+
* @description Faz o recarregamento da barra de filtros buscando o state no servidor.
|
98
|
+
* @async
|
99
|
+
* @return {Promise<void>} Retorna uma Promise que resolve quando o recarregamento for concluído.
|
89
100
|
*/
|
90
101
|
reload(): Promise<void>;
|
91
102
|
/**
|
92
|
-
* Retorna um item de filtro pelo ID.
|
103
|
+
* @description Retorna um item de filtro pelo ID.
|
104
|
+
* @async
|
105
|
+
* @param {string} id - ID do item de filtro.
|
106
|
+
* @returns {Promise<SnkFilterItemConfig | undefined>} O item de filtro correspondente ou undefined se não for encontrado.
|
93
107
|
*/
|
94
108
|
getFilterItem(id: string): Promise<SnkFilterItemConfig | undefined>;
|
95
109
|
/**
|
96
|
-
* Atualiza um item do filtro.
|
97
|
-
*
|
98
|
-
* @param
|
110
|
+
* @description Atualiza um item do filtro.
|
111
|
+
* @async
|
112
|
+
* @param {SnkFilterItemConfig} newFilterItem - Item com as informações atualizadas, caso o item não seja encontrado no array, ele não será modificado.
|
113
|
+
* @return {Promise<void>} Retorna uma Promise que resolve quando a atualização for concluída.
|
99
114
|
*/
|
100
115
|
updateFilterItem(newFilterItem: SnkFilterItemConfig): Promise<void>;
|
101
116
|
/**
|
102
|
-
* Adiciona um item de filtro.
|
103
|
-
*
|
104
|
-
* @param filterItem - Item a ser adicionado, caso o item já exista com o ID ele não será adicionado novamente
|
117
|
+
* @description Adiciona um item de filtro.
|
118
|
+
* @async
|
119
|
+
* @param {SnkFilterItemConfig} filterItem - Item a ser adicionado, caso o item já exista com o ID, ele não será adicionado novamente.
|
120
|
+
* @return {Promise<void>} Retorna uma Promise que resolve quando o item for adicionado.
|
105
121
|
*/
|
106
122
|
addFilterItem(filterItem: SnkFilterItemConfig): Promise<void>;
|
107
123
|
/**
|
108
|
-
* Remove um item de filtro.
|
109
|
-
*
|
110
|
-
* @param filterID - ID do a ser
|
111
|
-
*
|
112
|
-
* @returns {Promise<SnkFilterItemConfig|undefined>} - Retorna o item de filtro removido, ou undefined caso não encontrado.
|
124
|
+
* @description Remove um item de filtro.
|
125
|
+
* @async
|
126
|
+
* @param {string} filterID - ID do item a ser removido.
|
127
|
+
* @returns {Promise<SnkFilterItemConfig|undefined>} Retorna o item de filtro removido, ou undefined caso não seja encontrado.
|
113
128
|
*/
|
114
129
|
removeFilterItem(filterID: string): Promise<SnkFilterItemConfig | undefined>;
|
115
130
|
componentDidLoad(): void;
|
@@ -119,7 +134,7 @@ export declare class SnkFilterBar implements FilterProvider {
|
|
119
134
|
private doLoadData;
|
120
135
|
/**
|
121
136
|
* Conforme mecanismo de mensagens, é possível customizar as mensagens dos blocos de construção
|
122
|
-
* através de um pequeno
|
137
|
+
* através de um pequeno módulo na estrutura da aplicação:
|
123
138
|
* - Criar um arquivo no seguinte caminho: /messages/appmessages.msg.js.
|
124
139
|
* Para conhecer os detalhes do módulo, vide o arquivo neste projeto "/src/lib/message/resources/snk-filter-bar.msg.ts"
|
125
140
|
*/
|
@@ -144,7 +159,8 @@ export declare class SnkFilterBar implements FilterProvider {
|
|
144
159
|
*/
|
145
160
|
filterChangeListener(evt: CustomEvent): void;
|
146
161
|
/**
|
147
|
-
* Abre o modal de filtros
|
162
|
+
* @description Abre o modal de filtros.
|
163
|
+
* @async
|
148
164
|
*/
|
149
165
|
showFilterModal(): Promise<void>;
|
150
166
|
addPersonalizedFilter(isDefault?: boolean): void;
|
@@ -27,7 +27,7 @@ export declare class SnkForm {
|
|
27
27
|
*/
|
28
28
|
messagesBuilder: SnkMessageBuilder;
|
29
29
|
/**
|
30
|
-
* Chave da configuração
|
30
|
+
* Chave da configuração legada do formulário.
|
31
31
|
*/
|
32
32
|
formLegacyConfigName: string;
|
33
33
|
/**
|
@@ -35,33 +35,58 @@ export declare class SnkForm {
|
|
35
35
|
*/
|
36
36
|
resourceID: string;
|
37
37
|
/**
|
38
|
-
*
|
38
|
+
* @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
|
39
39
|
*/
|
40
40
|
exit: EventEmitter<void>;
|
41
41
|
/**
|
42
|
-
*
|
42
|
+
* @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
|
43
43
|
*/
|
44
44
|
actionClick: EventEmitter<string>;
|
45
45
|
/**
|
46
46
|
* Responsável por notificar quando ocorrer a renderização de itens do formulário.
|
47
|
+
* OBS: Emitido no subcomponente snk-form-view
|
47
48
|
*/
|
48
49
|
formItemsReady: EventEmitter<Array<HTMLElement>>;
|
49
50
|
/**
|
50
51
|
* Exibe a janela de configurações do formulário.
|
52
|
+
* @async
|
53
|
+
* @returns {Promise<void>}
|
51
54
|
*/
|
52
55
|
showConfig(): Promise<void>;
|
53
56
|
/**
|
54
57
|
* Fecha a janela de configurações do formulário.
|
58
|
+
* @async
|
59
|
+
* @returns {Promise<void>}
|
55
60
|
*/
|
56
61
|
hideConfig(): Promise<void>;
|
57
62
|
/**
|
58
|
-
* Registra um editor customizado para campos
|
63
|
+
* Registra um editor customizado para campos do formulário.
|
64
|
+
* @async
|
65
|
+
* @param {string} fieldName - Nome do campo.
|
66
|
+
* @param {ICustomEditor} customEditor - Editor customizado.
|
67
|
+
* @returns {Promise<void>}
|
59
68
|
*/
|
60
69
|
addCustomEditor(fieldName: string, customEditor: ICustomEditor): Promise<void>;
|
61
70
|
/**
|
62
71
|
* Altera/adiciona uma propriedade nos metadados do campo.
|
72
|
+
* @async
|
73
|
+
* @param {string} fieldName - Nome do campo.
|
74
|
+
* @param {string} propName - Nome da propriedade.
|
75
|
+
* @param {any} value - Valor da propriedade.
|
76
|
+
* @returns {Promise<void>}
|
63
77
|
*/
|
64
78
|
setFieldProp(fieldName: string, propName: string, value: any): Promise<void>;
|
79
|
+
/**
|
80
|
+
* Valida o formulário.
|
81
|
+
* @async
|
82
|
+
* @returns {Promise<void>}
|
83
|
+
* @description
|
84
|
+
* Este método executa a validação do formulário, verificando se todos os campos estão
|
85
|
+
* preenchidos corretamente de acordo com as regras definidas.
|
86
|
+
* Se a validação falhar, uma exceção será lançada com os detalhes dos erros encontrados.
|
87
|
+
* Caso contrário, o método será resolvido sem erros.
|
88
|
+
*/
|
89
|
+
validate(): Promise<void>;
|
65
90
|
private closeConfig;
|
66
91
|
private dataunitReady;
|
67
92
|
private setCustomEditors;
|