@vaadin/grid-pro 25.2.0-alpha9 → 25.2.0-beta2
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/custom-elements.json +220 -199
- package/package.json +15 -15
- package/src/vaadin-grid-pro-edit-column-mixin.js +0 -5
- package/src/vaadin-grid-pro-edit-column.d.ts +3 -1
- package/src/vaadin-grid-pro-edit-column.js +0 -2
- package/src/vaadin-grid-pro-edit-select-mixin.js +2 -6
- package/src/vaadin-grid-pro-edit-select.js +0 -2
- package/src/vaadin-grid-pro-inline-editing-mixin.js +4 -32
- package/src/vaadin-grid-pro.d.ts +1 -1
- package/src/vaadin-grid-pro.js +1 -4
- package/web-types.json +93 -216
- package/web-types.lit.json +95 -109
package/custom-elements.json
CHANGED
|
@@ -181,8 +181,8 @@
|
|
|
181
181
|
"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.",
|
|
182
182
|
"attribute": "auto-width",
|
|
183
183
|
"inheritedFrom": {
|
|
184
|
-
"name": "
|
|
185
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
184
|
+
"name": "GridColumnMixin",
|
|
185
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
186
186
|
}
|
|
187
187
|
},
|
|
188
188
|
{
|
|
@@ -251,8 +251,8 @@
|
|
|
251
251
|
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
252
252
|
"attribute": "flex-grow",
|
|
253
253
|
"inheritedFrom": {
|
|
254
|
-
"name": "
|
|
255
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
254
|
+
"name": "GridColumnMixin",
|
|
255
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
256
256
|
}
|
|
257
257
|
},
|
|
258
258
|
{
|
|
@@ -265,8 +265,8 @@
|
|
|
265
265
|
"description": "Custom part name for the footer cell.",
|
|
266
266
|
"attribute": "footer-part-name",
|
|
267
267
|
"inheritedFrom": {
|
|
268
|
-
"name": "
|
|
269
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
268
|
+
"name": "ColumnBaseMixin",
|
|
269
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
270
270
|
}
|
|
271
271
|
},
|
|
272
272
|
{
|
|
@@ -279,8 +279,8 @@
|
|
|
279
279
|
"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.",
|
|
280
280
|
"attribute": "footer-renderer",
|
|
281
281
|
"inheritedFrom": {
|
|
282
|
-
"name": "
|
|
283
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
282
|
+
"name": "ColumnBaseMixin",
|
|
283
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
284
284
|
}
|
|
285
285
|
},
|
|
286
286
|
{
|
|
@@ -293,8 +293,8 @@
|
|
|
293
293
|
"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.",
|
|
294
294
|
"attribute": "frozen",
|
|
295
295
|
"inheritedFrom": {
|
|
296
|
-
"name": "
|
|
297
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
296
|
+
"name": "ColumnBaseMixin",
|
|
297
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
298
298
|
}
|
|
299
299
|
},
|
|
300
300
|
{
|
|
@@ -307,8 +307,8 @@
|
|
|
307
307
|
"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.",
|
|
308
308
|
"attribute": "frozen-to-end",
|
|
309
309
|
"inheritedFrom": {
|
|
310
|
-
"name": "
|
|
311
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
310
|
+
"name": "ColumnBaseMixin",
|
|
311
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
312
312
|
}
|
|
313
313
|
},
|
|
314
314
|
{
|
|
@@ -321,8 +321,8 @@
|
|
|
321
321
|
"description": "Text content to display in the header cell of the column.",
|
|
322
322
|
"attribute": "header",
|
|
323
323
|
"inheritedFrom": {
|
|
324
|
-
"name": "
|
|
325
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
324
|
+
"name": "ColumnBaseMixin",
|
|
325
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
326
326
|
}
|
|
327
327
|
},
|
|
328
328
|
{
|
|
@@ -335,8 +335,8 @@
|
|
|
335
335
|
"description": "Custom part name for the header cell.",
|
|
336
336
|
"attribute": "header-part-name",
|
|
337
337
|
"inheritedFrom": {
|
|
338
|
-
"name": "
|
|
339
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
338
|
+
"name": "ColumnBaseMixin",
|
|
339
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
340
340
|
}
|
|
341
341
|
},
|
|
342
342
|
{
|
|
@@ -349,8 +349,8 @@
|
|
|
349
349
|
"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.",
|
|
350
350
|
"attribute": "header-renderer",
|
|
351
351
|
"inheritedFrom": {
|
|
352
|
-
"name": "
|
|
353
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
352
|
+
"name": "ColumnBaseMixin",
|
|
353
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
354
354
|
}
|
|
355
355
|
},
|
|
356
356
|
{
|
|
@@ -363,8 +363,8 @@
|
|
|
363
363
|
"description": "When set to true, the cells for this column are hidden.",
|
|
364
364
|
"attribute": "hidden",
|
|
365
365
|
"inheritedFrom": {
|
|
366
|
-
"name": "
|
|
367
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
366
|
+
"name": "ColumnBaseMixin",
|
|
367
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
368
368
|
}
|
|
369
369
|
},
|
|
370
370
|
{
|
|
@@ -391,8 +391,8 @@
|
|
|
391
391
|
"description": "JS Path of the property in the item used for the editable content.",
|
|
392
392
|
"attribute": "path",
|
|
393
393
|
"inheritedFrom": {
|
|
394
|
-
"name": "
|
|
395
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
394
|
+
"name": "GridColumnMixin",
|
|
395
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
396
396
|
}
|
|
397
397
|
},
|
|
398
398
|
{
|
|
@@ -405,8 +405,8 @@
|
|
|
405
405
|
"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.",
|
|
406
406
|
"attribute": "renderer",
|
|
407
407
|
"inheritedFrom": {
|
|
408
|
-
"name": "
|
|
409
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
408
|
+
"name": "GridColumnMixin",
|
|
409
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
410
410
|
}
|
|
411
411
|
},
|
|
412
412
|
{
|
|
@@ -420,8 +420,8 @@
|
|
|
420
420
|
"default": "false",
|
|
421
421
|
"attribute": "resizable",
|
|
422
422
|
"inheritedFrom": {
|
|
423
|
-
"name": "
|
|
424
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
423
|
+
"name": "ColumnBaseMixin",
|
|
424
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
425
425
|
}
|
|
426
426
|
},
|
|
427
427
|
{
|
|
@@ -434,8 +434,8 @@
|
|
|
434
434
|
"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.",
|
|
435
435
|
"attribute": "row-header",
|
|
436
436
|
"inheritedFrom": {
|
|
437
|
-
"name": "
|
|
438
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
437
|
+
"name": "ColumnBaseMixin",
|
|
438
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
439
439
|
}
|
|
440
440
|
},
|
|
441
441
|
{
|
|
@@ -448,8 +448,8 @@
|
|
|
448
448
|
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
449
449
|
"attribute": "text-align",
|
|
450
450
|
"inheritedFrom": {
|
|
451
|
-
"name": "
|
|
452
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
451
|
+
"name": "ColumnBaseMixin",
|
|
452
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
453
453
|
}
|
|
454
454
|
},
|
|
455
455
|
{
|
|
@@ -462,8 +462,8 @@
|
|
|
462
462
|
"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.",
|
|
463
463
|
"attribute": "width",
|
|
464
464
|
"inheritedFrom": {
|
|
465
|
-
"name": "
|
|
466
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
465
|
+
"name": "GridColumnMixin",
|
|
466
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
467
467
|
}
|
|
468
468
|
}
|
|
469
469
|
],
|
|
@@ -488,8 +488,8 @@
|
|
|
488
488
|
"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.",
|
|
489
489
|
"fieldName": "autoWidth",
|
|
490
490
|
"inheritedFrom": {
|
|
491
|
-
"name": "
|
|
492
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
491
|
+
"name": "GridColumnMixin",
|
|
492
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
493
493
|
}
|
|
494
494
|
},
|
|
495
495
|
{
|
|
@@ -536,8 +536,8 @@
|
|
|
536
536
|
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
537
537
|
"fieldName": "flexGrow",
|
|
538
538
|
"inheritedFrom": {
|
|
539
|
-
"name": "
|
|
540
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
539
|
+
"name": "GridColumnMixin",
|
|
540
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
541
541
|
}
|
|
542
542
|
},
|
|
543
543
|
{
|
|
@@ -548,8 +548,8 @@
|
|
|
548
548
|
"description": "Custom part name for the footer cell.",
|
|
549
549
|
"fieldName": "footerPartName",
|
|
550
550
|
"inheritedFrom": {
|
|
551
|
-
"name": "
|
|
552
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
551
|
+
"name": "ColumnBaseMixin",
|
|
552
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
553
553
|
}
|
|
554
554
|
},
|
|
555
555
|
{
|
|
@@ -560,8 +560,8 @@
|
|
|
560
560
|
"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.",
|
|
561
561
|
"fieldName": "footerRenderer",
|
|
562
562
|
"inheritedFrom": {
|
|
563
|
-
"name": "
|
|
564
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
563
|
+
"name": "ColumnBaseMixin",
|
|
564
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
565
565
|
}
|
|
566
566
|
},
|
|
567
567
|
{
|
|
@@ -572,8 +572,8 @@
|
|
|
572
572
|
"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.",
|
|
573
573
|
"fieldName": "frozen",
|
|
574
574
|
"inheritedFrom": {
|
|
575
|
-
"name": "
|
|
576
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
575
|
+
"name": "ColumnBaseMixin",
|
|
576
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
577
577
|
}
|
|
578
578
|
},
|
|
579
579
|
{
|
|
@@ -584,8 +584,8 @@
|
|
|
584
584
|
"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.",
|
|
585
585
|
"fieldName": "frozenToEnd",
|
|
586
586
|
"inheritedFrom": {
|
|
587
|
-
"name": "
|
|
588
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
587
|
+
"name": "ColumnBaseMixin",
|
|
588
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
589
589
|
}
|
|
590
590
|
},
|
|
591
591
|
{
|
|
@@ -596,8 +596,8 @@
|
|
|
596
596
|
"description": "Text content to display in the header cell of the column.",
|
|
597
597
|
"fieldName": "header",
|
|
598
598
|
"inheritedFrom": {
|
|
599
|
-
"name": "
|
|
600
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
599
|
+
"name": "ColumnBaseMixin",
|
|
600
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
601
601
|
}
|
|
602
602
|
},
|
|
603
603
|
{
|
|
@@ -608,8 +608,8 @@
|
|
|
608
608
|
"description": "Custom part name for the header cell.",
|
|
609
609
|
"fieldName": "headerPartName",
|
|
610
610
|
"inheritedFrom": {
|
|
611
|
-
"name": "
|
|
612
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
611
|
+
"name": "ColumnBaseMixin",
|
|
612
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
613
613
|
}
|
|
614
614
|
},
|
|
615
615
|
{
|
|
@@ -620,8 +620,8 @@
|
|
|
620
620
|
"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.",
|
|
621
621
|
"fieldName": "headerRenderer",
|
|
622
622
|
"inheritedFrom": {
|
|
623
|
-
"name": "
|
|
624
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
623
|
+
"name": "ColumnBaseMixin",
|
|
624
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
625
625
|
}
|
|
626
626
|
},
|
|
627
627
|
{
|
|
@@ -632,8 +632,8 @@
|
|
|
632
632
|
"description": "When set to true, the cells for this column are hidden.",
|
|
633
633
|
"fieldName": "hidden",
|
|
634
634
|
"inheritedFrom": {
|
|
635
|
-
"name": "
|
|
636
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
635
|
+
"name": "ColumnBaseMixin",
|
|
636
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
637
637
|
}
|
|
638
638
|
},
|
|
639
639
|
{
|
|
@@ -656,8 +656,8 @@
|
|
|
656
656
|
"description": "JS Path of the property in the item used for the editable content.",
|
|
657
657
|
"fieldName": "path",
|
|
658
658
|
"inheritedFrom": {
|
|
659
|
-
"name": "
|
|
660
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
659
|
+
"name": "GridColumnMixin",
|
|
660
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
661
661
|
}
|
|
662
662
|
},
|
|
663
663
|
{
|
|
@@ -668,8 +668,8 @@
|
|
|
668
668
|
"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.",
|
|
669
669
|
"fieldName": "renderer",
|
|
670
670
|
"inheritedFrom": {
|
|
671
|
-
"name": "
|
|
672
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
671
|
+
"name": "GridColumnMixin",
|
|
672
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
673
673
|
}
|
|
674
674
|
},
|
|
675
675
|
{
|
|
@@ -681,8 +681,8 @@
|
|
|
681
681
|
"default": "false",
|
|
682
682
|
"fieldName": "resizable",
|
|
683
683
|
"inheritedFrom": {
|
|
684
|
-
"name": "
|
|
685
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
684
|
+
"name": "ColumnBaseMixin",
|
|
685
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
686
686
|
}
|
|
687
687
|
},
|
|
688
688
|
{
|
|
@@ -693,8 +693,8 @@
|
|
|
693
693
|
"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.",
|
|
694
694
|
"fieldName": "rowHeader",
|
|
695
695
|
"inheritedFrom": {
|
|
696
|
-
"name": "
|
|
697
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
696
|
+
"name": "ColumnBaseMixin",
|
|
697
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
698
698
|
}
|
|
699
699
|
},
|
|
700
700
|
{
|
|
@@ -705,8 +705,8 @@
|
|
|
705
705
|
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
706
706
|
"fieldName": "textAlign",
|
|
707
707
|
"inheritedFrom": {
|
|
708
|
-
"name": "
|
|
709
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
708
|
+
"name": "ColumnBaseMixin",
|
|
709
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
710
710
|
}
|
|
711
711
|
},
|
|
712
712
|
{
|
|
@@ -717,8 +717,8 @@
|
|
|
717
717
|
"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.",
|
|
718
718
|
"fieldName": "width",
|
|
719
719
|
"inheritedFrom": {
|
|
720
|
-
"name": "
|
|
721
|
-
"package": "@vaadin/grid/src/vaadin-grid-column.js"
|
|
720
|
+
"name": "GridColumnMixin",
|
|
721
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-mixin.js"
|
|
722
722
|
}
|
|
723
723
|
}
|
|
724
724
|
],
|
|
@@ -890,7 +890,7 @@
|
|
|
890
890
|
"declarations": [
|
|
891
891
|
{
|
|
892
892
|
"kind": "class",
|
|
893
|
-
"description": "
|
|
893
|
+
"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>`](#/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>`](#/elements/vaadin-checkbox).\n- `<vaadin-grid-pro-edit-text-field>` - has the same API as [`<vaadin-text-field>`](#/elements/vaadin-text-field).\n- `<vaadin-grid-pro-edit-select>` - has the same API as [`<vaadin-select>`](#/elements/vaadin-select).",
|
|
894
894
|
"name": "GridPro",
|
|
895
895
|
"members": [
|
|
896
896
|
{
|
|
@@ -903,8 +903,8 @@
|
|
|
903
903
|
"description": "String used to label the grid to screen reader users.",
|
|
904
904
|
"attribute": "accessible-name",
|
|
905
905
|
"inheritedFrom": {
|
|
906
|
-
"name": "
|
|
907
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
906
|
+
"name": "A11yMixin",
|
|
907
|
+
"package": "@vaadin/grid/src/vaadin-grid-a11y-mixin.js"
|
|
908
908
|
}
|
|
909
909
|
},
|
|
910
910
|
{
|
|
@@ -917,8 +917,8 @@
|
|
|
917
917
|
"description": "The item user has last interacted with. Turns to `null` after user deactivates\nthe item by re-interacting with the currently active item.",
|
|
918
918
|
"attribute": "active-item",
|
|
919
919
|
"inheritedFrom": {
|
|
920
|
-
"name": "
|
|
921
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
920
|
+
"name": "ActiveItemMixin",
|
|
921
|
+
"package": "@vaadin/grid/src/vaadin-grid-active-item-mixin.js"
|
|
922
922
|
}
|
|
923
923
|
},
|
|
924
924
|
{
|
|
@@ -931,8 +931,8 @@
|
|
|
931
931
|
"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.",
|
|
932
932
|
"attribute": "all-rows-visible",
|
|
933
933
|
"inheritedFrom": {
|
|
934
|
-
"name": "
|
|
935
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
934
|
+
"name": "GridMixin",
|
|
935
|
+
"package": "@vaadin/grid/src/vaadin-grid-mixin.js"
|
|
936
936
|
}
|
|
937
937
|
},
|
|
938
938
|
{
|
|
@@ -945,8 +945,8 @@
|
|
|
945
945
|
"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.",
|
|
946
946
|
"attribute": "cell-part-name-generator",
|
|
947
947
|
"inheritedFrom": {
|
|
948
|
-
"name": "
|
|
949
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
948
|
+
"name": "StylingMixin",
|
|
949
|
+
"package": "@vaadin/grid/src/vaadin-grid-styling-mixin.js"
|
|
950
950
|
}
|
|
951
951
|
},
|
|
952
952
|
{
|
|
@@ -954,8 +954,8 @@
|
|
|
954
954
|
"name": "clearCache",
|
|
955
955
|
"description": "Clears the cached pages and reloads data from dataprovider when needed.",
|
|
956
956
|
"inheritedFrom": {
|
|
957
|
-
"name": "
|
|
958
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
957
|
+
"name": "DataProviderMixin",
|
|
958
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
959
959
|
}
|
|
960
960
|
},
|
|
961
961
|
{
|
|
@@ -971,8 +971,8 @@
|
|
|
971
971
|
],
|
|
972
972
|
"description": "Close the details row of a given item.",
|
|
973
973
|
"inheritedFrom": {
|
|
974
|
-
"name": "
|
|
975
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
974
|
+
"name": "RowDetailsMixin",
|
|
975
|
+
"package": "@vaadin/grid/src/vaadin-grid-row-details-mixin.js"
|
|
976
976
|
}
|
|
977
977
|
},
|
|
978
978
|
{
|
|
@@ -988,8 +988,8 @@
|
|
|
988
988
|
],
|
|
989
989
|
"description": "Collapses the given item tree.",
|
|
990
990
|
"inheritedFrom": {
|
|
991
|
-
"name": "
|
|
992
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
991
|
+
"name": "DataProviderMixin",
|
|
992
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
993
993
|
}
|
|
994
994
|
},
|
|
995
995
|
{
|
|
@@ -1002,8 +1002,8 @@
|
|
|
1002
1002
|
"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.",
|
|
1003
1003
|
"attribute": "column-rendering",
|
|
1004
1004
|
"inheritedFrom": {
|
|
1005
|
-
"name": "
|
|
1006
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1005
|
+
"name": "ScrollMixin",
|
|
1006
|
+
"package": "@vaadin/grid/src/vaadin-grid-scroll-mixin.js"
|
|
1007
1007
|
}
|
|
1008
1008
|
},
|
|
1009
1009
|
{
|
|
@@ -1016,8 +1016,8 @@
|
|
|
1016
1016
|
"description": "Set to true to allow column reordering.",
|
|
1017
1017
|
"attribute": "column-reordering-allowed",
|
|
1018
1018
|
"inheritedFrom": {
|
|
1019
|
-
"name": "
|
|
1020
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1019
|
+
"name": "ColumnReorderingMixin",
|
|
1020
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-reordering-mixin.js"
|
|
1021
1021
|
}
|
|
1022
1022
|
},
|
|
1023
1023
|
{
|
|
@@ -1030,8 +1030,8 @@
|
|
|
1030
1030
|
"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.",
|
|
1031
1031
|
"attribute": "data-provider",
|
|
1032
1032
|
"inheritedFrom": {
|
|
1033
|
-
"name": "
|
|
1034
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1033
|
+
"name": "DataProviderMixin",
|
|
1034
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1035
1035
|
}
|
|
1036
1036
|
},
|
|
1037
1037
|
{
|
|
@@ -1048,8 +1048,8 @@
|
|
|
1048
1048
|
],
|
|
1049
1049
|
"description": "Deselects the given item if it is already selected.",
|
|
1050
1050
|
"inheritedFrom": {
|
|
1051
|
-
"name": "
|
|
1052
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1051
|
+
"name": "SelectionMixin",
|
|
1052
|
+
"package": "@vaadin/grid/src/vaadin-grid-selection-mixin.js"
|
|
1053
1053
|
}
|
|
1054
1054
|
},
|
|
1055
1055
|
{
|
|
@@ -1062,8 +1062,22 @@
|
|
|
1062
1062
|
"description": "An array containing references to items with open row details.",
|
|
1063
1063
|
"attribute": "details-opened-items",
|
|
1064
1064
|
"inheritedFrom": {
|
|
1065
|
-
"name": "
|
|
1066
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1065
|
+
"name": "RowDetailsMixin",
|
|
1066
|
+
"package": "@vaadin/grid/src/vaadin-grid-row-details-mixin.js"
|
|
1067
|
+
}
|
|
1068
|
+
},
|
|
1069
|
+
{
|
|
1070
|
+
"kind": "field",
|
|
1071
|
+
"name": "disabled",
|
|
1072
|
+
"privacy": "public",
|
|
1073
|
+
"type": {
|
|
1074
|
+
"text": "boolean"
|
|
1075
|
+
},
|
|
1076
|
+
"description": "If true, the user cannot interact with this element.",
|
|
1077
|
+
"attribute": "disabled",
|
|
1078
|
+
"inheritedFrom": {
|
|
1079
|
+
"name": "DisabledMixin",
|
|
1080
|
+
"package": "@vaadin/a11y-base/src/disabled-mixin.js"
|
|
1067
1081
|
}
|
|
1068
1082
|
},
|
|
1069
1083
|
{
|
|
@@ -1076,8 +1090,8 @@
|
|
|
1076
1090
|
"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.",
|
|
1077
1091
|
"attribute": "drag-filter",
|
|
1078
1092
|
"inheritedFrom": {
|
|
1079
|
-
"name": "
|
|
1080
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1093
|
+
"name": "DragAndDropMixin",
|
|
1094
|
+
"package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
|
|
1081
1095
|
}
|
|
1082
1096
|
},
|
|
1083
1097
|
{
|
|
@@ -1090,8 +1104,8 @@
|
|
|
1090
1104
|
"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.",
|
|
1091
1105
|
"attribute": "drop-filter",
|
|
1092
1106
|
"inheritedFrom": {
|
|
1093
|
-
"name": "
|
|
1094
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1107
|
+
"name": "DragAndDropMixin",
|
|
1108
|
+
"package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
|
|
1095
1109
|
}
|
|
1096
1110
|
},
|
|
1097
1111
|
{
|
|
@@ -1104,8 +1118,8 @@
|
|
|
1104
1118
|
"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.",
|
|
1105
1119
|
"attribute": "drop-mode",
|
|
1106
1120
|
"inheritedFrom": {
|
|
1107
|
-
"name": "
|
|
1108
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1121
|
+
"name": "DragAndDropMixin",
|
|
1122
|
+
"package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
|
|
1109
1123
|
}
|
|
1110
1124
|
},
|
|
1111
1125
|
{
|
|
@@ -1146,8 +1160,8 @@
|
|
|
1146
1160
|
"description": "An array that contains the expanded items.",
|
|
1147
1161
|
"attribute": "expanded-items",
|
|
1148
1162
|
"inheritedFrom": {
|
|
1149
|
-
"name": "
|
|
1150
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1163
|
+
"name": "DataProviderMixin",
|
|
1164
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1151
1165
|
}
|
|
1152
1166
|
},
|
|
1153
1167
|
{
|
|
@@ -1163,8 +1177,8 @@
|
|
|
1163
1177
|
],
|
|
1164
1178
|
"description": "Expands the given item tree.",
|
|
1165
1179
|
"inheritedFrom": {
|
|
1166
|
-
"name": "
|
|
1167
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1180
|
+
"name": "DataProviderMixin",
|
|
1181
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1168
1182
|
}
|
|
1169
1183
|
},
|
|
1170
1184
|
{
|
|
@@ -1172,8 +1186,8 @@
|
|
|
1172
1186
|
"name": "filterDragAndDrop",
|
|
1173
1187
|
"description": "Runs the `dragFilter` and `dropFilter` hooks for the visible cells.\nIf the filter depends on varying conditions, you may need to\ncall this function manually in order to update the draggability when\nthe conditions change.",
|
|
1174
1188
|
"inheritedFrom": {
|
|
1175
|
-
"name": "
|
|
1176
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1189
|
+
"name": "DragAndDropMixin",
|
|
1190
|
+
"package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
|
|
1177
1191
|
}
|
|
1178
1192
|
},
|
|
1179
1193
|
{
|
|
@@ -1181,8 +1195,8 @@
|
|
|
1181
1195
|
"name": "generateCellPartNames",
|
|
1182
1196
|
"description": "Runs the `cellPartNameGenerator` for the visible cells.\nIf the generator depends on varying conditions, you need to\ncall this function manually in order to update the styles when\nthe conditions change.",
|
|
1183
1197
|
"inheritedFrom": {
|
|
1184
|
-
"name": "
|
|
1185
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1198
|
+
"name": "StylingMixin",
|
|
1199
|
+
"package": "@vaadin/grid/src/vaadin-grid-styling-mixin.js"
|
|
1186
1200
|
}
|
|
1187
1201
|
},
|
|
1188
1202
|
{
|
|
@@ -1203,8 +1217,8 @@
|
|
|
1203
1217
|
}
|
|
1204
1218
|
},
|
|
1205
1219
|
"inheritedFrom": {
|
|
1206
|
-
"name": "
|
|
1207
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1220
|
+
"name": "EventContextMixin",
|
|
1221
|
+
"package": "@vaadin/grid/src/vaadin-grid-event-context-mixin.js"
|
|
1208
1222
|
}
|
|
1209
1223
|
},
|
|
1210
1224
|
{
|
|
@@ -1225,8 +1239,8 @@
|
|
|
1225
1239
|
}
|
|
1226
1240
|
},
|
|
1227
1241
|
"inheritedFrom": {
|
|
1228
|
-
"name": "
|
|
1229
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1242
|
+
"name": "DataProviderMixin",
|
|
1243
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1230
1244
|
}
|
|
1231
1245
|
},
|
|
1232
1246
|
{
|
|
@@ -1239,8 +1253,8 @@
|
|
|
1239
1253
|
"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.",
|
|
1240
1254
|
"attribute": "is-item-selectable",
|
|
1241
1255
|
"inheritedFrom": {
|
|
1242
|
-
"name": "
|
|
1243
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1256
|
+
"name": "SelectionMixin",
|
|
1257
|
+
"package": "@vaadin/grid/src/vaadin-grid-selection-mixin.js"
|
|
1244
1258
|
}
|
|
1245
1259
|
},
|
|
1246
1260
|
{
|
|
@@ -1253,8 +1267,8 @@
|
|
|
1253
1267
|
"description": "Path to an item sub-property that indicates whether the item has child items.",
|
|
1254
1268
|
"attribute": "item-has-children-path",
|
|
1255
1269
|
"inheritedFrom": {
|
|
1256
|
-
"name": "
|
|
1257
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1270
|
+
"name": "DataProviderMixin",
|
|
1271
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1258
1272
|
}
|
|
1259
1273
|
},
|
|
1260
1274
|
{
|
|
@@ -1267,8 +1281,8 @@
|
|
|
1267
1281
|
"description": "Path to an item sub-property that identifies the item.",
|
|
1268
1282
|
"attribute": "item-id-path",
|
|
1269
1283
|
"inheritedFrom": {
|
|
1270
|
-
"name": "
|
|
1271
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1284
|
+
"name": "DataProviderMixin",
|
|
1285
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1272
1286
|
}
|
|
1273
1287
|
},
|
|
1274
1288
|
{
|
|
@@ -1281,8 +1295,8 @@
|
|
|
1281
1295
|
"description": "An array containing the items which will be passed to renderer functions.",
|
|
1282
1296
|
"attribute": "items",
|
|
1283
1297
|
"inheritedFrom": {
|
|
1284
|
-
"name": "
|
|
1285
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1298
|
+
"name": "ArrayDataProviderMixin",
|
|
1299
|
+
"package": "@vaadin/grid/src/vaadin-grid-array-data-provider-mixin.js"
|
|
1286
1300
|
}
|
|
1287
1301
|
},
|
|
1288
1302
|
{
|
|
@@ -1296,8 +1310,8 @@
|
|
|
1296
1310
|
"attribute": "loading",
|
|
1297
1311
|
"readonly": true,
|
|
1298
1312
|
"inheritedFrom": {
|
|
1299
|
-
"name": "
|
|
1300
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1313
|
+
"name": "DataProviderMixin",
|
|
1314
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1301
1315
|
}
|
|
1302
1316
|
},
|
|
1303
1317
|
{
|
|
@@ -1310,8 +1324,8 @@
|
|
|
1310
1324
|
"description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
|
|
1311
1325
|
"attribute": "multi-sort",
|
|
1312
1326
|
"inheritedFrom": {
|
|
1313
|
-
"name": "
|
|
1314
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1327
|
+
"name": "SortMixin",
|
|
1328
|
+
"package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
|
|
1315
1329
|
}
|
|
1316
1330
|
},
|
|
1317
1331
|
{
|
|
@@ -1324,8 +1338,8 @@
|
|
|
1324
1338
|
"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.",
|
|
1325
1339
|
"attribute": "multi-sort-on-shift-click",
|
|
1326
1340
|
"inheritedFrom": {
|
|
1327
|
-
"name": "
|
|
1328
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1341
|
+
"name": "SortMixin",
|
|
1342
|
+
"package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
|
|
1329
1343
|
}
|
|
1330
1344
|
},
|
|
1331
1345
|
{
|
|
@@ -1338,8 +1352,8 @@
|
|
|
1338
1352
|
"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\"`.",
|
|
1339
1353
|
"attribute": "multi-sort-priority",
|
|
1340
1354
|
"inheritedFrom": {
|
|
1341
|
-
"name": "
|
|
1342
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1355
|
+
"name": "SortMixin",
|
|
1356
|
+
"package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
|
|
1343
1357
|
}
|
|
1344
1358
|
},
|
|
1345
1359
|
{
|
|
@@ -1355,8 +1369,8 @@
|
|
|
1355
1369
|
],
|
|
1356
1370
|
"description": "Open the details row of a given item.",
|
|
1357
1371
|
"inheritedFrom": {
|
|
1358
|
-
"name": "
|
|
1359
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1372
|
+
"name": "RowDetailsMixin",
|
|
1373
|
+
"package": "@vaadin/grid/src/vaadin-grid-row-details-mixin.js"
|
|
1360
1374
|
}
|
|
1361
1375
|
},
|
|
1362
1376
|
{
|
|
@@ -1369,8 +1383,8 @@
|
|
|
1369
1383
|
"description": "Number of items fetched at a time from the dataprovider.",
|
|
1370
1384
|
"attribute": "page-size",
|
|
1371
1385
|
"inheritedFrom": {
|
|
1372
|
-
"name": "
|
|
1373
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1386
|
+
"name": "DataProviderMixin",
|
|
1387
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1374
1388
|
}
|
|
1375
1389
|
},
|
|
1376
1390
|
{
|
|
@@ -1378,8 +1392,8 @@
|
|
|
1378
1392
|
"name": "recalculateColumnWidths",
|
|
1379
1393
|
"description": "Updates the `width` of all columns which have `autoWidth` set to `true`.",
|
|
1380
1394
|
"inheritedFrom": {
|
|
1381
|
-
"name": "
|
|
1382
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1395
|
+
"name": "ColumnAutoWidthMixin",
|
|
1396
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-auto-width-mixin.js"
|
|
1383
1397
|
}
|
|
1384
1398
|
},
|
|
1385
1399
|
{
|
|
@@ -1387,8 +1401,8 @@
|
|
|
1387
1401
|
"name": "requestContentUpdate",
|
|
1388
1402
|
"description": "Requests an update for the content of cells.\n\nWhile performing the update, the following renderers are invoked:\n- `Grid.rowDetailsRenderer`\n- `GridColumn.renderer`\n- `GridColumn.headerRenderer`\n- `GridColumn.footerRenderer`\n\nIt is not guaranteed that the update happens immediately (synchronously) after it is requested.",
|
|
1389
1403
|
"inheritedFrom": {
|
|
1390
|
-
"name": "
|
|
1391
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1404
|
+
"name": "GridMixin",
|
|
1405
|
+
"package": "@vaadin/grid/src/vaadin-grid-mixin.js"
|
|
1392
1406
|
}
|
|
1393
1407
|
},
|
|
1394
1408
|
{
|
|
@@ -1401,8 +1415,8 @@
|
|
|
1401
1415
|
"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.",
|
|
1402
1416
|
"attribute": "row-details-renderer",
|
|
1403
1417
|
"inheritedFrom": {
|
|
1404
|
-
"name": "
|
|
1405
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1418
|
+
"name": "RowDetailsMixin",
|
|
1419
|
+
"package": "@vaadin/grid/src/vaadin-grid-row-details-mixin.js"
|
|
1406
1420
|
}
|
|
1407
1421
|
},
|
|
1408
1422
|
{
|
|
@@ -1415,8 +1429,8 @@
|
|
|
1415
1429
|
"description": "Marks the grid's rows to be available for dragging.",
|
|
1416
1430
|
"attribute": "rows-draggable",
|
|
1417
1431
|
"inheritedFrom": {
|
|
1418
|
-
"name": "
|
|
1419
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1432
|
+
"name": "DragAndDropMixin",
|
|
1433
|
+
"package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
|
|
1420
1434
|
}
|
|
1421
1435
|
},
|
|
1422
1436
|
{
|
|
@@ -1433,8 +1447,8 @@
|
|
|
1433
1447
|
],
|
|
1434
1448
|
"description": "Scrolls horizontally so that the column becomes visible in the viewport.\n\nThe column can be specified either by its index (among visible columns\nin visual order) or by the column element itself.",
|
|
1435
1449
|
"inheritedFrom": {
|
|
1436
|
-
"name": "
|
|
1437
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1450
|
+
"name": "ScrollMixin",
|
|
1451
|
+
"package": "@vaadin/grid/src/vaadin-grid-scroll-mixin.js"
|
|
1438
1452
|
}
|
|
1439
1453
|
},
|
|
1440
1454
|
{
|
|
@@ -1451,8 +1465,8 @@
|
|
|
1451
1465
|
],
|
|
1452
1466
|
"description": "Scroll to a specific row index in the virtual list. Note that the row index is\nnot always the same for any particular item. For example, sorting or filtering\nitems can affect the row index related to an item.\n\nThe `indexes` parameter can be either a single number or multiple numbers.\nThe grid will first try to scroll to the item at the first index on the top level.\nIn case the item at the first index is expanded, the grid will then try scroll to the\nitem at the second index within the children of the expanded first item, and so on.\nEach given index points to a child of the item at the previous index.\n\nUsing `Infinity` as an index will point to the last item on the level.",
|
|
1453
1467
|
"inheritedFrom": {
|
|
1454
|
-
"name": "
|
|
1455
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1468
|
+
"name": "DataProviderMixin",
|
|
1469
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1456
1470
|
}
|
|
1457
1471
|
},
|
|
1458
1472
|
{
|
|
@@ -1465,8 +1479,8 @@
|
|
|
1465
1479
|
"description": "An array that contains the selected items.",
|
|
1466
1480
|
"attribute": "selected-items",
|
|
1467
1481
|
"inheritedFrom": {
|
|
1468
|
-
"name": "
|
|
1469
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1482
|
+
"name": "SelectionMixin",
|
|
1483
|
+
"package": "@vaadin/grid/src/vaadin-grid-selection-mixin.js"
|
|
1470
1484
|
}
|
|
1471
1485
|
},
|
|
1472
1486
|
{
|
|
@@ -1483,8 +1497,8 @@
|
|
|
1483
1497
|
],
|
|
1484
1498
|
"description": "Selects the given item.",
|
|
1485
1499
|
"inheritedFrom": {
|
|
1486
|
-
"name": "
|
|
1487
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1500
|
+
"name": "SelectionMixin",
|
|
1501
|
+
"package": "@vaadin/grid/src/vaadin-grid-selection-mixin.js"
|
|
1488
1502
|
}
|
|
1489
1503
|
},
|
|
1490
1504
|
{
|
|
@@ -1501,8 +1515,8 @@
|
|
|
1501
1515
|
],
|
|
1502
1516
|
"description": "Sets the default multi-sort priority to use for all grid instances.\nThis method should be called before creating any grid instances.\nChanging this setting does not affect the default for existing grids.",
|
|
1503
1517
|
"inheritedFrom": {
|
|
1504
|
-
"name": "
|
|
1505
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1518
|
+
"name": "SortMixin",
|
|
1519
|
+
"package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
|
|
1506
1520
|
}
|
|
1507
1521
|
},
|
|
1508
1522
|
{
|
|
@@ -1529,14 +1543,9 @@
|
|
|
1529
1543
|
"description": "The number of root-level items in the grid.",
|
|
1530
1544
|
"attribute": "size",
|
|
1531
1545
|
"inheritedFrom": {
|
|
1532
|
-
"name": "
|
|
1533
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1546
|
+
"name": "DataProviderMixin",
|
|
1547
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1534
1548
|
}
|
|
1535
|
-
},
|
|
1536
|
-
{
|
|
1537
|
-
"kind": "field",
|
|
1538
|
-
"name": "slotStyles",
|
|
1539
|
-
"readonly": true
|
|
1540
1549
|
}
|
|
1541
1550
|
],
|
|
1542
1551
|
"events": [
|
|
@@ -1552,11 +1561,11 @@
|
|
|
1552
1561
|
}
|
|
1553
1562
|
},
|
|
1554
1563
|
{
|
|
1555
|
-
"name": "cell-activate",
|
|
1556
1564
|
"type": {
|
|
1557
1565
|
"text": "CustomEvent"
|
|
1558
1566
|
},
|
|
1559
1567
|
"description": "Fired when the cell is activated with click or keyboard.",
|
|
1568
|
+
"name": "cell-activate",
|
|
1560
1569
|
"inheritedFrom": {
|
|
1561
1570
|
"name": "Grid",
|
|
1562
1571
|
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
@@ -1577,7 +1586,7 @@
|
|
|
1577
1586
|
"type": {
|
|
1578
1587
|
"text": "CustomEvent"
|
|
1579
1588
|
},
|
|
1580
|
-
"description": "Fired when a cell is focused with click or keyboard navigation.",
|
|
1589
|
+
"description": "Fired when a cell is focused with click or keyboard navigation. Use the `context` property to read event details.",
|
|
1581
1590
|
"name": "cell-focus",
|
|
1582
1591
|
"inheritedFrom": {
|
|
1583
1592
|
"name": "Grid",
|
|
@@ -1585,22 +1594,22 @@
|
|
|
1585
1594
|
}
|
|
1586
1595
|
},
|
|
1587
1596
|
{
|
|
1588
|
-
"name": "column-reorder",
|
|
1589
1597
|
"type": {
|
|
1590
1598
|
"text": "CustomEvent"
|
|
1591
1599
|
},
|
|
1592
1600
|
"description": "Fired when the columns in the grid are reordered.",
|
|
1601
|
+
"name": "column-reorder",
|
|
1593
1602
|
"inheritedFrom": {
|
|
1594
1603
|
"name": "Grid",
|
|
1595
1604
|
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1596
1605
|
}
|
|
1597
1606
|
},
|
|
1598
1607
|
{
|
|
1599
|
-
"name": "column-resize",
|
|
1600
1608
|
"type": {
|
|
1601
1609
|
"text": "CustomEvent"
|
|
1602
1610
|
},
|
|
1603
1611
|
"description": "Fired when the grid column resize is finished.",
|
|
1612
|
+
"name": "column-resize",
|
|
1604
1613
|
"inheritedFrom": {
|
|
1605
1614
|
"name": "Grid",
|
|
1606
1615
|
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
@@ -1666,7 +1675,7 @@
|
|
|
1666
1675
|
"type": {
|
|
1667
1676
|
"text": "CustomEvent"
|
|
1668
1677
|
},
|
|
1669
|
-
"description": "Fired before exiting
|
|
1678
|
+
"description": "Fired before exiting cell edit mode if the value has been changed. If the default is prevented, the value change is not applied.",
|
|
1670
1679
|
"inheritedFrom": {
|
|
1671
1680
|
"name": "InlineEditingMixin",
|
|
1672
1681
|
"module": "src/vaadin-grid-pro-inline-editing-mixin.js"
|
|
@@ -1742,8 +1751,8 @@
|
|
|
1742
1751
|
"description": "String used to label the grid to screen reader users.",
|
|
1743
1752
|
"fieldName": "accessibleName",
|
|
1744
1753
|
"inheritedFrom": {
|
|
1745
|
-
"name": "
|
|
1746
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1754
|
+
"name": "A11yMixin",
|
|
1755
|
+
"package": "@vaadin/grid/src/vaadin-grid-a11y-mixin.js"
|
|
1747
1756
|
}
|
|
1748
1757
|
},
|
|
1749
1758
|
{
|
|
@@ -1754,8 +1763,8 @@
|
|
|
1754
1763
|
"description": "The item user has last interacted with. Turns to `null` after user deactivates\nthe item by re-interacting with the currently active item.",
|
|
1755
1764
|
"fieldName": "activeItem",
|
|
1756
1765
|
"inheritedFrom": {
|
|
1757
|
-
"name": "
|
|
1758
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1766
|
+
"name": "ActiveItemMixin",
|
|
1767
|
+
"package": "@vaadin/grid/src/vaadin-grid-active-item-mixin.js"
|
|
1759
1768
|
}
|
|
1760
1769
|
},
|
|
1761
1770
|
{
|
|
@@ -1766,8 +1775,8 @@
|
|
|
1766
1775
|
"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.",
|
|
1767
1776
|
"fieldName": "allRowsVisible",
|
|
1768
1777
|
"inheritedFrom": {
|
|
1769
|
-
"name": "
|
|
1770
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1778
|
+
"name": "GridMixin",
|
|
1779
|
+
"package": "@vaadin/grid/src/vaadin-grid-mixin.js"
|
|
1771
1780
|
}
|
|
1772
1781
|
},
|
|
1773
1782
|
{
|
|
@@ -1778,8 +1787,8 @@
|
|
|
1778
1787
|
"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.",
|
|
1779
1788
|
"fieldName": "cellPartNameGenerator",
|
|
1780
1789
|
"inheritedFrom": {
|
|
1781
|
-
"name": "
|
|
1782
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1790
|
+
"name": "StylingMixin",
|
|
1791
|
+
"package": "@vaadin/grid/src/vaadin-grid-styling-mixin.js"
|
|
1783
1792
|
}
|
|
1784
1793
|
},
|
|
1785
1794
|
{
|
|
@@ -1790,8 +1799,8 @@
|
|
|
1790
1799
|
"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.",
|
|
1791
1800
|
"fieldName": "columnRendering",
|
|
1792
1801
|
"inheritedFrom": {
|
|
1793
|
-
"name": "
|
|
1794
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1802
|
+
"name": "ScrollMixin",
|
|
1803
|
+
"package": "@vaadin/grid/src/vaadin-grid-scroll-mixin.js"
|
|
1795
1804
|
}
|
|
1796
1805
|
},
|
|
1797
1806
|
{
|
|
@@ -1802,8 +1811,8 @@
|
|
|
1802
1811
|
"description": "Set to true to allow column reordering.",
|
|
1803
1812
|
"fieldName": "columnReorderingAllowed",
|
|
1804
1813
|
"inheritedFrom": {
|
|
1805
|
-
"name": "
|
|
1806
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1814
|
+
"name": "ColumnReorderingMixin",
|
|
1815
|
+
"package": "@vaadin/grid/src/vaadin-grid-column-reordering-mixin.js"
|
|
1807
1816
|
}
|
|
1808
1817
|
},
|
|
1809
1818
|
{
|
|
@@ -1814,8 +1823,20 @@
|
|
|
1814
1823
|
"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.",
|
|
1815
1824
|
"fieldName": "dataProvider",
|
|
1816
1825
|
"inheritedFrom": {
|
|
1817
|
-
"name": "
|
|
1818
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1826
|
+
"name": "DataProviderMixin",
|
|
1827
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1828
|
+
}
|
|
1829
|
+
},
|
|
1830
|
+
{
|
|
1831
|
+
"name": "disabled",
|
|
1832
|
+
"type": {
|
|
1833
|
+
"text": "boolean"
|
|
1834
|
+
},
|
|
1835
|
+
"description": "If true, the user cannot interact with this element.",
|
|
1836
|
+
"fieldName": "disabled",
|
|
1837
|
+
"inheritedFrom": {
|
|
1838
|
+
"name": "DisabledMixin",
|
|
1839
|
+
"package": "@vaadin/a11y-base/src/disabled-mixin.js"
|
|
1819
1840
|
}
|
|
1820
1841
|
},
|
|
1821
1842
|
{
|
|
@@ -1826,8 +1847,8 @@
|
|
|
1826
1847
|
"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.",
|
|
1827
1848
|
"fieldName": "dragFilter",
|
|
1828
1849
|
"inheritedFrom": {
|
|
1829
|
-
"name": "
|
|
1830
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1850
|
+
"name": "DragAndDropMixin",
|
|
1851
|
+
"package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
|
|
1831
1852
|
}
|
|
1832
1853
|
},
|
|
1833
1854
|
{
|
|
@@ -1838,8 +1859,8 @@
|
|
|
1838
1859
|
"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.",
|
|
1839
1860
|
"fieldName": "dropFilter",
|
|
1840
1861
|
"inheritedFrom": {
|
|
1841
|
-
"name": "
|
|
1842
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1862
|
+
"name": "DragAndDropMixin",
|
|
1863
|
+
"package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
|
|
1843
1864
|
}
|
|
1844
1865
|
},
|
|
1845
1866
|
{
|
|
@@ -1850,8 +1871,8 @@
|
|
|
1850
1871
|
"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.",
|
|
1851
1872
|
"fieldName": "dropMode",
|
|
1852
1873
|
"inheritedFrom": {
|
|
1853
|
-
"name": "
|
|
1854
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1874
|
+
"name": "DragAndDropMixin",
|
|
1875
|
+
"package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
|
|
1855
1876
|
}
|
|
1856
1877
|
},
|
|
1857
1878
|
{
|
|
@@ -1886,8 +1907,8 @@
|
|
|
1886
1907
|
"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.",
|
|
1887
1908
|
"fieldName": "isItemSelectable",
|
|
1888
1909
|
"inheritedFrom": {
|
|
1889
|
-
"name": "
|
|
1890
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1910
|
+
"name": "SelectionMixin",
|
|
1911
|
+
"package": "@vaadin/grid/src/vaadin-grid-selection-mixin.js"
|
|
1891
1912
|
}
|
|
1892
1913
|
},
|
|
1893
1914
|
{
|
|
@@ -1898,8 +1919,8 @@
|
|
|
1898
1919
|
"description": "Path to an item sub-property that indicates whether the item has child items.",
|
|
1899
1920
|
"fieldName": "itemHasChildrenPath",
|
|
1900
1921
|
"inheritedFrom": {
|
|
1901
|
-
"name": "
|
|
1902
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1922
|
+
"name": "DataProviderMixin",
|
|
1923
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1903
1924
|
}
|
|
1904
1925
|
},
|
|
1905
1926
|
{
|
|
@@ -1910,8 +1931,8 @@
|
|
|
1910
1931
|
"description": "Path to an item sub-property that identifies the item.",
|
|
1911
1932
|
"fieldName": "itemIdPath",
|
|
1912
1933
|
"inheritedFrom": {
|
|
1913
|
-
"name": "
|
|
1914
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1934
|
+
"name": "DataProviderMixin",
|
|
1935
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1915
1936
|
}
|
|
1916
1937
|
},
|
|
1917
1938
|
{
|
|
@@ -1922,8 +1943,8 @@
|
|
|
1922
1943
|
"description": "`true` while data is being requested from the data provider.",
|
|
1923
1944
|
"fieldName": "loading",
|
|
1924
1945
|
"inheritedFrom": {
|
|
1925
|
-
"name": "
|
|
1926
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1946
|
+
"name": "DataProviderMixin",
|
|
1947
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1927
1948
|
}
|
|
1928
1949
|
},
|
|
1929
1950
|
{
|
|
@@ -1934,8 +1955,8 @@
|
|
|
1934
1955
|
"description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
|
|
1935
1956
|
"fieldName": "multiSort",
|
|
1936
1957
|
"inheritedFrom": {
|
|
1937
|
-
"name": "
|
|
1938
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1958
|
+
"name": "SortMixin",
|
|
1959
|
+
"package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
|
|
1939
1960
|
}
|
|
1940
1961
|
},
|
|
1941
1962
|
{
|
|
@@ -1946,8 +1967,8 @@
|
|
|
1946
1967
|
"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.",
|
|
1947
1968
|
"fieldName": "multiSortOnShiftClick",
|
|
1948
1969
|
"inheritedFrom": {
|
|
1949
|
-
"name": "
|
|
1950
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1970
|
+
"name": "SortMixin",
|
|
1971
|
+
"package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
|
|
1951
1972
|
}
|
|
1952
1973
|
},
|
|
1953
1974
|
{
|
|
@@ -1958,8 +1979,8 @@
|
|
|
1958
1979
|
"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\"`.",
|
|
1959
1980
|
"fieldName": "multiSortPriority",
|
|
1960
1981
|
"inheritedFrom": {
|
|
1961
|
-
"name": "
|
|
1962
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1982
|
+
"name": "SortMixin",
|
|
1983
|
+
"package": "@vaadin/grid/src/vaadin-grid-sort-mixin.js"
|
|
1963
1984
|
}
|
|
1964
1985
|
},
|
|
1965
1986
|
{
|
|
@@ -1970,8 +1991,8 @@
|
|
|
1970
1991
|
"description": "Number of items fetched at a time from the dataprovider.",
|
|
1971
1992
|
"fieldName": "pageSize",
|
|
1972
1993
|
"inheritedFrom": {
|
|
1973
|
-
"name": "
|
|
1974
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
1994
|
+
"name": "DataProviderMixin",
|
|
1995
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
1975
1996
|
}
|
|
1976
1997
|
},
|
|
1977
1998
|
{
|
|
@@ -1982,8 +2003,8 @@
|
|
|
1982
2003
|
"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.",
|
|
1983
2004
|
"fieldName": "rowDetailsRenderer",
|
|
1984
2005
|
"inheritedFrom": {
|
|
1985
|
-
"name": "
|
|
1986
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
2006
|
+
"name": "RowDetailsMixin",
|
|
2007
|
+
"package": "@vaadin/grid/src/vaadin-grid-row-details-mixin.js"
|
|
1987
2008
|
}
|
|
1988
2009
|
},
|
|
1989
2010
|
{
|
|
@@ -1994,8 +2015,8 @@
|
|
|
1994
2015
|
"description": "Marks the grid's rows to be available for dragging.",
|
|
1995
2016
|
"fieldName": "rowsDraggable",
|
|
1996
2017
|
"inheritedFrom": {
|
|
1997
|
-
"name": "
|
|
1998
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
2018
|
+
"name": "DragAndDropMixin",
|
|
2019
|
+
"package": "@vaadin/grid/src/vaadin-grid-drag-and-drop-mixin.js"
|
|
1999
2020
|
}
|
|
2000
2021
|
},
|
|
2001
2022
|
{
|
|
@@ -2018,8 +2039,8 @@
|
|
|
2018
2039
|
"description": "The number of root-level items in the grid.",
|
|
2019
2040
|
"fieldName": "size",
|
|
2020
2041
|
"inheritedFrom": {
|
|
2021
|
-
"name": "
|
|
2022
|
-
"package": "@vaadin/grid/src/vaadin-grid.js"
|
|
2042
|
+
"name": "DataProviderMixin",
|
|
2043
|
+
"package": "@vaadin/grid/src/vaadin-grid-data-provider-mixin.js"
|
|
2023
2044
|
}
|
|
2024
2045
|
}
|
|
2025
2046
|
]
|