@vaadin/grid-pro 25.1.0-alpha7 → 25.1.0-alpha9
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/package.json +14 -14
- package/web-types.json +270 -270
- package/web-types.lit.json +114 -114
package/web-types.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json.schemastore.org/web-types",
|
|
3
3
|
"name": "@vaadin/grid-pro",
|
|
4
|
-
"version": "25.1.0-
|
|
4
|
+
"version": "25.1.0-alpha9",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
@@ -11,79 +11,73 @@
|
|
|
11
11
|
"description": "`<vaadin-grid-pro-edit-column>` is a helper element for the `<vaadin-grid-pro>`\nthat provides default inline editing for the items.\n\n__Note that the `path` property must be explicitly specified for edit column.__\n\n#### Example:\n```html\n<vaadin-grid-pro>\n <vaadin-grid-pro-edit-column path=\"name.first\"></vaadin-grid-pro-edit-column>\n\n <vaadin-grid-column>\n ...\n```",
|
|
12
12
|
"attributes": [
|
|
13
13
|
{
|
|
14
|
-
"name": "
|
|
15
|
-
"description": "
|
|
14
|
+
"name": "auto-width",
|
|
15
|
+
"description": "Automatically sets the width of the column based on the column contents when this is set to `true`.\n\nFor performance reasons the column width is calculated automatically only once when the grid items\nare rendered for the first time and the calculation only considers the rows which are currently\nrendered in DOM (a bit more than what is currently visible). If the grid is scrolled, or the cell\ncontent changes, the column width might not match the contents anymore.\n\nHidden columns are ignored in the calculation and their widths are not automatically updated when\nyou show a column that was initially hidden.\n\nYou can manually trigger the auto sizing behavior again by calling `grid.recalculateColumnWidths()`.\n\nThe column width may still grow larger when `flexGrow` is not 0.",
|
|
16
16
|
"value": {
|
|
17
17
|
"type": [
|
|
18
|
-
"boolean"
|
|
19
|
-
"null",
|
|
20
|
-
"undefined"
|
|
18
|
+
"boolean"
|
|
21
19
|
]
|
|
22
20
|
}
|
|
23
21
|
},
|
|
24
22
|
{
|
|
25
|
-
"name": "
|
|
26
|
-
"description": "
|
|
23
|
+
"name": "editor-type",
|
|
24
|
+
"description": "Type of the cell editor component to be rendered. Allowed values:\n- `text` (default) - renders a text field\n- `checkbox` - renders a checkbox\n- `select` - renders a select with a list of items passed as `editorOptions`\n\nEditor type is set to `custom` when `editModeRenderer` is set.",
|
|
27
25
|
"value": {
|
|
28
26
|
"type": [
|
|
29
|
-
"
|
|
27
|
+
"GridProEditorType"
|
|
30
28
|
]
|
|
31
29
|
}
|
|
32
30
|
},
|
|
33
31
|
{
|
|
34
|
-
"name": "
|
|
35
|
-
"description": "
|
|
32
|
+
"name": "editor-value-path",
|
|
33
|
+
"description": "Path of the property used for the value of the editor component.",
|
|
36
34
|
"value": {
|
|
37
35
|
"type": [
|
|
38
|
-
"
|
|
36
|
+
"string"
|
|
39
37
|
]
|
|
40
38
|
}
|
|
41
39
|
},
|
|
42
40
|
{
|
|
43
|
-
"name": "
|
|
44
|
-
"description": "
|
|
41
|
+
"name": "flex-grow",
|
|
42
|
+
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
45
43
|
"value": {
|
|
46
44
|
"type": [
|
|
47
|
-
"
|
|
45
|
+
"number"
|
|
48
46
|
]
|
|
49
47
|
}
|
|
50
48
|
},
|
|
51
49
|
{
|
|
52
|
-
"name": "
|
|
53
|
-
"description": "
|
|
50
|
+
"name": "footer-part-name",
|
|
51
|
+
"description": "Custom part name for the footer cell.",
|
|
54
52
|
"value": {
|
|
55
53
|
"type": [
|
|
56
|
-
"
|
|
54
|
+
"string",
|
|
57
55
|
"null",
|
|
58
56
|
"undefined"
|
|
59
57
|
]
|
|
60
58
|
}
|
|
61
59
|
},
|
|
62
60
|
{
|
|
63
|
-
"name": "
|
|
64
|
-
"description": "
|
|
61
|
+
"name": "frozen",
|
|
62
|
+
"description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.",
|
|
65
63
|
"value": {
|
|
66
64
|
"type": [
|
|
67
|
-
"
|
|
68
|
-
"null",
|
|
69
|
-
"undefined"
|
|
65
|
+
"boolean"
|
|
70
66
|
]
|
|
71
67
|
}
|
|
72
68
|
},
|
|
73
69
|
{
|
|
74
|
-
"name": "
|
|
75
|
-
"description": "
|
|
70
|
+
"name": "frozen-to-end",
|
|
71
|
+
"description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.",
|
|
76
72
|
"value": {
|
|
77
73
|
"type": [
|
|
78
|
-
"
|
|
79
|
-
"null",
|
|
80
|
-
"undefined"
|
|
74
|
+
"boolean"
|
|
81
75
|
]
|
|
82
76
|
}
|
|
83
77
|
},
|
|
84
78
|
{
|
|
85
|
-
"name": "header
|
|
86
|
-
"description": "
|
|
79
|
+
"name": "header",
|
|
80
|
+
"description": "Text content to display in the header cell of the column.",
|
|
87
81
|
"value": {
|
|
88
82
|
"type": [
|
|
89
83
|
"string",
|
|
@@ -93,8 +87,8 @@
|
|
|
93
87
|
}
|
|
94
88
|
},
|
|
95
89
|
{
|
|
96
|
-
"name": "
|
|
97
|
-
"description": "Custom part name for the
|
|
90
|
+
"name": "header-part-name",
|
|
91
|
+
"description": "Custom part name for the header cell.",
|
|
98
92
|
"value": {
|
|
99
93
|
"type": [
|
|
100
94
|
"string",
|
|
@@ -104,39 +98,41 @@
|
|
|
104
98
|
}
|
|
105
99
|
},
|
|
106
100
|
{
|
|
107
|
-
"name": "
|
|
108
|
-
"description": "
|
|
101
|
+
"name": "hidden",
|
|
102
|
+
"description": "When set to true, the cells for this column are hidden.",
|
|
109
103
|
"value": {
|
|
110
104
|
"type": [
|
|
111
|
-
"
|
|
105
|
+
"boolean",
|
|
112
106
|
"null",
|
|
113
107
|
"undefined"
|
|
114
108
|
]
|
|
115
109
|
}
|
|
116
110
|
},
|
|
117
111
|
{
|
|
118
|
-
"name": "
|
|
119
|
-
"description": "
|
|
112
|
+
"name": "path",
|
|
113
|
+
"description": "JS Path of the property in the item used for the editable content.",
|
|
120
114
|
"value": {
|
|
121
115
|
"type": [
|
|
122
|
-
"
|
|
116
|
+
"string",
|
|
117
|
+
"null",
|
|
118
|
+
"undefined"
|
|
123
119
|
]
|
|
124
120
|
}
|
|
125
121
|
},
|
|
126
122
|
{
|
|
127
|
-
"name": "
|
|
128
|
-
"description": "
|
|
123
|
+
"name": "resizable",
|
|
124
|
+
"description": "When set to true, the column is user-resizable.",
|
|
129
125
|
"value": {
|
|
130
126
|
"type": [
|
|
131
|
-
"
|
|
127
|
+
"boolean",
|
|
132
128
|
"null",
|
|
133
129
|
"undefined"
|
|
134
130
|
]
|
|
135
131
|
}
|
|
136
132
|
},
|
|
137
133
|
{
|
|
138
|
-
"name": "
|
|
139
|
-
"description": "
|
|
134
|
+
"name": "row-header",
|
|
135
|
+
"description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.",
|
|
140
136
|
"value": {
|
|
141
137
|
"type": [
|
|
142
138
|
"boolean"
|
|
@@ -144,26 +140,30 @@
|
|
|
144
140
|
}
|
|
145
141
|
},
|
|
146
142
|
{
|
|
147
|
-
"name": "
|
|
148
|
-
"description": "
|
|
143
|
+
"name": "text-align",
|
|
144
|
+
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
149
145
|
"value": {
|
|
150
146
|
"type": [
|
|
151
|
-
"
|
|
147
|
+
"GridColumnTextAlign",
|
|
148
|
+
"null",
|
|
149
|
+
"undefined"
|
|
152
150
|
]
|
|
153
151
|
}
|
|
154
152
|
},
|
|
155
153
|
{
|
|
156
|
-
"name": "
|
|
157
|
-
"description": "
|
|
154
|
+
"name": "theme",
|
|
155
|
+
"description": "The theme variants to apply to the component.",
|
|
158
156
|
"value": {
|
|
159
157
|
"type": [
|
|
160
|
-
"string"
|
|
158
|
+
"string",
|
|
159
|
+
"null",
|
|
160
|
+
"undefined"
|
|
161
161
|
]
|
|
162
162
|
}
|
|
163
163
|
},
|
|
164
164
|
{
|
|
165
|
-
"name": "
|
|
166
|
-
"description": "
|
|
165
|
+
"name": "width",
|
|
166
|
+
"description": "Width of the cells for this column.\n\nPlease note that using the `em` length unit is discouraged as\nit might lead to misalignment issues if the header, body, and footer\ncells have different font sizes. Instead, use `rem` if you need\na length unit relative to the font size.",
|
|
167
167
|
"value": {
|
|
168
168
|
"type": [
|
|
169
169
|
"string",
|
|
@@ -176,57 +176,64 @@
|
|
|
176
176
|
"js": {
|
|
177
177
|
"properties": [
|
|
178
178
|
{
|
|
179
|
-
"name": "
|
|
180
|
-
"description": "
|
|
179
|
+
"name": "autoWidth",
|
|
180
|
+
"description": "Automatically sets the width of the column based on the column contents when this is set to `true`.\n\nFor performance reasons the column width is calculated automatically only once when the grid items\nare rendered for the first time and the calculation only considers the rows which are currently\nrendered in DOM (a bit more than what is currently visible). If the grid is scrolled, or the cell\ncontent changes, the column width might not match the contents anymore.\n\nHidden columns are ignored in the calculation and their widths are not automatically updated when\nyou show a column that was initially hidden.\n\nYou can manually trigger the auto sizing behavior again by calling `grid.recalculateColumnWidths()`.\n\nThe column width may still grow larger when `flexGrow` is not 0.",
|
|
181
181
|
"value": {
|
|
182
182
|
"type": [
|
|
183
|
-
"boolean"
|
|
183
|
+
"boolean"
|
|
184
|
+
]
|
|
185
|
+
}
|
|
186
|
+
},
|
|
187
|
+
{
|
|
188
|
+
"name": "editModeRenderer",
|
|
189
|
+
"description": "Custom function for rendering the cell content in edit mode.\nReceives three arguments:\n\n- `root` The cell content DOM element. Append your editor component to it.\n- `column` The `<vaadin-grid-pro-edit-column>` element.\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.\n - `model.detailsOpened` Details opened state.",
|
|
190
|
+
"value": {
|
|
191
|
+
"type": [
|
|
192
|
+
"GridBodyRenderer",
|
|
184
193
|
"null",
|
|
185
194
|
"undefined"
|
|
186
195
|
]
|
|
187
196
|
}
|
|
188
197
|
},
|
|
189
198
|
{
|
|
190
|
-
"name": "
|
|
191
|
-
"description": "
|
|
199
|
+
"name": "editorOptions",
|
|
200
|
+
"description": "The list of options which should be passed to cell editor component.\nUsed with the `select` editor type, to provide a list of items.",
|
|
192
201
|
"value": {
|
|
193
202
|
"type": [
|
|
194
|
-
"
|
|
203
|
+
"Array.<string>"
|
|
195
204
|
]
|
|
196
205
|
}
|
|
197
206
|
},
|
|
198
207
|
{
|
|
199
|
-
"name": "
|
|
200
|
-
"description": "
|
|
208
|
+
"name": "editorType",
|
|
209
|
+
"description": "Type of the cell editor component to be rendered. Allowed values:\n- `text` (default) - renders a text field\n- `checkbox` - renders a checkbox\n- `select` - renders a select with a list of items passed as `editorOptions`\n\nEditor type is set to `custom` when `editModeRenderer` is set.",
|
|
201
210
|
"value": {
|
|
202
211
|
"type": [
|
|
203
|
-
"
|
|
212
|
+
"GridProEditorType"
|
|
204
213
|
]
|
|
205
214
|
}
|
|
206
215
|
},
|
|
207
216
|
{
|
|
208
|
-
"name": "
|
|
209
|
-
"description": "
|
|
217
|
+
"name": "editorValuePath",
|
|
218
|
+
"description": "Path of the property used for the value of the editor component.",
|
|
210
219
|
"value": {
|
|
211
220
|
"type": [
|
|
212
|
-
"
|
|
221
|
+
"string"
|
|
213
222
|
]
|
|
214
223
|
}
|
|
215
224
|
},
|
|
216
225
|
{
|
|
217
|
-
"name": "
|
|
218
|
-
"description": "When set to
|
|
226
|
+
"name": "flexGrow",
|
|
227
|
+
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
219
228
|
"value": {
|
|
220
229
|
"type": [
|
|
221
|
-
"
|
|
222
|
-
"null",
|
|
223
|
-
"undefined"
|
|
230
|
+
"number"
|
|
224
231
|
]
|
|
225
232
|
}
|
|
226
233
|
},
|
|
227
234
|
{
|
|
228
|
-
"name": "
|
|
229
|
-
"description": "
|
|
235
|
+
"name": "footerPartName",
|
|
236
|
+
"description": "Custom part name for the footer cell.",
|
|
230
237
|
"value": {
|
|
231
238
|
"type": [
|
|
232
239
|
"string",
|
|
@@ -236,86 +243,84 @@
|
|
|
236
243
|
}
|
|
237
244
|
},
|
|
238
245
|
{
|
|
239
|
-
"name": "
|
|
240
|
-
"description": "
|
|
246
|
+
"name": "footerRenderer",
|
|
247
|
+
"description": "Custom function for rendering the footer content.\nReceives two arguments:\n\n- `root` The footer cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.",
|
|
241
248
|
"value": {
|
|
242
249
|
"type": [
|
|
243
|
-
"
|
|
250
|
+
"GridHeaderFooterRenderer",
|
|
244
251
|
"null",
|
|
245
252
|
"undefined"
|
|
246
253
|
]
|
|
247
254
|
}
|
|
248
255
|
},
|
|
249
256
|
{
|
|
250
|
-
"name": "
|
|
251
|
-
"description": "
|
|
257
|
+
"name": "frozen",
|
|
258
|
+
"description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.",
|
|
252
259
|
"value": {
|
|
253
260
|
"type": [
|
|
254
|
-
"
|
|
255
|
-
"null",
|
|
256
|
-
"undefined"
|
|
261
|
+
"boolean"
|
|
257
262
|
]
|
|
258
263
|
}
|
|
259
264
|
},
|
|
260
265
|
{
|
|
261
|
-
"name": "
|
|
262
|
-
"description": "
|
|
266
|
+
"name": "frozenToEnd",
|
|
267
|
+
"description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.",
|
|
263
268
|
"value": {
|
|
264
269
|
"type": [
|
|
265
|
-
"
|
|
266
|
-
"null",
|
|
267
|
-
"undefined"
|
|
270
|
+
"boolean"
|
|
268
271
|
]
|
|
269
272
|
}
|
|
270
273
|
},
|
|
271
274
|
{
|
|
272
|
-
"name": "
|
|
273
|
-
"description": "
|
|
275
|
+
"name": "header",
|
|
276
|
+
"description": "Text content to display in the header cell of the column.",
|
|
274
277
|
"value": {
|
|
275
278
|
"type": [
|
|
276
|
-
"
|
|
279
|
+
"string",
|
|
277
280
|
"null",
|
|
278
281
|
"undefined"
|
|
279
282
|
]
|
|
280
283
|
}
|
|
281
284
|
},
|
|
282
285
|
{
|
|
283
|
-
"name": "
|
|
284
|
-
"description": "Custom
|
|
286
|
+
"name": "headerPartName",
|
|
287
|
+
"description": "Custom part name for the header cell.",
|
|
285
288
|
"value": {
|
|
286
289
|
"type": [
|
|
287
|
-
"
|
|
290
|
+
"string",
|
|
288
291
|
"null",
|
|
289
292
|
"undefined"
|
|
290
293
|
]
|
|
291
294
|
}
|
|
292
295
|
},
|
|
293
296
|
{
|
|
294
|
-
"name": "
|
|
295
|
-
"description": "
|
|
297
|
+
"name": "headerRenderer",
|
|
298
|
+
"description": "Custom function for rendering the header content.\nReceives two arguments:\n\n- `root` The header cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.",
|
|
296
299
|
"value": {
|
|
297
300
|
"type": [
|
|
298
|
-
"
|
|
301
|
+
"GridHeaderFooterRenderer",
|
|
299
302
|
"null",
|
|
300
303
|
"undefined"
|
|
301
304
|
]
|
|
302
305
|
}
|
|
303
306
|
},
|
|
304
307
|
{
|
|
305
|
-
"name": "
|
|
306
|
-
"description": "
|
|
308
|
+
"name": "hidden",
|
|
309
|
+
"description": "When set to true, the cells for this column are hidden.",
|
|
307
310
|
"value": {
|
|
308
311
|
"type": [
|
|
309
|
-
"
|
|
312
|
+
"boolean",
|
|
313
|
+
"null",
|
|
314
|
+
"undefined"
|
|
310
315
|
]
|
|
311
316
|
}
|
|
312
317
|
},
|
|
313
318
|
{
|
|
314
|
-
"name": "
|
|
315
|
-
"description": "
|
|
319
|
+
"name": "isCellEditable",
|
|
320
|
+
"description": "A function to check whether a specific cell of this column can be\nedited. This allows to disable editing of individual rows or cells,\nbased on the item.\n\nReceives a `model` object containing the item for an individual row,\nand should return a boolean indicating whether the column's cell in\nthat row is editable.\n\nThe `model` object contains:\n- `model.index` The index of the item.\n- `model.item` The item.\n- `model.expanded` Sublevel toggle state.\n- `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n- `model.selected` Selected state.",
|
|
316
321
|
"value": {
|
|
317
322
|
"type": [
|
|
318
|
-
"
|
|
323
|
+
"Function",
|
|
319
324
|
"null",
|
|
320
325
|
"undefined"
|
|
321
326
|
]
|
|
@@ -333,17 +338,8 @@
|
|
|
333
338
|
}
|
|
334
339
|
},
|
|
335
340
|
{
|
|
336
|
-
"name": "
|
|
337
|
-
"description": "
|
|
338
|
-
"value": {
|
|
339
|
-
"type": [
|
|
340
|
-
"boolean"
|
|
341
|
-
]
|
|
342
|
-
}
|
|
343
|
-
},
|
|
344
|
-
{
|
|
345
|
-
"name": "editModeRenderer",
|
|
346
|
-
"description": "Custom function for rendering the cell content in edit mode.\nReceives three arguments:\n\n- `root` The cell content DOM element. Append your editor component to it.\n- `column` The `<vaadin-grid-pro-edit-column>` element.\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.\n - `model.detailsOpened` Details opened state.",
|
|
341
|
+
"name": "renderer",
|
|
342
|
+
"description": "Custom function for rendering the cell content.\nReceives three arguments:\n\n- `root` The cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.\n - `model.detailsOpened` Details opened state.\n - `model.hasChildren` Whether the item has children.",
|
|
347
343
|
"value": {
|
|
348
344
|
"type": [
|
|
349
345
|
"GridBodyRenderer",
|
|
@@ -353,38 +349,42 @@
|
|
|
353
349
|
}
|
|
354
350
|
},
|
|
355
351
|
{
|
|
356
|
-
"name": "
|
|
357
|
-
"description": "
|
|
352
|
+
"name": "resizable",
|
|
353
|
+
"description": "When set to true, the column is user-resizable.",
|
|
358
354
|
"value": {
|
|
359
355
|
"type": [
|
|
360
|
-
"
|
|
356
|
+
"boolean",
|
|
357
|
+
"null",
|
|
358
|
+
"undefined"
|
|
361
359
|
]
|
|
362
360
|
}
|
|
363
361
|
},
|
|
364
362
|
{
|
|
365
|
-
"name": "
|
|
366
|
-
"description": "
|
|
363
|
+
"name": "rowHeader",
|
|
364
|
+
"description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.",
|
|
367
365
|
"value": {
|
|
368
366
|
"type": [
|
|
369
|
-
"
|
|
367
|
+
"boolean"
|
|
370
368
|
]
|
|
371
369
|
}
|
|
372
370
|
},
|
|
373
371
|
{
|
|
374
|
-
"name": "
|
|
375
|
-
"description": "
|
|
372
|
+
"name": "textAlign",
|
|
373
|
+
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
376
374
|
"value": {
|
|
377
375
|
"type": [
|
|
378
|
-
"
|
|
376
|
+
"GridColumnTextAlign",
|
|
377
|
+
"null",
|
|
378
|
+
"undefined"
|
|
379
379
|
]
|
|
380
380
|
}
|
|
381
381
|
},
|
|
382
382
|
{
|
|
383
|
-
"name": "
|
|
384
|
-
"description": "
|
|
383
|
+
"name": "width",
|
|
384
|
+
"description": "Width of the cells for this column.\n\nPlease note that using the `em` length unit is discouraged as\nit might lead to misalignment issues if the header, body, and footer\ncells have different font sizes. Instead, use `rem` if you need\na length unit relative to the font size.",
|
|
385
385
|
"value": {
|
|
386
386
|
"type": [
|
|
387
|
-
"
|
|
387
|
+
"string",
|
|
388
388
|
"null",
|
|
389
389
|
"undefined"
|
|
390
390
|
]
|
|
@@ -401,7 +401,7 @@
|
|
|
401
401
|
},
|
|
402
402
|
{
|
|
403
403
|
"name": "vaadin-grid-pro",
|
|
404
|
-
"description": "`<vaadin-grid-pro>` is a high quality data grid / data table Web Component with extended functionality.\nIt extends `<vaadin-grid>` and adds extra features on top of the basic ones.\n\nSee [`<vaadin-grid>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-
|
|
404
|
+
"description": "`<vaadin-grid-pro>` is a high quality data grid / data table Web Component with extended functionality.\nIt extends `<vaadin-grid>` and adds extra features on top of the basic ones.\n\nSee [`<vaadin-grid>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-alpha9/#/elements/vaadin-grid) documentation for details.\n\n```html\n<vaadin-grid-pro></vaadin-grid-pro>\n```\n\n### Internal components\n\nIn addition to `<vaadin-grid-pro>` itself, the following internal\ncomponents are themable:\n\n- `<vaadin-grid-pro-edit-checkbox>` - has the same API as [`<vaadin-checkbox>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-alpha9/#/elements/vaadin-checkbox).\n- `<vaadin-grid-pro-edit-text-field>` - has the same API as [`<vaadin-text-field>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-alpha9/#/elements/vaadin-text-field).\n- `<vaadin-grid-pro-edit-select>` - has the same API as [`<vaadin-select>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-alpha9/#/elements/vaadin-select).",
|
|
405
405
|
"attributes": [
|
|
406
406
|
{
|
|
407
407
|
"name": "accessible-name",
|
|
@@ -415,66 +415,68 @@
|
|
|
415
415
|
}
|
|
416
416
|
},
|
|
417
417
|
{
|
|
418
|
-
"name": "
|
|
419
|
-
"description": "
|
|
418
|
+
"name": "all-rows-visible",
|
|
419
|
+
"description": "If true, the grid's height is defined by its rows.\n\nEffectively, this disables the grid's virtual scrolling so that all the rows are rendered in the DOM at once.\nIf the grid has a large number of items, using the feature is discouraged to avoid performance issues.",
|
|
420
420
|
"value": {
|
|
421
421
|
"type": [
|
|
422
|
-
"
|
|
422
|
+
"boolean"
|
|
423
423
|
]
|
|
424
424
|
}
|
|
425
425
|
},
|
|
426
426
|
{
|
|
427
|
-
"name": "
|
|
428
|
-
"description": "
|
|
427
|
+
"name": "column-rendering",
|
|
428
|
+
"description": "Allows you to choose between modes for rendering columns in the grid:\n\n\"eager\" (default): All columns are rendered upfront, regardless of their visibility within the viewport.\nThis mode should generally be preferred, as it avoids the limitations imposed by the \"lazy\" mode.\nUse this mode unless the grid has a large number of columns and performance outweighs the limitations\nin priority.\n\n\"lazy\": Optimizes the rendering of cells when there are multiple columns in the grid by virtualizing\nhorizontal scrolling. In this mode, body cells are rendered only when their corresponding columns are\ninside the visible viewport.\n\nUsing \"lazy\" rendering should be used only if you're dealing with a large number of columns and performance\nis your highest priority. For most use cases, the default \"eager\" mode is recommended due to the\nlimitations imposed by the \"lazy\" mode.\n\nWhen using the \"lazy\" mode, keep the following limitations in mind:\n\n- Row Height: When only a number of columns are visible at once, the height of a row can only be that of\nthe highest cell currently visible on that row. Make sure each cell on a single row has the same height\nas all other cells on that row. If row cells have different heights, users may experience jumpiness when\nscrolling the grid horizontally as lazily rendered cells with different heights are scrolled into view.\n\n- Auto-width Columns: For the columns that are initially outside the visible viewport but still use auto-width,\nonly the header content is taken into account when calculating the column width because the body cells\nof the columns outside the viewport are not initially rendered.\n\n- Screen Reader Compatibility: Screen readers may not be able to associate the focused cells with the correct\nheaders when only a subset of the body cells on a row is rendered.\n\n- Keyboard Navigation: Tabbing through focusable elements inside the grid body may not work as expected because\nsome of the columns that would include focusable elements in the body cells may be outside the visible viewport\nand thus not rendered.",
|
|
429
429
|
"value": {
|
|
430
430
|
"type": [
|
|
431
|
-
"
|
|
431
|
+
"ColumnRendering"
|
|
432
432
|
]
|
|
433
433
|
}
|
|
434
434
|
},
|
|
435
435
|
{
|
|
436
|
-
"name": "
|
|
437
|
-
"description": "
|
|
436
|
+
"name": "column-reordering-allowed",
|
|
437
|
+
"description": "Set to true to allow column reordering.",
|
|
438
438
|
"value": {
|
|
439
439
|
"type": [
|
|
440
|
-
"
|
|
441
|
-
"null",
|
|
442
|
-
"undefined"
|
|
440
|
+
"boolean"
|
|
443
441
|
]
|
|
444
442
|
}
|
|
445
443
|
},
|
|
446
444
|
{
|
|
447
|
-
"name": "
|
|
448
|
-
"description": "
|
|
445
|
+
"name": "drop-mode",
|
|
446
|
+
"description": "Defines the locations within the Grid row where an element can be dropped.\n\nPossible values are:\n- `between`: The drop event can happen between Grid rows.\n- `on-top`: The drop event can happen on top of Grid rows.\n- `on-top-or-between`: The drop event can happen either on top of or between Grid rows.\n- `on-grid`: The drop event will not happen on any specific row, it will show the drop target outline around the whole grid.",
|
|
449
447
|
"value": {
|
|
450
448
|
"type": [
|
|
451
|
-
"
|
|
449
|
+
"GridDropMode",
|
|
452
450
|
"null",
|
|
453
451
|
"undefined"
|
|
454
452
|
]
|
|
455
453
|
}
|
|
456
454
|
},
|
|
457
455
|
{
|
|
458
|
-
"name": "
|
|
459
|
-
"description": "
|
|
456
|
+
"name": "edit-on-click",
|
|
457
|
+
"description": "When true, the grid enters cell edit mode on a single click\ninstead of the default double click.",
|
|
460
458
|
"value": {
|
|
461
459
|
"type": [
|
|
462
|
-
"
|
|
460
|
+
"boolean",
|
|
461
|
+
"null",
|
|
462
|
+
"undefined"
|
|
463
463
|
]
|
|
464
464
|
}
|
|
465
465
|
},
|
|
466
466
|
{
|
|
467
|
-
"name": "
|
|
468
|
-
"description": "When
|
|
467
|
+
"name": "enter-next-row",
|
|
468
|
+
"description": "When true, pressing Enter while in cell edit mode\nwill move focus to the editable cell in the next row\n(Shift + Enter - same, but for previous row).",
|
|
469
469
|
"value": {
|
|
470
470
|
"type": [
|
|
471
|
-
"boolean"
|
|
471
|
+
"boolean",
|
|
472
|
+
"null",
|
|
473
|
+
"undefined"
|
|
472
474
|
]
|
|
473
475
|
}
|
|
474
476
|
},
|
|
475
477
|
{
|
|
476
|
-
"name": "
|
|
477
|
-
"description": "
|
|
478
|
+
"name": "item-has-children-path",
|
|
479
|
+
"description": "Path to an item sub-property that indicates whether the item has child items.",
|
|
478
480
|
"value": {
|
|
479
481
|
"type": [
|
|
480
482
|
"string",
|
|
@@ -484,17 +486,19 @@
|
|
|
484
486
|
}
|
|
485
487
|
},
|
|
486
488
|
{
|
|
487
|
-
"name": "
|
|
488
|
-
"description": "
|
|
489
|
+
"name": "item-id-path",
|
|
490
|
+
"description": "Path to an item sub-property that identifies the item.",
|
|
489
491
|
"value": {
|
|
490
492
|
"type": [
|
|
491
|
-
"
|
|
493
|
+
"string",
|
|
494
|
+
"null",
|
|
495
|
+
"undefined"
|
|
492
496
|
]
|
|
493
497
|
}
|
|
494
498
|
},
|
|
495
499
|
{
|
|
496
|
-
"name": "
|
|
497
|
-
"description": "
|
|
500
|
+
"name": "multi-sort",
|
|
501
|
+
"description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
|
|
498
502
|
"value": {
|
|
499
503
|
"type": [
|
|
500
504
|
"boolean"
|
|
@@ -502,39 +506,37 @@
|
|
|
502
506
|
}
|
|
503
507
|
},
|
|
504
508
|
{
|
|
505
|
-
"name": "
|
|
506
|
-
"description": "
|
|
509
|
+
"name": "multi-sort-on-shift-click",
|
|
510
|
+
"description": "When `true`, Shift-clicking an unsorted column's sorter adds it to the multi-sort.\nShift + Space does the same action via keyboard. This property has precedence over the\n`multiSort` property. If `multiSortOnShiftClick` is true, the multiSort property is effectively ignored.",
|
|
507
511
|
"value": {
|
|
508
512
|
"type": [
|
|
509
|
-
"
|
|
510
|
-
"null",
|
|
511
|
-
"undefined"
|
|
513
|
+
"boolean"
|
|
512
514
|
]
|
|
513
515
|
}
|
|
514
516
|
},
|
|
515
517
|
{
|
|
516
|
-
"name": "
|
|
517
|
-
"description": "
|
|
518
|
+
"name": "multi-sort-priority",
|
|
519
|
+
"description": "Controls how columns are added to the sort order when using multi-sort.\nThe sort order is visually indicated by numbers in grid sorters placed in column headers.\n\nBy default, whenever an unsorted column is sorted, or the sort-direction of a column is\nchanged, that column gets sort priority 1, thus affecting the priority for all the other\nsorted columns. This is identical to using `multi-sort-priority=\"prepend\"`.\n\nUsing this property allows to change this behavior so that sorting an unsorted column\nwould add it to the \"end\" of the sort, and changing column's sort direction would retain\nit's previous priority. To set this, use `multi-sort-priority=\"append\"`.",
|
|
518
520
|
"value": {
|
|
519
521
|
"type": [
|
|
520
|
-
"
|
|
522
|
+
"string",
|
|
521
523
|
"null",
|
|
522
524
|
"undefined"
|
|
523
525
|
]
|
|
524
526
|
}
|
|
525
527
|
},
|
|
526
528
|
{
|
|
527
|
-
"name": "
|
|
528
|
-
"description": "
|
|
529
|
+
"name": "page-size",
|
|
530
|
+
"description": "Number of items fetched at a time from the dataprovider.",
|
|
529
531
|
"value": {
|
|
530
532
|
"type": [
|
|
531
|
-
"
|
|
533
|
+
"number"
|
|
532
534
|
]
|
|
533
535
|
}
|
|
534
536
|
},
|
|
535
537
|
{
|
|
536
|
-
"name": "
|
|
537
|
-
"description": "
|
|
538
|
+
"name": "rows-draggable",
|
|
539
|
+
"description": "Marks the grid's rows to be available for dragging.",
|
|
538
540
|
"value": {
|
|
539
541
|
"type": [
|
|
540
542
|
"boolean",
|
|
@@ -555,13 +557,11 @@
|
|
|
555
557
|
}
|
|
556
558
|
},
|
|
557
559
|
{
|
|
558
|
-
"name": "
|
|
559
|
-
"description": "
|
|
560
|
+
"name": "size",
|
|
561
|
+
"description": "The number of root-level items in the grid.",
|
|
560
562
|
"value": {
|
|
561
563
|
"type": [
|
|
562
|
-
"
|
|
563
|
-
"null",
|
|
564
|
-
"undefined"
|
|
564
|
+
"number"
|
|
565
565
|
]
|
|
566
566
|
}
|
|
567
567
|
},
|
|
@@ -600,30 +600,40 @@
|
|
|
600
600
|
}
|
|
601
601
|
},
|
|
602
602
|
{
|
|
603
|
-
"name": "
|
|
604
|
-
"description": "
|
|
603
|
+
"name": "allRowsVisible",
|
|
604
|
+
"description": "If true, the grid's height is defined by its rows.\n\nEffectively, this disables the grid's virtual scrolling so that all the rows are rendered in the DOM at once.\nIf the grid has a large number of items, using the feature is discouraged to avoid performance issues.",
|
|
605
605
|
"value": {
|
|
606
606
|
"type": [
|
|
607
|
-
"
|
|
607
|
+
"boolean"
|
|
608
|
+
]
|
|
609
|
+
}
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
"name": "cellPartNameGenerator",
|
|
613
|
+
"description": "A function that allows generating CSS `part` names for grid cells in Shadow DOM based\non their row and column, for styling from outside using the `::part()` selector.\n\nThe return value should be the generated part name as a string, or multiple part names\nseparated by whitespace characters.\n\nReceives two arguments:\n- `column` The `<vaadin-grid-column>` element (`undefined` for details-cell).\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.",
|
|
614
|
+
"value": {
|
|
615
|
+
"type": [
|
|
616
|
+
"GridCellPartNameGenerator",
|
|
617
|
+
"null",
|
|
608
618
|
"undefined"
|
|
609
619
|
]
|
|
610
620
|
}
|
|
611
621
|
},
|
|
612
622
|
{
|
|
613
|
-
"name": "
|
|
614
|
-
"description": "
|
|
623
|
+
"name": "columnRendering",
|
|
624
|
+
"description": "Allows you to choose between modes for rendering columns in the grid:\n\n\"eager\" (default): All columns are rendered upfront, regardless of their visibility within the viewport.\nThis mode should generally be preferred, as it avoids the limitations imposed by the \"lazy\" mode.\nUse this mode unless the grid has a large number of columns and performance outweighs the limitations\nin priority.\n\n\"lazy\": Optimizes the rendering of cells when there are multiple columns in the grid by virtualizing\nhorizontal scrolling. In this mode, body cells are rendered only when their corresponding columns are\ninside the visible viewport.\n\nUsing \"lazy\" rendering should be used only if you're dealing with a large number of columns and performance\nis your highest priority. For most use cases, the default \"eager\" mode is recommended due to the\nlimitations imposed by the \"lazy\" mode.\n\nWhen using the \"lazy\" mode, keep the following limitations in mind:\n\n- Row Height: When only a number of columns are visible at once, the height of a row can only be that of\nthe highest cell currently visible on that row. Make sure each cell on a single row has the same height\nas all other cells on that row. If row cells have different heights, users may experience jumpiness when\nscrolling the grid horizontally as lazily rendered cells with different heights are scrolled into view.\n\n- Auto-width Columns: For the columns that are initially outside the visible viewport but still use auto-width,\nonly the header content is taken into account when calculating the column width because the body cells\nof the columns outside the viewport are not initially rendered.\n\n- Screen Reader Compatibility: Screen readers may not be able to associate the focused cells with the correct\nheaders when only a subset of the body cells on a row is rendered.\n\n- Keyboard Navigation: Tabbing through focusable elements inside the grid body may not work as expected because\nsome of the columns that would include focusable elements in the body cells may be outside the visible viewport\nand thus not rendered.",
|
|
615
625
|
"value": {
|
|
616
626
|
"type": [
|
|
617
|
-
"
|
|
627
|
+
"ColumnRendering"
|
|
618
628
|
]
|
|
619
629
|
}
|
|
620
630
|
},
|
|
621
631
|
{
|
|
622
|
-
"name": "
|
|
623
|
-
"description": "
|
|
632
|
+
"name": "columnReorderingAllowed",
|
|
633
|
+
"description": "Set to true to allow column reordering.",
|
|
624
634
|
"value": {
|
|
625
635
|
"type": [
|
|
626
|
-
"
|
|
636
|
+
"boolean"
|
|
627
637
|
]
|
|
628
638
|
}
|
|
629
639
|
},
|
|
@@ -639,68 +649,72 @@
|
|
|
639
649
|
}
|
|
640
650
|
},
|
|
641
651
|
{
|
|
642
|
-
"name": "
|
|
643
|
-
"description": "
|
|
652
|
+
"name": "detailsOpenedItems",
|
|
653
|
+
"description": "An array containing references to items with open row details.",
|
|
644
654
|
"value": {
|
|
645
655
|
"type": [
|
|
646
|
-
"
|
|
647
|
-
"null",
|
|
648
|
-
"undefined"
|
|
656
|
+
"Array.<GridItem>"
|
|
649
657
|
]
|
|
650
658
|
}
|
|
651
659
|
},
|
|
652
660
|
{
|
|
653
|
-
"name": "
|
|
654
|
-
"description": "
|
|
661
|
+
"name": "dragFilter",
|
|
662
|
+
"description": "A function that filters dragging of specific grid rows. The return value should be false\nif dragging of the row should be disabled.\n\nReceives one argument:\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.",
|
|
655
663
|
"value": {
|
|
656
664
|
"type": [
|
|
657
|
-
"
|
|
665
|
+
"GridDragAndDropFilter",
|
|
658
666
|
"null",
|
|
659
667
|
"undefined"
|
|
660
668
|
]
|
|
661
669
|
}
|
|
662
670
|
},
|
|
663
671
|
{
|
|
664
|
-
"name": "
|
|
665
|
-
"description": "
|
|
672
|
+
"name": "dropFilter",
|
|
673
|
+
"description": "A function that filters dropping on specific grid rows. The return value should be false\nif dropping on the row should be disabled.\n\nReceives one argument:\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.",
|
|
666
674
|
"value": {
|
|
667
675
|
"type": [
|
|
668
|
-
"
|
|
676
|
+
"GridDragAndDropFilter",
|
|
677
|
+
"null",
|
|
678
|
+
"undefined"
|
|
669
679
|
]
|
|
670
680
|
}
|
|
671
681
|
},
|
|
672
682
|
{
|
|
673
|
-
"name": "
|
|
674
|
-
"description": "
|
|
683
|
+
"name": "dropMode",
|
|
684
|
+
"description": "Defines the locations within the Grid row where an element can be dropped.\n\nPossible values are:\n- `between`: The drop event can happen between Grid rows.\n- `on-top`: The drop event can happen on top of Grid rows.\n- `on-top-or-between`: The drop event can happen either on top of or between Grid rows.\n- `on-grid`: The drop event will not happen on any specific row, it will show the drop target outline around the whole grid.",
|
|
675
685
|
"value": {
|
|
676
686
|
"type": [
|
|
677
|
-
"
|
|
687
|
+
"GridDropMode",
|
|
688
|
+
"null",
|
|
689
|
+
"undefined"
|
|
678
690
|
]
|
|
679
691
|
}
|
|
680
692
|
},
|
|
681
693
|
{
|
|
682
|
-
"name": "
|
|
683
|
-
"description": "
|
|
694
|
+
"name": "editOnClick",
|
|
695
|
+
"description": "When true, the grid enters cell edit mode on a single click\ninstead of the default double click.",
|
|
684
696
|
"value": {
|
|
685
697
|
"type": [
|
|
686
|
-
"
|
|
698
|
+
"boolean",
|
|
687
699
|
"null",
|
|
688
700
|
"undefined"
|
|
689
701
|
]
|
|
690
702
|
}
|
|
691
703
|
},
|
|
692
704
|
{
|
|
693
|
-
"name": "
|
|
694
|
-
"description": "
|
|
705
|
+
"name": "enterNextRow",
|
|
706
|
+
"description": "When true, pressing Enter while in cell edit mode\nwill move focus to the editable cell in the next row\n(Shift + Enter - same, but for previous row).",
|
|
695
707
|
"value": {
|
|
696
708
|
"type": [
|
|
697
|
-
"
|
|
709
|
+
"boolean",
|
|
710
|
+
"null",
|
|
711
|
+
"undefined"
|
|
698
712
|
]
|
|
699
713
|
}
|
|
700
714
|
},
|
|
701
715
|
{
|
|
702
|
-
"name": "
|
|
703
|
-
"description": "An array that contains the
|
|
716
|
+
"name": "expandedItems",
|
|
717
|
+
"description": "An array that contains the expanded items.",
|
|
704
718
|
"value": {
|
|
705
719
|
"type": [
|
|
706
720
|
"Array.<GridItem>"
|
|
@@ -719,17 +733,19 @@
|
|
|
719
733
|
}
|
|
720
734
|
},
|
|
721
735
|
{
|
|
722
|
-
"name": "
|
|
723
|
-
"description": "
|
|
736
|
+
"name": "itemHasChildrenPath",
|
|
737
|
+
"description": "Path to an item sub-property that indicates whether the item has child items.",
|
|
724
738
|
"value": {
|
|
725
739
|
"type": [
|
|
726
|
-
"
|
|
740
|
+
"string",
|
|
741
|
+
"null",
|
|
742
|
+
"undefined"
|
|
727
743
|
]
|
|
728
744
|
}
|
|
729
745
|
},
|
|
730
746
|
{
|
|
731
|
-
"name": "
|
|
732
|
-
"description": "
|
|
747
|
+
"name": "itemIdPath",
|
|
748
|
+
"description": "Path to an item sub-property that identifies the item.",
|
|
733
749
|
"value": {
|
|
734
750
|
"type": [
|
|
735
751
|
"string",
|
|
@@ -739,17 +755,18 @@
|
|
|
739
755
|
}
|
|
740
756
|
},
|
|
741
757
|
{
|
|
742
|
-
"name": "
|
|
743
|
-
"description": "
|
|
758
|
+
"name": "items",
|
|
759
|
+
"description": "An array containing the items which will be passed to renderer functions.",
|
|
744
760
|
"value": {
|
|
745
761
|
"type": [
|
|
746
|
-
"
|
|
762
|
+
"Array.<GridItem>",
|
|
763
|
+
"undefined"
|
|
747
764
|
]
|
|
748
765
|
}
|
|
749
766
|
},
|
|
750
767
|
{
|
|
751
|
-
"name": "
|
|
752
|
-
"description": "
|
|
768
|
+
"name": "multiSort",
|
|
769
|
+
"description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
|
|
753
770
|
"value": {
|
|
754
771
|
"type": [
|
|
755
772
|
"boolean"
|
|
@@ -757,77 +774,62 @@
|
|
|
757
774
|
}
|
|
758
775
|
},
|
|
759
776
|
{
|
|
760
|
-
"name": "
|
|
761
|
-
"description": "
|
|
777
|
+
"name": "multiSortOnShiftClick",
|
|
778
|
+
"description": "When `true`, Shift-clicking an unsorted column's sorter adds it to the multi-sort.\nShift + Space does the same action via keyboard. This property has precedence over the\n`multiSort` property. If `multiSortOnShiftClick` is true, the multiSort property is effectively ignored.",
|
|
762
779
|
"value": {
|
|
763
780
|
"type": [
|
|
764
|
-
"
|
|
765
|
-
"null",
|
|
766
|
-
"undefined"
|
|
781
|
+
"boolean"
|
|
767
782
|
]
|
|
768
783
|
}
|
|
769
784
|
},
|
|
770
785
|
{
|
|
771
|
-
"name": "
|
|
772
|
-
"description": "
|
|
786
|
+
"name": "multiSortPriority",
|
|
787
|
+
"description": "Controls how columns are added to the sort order when using multi-sort.\nThe sort order is visually indicated by numbers in grid sorters placed in column headers.\n\nBy default, whenever an unsorted column is sorted, or the sort-direction of a column is\nchanged, that column gets sort priority 1, thus affecting the priority for all the other\nsorted columns. This is identical to using `multi-sort-priority=\"prepend\"`.\n\nUsing this property allows to change this behavior so that sorting an unsorted column\nwould add it to the \"end\" of the sort, and changing column's sort direction would retain\nit's previous priority. To set this, use `multi-sort-priority=\"append\"`.",
|
|
773
788
|
"value": {
|
|
774
789
|
"type": [
|
|
775
|
-
"
|
|
790
|
+
"string",
|
|
776
791
|
"null",
|
|
777
792
|
"undefined"
|
|
778
793
|
]
|
|
779
794
|
}
|
|
780
795
|
},
|
|
781
796
|
{
|
|
782
|
-
"name": "
|
|
783
|
-
"description": "
|
|
797
|
+
"name": "pageSize",
|
|
798
|
+
"description": "Number of items fetched at a time from the dataprovider.",
|
|
784
799
|
"value": {
|
|
785
800
|
"type": [
|
|
786
|
-
"
|
|
787
|
-
"null",
|
|
788
|
-
"undefined"
|
|
801
|
+
"number"
|
|
789
802
|
]
|
|
790
803
|
}
|
|
791
804
|
},
|
|
792
805
|
{
|
|
793
|
-
"name": "
|
|
794
|
-
"description": "
|
|
806
|
+
"name": "rowDetailsRenderer",
|
|
807
|
+
"description": "Custom function for rendering the content of the row details.\nReceives three arguments:\n\n- `root` The row details content DOM element. Append your content to it.\n- `grid` The `<vaadin-grid>` element.\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.level` The number of the item's tree sublevel, starts from 0.\n - `model.expanded` True if the item's tree sublevel is expanded.\n - `model.selected` True if the item is selected.",
|
|
795
808
|
"value": {
|
|
796
809
|
"type": [
|
|
797
|
-
"
|
|
810
|
+
"GridRowDetailsRenderer",
|
|
798
811
|
"null",
|
|
799
812
|
"undefined"
|
|
800
813
|
]
|
|
801
814
|
}
|
|
802
815
|
},
|
|
803
816
|
{
|
|
804
|
-
"name": "
|
|
805
|
-
"description": "
|
|
817
|
+
"name": "rowsDraggable",
|
|
818
|
+
"description": "Marks the grid's rows to be available for dragging.",
|
|
806
819
|
"value": {
|
|
807
820
|
"type": [
|
|
808
|
-
"
|
|
821
|
+
"boolean",
|
|
809
822
|
"null",
|
|
810
823
|
"undefined"
|
|
811
824
|
]
|
|
812
825
|
}
|
|
813
826
|
},
|
|
814
827
|
{
|
|
815
|
-
"name": "
|
|
816
|
-
"description": "
|
|
817
|
-
"value": {
|
|
818
|
-
"type": [
|
|
819
|
-
"boolean"
|
|
820
|
-
]
|
|
821
|
-
}
|
|
822
|
-
},
|
|
823
|
-
{
|
|
824
|
-
"name": "enterNextRow",
|
|
825
|
-
"description": "When true, pressing Enter while in cell edit mode\nwill move focus to the editable cell in the next row\n(Shift + Enter - same, but for previous row).",
|
|
828
|
+
"name": "selectedItems",
|
|
829
|
+
"description": "An array that contains the selected items.",
|
|
826
830
|
"value": {
|
|
827
831
|
"type": [
|
|
828
|
-
"
|
|
829
|
-
"null",
|
|
830
|
-
"undefined"
|
|
832
|
+
"Array.<GridItem>"
|
|
831
833
|
]
|
|
832
834
|
}
|
|
833
835
|
},
|
|
@@ -843,13 +845,11 @@
|
|
|
843
845
|
}
|
|
844
846
|
},
|
|
845
847
|
{
|
|
846
|
-
"name": "
|
|
847
|
-
"description": "
|
|
848
|
+
"name": "size",
|
|
849
|
+
"description": "The number of root-level items in the grid.",
|
|
848
850
|
"value": {
|
|
849
851
|
"type": [
|
|
850
|
-
"
|
|
851
|
-
"null",
|
|
852
|
-
"undefined"
|
|
852
|
+
"number"
|
|
853
853
|
]
|
|
854
854
|
}
|
|
855
855
|
}
|
|
@@ -864,32 +864,32 @@
|
|
|
864
864
|
"description": "Fired when the cell is activated with click or keyboard."
|
|
865
865
|
},
|
|
866
866
|
{
|
|
867
|
-
"name": "
|
|
868
|
-
"description": "Fired when
|
|
867
|
+
"name": "cell-edit-started",
|
|
868
|
+
"description": "Fired when the user starts editing a grid cell."
|
|
869
869
|
},
|
|
870
870
|
{
|
|
871
|
-
"name": "
|
|
872
|
-
"description": "Fired when
|
|
871
|
+
"name": "cell-focus",
|
|
872
|
+
"description": "Fired when a cell is focused with click or keyboard navigation.\n\nUse context property of @see {@link GridCellFocusEvent} to get detail information about the event."
|
|
873
873
|
},
|
|
874
874
|
{
|
|
875
|
-
"name": "
|
|
876
|
-
"description": "Fired when the
|
|
875
|
+
"name": "column-reorder",
|
|
876
|
+
"description": "Fired when the columns in the grid are reordered."
|
|
877
877
|
},
|
|
878
878
|
{
|
|
879
|
-
"name": "
|
|
880
|
-
"description": "Fired when
|
|
879
|
+
"name": "column-resize",
|
|
880
|
+
"description": "Fired when a column in the grid is resized by the user."
|
|
881
881
|
},
|
|
882
882
|
{
|
|
883
|
-
"name": "
|
|
884
|
-
"description": "Fired when the `
|
|
883
|
+
"name": "data-provider-changed",
|
|
884
|
+
"description": "Fired when the `dataProvider` property changes."
|
|
885
885
|
},
|
|
886
886
|
{
|
|
887
|
-
"name": "
|
|
888
|
-
"description": "Fired when
|
|
887
|
+
"name": "enter-next-row-changed",
|
|
888
|
+
"description": "Fired when the `enterNextRow` property changes."
|
|
889
889
|
},
|
|
890
890
|
{
|
|
891
|
-
"name": "
|
|
892
|
-
"description": "Fired when the
|
|
891
|
+
"name": "expanded-items-changed",
|
|
892
|
+
"description": "Fired when the `expandedItems` property changes."
|
|
893
893
|
},
|
|
894
894
|
{
|
|
895
895
|
"name": "grid-dragend",
|
|
@@ -903,29 +903,29 @@
|
|
|
903
903
|
"name": "grid-drop",
|
|
904
904
|
"description": "Fired when a drop occurs on top of the grid."
|
|
905
905
|
},
|
|
906
|
-
{
|
|
907
|
-
"name": "cell-edit-started",
|
|
908
|
-
"description": "Fired when the user starts editing a grid cell."
|
|
909
|
-
},
|
|
910
906
|
{
|
|
911
907
|
"name": "item-property-changed",
|
|
912
908
|
"description": "Fired before exiting the cell edit mode, if the value has been changed.\nIf the default is prevented, value change would not be applied."
|
|
913
909
|
},
|
|
914
910
|
{
|
|
915
|
-
"name": "
|
|
916
|
-
"description": "Fired when the
|
|
911
|
+
"name": "item-toggle",
|
|
912
|
+
"description": "Fired when the user selects or deselects an item through the selection column."
|
|
917
913
|
},
|
|
918
914
|
{
|
|
919
|
-
"name": "
|
|
920
|
-
"description": "Fired when the `
|
|
915
|
+
"name": "loading-changed",
|
|
916
|
+
"description": "Fired when the `loading` property changes."
|
|
921
917
|
},
|
|
922
918
|
{
|
|
923
|
-
"name": "
|
|
924
|
-
"description": "Fired when the `
|
|
919
|
+
"name": "selected-items-changed",
|
|
920
|
+
"description": "Fired when the `selectedItems` property changes."
|
|
925
921
|
},
|
|
926
922
|
{
|
|
927
923
|
"name": "single-cell-edit-changed",
|
|
928
924
|
"description": "Fired when the `singleCellEdit` property changes."
|
|
925
|
+
},
|
|
926
|
+
{
|
|
927
|
+
"name": "size-changed",
|
|
928
|
+
"description": "Fired when the `size` property changes."
|
|
929
929
|
}
|
|
930
930
|
]
|
|
931
931
|
}
|