@sankhyalabs/ezui-docs 5.21.0-dev.4 → 5.21.0-dev.40
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/ez-chart/readme.md +32 -0
- package/components/ez-form/readme.md +28 -6
- package/components/ez-form-view/custom-input/readme.md +68 -0
- package/components/ez-form-view/readme.md +26 -3
- package/components/ez-grid/readme.md +71 -0
- package/components/ez-list/readme.md +1 -0
- package/package.json +1 -1
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# ez-chart
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| --------------- | ----------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
|
|
12
|
+
| `chartSubTitle` | `chart-sub-title` | Define o sub titulo a ser apresentado no gráfico | `string` | `""` |
|
|
13
|
+
| `chartTitle` | `chart-title` | Define o titulo a ser apresentado no gráfico | `string` | `""` |
|
|
14
|
+
| `height` | `height` | Define a altura do gráfico | `number` | `undefined` |
|
|
15
|
+
| `legendEnabled` | `legend-enabled` | Define se a legenda do gráfico deve ser apresentada ou não. | `boolean` | `true` |
|
|
16
|
+
| `series` | -- | Define as series a serem apresentadas no gráfico | `ChartSerie[] \| ({ data: (number \| ChartSerieData)[]; name?: string; color?: string; type?: "line" \| "column" \| "bar"; yAxis?: number; toolTipFormatter?: (serieName: string, xAxis: string \| number, yAxis: number, dataName: string, percentage: number) => string; showDataLabel?: boolean; })` | `undefined` |
|
|
17
|
+
| `type` | `type` | Define o tipo de gráfico apresentado pelo componente | `ChartType.BAR \| ChartType.COLUMN \| ChartType.DONUT \| ChartType.LINE \| ChartType.PIE` | `ChartType.LINE` |
|
|
18
|
+
| `width` | `width` | Define uma largura do gráfico | `number` | `undefined` |
|
|
19
|
+
| `xAxis` | -- | Definições do eixo X do gráfico | `ChartAxis[] \| ({ color?: string; categories?: string[]; formatter?: (value: string \| number) => string; text?: string; invertedPosition?: boolean; })` | `undefined` |
|
|
20
|
+
| `yAxis` | -- | Definições do eixo Y do gráfico | `ChartAxis[] \| ({ color?: string; categories?: string[]; formatter?: (value: string \| number) => string; text?: string; invertedPosition?: boolean; })` | `undefined` |
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
## Events
|
|
24
|
+
|
|
25
|
+
| Event | Description | Type |
|
|
26
|
+
| -------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
|
27
|
+
| `ezSerieClick` | Evento emitido quando ocorre um click em uma serie do gráfico | `CustomEvent<{ name: string; data: number[]; type: string; yAxis: number; }>` |
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
----------------------------------------------
|
|
31
|
+
|
|
32
|
+
|
|
@@ -7,12 +7,13 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property | Attribute
|
|
11
|
-
| ------------------ |
|
|
12
|
-
| `config` | --
|
|
13
|
-
| `dataUnit` | --
|
|
14
|
-
| `fieldToFocus` | `field-to-focus`
|
|
15
|
-
| `
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ------------------ | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
|
|
12
|
+
| `config` | -- | Configuração do formulário. | `IFormConfig` | `undefined` |
|
|
13
|
+
| `dataUnit` | -- | Unidade de dados. Responsável pelo controle de edição de registros e informações pertinentes aos campos. | `DataUnit` | `undefined` |
|
|
14
|
+
| `fieldToFocus` | `field-to-focus` | Determina o campo que deve ficar em evidência. | `string` | `undefined` |
|
|
15
|
+
| `onlyStaticFields` | `only-static-fields` | Define se os campos que serão apresentados são todos estáticos. Quando verdadeira, ocorrerá no DataBinder o bind dos campos com o DataUnit. | `boolean` | `false` |
|
|
16
|
+
| `recordsValidator` | -- | Define um validador responsável pela integridade dos registros. | `IRecordValidator` | `undefined` |
|
|
16
17
|
|
|
17
18
|
|
|
18
19
|
## Events
|
|
@@ -27,6 +28,26 @@
|
|
|
27
28
|
|
|
28
29
|
## Methods
|
|
29
30
|
|
|
31
|
+
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
|
|
32
|
+
|
|
33
|
+
Registra um editor customizado para campos da grade e formulário.
|
|
34
|
+
|
|
35
|
+
#### Returns
|
|
36
|
+
|
|
37
|
+
Type: `Promise<void>`
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
|
42
|
+
|
|
43
|
+
Altera/adiciona uma propriedade nos metadados do campo.
|
|
44
|
+
|
|
45
|
+
#### Returns
|
|
46
|
+
|
|
47
|
+
Type: `Promise<void>`
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
|
|
30
51
|
### `validate() => Promise<void>`
|
|
31
52
|
|
|
32
53
|
Realiza validação no conteúdo de todos os campos.
|
|
@@ -51,6 +72,7 @@ graph TD;
|
|
|
51
72
|
ez-form --> ez-tabselector
|
|
52
73
|
ez-form --> ez-form-view
|
|
53
74
|
ez-tabselector --> ez-icon
|
|
75
|
+
ez-form-view --> ez-custom-form-input
|
|
54
76
|
ez-form-view --> ez-collapsible-box
|
|
55
77
|
ez-form-view --> ez-check
|
|
56
78
|
ez-form-view --> ez-combo-box
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# ez-custom-form-input
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<!-- Auto Generated Below -->
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ----------------- | ---------------- | ------------------------------------------------------------------------------------- | ---------------------------------------- | ----------- |
|
|
12
|
+
| `builderFallback` | -- | Builder original do FormView que será chamado caso o custom não retorne nenhum valor. | `(field: IFormViewField) => HTMLElement` | `undefined` |
|
|
13
|
+
| `customEditor` | -- | Instância do editor customizado. | `ICustomEditor` | `undefined` |
|
|
14
|
+
| `detailContext` | `detail-context` | Define de qual contexto o editor está sendo acionado. | `string` | `undefined` |
|
|
15
|
+
| `formViewField` | -- | Campo que o elemento customizado representa. | `IFormViewField` | `undefined` |
|
|
16
|
+
| `selectedRecord` | -- | Define os registros da linha selecionada. | `Record` | `undefined` |
|
|
17
|
+
| `value` | `value` | Valores dos campos do formulário. | `any` | `undefined` |
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
## Methods
|
|
21
|
+
|
|
22
|
+
### `isInvalid() => Promise<boolean>`
|
|
23
|
+
|
|
24
|
+
Retorna se o conteúdo é inválido.
|
|
25
|
+
|
|
26
|
+
#### Returns
|
|
27
|
+
|
|
28
|
+
Type: `Promise<boolean>`
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
### `setBlur() => Promise<void>`
|
|
33
|
+
|
|
34
|
+
Remove o foco do campo.
|
|
35
|
+
|
|
36
|
+
#### Returns
|
|
37
|
+
|
|
38
|
+
Type: `Promise<void>`
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
### `setFocus() => Promise<void>`
|
|
43
|
+
|
|
44
|
+
Aplica foco no campo.
|
|
45
|
+
|
|
46
|
+
#### Returns
|
|
47
|
+
|
|
48
|
+
Type: `Promise<void>`
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
## Dependencies
|
|
54
|
+
|
|
55
|
+
### Used by
|
|
56
|
+
|
|
57
|
+
- [ez-form-view](..)
|
|
58
|
+
|
|
59
|
+
### Graph
|
|
60
|
+
```mermaid
|
|
61
|
+
graph TD;
|
|
62
|
+
ez-form-view --> ez-custom-form-input
|
|
63
|
+
style ez-custom-form-input fill:#f9f,stroke:#333,stroke-width:4px
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
----------------------------------------------
|
|
67
|
+
|
|
68
|
+
|
|
@@ -7,9 +7,10 @@
|
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
|
-
| Property
|
|
11
|
-
|
|
|
12
|
-
| `fields`
|
|
10
|
+
| Property | Attribute | Description | Type | Default |
|
|
11
|
+
| ---------------- | --------- | ------------------------------------------------------------------------- | ------------------ | ----------- |
|
|
12
|
+
| `fields` | -- | Define a lista de metadados usada para criar os campos de user interface. | `IFormViewField[]` | `undefined` |
|
|
13
|
+
| `selectedRecord` | -- | Define os registros da linha selecionada. | `Record` | `undefined` |
|
|
13
14
|
|
|
14
15
|
|
|
15
16
|
## Events
|
|
@@ -22,6 +23,26 @@
|
|
|
22
23
|
|
|
23
24
|
## Methods
|
|
24
25
|
|
|
26
|
+
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
|
|
27
|
+
|
|
28
|
+
Registra um editor customizado para campos da grade e formulário.
|
|
29
|
+
|
|
30
|
+
#### Returns
|
|
31
|
+
|
|
32
|
+
Type: `Promise<void>`
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
### `setFieldProp(fieldName: string, propName: string, value: any) => Promise<void>`
|
|
37
|
+
|
|
38
|
+
Altera/adiciona uma propriedade nos metados do campo.
|
|
39
|
+
|
|
40
|
+
#### Returns
|
|
41
|
+
|
|
42
|
+
Type: `Promise<void>`
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
|
|
25
46
|
### `showUp() => Promise<void>`
|
|
26
47
|
|
|
27
48
|
|
|
@@ -41,6 +62,7 @@ Type: `Promise<void>`
|
|
|
41
62
|
|
|
42
63
|
### Depends on
|
|
43
64
|
|
|
65
|
+
- [ez-custom-form-input](custom-input)
|
|
44
66
|
- [ez-collapsible-box](../ez-collapsible-box)
|
|
45
67
|
- [ez-check](../ez-check)
|
|
46
68
|
- [ez-combo-box](../ez-combo-box)
|
|
@@ -56,6 +78,7 @@ Type: `Promise<void>`
|
|
|
56
78
|
### Graph
|
|
57
79
|
```mermaid
|
|
58
80
|
graph TD;
|
|
81
|
+
ez-form-view --> ez-custom-form-input
|
|
59
82
|
ez-form-view --> ez-collapsible-box
|
|
60
83
|
ez-form-view --> ez-check
|
|
61
84
|
ez-form-view --> ez-combo-box
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
|
|
10
10
|
| Property | Attribute | Description | Type | Default |
|
|
11
11
|
| ------------------------ | -------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ----------- |
|
|
12
|
+
| `autoFocus` | `auto-focus` | Define se a grid será focada ao ser carregada. | `boolean` | `true` |
|
|
12
13
|
| `canEdit` | `can-edit` | Define se a edição está habilitada na grid. | `boolean` | `true` |
|
|
13
14
|
| `columnfilterDataSource` | -- | Define um `IMultiSelectionListDataSource` responsável por alimentar o filtro de colunas. | `IMultiSelectionListDataSource` | `undefined` |
|
|
14
15
|
| `config` | -- | Configuração de exibição da grade. | `IGridConfig` | `undefined` |
|
|
@@ -44,6 +45,36 @@ Type: `Promise<void>`
|
|
|
44
45
|
|
|
45
46
|
|
|
46
47
|
|
|
48
|
+
### `addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>`
|
|
49
|
+
|
|
50
|
+
Registra um editor customizado para campos da grade e formulário.
|
|
51
|
+
|
|
52
|
+
#### Returns
|
|
53
|
+
|
|
54
|
+
Type: `Promise<void>`
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
### `addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter) => Promise<void>`
|
|
59
|
+
|
|
60
|
+
Registra um formatador de valores para uma coluna da grid.
|
|
61
|
+
|
|
62
|
+
#### Returns
|
|
63
|
+
|
|
64
|
+
Type: `Promise<void>`
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
### `addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>`
|
|
69
|
+
|
|
70
|
+
Registra um render customizado para colunas da grid.
|
|
71
|
+
|
|
72
|
+
#### Returns
|
|
73
|
+
|
|
74
|
+
Type: `Promise<void>`
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
47
78
|
### `filterColumns(search: string) => Promise<Array<EzGridColumn>>`
|
|
48
79
|
|
|
49
80
|
Usa um argumento para filtrar as colunas po label
|
|
@@ -74,6 +105,16 @@ Type: `Promise<EzGridColumn[]>`
|
|
|
74
105
|
|
|
75
106
|
|
|
76
107
|
|
|
108
|
+
### `getCustomValueFormatter(columnName: string) => Promise<ICustomFormatter | undefined>`
|
|
109
|
+
|
|
110
|
+
Retorna o formatador customizado da coluna caso exista.
|
|
111
|
+
|
|
112
|
+
#### Returns
|
|
113
|
+
|
|
114
|
+
Type: `Promise<ICustomFormatter>`
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
77
118
|
### `getSelection() => Promise<Array<any>>`
|
|
78
119
|
|
|
79
120
|
Obtém as linhas selecionadas.
|
|
@@ -104,6 +145,26 @@ Type: `Promise<void>`
|
|
|
104
145
|
|
|
105
146
|
|
|
106
147
|
|
|
148
|
+
### `refreshSelectedRows() => Promise<void>`
|
|
149
|
+
|
|
150
|
+
Atualiza linhas da grade.
|
|
151
|
+
|
|
152
|
+
#### Returns
|
|
153
|
+
|
|
154
|
+
Type: `Promise<void>`
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
### `removeCustomValueFormatter(columnName: string) => Promise<void>`
|
|
159
|
+
|
|
160
|
+
Remove o formatador de valores de uma coluna da grid.
|
|
161
|
+
|
|
162
|
+
#### Returns
|
|
163
|
+
|
|
164
|
+
Type: `Promise<void>`
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
107
168
|
### `setColumnsDef(cols: Array<EzGridColumn>) => Promise<void>`
|
|
108
169
|
|
|
109
170
|
Aplica a definição de colunas.
|
|
@@ -134,6 +195,16 @@ Type: `Promise<void>`
|
|
|
134
195
|
|
|
135
196
|
|
|
136
197
|
|
|
198
|
+
### `setFocus() => Promise<void>`
|
|
199
|
+
|
|
200
|
+
Atribui o foco para a grade.
|
|
201
|
+
|
|
202
|
+
#### Returns
|
|
203
|
+
|
|
204
|
+
Type: `Promise<void>`
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
137
208
|
|
|
138
209
|
## Dependencies
|
|
139
210
|
|
|
@@ -25,6 +25,7 @@
|
|
|
25
25
|
| --------------- | ----------------------------------------------------------- | ---------------------------------------- |
|
|
26
26
|
| `ezChange` | Emitido quando acontece a alteração de estado da lista. | `CustomEvent<(ListItem \| ListGroup)[]>` |
|
|
27
27
|
| `ezCheckChange` | Emitido quando acontece a alteração de um item do checkbox. | `CustomEvent<ListItem>` |
|
|
28
|
+
| `ezDoubleClick` | Emitido quando ocorre um duplo clique em um item da lista. | `CustomEvent<ListItem>` |
|
|
28
29
|
| `ezSelectItem` | Emitido sempre que um item da lista for selecionado. | `CustomEvent<ListItem>` |
|
|
29
30
|
|
|
30
31
|
|