@sankhyalabs/sankhyablocks-docs 0.0.0-feat-dev-KB-46477.4 → 0.0.0-feat-dev-KB-45934.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.
- package/components/snk-application/readme.md +2 -2
- package/components/snk-crud/readme.md +0 -30
- package/components/snk-crud/subcomponents/readme.md +0 -10
- package/components/snk-data-unit/readme.md +0 -30
- package/components/snk-form/readme.md +0 -10
- package/components/snk-grid/readme.md +0 -20
- package/components/snk-simple-crud/readme.md +2 -30
- package/package.json +1 -1
|
@@ -106,7 +106,7 @@ Type: `Promise<boolean>`
|
|
|
106
106
|
|
|
107
107
|
|
|
108
108
|
|
|
109
|
-
### `createDataunit(entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string
|
|
109
|
+
### `createDataunit(entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
|
|
110
110
|
|
|
111
111
|
Cria o DataUnit a partir do nome da entidade. É possível armazená-lo no cache
|
|
112
112
|
passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado.
|
|
@@ -231,7 +231,7 @@ Type: `Promise<DataFetcher>`
|
|
|
231
231
|
|
|
232
232
|
DataFetcher do application
|
|
233
233
|
|
|
234
|
-
### `getDataUnit(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string
|
|
234
|
+
### `getDataUnit(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>`
|
|
235
235
|
|
|
236
236
|
Obtem um DataUnit do cache ou cria um caso ainda não tenha sido criado.
|
|
237
237
|
|
|
@@ -39,16 +39,6 @@
|
|
|
39
39
|
|
|
40
40
|
## Methods
|
|
41
41
|
|
|
42
|
-
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
|
43
|
-
|
|
44
|
-
Registra um formatador de valores para uma coluna da grid.
|
|
45
|
-
|
|
46
|
-
#### Returns
|
|
47
|
-
|
|
48
|
-
Type: `Promise<void>`
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
42
|
### `closeConfigurator() => Promise<void>`
|
|
53
43
|
|
|
54
44
|
Usado para fechar o configurator do CRUD
|
|
@@ -99,26 +89,6 @@ Type: `Promise<void>`
|
|
|
99
89
|
|
|
100
90
|
|
|
101
91
|
|
|
102
|
-
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
|
103
|
-
|
|
104
|
-
Remove o formatador de valores de uma coluna da grid.
|
|
105
|
-
|
|
106
|
-
#### Returns
|
|
107
|
-
|
|
108
|
-
Type: `Promise<void>`
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
|
113
|
-
|
|
114
|
-
Altera/adiciona uma propriedade nos metadados do campo.
|
|
115
|
-
|
|
116
|
-
#### Returns
|
|
117
|
-
|
|
118
|
-
Type: `Promise<void>`
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
92
|
|
|
123
93
|
## Dependencies
|
|
124
94
|
|
|
@@ -47,16 +47,6 @@ Type: `Promise<void>`
|
|
|
47
47
|
|
|
48
48
|
|
|
49
49
|
|
|
50
|
-
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
|
51
|
-
|
|
52
|
-
Altera/adiciona uma propriedade nos metadados do campo.
|
|
53
|
-
|
|
54
|
-
#### Returns
|
|
55
|
-
|
|
56
|
-
Type: `Promise<void>`
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
50
|
### `showFormConfig(detail?: boolean) => Promise<void>`
|
|
61
51
|
|
|
62
52
|
Abre o configurador do formulário
|
|
@@ -46,36 +46,6 @@ Type: `Promise<DataUnit>`
|
|
|
46
46
|
|
|
47
47
|
|
|
48
48
|
|
|
49
|
-
### `getFieldsWithRmPrecision() => Promise<string[]>`
|
|
50
|
-
|
|
51
|
-
Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision).
|
|
52
|
-
|
|
53
|
-
#### Returns
|
|
54
|
-
|
|
55
|
-
Type: `Promise<string[]>`
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
### `getFieldsWithRmp() => Promise<string[]>`
|
|
60
|
-
|
|
61
|
-
Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
|
|
62
|
-
|
|
63
|
-
#### Returns
|
|
64
|
-
|
|
65
|
-
Type: `Promise<string[]>`
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
### `getRowMetadata(record?: Record | string) => Promise<RowMetadata>`
|
|
70
|
-
|
|
71
|
-
Busca os metadados da linha selecionada.
|
|
72
|
-
|
|
73
|
-
#### Returns
|
|
74
|
-
|
|
75
|
-
Type: `Promise<RowMetadata>`
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
49
|
### `getSelectedRecordsIDsInfo() => Promise<Array<IRecordID>>`
|
|
80
50
|
|
|
81
51
|
Método que retorna a lista de IDs dos registros selecionados.
|
|
@@ -37,16 +37,6 @@ Type: `Promise<void>`
|
|
|
37
37
|
|
|
38
38
|
|
|
39
39
|
|
|
40
|
-
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
|
41
|
-
|
|
42
|
-
Altera/adiciona uma propriedade nos metadados do campo.
|
|
43
|
-
|
|
44
|
-
#### Returns
|
|
45
|
-
|
|
46
|
-
Type: `Promise<void>`
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
40
|
### `showConfig() => Promise<void>`
|
|
51
41
|
|
|
52
42
|
Exibe a janela de configurações do formulário.
|
|
@@ -42,16 +42,6 @@
|
|
|
42
42
|
|
|
43
43
|
## Methods
|
|
44
44
|
|
|
45
|
-
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
|
46
|
-
|
|
47
|
-
Registra um formatador de valores para uma coluna da grid.
|
|
48
|
-
|
|
49
|
-
#### Returns
|
|
50
|
-
|
|
51
|
-
Type: `Promise<void>`
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
45
|
### `findColumn() => Promise<void>`
|
|
56
46
|
|
|
57
47
|
Abre o localizador de colunas
|
|
@@ -92,16 +82,6 @@ Type: `Promise<void>`
|
|
|
92
82
|
|
|
93
83
|
|
|
94
84
|
|
|
95
|
-
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
|
96
|
-
|
|
97
|
-
Remove o formatador de valores de uma coluna da grid.
|
|
98
|
-
|
|
99
|
-
#### Returns
|
|
100
|
-
|
|
101
|
-
Type: `Promise<void>`
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
85
|
### `setConfig(config: IGridConfig) => Promise<void>`
|
|
106
86
|
|
|
107
87
|
Atribui o valor da configuração da grade.
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| `configName` | `config-name` | Usado para salvar as configurações dos blocos de construção. | `string` | `undefined` |
|
|
14
14
|
| `dataState` | -- | | `DataState` | `undefined` |
|
|
15
15
|
| `dataUnit` | -- | | `DataUnit` | `undefined` |
|
|
16
|
+
| `entityName` | `entity-name` | Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD | `string` | `undefined` |
|
|
16
17
|
| `formConfig` | -- | | `IFormConfig` | `undefined` |
|
|
17
18
|
| `formLegacyConfigName` | `form-legacy-config-name` | Chave da configuração legado do formulário. | `string` | `undefined` |
|
|
18
19
|
| `gridConfig` | -- | | `IGridConfig` | `undefined` |
|
|
@@ -21,6 +22,7 @@
|
|
|
21
22
|
| `messagesBuilder` | -- | Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. | `SnkMessageBuilder` | `undefined` |
|
|
22
23
|
| `mode` | `mode` | | `SIMPLE_CRUD_MODE.IN_MEMORY \| SIMPLE_CRUD_MODE.SERVER` | `SIMPLE_CRUD_MODE.SERVER` |
|
|
23
24
|
| `multipleSelection` | `multiple-selection` | Determina se pode haver mais de uma linha selecionada na grade. | `boolean` | `undefined` |
|
|
25
|
+
| `pageSize` | `page-size` | Determina quantas linhas são retornadas por página. | `number` | `150` |
|
|
24
26
|
| `resourceID` | `resource-i-d` | Identificador de recursos como configurações e acesso. | `string` | `undefined` |
|
|
25
27
|
| `showConfiguratorButtons` | `show-configurator-buttons` | Usado para exibir os botões de ação do snk-configurator. | `boolean` | `undefined` |
|
|
26
28
|
| `taskbarManager` | -- | Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. | `TaskbarManager` | `undefined` |
|
|
@@ -42,16 +44,6 @@
|
|
|
42
44
|
|
|
43
45
|
## Methods
|
|
44
46
|
|
|
45
|
-
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
|
46
|
-
|
|
47
|
-
Registra um formatador de valores para uma coluna da grid.
|
|
48
|
-
|
|
49
|
-
#### Returns
|
|
50
|
-
|
|
51
|
-
Type: `Promise<void>`
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
47
|
### `closeConfigurator() => Promise<void>`
|
|
56
48
|
|
|
57
49
|
Usado para fechar o configurator do CRUD
|
|
@@ -92,26 +84,6 @@ Type: `Promise<void>`
|
|
|
92
84
|
|
|
93
85
|
|
|
94
86
|
|
|
95
|
-
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
|
96
|
-
|
|
97
|
-
Remove o formatador de valores de uma coluna da grid.
|
|
98
|
-
|
|
99
|
-
#### Returns
|
|
100
|
-
|
|
101
|
-
Type: `Promise<void>`
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
|
106
|
-
|
|
107
|
-
Altera/adiciona uma propriedade nos metadados do campo.
|
|
108
|
-
|
|
109
|
-
#### Returns
|
|
110
|
-
|
|
111
|
-
Type: `Promise<void>`
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
87
|
### `setMetadata(metadata: UnitMetadata) => Promise<void>`
|
|
116
88
|
|
|
117
89
|
|