@vaadin/grid-pro 25.1.0-alpha8 → 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.lit.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
|
"framework": "lit",
|
|
7
7
|
"framework-config": {
|
|
@@ -20,8 +20,8 @@
|
|
|
20
20
|
"extension": true,
|
|
21
21
|
"attributes": [
|
|
22
22
|
{
|
|
23
|
-
"name": "?
|
|
24
|
-
"description": "
|
|
23
|
+
"name": "?autoWidth",
|
|
24
|
+
"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.",
|
|
25
25
|
"value": {
|
|
26
26
|
"kind": "expression"
|
|
27
27
|
}
|
|
@@ -41,127 +41,127 @@
|
|
|
41
41
|
}
|
|
42
42
|
},
|
|
43
43
|
{
|
|
44
|
-
"name": "?
|
|
45
|
-
"description": "When true, the cells for this column
|
|
44
|
+
"name": "?hidden",
|
|
45
|
+
"description": "When set to true, the cells for this column are hidden.",
|
|
46
46
|
"value": {
|
|
47
47
|
"kind": "expression"
|
|
48
48
|
}
|
|
49
49
|
},
|
|
50
50
|
{
|
|
51
|
-
"name": "?
|
|
52
|
-
"description": "When set to true, the
|
|
51
|
+
"name": "?resizable",
|
|
52
|
+
"description": "When set to true, the column is user-resizable.",
|
|
53
53
|
"value": {
|
|
54
54
|
"kind": "expression"
|
|
55
55
|
}
|
|
56
56
|
},
|
|
57
57
|
{
|
|
58
|
-
"name": "?
|
|
59
|
-
"description": "
|
|
58
|
+
"name": "?rowHeader",
|
|
59
|
+
"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.",
|
|
60
60
|
"value": {
|
|
61
61
|
"kind": "expression"
|
|
62
62
|
}
|
|
63
63
|
},
|
|
64
64
|
{
|
|
65
|
-
"name": ".
|
|
66
|
-
"description": "
|
|
65
|
+
"name": ".editModeRenderer",
|
|
66
|
+
"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.",
|
|
67
67
|
"value": {
|
|
68
68
|
"kind": "expression"
|
|
69
69
|
}
|
|
70
70
|
},
|
|
71
71
|
{
|
|
72
|
-
"name": ".
|
|
73
|
-
"description": "
|
|
72
|
+
"name": ".editorOptions",
|
|
73
|
+
"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.",
|
|
74
74
|
"value": {
|
|
75
75
|
"kind": "expression"
|
|
76
76
|
}
|
|
77
77
|
},
|
|
78
78
|
{
|
|
79
|
-
"name": ".
|
|
80
|
-
"description": "
|
|
79
|
+
"name": ".editorType",
|
|
80
|
+
"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.",
|
|
81
81
|
"value": {
|
|
82
82
|
"kind": "expression"
|
|
83
83
|
}
|
|
84
84
|
},
|
|
85
85
|
{
|
|
86
|
-
"name": ".
|
|
87
|
-
"description": "
|
|
86
|
+
"name": ".editorValuePath",
|
|
87
|
+
"description": "Path of the property used for the value of the editor component.",
|
|
88
88
|
"value": {
|
|
89
89
|
"kind": "expression"
|
|
90
90
|
}
|
|
91
91
|
},
|
|
92
92
|
{
|
|
93
|
-
"name": ".
|
|
94
|
-
"description": "
|
|
93
|
+
"name": ".flexGrow",
|
|
94
|
+
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
95
95
|
"value": {
|
|
96
96
|
"kind": "expression"
|
|
97
97
|
}
|
|
98
98
|
},
|
|
99
99
|
{
|
|
100
|
-
"name": ".
|
|
101
|
-
"description": "Custom
|
|
100
|
+
"name": ".footerPartName",
|
|
101
|
+
"description": "Custom part name for the footer cell.",
|
|
102
102
|
"value": {
|
|
103
103
|
"kind": "expression"
|
|
104
104
|
}
|
|
105
105
|
},
|
|
106
106
|
{
|
|
107
|
-
"name": ".
|
|
108
|
-
"description": "
|
|
107
|
+
"name": ".footerRenderer",
|
|
108
|
+
"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.",
|
|
109
109
|
"value": {
|
|
110
110
|
"kind": "expression"
|
|
111
111
|
}
|
|
112
112
|
},
|
|
113
113
|
{
|
|
114
|
-
"name": ".
|
|
115
|
-
"description": "
|
|
114
|
+
"name": ".header",
|
|
115
|
+
"description": "Text content to display in the header cell of the column.",
|
|
116
116
|
"value": {
|
|
117
117
|
"kind": "expression"
|
|
118
118
|
}
|
|
119
119
|
},
|
|
120
120
|
{
|
|
121
|
-
"name": ".
|
|
122
|
-
"description": "Custom
|
|
121
|
+
"name": ".headerPartName",
|
|
122
|
+
"description": "Custom part name for the header cell.",
|
|
123
123
|
"value": {
|
|
124
124
|
"kind": "expression"
|
|
125
125
|
}
|
|
126
126
|
},
|
|
127
127
|
{
|
|
128
|
-
"name": ".
|
|
129
|
-
"description": "
|
|
128
|
+
"name": ".headerRenderer",
|
|
129
|
+
"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.",
|
|
130
130
|
"value": {
|
|
131
131
|
"kind": "expression"
|
|
132
132
|
}
|
|
133
133
|
},
|
|
134
134
|
{
|
|
135
|
-
"name": ".
|
|
136
|
-
"description": "
|
|
135
|
+
"name": ".isCellEditable",
|
|
136
|
+
"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.",
|
|
137
137
|
"value": {
|
|
138
138
|
"kind": "expression"
|
|
139
139
|
}
|
|
140
140
|
},
|
|
141
141
|
{
|
|
142
|
-
"name": ".
|
|
143
|
-
"description": "
|
|
142
|
+
"name": ".path",
|
|
143
|
+
"description": "JS Path of the property in the item used for the editable content.",
|
|
144
144
|
"value": {
|
|
145
145
|
"kind": "expression"
|
|
146
146
|
}
|
|
147
147
|
},
|
|
148
148
|
{
|
|
149
|
-
"name": ".
|
|
150
|
-
"description": "
|
|
149
|
+
"name": ".renderer",
|
|
150
|
+
"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.",
|
|
151
151
|
"value": {
|
|
152
152
|
"kind": "expression"
|
|
153
153
|
}
|
|
154
154
|
},
|
|
155
155
|
{
|
|
156
|
-
"name": ".
|
|
157
|
-
"description": "
|
|
156
|
+
"name": ".textAlign",
|
|
157
|
+
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
158
158
|
"value": {
|
|
159
159
|
"kind": "expression"
|
|
160
160
|
}
|
|
161
161
|
},
|
|
162
162
|
{
|
|
163
|
-
"name": ".
|
|
164
|
-
"description": "
|
|
163
|
+
"name": ".width",
|
|
164
|
+
"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.",
|
|
165
165
|
"value": {
|
|
166
166
|
"kind": "expression"
|
|
167
167
|
}
|
|
@@ -177,61 +177,61 @@
|
|
|
177
177
|
},
|
|
178
178
|
{
|
|
179
179
|
"name": "vaadin-grid-pro",
|
|
180
|
-
"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-
|
|
180
|
+
"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).",
|
|
181
181
|
"extension": true,
|
|
182
182
|
"attributes": [
|
|
183
183
|
{
|
|
184
|
-
"name": "?
|
|
185
|
-
"description": "
|
|
184
|
+
"name": "?allRowsVisible",
|
|
185
|
+
"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.",
|
|
186
186
|
"value": {
|
|
187
187
|
"kind": "expression"
|
|
188
188
|
}
|
|
189
189
|
},
|
|
190
190
|
{
|
|
191
|
-
"name": "?
|
|
192
|
-
"description": "
|
|
191
|
+
"name": "?columnReorderingAllowed",
|
|
192
|
+
"description": "Set to true to allow column reordering.",
|
|
193
193
|
"value": {
|
|
194
194
|
"kind": "expression"
|
|
195
195
|
}
|
|
196
196
|
},
|
|
197
197
|
{
|
|
198
|
-
"name": "?
|
|
199
|
-
"description": "
|
|
198
|
+
"name": "?editOnClick",
|
|
199
|
+
"description": "When true, the grid enters cell edit mode on a single click\ninstead of the default double click.",
|
|
200
200
|
"value": {
|
|
201
201
|
"kind": "expression"
|
|
202
202
|
}
|
|
203
203
|
},
|
|
204
204
|
{
|
|
205
|
-
"name": "?
|
|
206
|
-
"description": "
|
|
205
|
+
"name": "?enterNextRow",
|
|
206
|
+
"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).",
|
|
207
207
|
"value": {
|
|
208
208
|
"kind": "expression"
|
|
209
209
|
}
|
|
210
210
|
},
|
|
211
211
|
{
|
|
212
|
-
"name": "?
|
|
213
|
-
"description": "
|
|
212
|
+
"name": "?multiSort",
|
|
213
|
+
"description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
|
|
214
214
|
"value": {
|
|
215
215
|
"kind": "expression"
|
|
216
216
|
}
|
|
217
217
|
},
|
|
218
218
|
{
|
|
219
|
-
"name": "?
|
|
220
|
-
"description": "When true
|
|
219
|
+
"name": "?multiSortOnShiftClick",
|
|
220
|
+
"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.",
|
|
221
221
|
"value": {
|
|
222
222
|
"kind": "expression"
|
|
223
223
|
}
|
|
224
224
|
},
|
|
225
225
|
{
|
|
226
|
-
"name": "?
|
|
227
|
-
"description": "
|
|
226
|
+
"name": "?rowsDraggable",
|
|
227
|
+
"description": "Marks the grid's rows to be available for dragging.",
|
|
228
228
|
"value": {
|
|
229
229
|
"kind": "expression"
|
|
230
230
|
}
|
|
231
231
|
},
|
|
232
232
|
{
|
|
233
|
-
"name": "?
|
|
234
|
-
"description": "When true,
|
|
233
|
+
"name": "?singleCellEdit",
|
|
234
|
+
"description": "When true, after moving to next or previous editable cell using\nTab / Shift+Tab, it will be focused without edit mode.\n\nWhen `enterNextRow` is true, pressing Enter will also\npreserve edit mode, otherwise, it will have no effect.",
|
|
235
235
|
"value": {
|
|
236
236
|
"kind": "expression"
|
|
237
237
|
}
|
|
@@ -251,85 +251,85 @@
|
|
|
251
251
|
}
|
|
252
252
|
},
|
|
253
253
|
{
|
|
254
|
-
"name": ".
|
|
255
|
-
"description": "
|
|
254
|
+
"name": ".cellPartNameGenerator",
|
|
255
|
+
"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.",
|
|
256
256
|
"value": {
|
|
257
257
|
"kind": "expression"
|
|
258
258
|
}
|
|
259
259
|
},
|
|
260
260
|
{
|
|
261
|
-
"name": ".
|
|
262
|
-
"description": "
|
|
261
|
+
"name": ".columnRendering",
|
|
262
|
+
"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.",
|
|
263
263
|
"value": {
|
|
264
264
|
"kind": "expression"
|
|
265
265
|
}
|
|
266
266
|
},
|
|
267
267
|
{
|
|
268
|
-
"name": ".
|
|
269
|
-
"description": "
|
|
268
|
+
"name": ".dataProvider",
|
|
269
|
+
"description": "Function that provides items lazily. Receives arguments `params`, `callback`\n\n`params.page` Requested page index\n\n`params.pageSize` Current page size\n\n`params.filters` Currently applied filters\n\n`params.sortOrders` Currently applied sorting orders\n\n`params.parentItem` When tree is used, and sublevel items\nare requested, reference to parent item of the requested sublevel.\nOtherwise `undefined`.\n\n`callback(items, size)` Callback function with arguments:\n - `items` Current page of items\n - `size` Total number of items. When tree sublevel items\n are requested, total number of items in the requested sublevel.\n Optional when tree is not used, required for tree.",
|
|
270
270
|
"value": {
|
|
271
271
|
"kind": "expression"
|
|
272
272
|
}
|
|
273
273
|
},
|
|
274
274
|
{
|
|
275
|
-
"name": ".
|
|
276
|
-
"description": "
|
|
275
|
+
"name": ".detailsOpenedItems",
|
|
276
|
+
"description": "An array containing references to items with open row details.",
|
|
277
277
|
"value": {
|
|
278
278
|
"kind": "expression"
|
|
279
279
|
}
|
|
280
280
|
},
|
|
281
281
|
{
|
|
282
|
-
"name": ".
|
|
283
|
-
"description": "
|
|
282
|
+
"name": ".dragFilter",
|
|
283
|
+
"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.",
|
|
284
284
|
"value": {
|
|
285
285
|
"kind": "expression"
|
|
286
286
|
}
|
|
287
287
|
},
|
|
288
288
|
{
|
|
289
|
-
"name": ".
|
|
290
|
-
"description": "
|
|
289
|
+
"name": ".dropFilter",
|
|
290
|
+
"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.",
|
|
291
291
|
"value": {
|
|
292
292
|
"kind": "expression"
|
|
293
293
|
}
|
|
294
294
|
},
|
|
295
295
|
{
|
|
296
|
-
"name": ".
|
|
297
|
-
"description": "
|
|
296
|
+
"name": ".dropMode",
|
|
297
|
+
"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.",
|
|
298
298
|
"value": {
|
|
299
299
|
"kind": "expression"
|
|
300
300
|
}
|
|
301
301
|
},
|
|
302
302
|
{
|
|
303
|
-
"name": ".
|
|
304
|
-
"description": "An array
|
|
303
|
+
"name": ".expandedItems",
|
|
304
|
+
"description": "An array that contains the expanded items.",
|
|
305
305
|
"value": {
|
|
306
306
|
"kind": "expression"
|
|
307
307
|
}
|
|
308
308
|
},
|
|
309
309
|
{
|
|
310
|
-
"name": ".
|
|
311
|
-
"description": "
|
|
310
|
+
"name": ".isItemSelectable",
|
|
311
|
+
"description": "A function to check whether a specific item in the grid may be\nselected or deselected by the user. Used by the selection column to\nconditionally enable to disable checkboxes for individual items. This\nfunction does not prevent programmatic selection/deselection of\nitems. Changing the function does not modify the currently selected\nitems.\n\nConfiguring this function hides the select all checkbox of the grid\nselection column, which means users can not select or deselect all\nitems anymore, nor do they get feedback on whether all items are\nselected or not.\n\nReceives an item instance and should return a boolean indicating\nwhether users may change the selection state of that item.",
|
|
312
312
|
"value": {
|
|
313
313
|
"kind": "expression"
|
|
314
314
|
}
|
|
315
315
|
},
|
|
316
316
|
{
|
|
317
|
-
"name": ".
|
|
318
|
-
"description": "
|
|
317
|
+
"name": ".itemHasChildrenPath",
|
|
318
|
+
"description": "Path to an item sub-property that indicates whether the item has child items.",
|
|
319
319
|
"value": {
|
|
320
320
|
"kind": "expression"
|
|
321
321
|
}
|
|
322
322
|
},
|
|
323
323
|
{
|
|
324
|
-
"name": ".
|
|
325
|
-
"description": "
|
|
324
|
+
"name": ".itemIdPath",
|
|
325
|
+
"description": "Path to an item sub-property that identifies the item.",
|
|
326
326
|
"value": {
|
|
327
327
|
"kind": "expression"
|
|
328
328
|
}
|
|
329
329
|
},
|
|
330
330
|
{
|
|
331
|
-
"name": ".
|
|
332
|
-
"description": "
|
|
331
|
+
"name": ".items",
|
|
332
|
+
"description": "An array containing the items which will be passed to renderer functions.",
|
|
333
333
|
"value": {
|
|
334
334
|
"kind": "expression"
|
|
335
335
|
}
|
|
@@ -342,29 +342,29 @@
|
|
|
342
342
|
}
|
|
343
343
|
},
|
|
344
344
|
{
|
|
345
|
-
"name": ".
|
|
346
|
-
"description": "
|
|
345
|
+
"name": ".pageSize",
|
|
346
|
+
"description": "Number of items fetched at a time from the dataprovider.",
|
|
347
347
|
"value": {
|
|
348
348
|
"kind": "expression"
|
|
349
349
|
}
|
|
350
350
|
},
|
|
351
351
|
{
|
|
352
|
-
"name": ".
|
|
353
|
-
"description": "
|
|
352
|
+
"name": ".rowDetailsRenderer",
|
|
353
|
+
"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.",
|
|
354
354
|
"value": {
|
|
355
355
|
"kind": "expression"
|
|
356
356
|
}
|
|
357
357
|
},
|
|
358
358
|
{
|
|
359
|
-
"name": ".
|
|
360
|
-
"description": "
|
|
359
|
+
"name": ".selectedItems",
|
|
360
|
+
"description": "An array that contains the selected items.",
|
|
361
361
|
"value": {
|
|
362
362
|
"kind": "expression"
|
|
363
363
|
}
|
|
364
364
|
},
|
|
365
365
|
{
|
|
366
|
-
"name": ".
|
|
367
|
-
"description": "
|
|
366
|
+
"name": ".size",
|
|
367
|
+
"description": "The number of root-level items in the grid.",
|
|
368
368
|
"value": {
|
|
369
369
|
"kind": "expression"
|
|
370
370
|
}
|
|
@@ -384,50 +384,50 @@
|
|
|
384
384
|
}
|
|
385
385
|
},
|
|
386
386
|
{
|
|
387
|
-
"name": "@
|
|
388
|
-
"description": "Fired when
|
|
387
|
+
"name": "@cell-edit-started",
|
|
388
|
+
"description": "Fired when the user starts editing a grid cell.",
|
|
389
389
|
"value": {
|
|
390
390
|
"kind": "expression"
|
|
391
391
|
}
|
|
392
392
|
},
|
|
393
393
|
{
|
|
394
|
-
"name": "@
|
|
395
|
-
"description": "Fired when
|
|
394
|
+
"name": "@cell-focus",
|
|
395
|
+
"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.",
|
|
396
396
|
"value": {
|
|
397
397
|
"kind": "expression"
|
|
398
398
|
}
|
|
399
399
|
},
|
|
400
400
|
{
|
|
401
|
-
"name": "@
|
|
402
|
-
"description": "Fired when the
|
|
401
|
+
"name": "@column-reorder",
|
|
402
|
+
"description": "Fired when the columns in the grid are reordered.",
|
|
403
403
|
"value": {
|
|
404
404
|
"kind": "expression"
|
|
405
405
|
}
|
|
406
406
|
},
|
|
407
407
|
{
|
|
408
|
-
"name": "@
|
|
409
|
-
"description": "Fired when
|
|
408
|
+
"name": "@column-resize",
|
|
409
|
+
"description": "Fired when a column in the grid is resized by the user.",
|
|
410
410
|
"value": {
|
|
411
411
|
"kind": "expression"
|
|
412
412
|
}
|
|
413
413
|
},
|
|
414
414
|
{
|
|
415
|
-
"name": "@
|
|
416
|
-
"description": "Fired when the `
|
|
415
|
+
"name": "@data-provider-changed",
|
|
416
|
+
"description": "Fired when the `dataProvider` property changes.",
|
|
417
417
|
"value": {
|
|
418
418
|
"kind": "expression"
|
|
419
419
|
}
|
|
420
420
|
},
|
|
421
421
|
{
|
|
422
|
-
"name": "@
|
|
423
|
-
"description": "Fired when
|
|
422
|
+
"name": "@enter-next-row-changed",
|
|
423
|
+
"description": "Fired when the `enterNextRow` property changes.",
|
|
424
424
|
"value": {
|
|
425
425
|
"kind": "expression"
|
|
426
426
|
}
|
|
427
427
|
},
|
|
428
428
|
{
|
|
429
|
-
"name": "@
|
|
430
|
-
"description": "Fired when the
|
|
429
|
+
"name": "@expanded-items-changed",
|
|
430
|
+
"description": "Fired when the `expandedItems` property changes.",
|
|
431
431
|
"value": {
|
|
432
432
|
"kind": "expression"
|
|
433
433
|
}
|
|
@@ -454,43 +454,43 @@
|
|
|
454
454
|
}
|
|
455
455
|
},
|
|
456
456
|
{
|
|
457
|
-
"name": "@
|
|
458
|
-
"description": "Fired
|
|
457
|
+
"name": "@item-property-changed",
|
|
458
|
+
"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.",
|
|
459
459
|
"value": {
|
|
460
460
|
"kind": "expression"
|
|
461
461
|
}
|
|
462
462
|
},
|
|
463
463
|
{
|
|
464
|
-
"name": "@item-
|
|
465
|
-
"description": "Fired
|
|
464
|
+
"name": "@item-toggle",
|
|
465
|
+
"description": "Fired when the user selects or deselects an item through the selection column.",
|
|
466
466
|
"value": {
|
|
467
467
|
"kind": "expression"
|
|
468
468
|
}
|
|
469
469
|
},
|
|
470
470
|
{
|
|
471
|
-
"name": "@
|
|
472
|
-
"description": "Fired when the `
|
|
471
|
+
"name": "@loading-changed",
|
|
472
|
+
"description": "Fired when the `loading` property changes.",
|
|
473
473
|
"value": {
|
|
474
474
|
"kind": "expression"
|
|
475
475
|
}
|
|
476
476
|
},
|
|
477
477
|
{
|
|
478
|
-
"name": "@
|
|
479
|
-
"description": "Fired when the `
|
|
478
|
+
"name": "@selected-items-changed",
|
|
479
|
+
"description": "Fired when the `selectedItems` property changes.",
|
|
480
480
|
"value": {
|
|
481
481
|
"kind": "expression"
|
|
482
482
|
}
|
|
483
483
|
},
|
|
484
484
|
{
|
|
485
|
-
"name": "@
|
|
486
|
-
"description": "Fired when the `
|
|
485
|
+
"name": "@single-cell-edit-changed",
|
|
486
|
+
"description": "Fired when the `singleCellEdit` property changes.",
|
|
487
487
|
"value": {
|
|
488
488
|
"kind": "expression"
|
|
489
489
|
}
|
|
490
490
|
},
|
|
491
491
|
{
|
|
492
|
-
"name": "@
|
|
493
|
-
"description": "Fired when the `
|
|
492
|
+
"name": "@size-changed",
|
|
493
|
+
"description": "Fired when the `size` property changes.",
|
|
494
494
|
"value": {
|
|
495
495
|
"kind": "expression"
|
|
496
496
|
}
|