@bryntum/grid-thin-trial 7.2.0 → 7.2.2
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/fluent2-dark.css +31 -31
- package/grid.css +6 -1
- package/grid.css.map +3 -3
- package/grid.d.ts +180 -66
- package/high-contrast-dark.css +32 -32
- package/lib/column/Column.js +1 -1
- package/lib/column/DateColumn.js +1 -1
- package/lib/column/NumberColumn.js +1 -1
- package/lib/column/TreeColumn.js +1 -1
- package/lib/column/WidgetColumn.js +1 -1
- package/lib/feature/CellCopyPaste.js +1 -1
- package/lib/feature/CellEdit.js +1 -1
- package/lib/feature/CellMenu.js +1 -1
- package/lib/feature/ColumnRename.js +1 -1
- package/lib/feature/Filter.js +1 -1
- package/lib/feature/Group.js +1 -1
- package/lib/feature/HeaderMenu.js +1 -1
- package/lib/feature/LockRows.js +1 -1
- package/lib/feature/QuickFind.js +1 -1
- package/lib/feature/RowCopyPaste.css +3 -0
- package/lib/feature/RowCopyPaste.js +1 -1
- package/lib/feature/RowExpander.js +1 -1
- package/lib/feature/Search.js +1 -1
- package/lib/feature/Sort.js +1 -1
- package/lib/feature/Split.js +1 -1
- package/lib/feature/Tree.js +1 -1
- package/lib/feature/TreeGroup.js +1 -1
- package/lib/feature/base/CopyPasteBase.js +1 -1
- package/lib/feature/experimental/ExcelExporter.js +1 -1
- package/lib/feature/export/PdfExport.js +3 -3
- package/lib/feature/export/consumer/MemoryConsumer.js +1 -0
- package/lib/feature/export/exporter/SinglePageUnscaledExporter.js +1 -1
- package/lib/row/RowManager.js +1 -1
- package/lib/util/TableExporter.js +1 -1
- package/lib/view/Grid.js +1 -1
- package/lib/view/GridBase.css +1 -1
- package/lib/view/GridBase.js +1 -1
- package/lib/view/Header.js +1 -1
- package/lib/view/SubGrid.js +1 -1
- package/lib/view/export/ExportDialog.js +1 -1
- package/lib/view/mixin/GridElementEvents.js +1 -1
- package/lib/view/mixin/GridNavigation.js +1 -1
- package/lib/view/mixin/GridState.js +1 -1
- package/lib/widget/GroupBar.js +1 -1
- package/locales/grid.locale.De.js +1 -1
- package/material3-dark.css +31 -31
- package/package.json +1 -1
- package/stockholm-dark.css +32 -32
- package/svalbard-dark.css +32 -32
- package/visby-dark.css +34 -33
- package/visby-light.css +2 -1
package/grid.d.ts
CHANGED
|
@@ -867,6 +867,8 @@ type ActionColumnConfig = {
|
|
|
867
867
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
868
868
|
/**
|
|
869
869
|
* Renderer function for the column header.
|
|
870
|
+
* ...
|
|
871
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/ActionColumn#config-headerRenderer)
|
|
870
872
|
* @param {object} renderData
|
|
871
873
|
* @param {Grid.column.Column} renderData.column This column
|
|
872
874
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -912,7 +914,7 @@ type ActionColumnConfig = {
|
|
|
912
914
|
id?: string|number
|
|
913
915
|
/**
|
|
914
916
|
* Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
|
|
915
|
-
* field edit instead of when editing is finished by using
|
|
917
|
+
* field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
|
|
916
918
|
*/
|
|
917
919
|
instantUpdate?: boolean
|
|
918
920
|
/**
|
|
@@ -1080,7 +1082,7 @@ type ActionColumnConfig = {
|
|
|
1080
1082
|
*/
|
|
1081
1083
|
responsiveLevels?: object
|
|
1082
1084
|
/**
|
|
1083
|
-
* Setting this option means that pressing the
|
|
1085
|
+
* Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
|
|
1084
1086
|
* revert the field to the value it had when the edit began. If the value is *not* changed
|
|
1085
1087
|
* from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
1086
1088
|
* behaviour will be activated. Finally, the edit will be canceled.
|
|
@@ -1584,6 +1586,8 @@ type AggregateColumnConfig = {
|
|
|
1584
1586
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
1585
1587
|
/**
|
|
1586
1588
|
* Renderer function for the column header.
|
|
1589
|
+
* ...
|
|
1590
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/AggregateColumn#config-headerRenderer)
|
|
1587
1591
|
* @param {object} renderData
|
|
1588
1592
|
* @param {Grid.column.Column} renderData.column This column
|
|
1589
1593
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -1642,7 +1646,7 @@ type AggregateColumnConfig = {
|
|
|
1642
1646
|
includeParentInChangeSet?: boolean
|
|
1643
1647
|
/**
|
|
1644
1648
|
* Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
|
|
1645
|
-
* field edit instead of when editing is finished by using
|
|
1649
|
+
* field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
|
|
1646
1650
|
*/
|
|
1647
1651
|
instantUpdate?: boolean
|
|
1648
1652
|
/**
|
|
@@ -1827,7 +1831,7 @@ type AggregateColumnConfig = {
|
|
|
1827
1831
|
*/
|
|
1828
1832
|
responsiveLevels?: object
|
|
1829
1833
|
/**
|
|
1830
|
-
* Setting this option means that pressing the
|
|
1834
|
+
* Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
|
|
1831
1835
|
* revert the field to the value it had when the edit began. If the value is *not* changed
|
|
1832
1836
|
* from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
1833
1837
|
* behaviour will be activated. Finally, the edit will be canceled.
|
|
@@ -2352,6 +2356,8 @@ type ChartColumnConfig = {
|
|
|
2352
2356
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
2353
2357
|
/**
|
|
2354
2358
|
* Renderer function for the column header.
|
|
2359
|
+
* ...
|
|
2360
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/ChartColumn#config-headerRenderer)
|
|
2355
2361
|
* @param {object} renderData
|
|
2356
2362
|
* @param {Grid.column.Column} renderData.column This column
|
|
2357
2363
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -2402,7 +2408,7 @@ type ChartColumnConfig = {
|
|
|
2402
2408
|
id?: string|number
|
|
2403
2409
|
/**
|
|
2404
2410
|
* Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
|
|
2405
|
-
* field edit instead of when editing is finished by using
|
|
2411
|
+
* field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
|
|
2406
2412
|
*/
|
|
2407
2413
|
instantUpdate?: boolean
|
|
2408
2414
|
/**
|
|
@@ -2578,7 +2584,7 @@ type ChartColumnConfig = {
|
|
|
2578
2584
|
*/
|
|
2579
2585
|
responsiveLevels?: object
|
|
2580
2586
|
/**
|
|
2581
|
-
* Setting this option means that pressing the
|
|
2587
|
+
* Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
|
|
2582
2588
|
* revert the field to the value it had when the edit began. If the value is *not* changed
|
|
2583
2589
|
* from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
2584
2590
|
* behaviour will be activated. Finally, the edit will be canceled.
|
|
@@ -3125,6 +3131,8 @@ type CheckColumnConfig = {
|
|
|
3125
3131
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
3126
3132
|
/**
|
|
3127
3133
|
* Renderer function for the column header.
|
|
3134
|
+
* ...
|
|
3135
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/CheckColumn#config-headerRenderer)
|
|
3128
3136
|
* @param {object} renderData
|
|
3129
3137
|
* @param {Grid.column.Column} renderData.column This column
|
|
3130
3138
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -3175,7 +3183,7 @@ type CheckColumnConfig = {
|
|
|
3175
3183
|
id?: string|number
|
|
3176
3184
|
/**
|
|
3177
3185
|
* Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
|
|
3178
|
-
* field edit instead of when editing is finished by using
|
|
3186
|
+
* field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
|
|
3179
3187
|
*/
|
|
3180
3188
|
instantUpdate?: boolean
|
|
3181
3189
|
/**
|
|
@@ -3351,7 +3359,7 @@ type CheckColumnConfig = {
|
|
|
3351
3359
|
*/
|
|
3352
3360
|
responsiveLevels?: object
|
|
3353
3361
|
/**
|
|
3354
|
-
* Setting this option means that pressing the
|
|
3362
|
+
* Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
|
|
3355
3363
|
* revert the field to the value it had when the edit began. If the value is *not* changed
|
|
3356
3364
|
* from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
3357
3365
|
* behaviour will be activated. Finally, the edit will be canceled.
|
|
@@ -3913,6 +3921,8 @@ type ColorColumnConfig = {
|
|
|
3913
3921
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
3914
3922
|
/**
|
|
3915
3923
|
* Renderer function for the column header.
|
|
3924
|
+
* ...
|
|
3925
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/ColorColumn#config-headerRenderer)
|
|
3916
3926
|
* @param {object} renderData
|
|
3917
3927
|
* @param {Grid.column.Column} renderData.column This column
|
|
3918
3928
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -3963,7 +3973,7 @@ type ColorColumnConfig = {
|
|
|
3963
3973
|
id?: string|number
|
|
3964
3974
|
/**
|
|
3965
3975
|
* Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
|
|
3966
|
-
* field edit instead of when editing is finished by using
|
|
3976
|
+
* field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
|
|
3967
3977
|
*/
|
|
3968
3978
|
instantUpdate?: boolean
|
|
3969
3979
|
/**
|
|
@@ -4135,7 +4145,7 @@ type ColorColumnConfig = {
|
|
|
4135
4145
|
*/
|
|
4136
4146
|
responsiveLevels?: object
|
|
4137
4147
|
/**
|
|
4138
|
-
* Setting this option means that pressing the
|
|
4148
|
+
* Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
|
|
4139
4149
|
* revert the field to the value it had when the edit began. If the value is *not* changed
|
|
4140
4150
|
* from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
4141
4151
|
* behaviour will be activated. Finally, the edit will be canceled.
|
|
@@ -4646,6 +4656,8 @@ type ColumnConfig = {
|
|
|
4646
4656
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
4647
4657
|
/**
|
|
4648
4658
|
* Renderer function for the column header.
|
|
4659
|
+
* ...
|
|
4660
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-headerRenderer)
|
|
4649
4661
|
* @param {object} renderData
|
|
4650
4662
|
* @param {Grid.column.Column} renderData.column This column
|
|
4651
4663
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -4696,7 +4708,7 @@ type ColumnConfig = {
|
|
|
4696
4708
|
id?: string|number
|
|
4697
4709
|
/**
|
|
4698
4710
|
* Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
|
|
4699
|
-
* field edit instead of when editing is finished by using
|
|
4711
|
+
* field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
|
|
4700
4712
|
*/
|
|
4701
4713
|
instantUpdate?: boolean
|
|
4702
4714
|
/**
|
|
@@ -4868,7 +4880,7 @@ type ColumnConfig = {
|
|
|
4868
4880
|
*/
|
|
4869
4881
|
responsiveLevels?: object
|
|
4870
4882
|
/**
|
|
4871
|
-
* Setting this option means that pressing the
|
|
4883
|
+
* Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
|
|
4872
4884
|
* revert the field to the value it had when the edit began. If the value is *not* changed
|
|
4873
4885
|
* from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
4874
4886
|
* behaviour will be activated. Finally, the edit will be canceled.
|
|
@@ -5233,7 +5245,7 @@ export class Column extends Model {
|
|
|
5233
5245
|
icon: string
|
|
5234
5246
|
/**
|
|
5235
5247
|
* Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
|
|
5236
|
-
* field edit instead of when editing is finished by using
|
|
5248
|
+
* field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
|
|
5237
5249
|
*/
|
|
5238
5250
|
instantUpdate: boolean
|
|
5239
5251
|
/**
|
|
@@ -5329,7 +5341,7 @@ export class Column extends Model {
|
|
|
5329
5341
|
*/
|
|
5330
5342
|
responsiveLevels: object
|
|
5331
5343
|
/**
|
|
5332
|
-
* Setting this option means that pressing the
|
|
5344
|
+
* Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
|
|
5333
5345
|
* revert the field to the value it had when the edit began. If the value is *not* changed
|
|
5334
5346
|
* from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
5335
5347
|
* behaviour will be activated. Finally, the edit will be canceled.
|
|
@@ -5941,6 +5953,8 @@ type CurrencyColumnConfig = {
|
|
|
5941
5953
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
5942
5954
|
/**
|
|
5943
5955
|
* Renderer function for the column header.
|
|
5956
|
+
* ...
|
|
5957
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/CurrencyColumn#config-headerRenderer)
|
|
5944
5958
|
* @param {object} renderData
|
|
5945
5959
|
* @param {Grid.column.Column} renderData.column This column
|
|
5946
5960
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -5996,7 +6010,7 @@ type CurrencyColumnConfig = {
|
|
|
5996
6010
|
id?: string|number
|
|
5997
6011
|
/**
|
|
5998
6012
|
* Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
|
|
5999
|
-
* field edit instead of when editing is finished by using
|
|
6013
|
+
* field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
|
|
6000
6014
|
*/
|
|
6001
6015
|
instantUpdate?: boolean
|
|
6002
6016
|
/**
|
|
@@ -6181,7 +6195,7 @@ type CurrencyColumnConfig = {
|
|
|
6181
6195
|
*/
|
|
6182
6196
|
responsiveLevels?: object
|
|
6183
6197
|
/**
|
|
6184
|
-
* Setting this option means that pressing the
|
|
6198
|
+
* Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
|
|
6185
6199
|
* revert the field to the value it had when the edit began. If the value is *not* changed
|
|
6186
6200
|
* from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
6187
6201
|
* behaviour will be activated. Finally, the edit will be canceled.
|
|
@@ -6691,6 +6705,8 @@ type DateColumnConfig = {
|
|
|
6691
6705
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
6692
6706
|
/**
|
|
6693
6707
|
* Renderer function for the column header.
|
|
6708
|
+
* ...
|
|
6709
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn#config-headerRenderer)
|
|
6694
6710
|
* @param {object} renderData
|
|
6695
6711
|
* @param {Grid.column.Column} renderData.column This column
|
|
6696
6712
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -6741,7 +6757,7 @@ type DateColumnConfig = {
|
|
|
6741
6757
|
id?: string|number
|
|
6742
6758
|
/**
|
|
6743
6759
|
* Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
|
|
6744
|
-
* field edit instead of when editing is finished by using
|
|
6760
|
+
* field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
|
|
6745
6761
|
*/
|
|
6746
6762
|
instantUpdate?: boolean
|
|
6747
6763
|
/**
|
|
@@ -6921,7 +6937,7 @@ type DateColumnConfig = {
|
|
|
6921
6937
|
*/
|
|
6922
6938
|
responsiveLevels?: object
|
|
6923
6939
|
/**
|
|
6924
|
-
* Setting this option means that pressing the
|
|
6940
|
+
* Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
|
|
6925
6941
|
* revert the field to the value it had when the edit began. If the value is *not* changed
|
|
6926
6942
|
* from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
6927
6943
|
* behaviour will be activated. Finally, the edit will be canceled.
|
|
@@ -7452,6 +7468,8 @@ type NumberColumnConfig = {
|
|
|
7452
7468
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
7453
7469
|
/**
|
|
7454
7470
|
* Renderer function for the column header.
|
|
7471
|
+
* ...
|
|
7472
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/NumberColumn#config-headerRenderer)
|
|
7455
7473
|
* @param {object} renderData
|
|
7456
7474
|
* @param {Grid.column.Column} renderData.column This column
|
|
7457
7475
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -7502,7 +7520,7 @@ type NumberColumnConfig = {
|
|
|
7502
7520
|
id?: string|number
|
|
7503
7521
|
/**
|
|
7504
7522
|
* Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
|
|
7505
|
-
* field edit instead of when editing is finished by using
|
|
7523
|
+
* field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
|
|
7506
7524
|
*/
|
|
7507
7525
|
instantUpdate?: boolean
|
|
7508
7526
|
/**
|
|
@@ -7687,7 +7705,7 @@ type NumberColumnConfig = {
|
|
|
7687
7705
|
*/
|
|
7688
7706
|
responsiveLevels?: object
|
|
7689
7707
|
/**
|
|
7690
|
-
* Setting this option means that pressing the
|
|
7708
|
+
* Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
|
|
7691
7709
|
* revert the field to the value it had when the edit began. If the value is *not* changed
|
|
7692
7710
|
* from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
7693
7711
|
* behaviour will be activated. Finally, the edit will be canceled.
|
|
@@ -8229,6 +8247,8 @@ type PercentColumnConfig = {
|
|
|
8229
8247
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
8230
8248
|
/**
|
|
8231
8249
|
* Renderer function for the column header.
|
|
8250
|
+
* ...
|
|
8251
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/PercentColumn#config-headerRenderer)
|
|
8232
8252
|
* @param {object} renderData
|
|
8233
8253
|
* @param {Grid.column.Column} renderData.column This column
|
|
8234
8254
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -8274,7 +8294,7 @@ type PercentColumnConfig = {
|
|
|
8274
8294
|
id?: string|number
|
|
8275
8295
|
/**
|
|
8276
8296
|
* Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
|
|
8277
|
-
* field edit instead of when editing is finished by using
|
|
8297
|
+
* field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
|
|
8278
8298
|
*/
|
|
8279
8299
|
instantUpdate?: boolean
|
|
8280
8300
|
/**
|
|
@@ -8469,7 +8489,7 @@ type PercentColumnConfig = {
|
|
|
8469
8489
|
*/
|
|
8470
8490
|
responsiveLevels?: object
|
|
8471
8491
|
/**
|
|
8472
|
-
* Setting this option means that pressing the
|
|
8492
|
+
* Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
|
|
8473
8493
|
* revert the field to the value it had when the edit began. If the value is *not* changed
|
|
8474
8494
|
* from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
8475
8495
|
* behaviour will be activated. Finally, the edit will be canceled.
|
|
@@ -9005,6 +9025,8 @@ type RatingColumnConfig = {
|
|
|
9005
9025
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
9006
9026
|
/**
|
|
9007
9027
|
* Renderer function for the column header.
|
|
9028
|
+
* ...
|
|
9029
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/RatingColumn#config-headerRenderer)
|
|
9008
9030
|
* @param {object} renderData
|
|
9009
9031
|
* @param {Grid.column.Column} renderData.column This column
|
|
9010
9032
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -9055,7 +9077,7 @@ type RatingColumnConfig = {
|
|
|
9055
9077
|
id?: string|number
|
|
9056
9078
|
/**
|
|
9057
9079
|
* Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
|
|
9058
|
-
* field edit instead of when editing is finished by using
|
|
9080
|
+
* field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
|
|
9059
9081
|
*/
|
|
9060
9082
|
instantUpdate?: boolean
|
|
9061
9083
|
/**
|
|
@@ -9240,7 +9262,7 @@ type RatingColumnConfig = {
|
|
|
9240
9262
|
*/
|
|
9241
9263
|
responsiveLevels?: object
|
|
9242
9264
|
/**
|
|
9243
|
-
* Setting this option means that pressing the
|
|
9265
|
+
* Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
|
|
9244
9266
|
* revert the field to the value it had when the edit began. If the value is *not* changed
|
|
9245
9267
|
* from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
9246
9268
|
* behaviour will be activated. Finally, the edit will be canceled.
|
|
@@ -9683,6 +9705,8 @@ type RowNumberColumnConfig = {
|
|
|
9683
9705
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
9684
9706
|
/**
|
|
9685
9707
|
* Renderer function for the column header.
|
|
9708
|
+
* ...
|
|
9709
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/RowNumberColumn#config-headerRenderer)
|
|
9686
9710
|
* @param {object} renderData
|
|
9687
9711
|
* @param {Grid.column.Column} renderData.column This column
|
|
9688
9712
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -10349,6 +10373,8 @@ type SparklineColumnConfig = {
|
|
|
10349
10373
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
10350
10374
|
/**
|
|
10351
10375
|
* Renderer function for the column header.
|
|
10376
|
+
* ...
|
|
10377
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/SparklineColumn#config-headerRenderer)
|
|
10352
10378
|
* @param {object} renderData
|
|
10353
10379
|
* @param {Grid.column.Column} renderData.column This column
|
|
10354
10380
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -10409,7 +10435,7 @@ type SparklineColumnConfig = {
|
|
|
10409
10435
|
id?: string|number
|
|
10410
10436
|
/**
|
|
10411
10437
|
* Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
|
|
10412
|
-
* field edit instead of when editing is finished by using
|
|
10438
|
+
* field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
|
|
10413
10439
|
*/
|
|
10414
10440
|
instantUpdate?: boolean
|
|
10415
10441
|
/**
|
|
@@ -10585,7 +10611,7 @@ type SparklineColumnConfig = {
|
|
|
10585
10611
|
*/
|
|
10586
10612
|
responsiveLevels?: object
|
|
10587
10613
|
/**
|
|
10588
|
-
* Setting this option means that pressing the
|
|
10614
|
+
* Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
|
|
10589
10615
|
* revert the field to the value it had when the edit began. If the value is *not* changed
|
|
10590
10616
|
* from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
10591
10617
|
* behaviour will be activated. Finally, the edit will be canceled.
|
|
@@ -11071,6 +11097,8 @@ type TemplateColumnConfig = {
|
|
|
11071
11097
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
11072
11098
|
/**
|
|
11073
11099
|
* Renderer function for the column header.
|
|
11100
|
+
* ...
|
|
11101
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/TemplateColumn#config-headerRenderer)
|
|
11074
11102
|
* @param {object} renderData
|
|
11075
11103
|
* @param {Grid.column.Column} renderData.column This column
|
|
11076
11104
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -11121,7 +11149,7 @@ type TemplateColumnConfig = {
|
|
|
11121
11149
|
id?: string|number
|
|
11122
11150
|
/**
|
|
11123
11151
|
* Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
|
|
11124
|
-
* field edit instead of when editing is finished by using
|
|
11152
|
+
* field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
|
|
11125
11153
|
*/
|
|
11126
11154
|
instantUpdate?: boolean
|
|
11127
11155
|
/**
|
|
@@ -11293,7 +11321,7 @@ type TemplateColumnConfig = {
|
|
|
11293
11321
|
*/
|
|
11294
11322
|
responsiveLevels?: object
|
|
11295
11323
|
/**
|
|
11296
|
-
* Setting this option means that pressing the
|
|
11324
|
+
* Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
|
|
11297
11325
|
* revert the field to the value it had when the edit began. If the value is *not* changed
|
|
11298
11326
|
* from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
11299
11327
|
* behaviour will be activated. Finally, the edit will be canceled.
|
|
@@ -11798,6 +11826,8 @@ type TimeColumnConfig = {
|
|
|
11798
11826
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
11799
11827
|
/**
|
|
11800
11828
|
* Renderer function for the column header.
|
|
11829
|
+
* ...
|
|
11830
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/TimeColumn#config-headerRenderer)
|
|
11801
11831
|
* @param {object} renderData
|
|
11802
11832
|
* @param {Grid.column.Column} renderData.column This column
|
|
11803
11833
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -11848,7 +11878,7 @@ type TimeColumnConfig = {
|
|
|
11848
11878
|
id?: string|number
|
|
11849
11879
|
/**
|
|
11850
11880
|
* Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
|
|
11851
|
-
* field edit instead of when editing is finished by using
|
|
11881
|
+
* field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
|
|
11852
11882
|
*/
|
|
11853
11883
|
instantUpdate?: boolean
|
|
11854
11884
|
/**
|
|
@@ -12020,7 +12050,7 @@ type TimeColumnConfig = {
|
|
|
12020
12050
|
*/
|
|
12021
12051
|
responsiveLevels?: object
|
|
12022
12052
|
/**
|
|
12023
|
-
* Setting this option means that pressing the
|
|
12053
|
+
* Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
|
|
12024
12054
|
* revert the field to the value it had when the edit began. If the value is *not* changed
|
|
12025
12055
|
* from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
12026
12056
|
* behaviour will be activated. Finally, the edit will be canceled.
|
|
@@ -12528,6 +12558,8 @@ type TreeColumnConfig = {
|
|
|
12528
12558
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
12529
12559
|
/**
|
|
12530
12560
|
* Renderer function for the column header.
|
|
12561
|
+
* ...
|
|
12562
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/TreeColumn#config-headerRenderer)
|
|
12531
12563
|
* @param {object} renderData
|
|
12532
12564
|
* @param {Grid.column.Column} renderData.column This column
|
|
12533
12565
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -12584,7 +12616,7 @@ type TreeColumnConfig = {
|
|
|
12584
12616
|
indentSize?: number
|
|
12585
12617
|
/**
|
|
12586
12618
|
* Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
|
|
12587
|
-
* field edit instead of when editing is finished by using
|
|
12619
|
+
* field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
|
|
12588
12620
|
*/
|
|
12589
12621
|
instantUpdate?: boolean
|
|
12590
12622
|
/**
|
|
@@ -12760,7 +12792,7 @@ type TreeColumnConfig = {
|
|
|
12760
12792
|
*/
|
|
12761
12793
|
responsiveLevels?: object
|
|
12762
12794
|
/**
|
|
12763
|
-
* Setting this option means that pressing the
|
|
12795
|
+
* Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
|
|
12764
12796
|
* revert the field to the value it had when the edit began. If the value is *not* changed
|
|
12765
12797
|
* from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
12766
12798
|
* behaviour will be activated. Finally, the edit will be canceled.
|
|
@@ -13285,6 +13317,8 @@ type WidgetColumnConfig = {
|
|
|
13285
13317
|
headerMenuItems?: Record<string, MenuItemEntry>
|
|
13286
13318
|
/**
|
|
13287
13319
|
* Renderer function for the column header.
|
|
13320
|
+
* ...
|
|
13321
|
+
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/WidgetColumn#config-headerRenderer)
|
|
13288
13322
|
* @param {object} renderData
|
|
13289
13323
|
* @param {Grid.column.Column} renderData.column This column
|
|
13290
13324
|
* @param {HTMLElement} renderData.headerElement The header element
|
|
@@ -13335,7 +13369,7 @@ type WidgetColumnConfig = {
|
|
|
13335
13369
|
id?: string|number
|
|
13336
13370
|
/**
|
|
13337
13371
|
* Set to `true` to have the [CellEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit) feature update the record being edited live upon
|
|
13338
|
-
* field edit instead of when editing is finished by using
|
|
13372
|
+
* field edit instead of when editing is finished by using <kbd>Tab</kbd> or <kbd>Enter</kbd>
|
|
13339
13373
|
*/
|
|
13340
13374
|
instantUpdate?: boolean
|
|
13341
13375
|
/**
|
|
@@ -13511,7 +13545,7 @@ type WidgetColumnConfig = {
|
|
|
13511
13545
|
*/
|
|
13512
13546
|
responsiveLevels?: object
|
|
13513
13547
|
/**
|
|
13514
|
-
* Setting this option means that pressing the
|
|
13548
|
+
* Setting this option means that pressing the <kbd>Escape</kbd> key after editing the field will
|
|
13515
13549
|
* revert the field to the value it had when the edit began. If the value is *not* changed
|
|
13516
13550
|
* from when the edit started, the input field's [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
13517
13551
|
* behaviour will be activated. Finally, the edit will be canceled.
|
|
@@ -16204,7 +16238,7 @@ export class CellEdit extends GridEditBase {
|
|
|
16204
16238
|
/**
|
|
16205
16239
|
* Displays an OK / Cancel confirmation dialog box owned by the current Editor. This is intended to be
|
|
16206
16240
|
* used by [finalizeCellEdit](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-finalizeCellEdit) implementations. The returned promise resolves passing
|
|
16207
|
-
* `true` if the "OK" button is pressed, and `false` if the "Cancel" button is pressed. Typing
|
|
16241
|
+
* `true` if the "OK" button is pressed, and `false` if the "Cancel" button is pressed. Typing <kbd>Escape</kbd> rejects.
|
|
16208
16242
|
* @param {object} options An options object for what to show.
|
|
16209
16243
|
*/
|
|
16210
16244
|
confirm(options: {
|
|
@@ -16468,7 +16502,7 @@ type CellMenuConfig = {
|
|
|
16468
16502
|
|
|
16469
16503
|
/**
|
|
16470
16504
|
* Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
|
|
16471
|
-
*
|
|
16505
|
+
* <kbd>Space</kbd> key when the cell is focused.
|
|
16472
16506
|
* ...
|
|
16473
16507
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu)
|
|
16474
16508
|
*/
|
|
@@ -16741,7 +16775,7 @@ type CellTooltipConfig = {
|
|
|
16741
16775
|
*/
|
|
16742
16776
|
closeAction?: 'hide'|'destroy'
|
|
16743
16777
|
/**
|
|
16744
|
-
* Close popup when
|
|
16778
|
+
* Close popup when <kbd>Escape</kbd> key is pressed.
|
|
16745
16779
|
*/
|
|
16746
16780
|
closeOnEscape?: boolean
|
|
16747
16781
|
/**
|
|
@@ -20353,8 +20387,8 @@ type GroupConfig = {
|
|
|
20353
20387
|
|
|
20354
20388
|
/**
|
|
20355
20389
|
* Enables rendering and handling of row groups. The actual grouping is done in the store, but triggered by
|
|
20356
|
-
* <kbd>
|
|
20357
|
-
* one anywhere on grid). Use <kbd>
|
|
20390
|
+
* <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
|
|
20391
|
+
* one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
|
|
20358
20392
|
* grouper.
|
|
20359
20393
|
* ...
|
|
20360
20394
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Group)
|
|
@@ -25636,10 +25670,10 @@ type TreeGroupConfig = {
|
|
|
25636
25670
|
*/
|
|
25637
25671
|
parentCls?: string
|
|
25638
25672
|
/**
|
|
25639
|
-
* A function letting you format the text shown in the generated parent group levels. This method will be
|
|
25640
|
-
* with the value produced by the column representing the grouped level. Each column's renderer method
|
|
25641
|
-
* provided an extra `isTreeGroup` param to indicate that the value will be used for a generated parent.
|
|
25642
|
-
* and other DOM specific args will be in the context of the tree column.
|
|
25673
|
+
* A function letting you format the text shown in the generated parent group levels. This method will be
|
|
25674
|
+
* provided with the value produced by the column representing the grouped level. Each column's renderer method
|
|
25675
|
+
* will be provided an extra `isTreeGroup` param to indicate that the value will be used for a generated parent.
|
|
25676
|
+
* `cellElement` and other DOM specific args will be in the context of the tree column.
|
|
25643
25677
|
* ...
|
|
25644
25678
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/TreeGroup#config-parentRenderer)
|
|
25645
25679
|
* @param {object} data The rendering data representing the generated tree parent record
|
|
@@ -26793,7 +26827,7 @@ type ExcelExporterConfig = {
|
|
|
26793
26827
|
*/
|
|
26794
26828
|
localizableProperties?: string[]
|
|
26795
26829
|
/**
|
|
26796
|
-
* This hook allows
|
|
26830
|
+
* This hook allows using 3rd party libraries to generate XLSX files.
|
|
26797
26831
|
* ...
|
|
26798
26832
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsProvider)
|
|
26799
26833
|
*/
|
|
@@ -29288,7 +29322,7 @@ type SinglePageUnscaledExporterConfig = {
|
|
|
29288
29322
|
|
|
29289
29323
|
/**
|
|
29290
29324
|
* A single page exporter. Used by the [PdfExport](https://bryntum.com/products/grid/docs/api/Grid/feature/export/PdfExport) feature to export to single page. Content
|
|
29291
|
-
* is exported with dimensions required to fit all requested rows and columns. This allows
|
|
29325
|
+
* is exported with dimensions required to fit all requested rows and columns. This allows generating a PDF page not
|
|
29292
29326
|
* constrained by the standard paper formats.
|
|
29293
29327
|
* ...
|
|
29294
29328
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/exporter/SinglePageUnscaledExporter)
|
|
@@ -29698,7 +29732,7 @@ type GridListenersTypes = {
|
|
|
29698
29732
|
*/
|
|
29699
29733
|
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
|
|
29700
29734
|
/**
|
|
29701
|
-
* Fires on the owning Grid before deleting a range of selected cell values by pressing
|
|
29735
|
+
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
29702
29736
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
29703
29737
|
* @param {object} event Event object
|
|
29704
29738
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
@@ -30663,6 +30697,14 @@ type GridListenersTypes = {
|
|
|
30663
30697
|
* @param {Core.widget.Tool} event.tool The tool which is being clicked.
|
|
30664
30698
|
*/
|
|
30665
30699
|
toolClick: (event: { source: Tool, tool: Tool }) => void
|
|
30700
|
+
/**
|
|
30701
|
+
* Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
|
|
30702
|
+
* @param {object} event Event object
|
|
30703
|
+
* @param {Grid.view.Grid} event.source The grid instance
|
|
30704
|
+
* @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
|
|
30705
|
+
* @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
|
|
30706
|
+
*/
|
|
30707
|
+
treeGroup: (event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void
|
|
30666
30708
|
/**
|
|
30667
30709
|
* Fires when row locking is disabled.
|
|
30668
30710
|
* @param {object} event Event object
|
|
@@ -30717,7 +30759,7 @@ type GridListeners = {
|
|
|
30717
30759
|
*/
|
|
30718
30760
|
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
|
|
30719
30761
|
/**
|
|
30720
|
-
* Fires on the owning Grid before deleting a range of selected cell values by pressing
|
|
30762
|
+
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
30721
30763
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
30722
30764
|
* @param {object} event Event object
|
|
30723
30765
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
@@ -31682,6 +31724,14 @@ type GridListeners = {
|
|
|
31682
31724
|
* @param {Core.widget.Tool} event.tool The tool which is being clicked.
|
|
31683
31725
|
*/
|
|
31684
31726
|
toolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
|
|
31727
|
+
/**
|
|
31728
|
+
* Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
|
|
31729
|
+
* @param {object} event Event object
|
|
31730
|
+
* @param {Grid.view.Grid} event.source The grid instance
|
|
31731
|
+
* @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
|
|
31732
|
+
* @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
|
|
31733
|
+
*/
|
|
31734
|
+
treeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
|
|
31685
31735
|
/**
|
|
31686
31736
|
* Fires when row locking is disabled.
|
|
31687
31737
|
* @param {object} event Event object
|
|
@@ -32346,7 +32396,7 @@ type GridConfig = {
|
|
|
32346
32396
|
rootElement?: ShadowRoot|HTMLElement
|
|
32347
32397
|
/**
|
|
32348
32398
|
* Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
|
|
32349
|
-
*
|
|
32399
|
+
* overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
|
|
32350
32400
|
* a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
|
|
32351
32401
|
* ...
|
|
32352
32402
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-rowHeight)
|
|
@@ -32577,7 +32627,7 @@ type GridConfig = {
|
|
|
32577
32627
|
*/
|
|
32578
32628
|
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
|
|
32579
32629
|
/**
|
|
32580
|
-
* Fires on the owning Grid before deleting a range of selected cell values by pressing
|
|
32630
|
+
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
32581
32631
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
32582
32632
|
* @param {object} event Event object
|
|
32583
32633
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
@@ -33542,6 +33592,14 @@ type GridConfig = {
|
|
|
33542
33592
|
* @param {Core.widget.Tool} event.tool The tool which is being clicked.
|
|
33543
33593
|
*/
|
|
33544
33594
|
onToolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
|
|
33595
|
+
/**
|
|
33596
|
+
* Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
|
|
33597
|
+
* @param {object} event Event object
|
|
33598
|
+
* @param {Grid.view.Grid} event.source The grid instance
|
|
33599
|
+
* @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
|
|
33600
|
+
* @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
|
|
33601
|
+
*/
|
|
33602
|
+
onTreeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
|
|
33545
33603
|
/**
|
|
33546
33604
|
* Fires when row locking is disabled.
|
|
33547
33605
|
* @param {object} event Event object
|
|
@@ -33815,7 +33873,7 @@ type GridBaseListenersTypes = {
|
|
|
33815
33873
|
*/
|
|
33816
33874
|
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
|
|
33817
33875
|
/**
|
|
33818
|
-
* Fires on the owning Grid before deleting a range of selected cell values by pressing
|
|
33876
|
+
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
33819
33877
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
33820
33878
|
* @param {object} event Event object
|
|
33821
33879
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
@@ -34780,6 +34838,14 @@ type GridBaseListenersTypes = {
|
|
|
34780
34838
|
* @param {Core.widget.Tool} event.tool The tool which is being clicked.
|
|
34781
34839
|
*/
|
|
34782
34840
|
toolClick: (event: { source: Tool, tool: Tool }) => void
|
|
34841
|
+
/**
|
|
34842
|
+
* Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
|
|
34843
|
+
* @param {object} event Event object
|
|
34844
|
+
* @param {Grid.view.Grid} event.source The grid instance
|
|
34845
|
+
* @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
|
|
34846
|
+
* @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
|
|
34847
|
+
*/
|
|
34848
|
+
treeGroup: (event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void
|
|
34783
34849
|
/**
|
|
34784
34850
|
* Fires when row locking is disabled.
|
|
34785
34851
|
* @param {object} event Event object
|
|
@@ -34834,7 +34900,7 @@ type GridBaseListeners = {
|
|
|
34834
34900
|
*/
|
|
34835
34901
|
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
|
|
34836
34902
|
/**
|
|
34837
|
-
* Fires on the owning Grid before deleting a range of selected cell values by pressing
|
|
34903
|
+
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
34838
34904
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
34839
34905
|
* @param {object} event Event object
|
|
34840
34906
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
@@ -35799,6 +35865,14 @@ type GridBaseListeners = {
|
|
|
35799
35865
|
* @param {Core.widget.Tool} event.tool The tool which is being clicked.
|
|
35800
35866
|
*/
|
|
35801
35867
|
toolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
|
|
35868
|
+
/**
|
|
35869
|
+
* Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
|
|
35870
|
+
* @param {object} event Event object
|
|
35871
|
+
* @param {Grid.view.Grid} event.source The grid instance
|
|
35872
|
+
* @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
|
|
35873
|
+
* @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
|
|
35874
|
+
*/
|
|
35875
|
+
treeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
|
|
35802
35876
|
/**
|
|
35803
35877
|
* Fires when row locking is disabled.
|
|
35804
35878
|
* @param {object} event Event object
|
|
@@ -36462,7 +36536,7 @@ type GridBaseConfig = {
|
|
|
36462
36536
|
rootElement?: ShadowRoot|HTMLElement
|
|
36463
36537
|
/**
|
|
36464
36538
|
* Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
|
|
36465
|
-
*
|
|
36539
|
+
* overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
|
|
36466
36540
|
* a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
|
|
36467
36541
|
* ...
|
|
36468
36542
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rowHeight)
|
|
@@ -36693,7 +36767,7 @@ type GridBaseConfig = {
|
|
|
36693
36767
|
*/
|
|
36694
36768
|
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
|
|
36695
36769
|
/**
|
|
36696
|
-
* Fires on the owning Grid before deleting a range of selected cell values by pressing
|
|
36770
|
+
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
36697
36771
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
36698
36772
|
* @param {object} event Event object
|
|
36699
36773
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
@@ -37658,6 +37732,14 @@ type GridBaseConfig = {
|
|
|
37658
37732
|
* @param {Core.widget.Tool} event.tool The tool which is being clicked.
|
|
37659
37733
|
*/
|
|
37660
37734
|
onToolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
|
|
37735
|
+
/**
|
|
37736
|
+
* Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
|
|
37737
|
+
* @param {object} event Event object
|
|
37738
|
+
* @param {Grid.view.Grid} event.source The grid instance
|
|
37739
|
+
* @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
|
|
37740
|
+
* @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
|
|
37741
|
+
*/
|
|
37742
|
+
onTreeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
|
|
37661
37743
|
/**
|
|
37662
37744
|
* Fires when row locking is disabled.
|
|
37663
37745
|
* @param {object} event Event object
|
|
@@ -37921,7 +38003,7 @@ export class GridBase extends Panel {
|
|
|
37921
38003
|
readonly responsiveLevel: string
|
|
37922
38004
|
/**
|
|
37923
38005
|
* Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
|
|
37924
|
-
*
|
|
38006
|
+
* overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
|
|
37925
38007
|
* a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
|
|
37926
38008
|
*/
|
|
37927
38009
|
rowHeight: number
|
|
@@ -38041,7 +38123,7 @@ export class GridBase extends Panel {
|
|
|
38041
38123
|
*/
|
|
38042
38124
|
onBeforeCellEditStart: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
|
|
38043
38125
|
/**
|
|
38044
|
-
* Fires on the owning Grid before deleting a range of selected cell values by pressing
|
|
38126
|
+
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
38045
38127
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
38046
38128
|
* @param {object} event Event object
|
|
38047
38129
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
@@ -38870,6 +38952,14 @@ export class GridBase extends Panel {
|
|
|
38870
38952
|
* @param {boolean} event.collapse `true` if the node is being collapsed.
|
|
38871
38953
|
*/
|
|
38872
38954
|
onToggleNode: ((event: { record: Model, collapse: boolean }) => void)|string
|
|
38955
|
+
/**
|
|
38956
|
+
* Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
|
|
38957
|
+
* @param {object} event Event object
|
|
38958
|
+
* @param {Grid.view.Grid} event.source The grid instance
|
|
38959
|
+
* @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
|
|
38960
|
+
* @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
|
|
38961
|
+
*/
|
|
38962
|
+
onTreeGroup: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
|
|
38873
38963
|
/**
|
|
38874
38964
|
* Fires when row locking is disabled.
|
|
38875
38965
|
* @param {object} event Event object
|
|
@@ -40360,7 +40450,7 @@ type TreeGridListenersTypes = {
|
|
|
40360
40450
|
*/
|
|
40361
40451
|
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void
|
|
40362
40452
|
/**
|
|
40363
|
-
* Fires on the owning Grid before deleting a range of selected cell values by pressing
|
|
40453
|
+
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
40364
40454
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
40365
40455
|
* @param {object} event Event object
|
|
40366
40456
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
@@ -41325,6 +41415,14 @@ type TreeGridListenersTypes = {
|
|
|
41325
41415
|
* @param {Core.widget.Tool} event.tool The tool which is being clicked.
|
|
41326
41416
|
*/
|
|
41327
41417
|
toolClick: (event: { source: Tool, tool: Tool }) => void
|
|
41418
|
+
/**
|
|
41419
|
+
* Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
|
|
41420
|
+
* @param {object} event Event object
|
|
41421
|
+
* @param {Grid.view.Grid} event.source The grid instance
|
|
41422
|
+
* @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
|
|
41423
|
+
* @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
|
|
41424
|
+
*/
|
|
41425
|
+
treeGroup: (event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void
|
|
41328
41426
|
/**
|
|
41329
41427
|
* Fires when row locking is disabled.
|
|
41330
41428
|
* @param {object} event Event object
|
|
@@ -41379,7 +41477,7 @@ type TreeGridListeners = {
|
|
|
41379
41477
|
*/
|
|
41380
41478
|
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
|
|
41381
41479
|
/**
|
|
41382
|
-
* Fires on the owning Grid before deleting a range of selected cell values by pressing
|
|
41480
|
+
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
41383
41481
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
41384
41482
|
* @param {object} event Event object
|
|
41385
41483
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
@@ -42344,6 +42442,14 @@ type TreeGridListeners = {
|
|
|
42344
42442
|
* @param {Core.widget.Tool} event.tool The tool which is being clicked.
|
|
42345
42443
|
*/
|
|
42346
42444
|
toolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
|
|
42445
|
+
/**
|
|
42446
|
+
* Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
|
|
42447
|
+
* @param {object} event Event object
|
|
42448
|
+
* @param {Grid.view.Grid} event.source The grid instance
|
|
42449
|
+
* @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
|
|
42450
|
+
* @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
|
|
42451
|
+
*/
|
|
42452
|
+
treeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
|
|
42347
42453
|
/**
|
|
42348
42454
|
* Fires when row locking is disabled.
|
|
42349
42455
|
* @param {object} event Event object
|
|
@@ -43008,7 +43114,7 @@ type TreeGridConfig = {
|
|
|
43008
43114
|
rootElement?: ShadowRoot|HTMLElement
|
|
43009
43115
|
/**
|
|
43010
43116
|
* Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
|
|
43011
|
-
*
|
|
43117
|
+
* overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
|
|
43012
43118
|
* a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
|
|
43013
43119
|
* ...
|
|
43014
43120
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-rowHeight)
|
|
@@ -43239,7 +43345,7 @@ type TreeGridConfig = {
|
|
|
43239
43345
|
*/
|
|
43240
43346
|
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
|
|
43241
43347
|
/**
|
|
43242
|
-
* Fires on the owning Grid before deleting a range of selected cell values by pressing
|
|
43348
|
+
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
43243
43349
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
43244
43350
|
* @param {object} event Event object
|
|
43245
43351
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
@@ -44204,6 +44310,14 @@ type TreeGridConfig = {
|
|
|
44204
44310
|
* @param {Core.widget.Tool} event.tool The tool which is being clicked.
|
|
44205
44311
|
*/
|
|
44206
44312
|
onToolClick?: ((event: { source: Tool, tool: Tool }) => void)|string
|
|
44313
|
+
/**
|
|
44314
|
+
* Fired on the owning Grid/Scheduler/Gantt after tree grouping levels change
|
|
44315
|
+
* @param {object} event Event object
|
|
44316
|
+
* @param {Grid.view.Grid} event.source The grid instance
|
|
44317
|
+
* @param {(string|Function)[]} event.groupers Array of field names or functions representing the current grouping levels
|
|
44318
|
+
* @param {(string|Function)[]} event.oldGroupers Array of field names or functions representing the previous grouping levels
|
|
44319
|
+
*/
|
|
44320
|
+
onTreeGroup?: ((event: { source: Grid, groupers: (string|Function)[], oldGroupers: (string|Function)[] }) => void)|string
|
|
44207
44321
|
/**
|
|
44208
44322
|
* Fires when row locking is disabled.
|
|
44209
44323
|
* @param {object} event Event object
|
|
@@ -44949,7 +45063,7 @@ type ExportDialogConfig = {
|
|
|
44949
45063
|
*/
|
|
44950
45064
|
closeAction?: 'hide'|'destroy'
|
|
44951
45065
|
/**
|
|
44952
|
-
* Close popup when
|
|
45066
|
+
* Close popup when <kbd>Escape</kbd> key is pressed.
|
|
44953
45067
|
*/
|
|
44954
45068
|
closeOnEscape?: boolean
|
|
44955
45069
|
/**
|
|
@@ -47400,7 +47514,7 @@ type AIFilterFieldConfig = {
|
|
|
47400
47514
|
required?: boolean
|
|
47401
47515
|
/**
|
|
47402
47516
|
* If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
47403
|
-
* the
|
|
47517
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
47404
47518
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
47405
47519
|
* behaviour will be activated.
|
|
47406
47520
|
*/
|
|
@@ -48259,7 +48373,7 @@ type ChecklistFilterComboConfig = {
|
|
|
48259
48373
|
contentElementCls?: string|object
|
|
48260
48374
|
/**
|
|
48261
48375
|
* If configured as `true`, this means that when an unmatched string is typed into the
|
|
48262
|
-
* combo's input field, and
|
|
48376
|
+
* combo's input field, and <kbd>Enter</kbd>, or the [multiValueSeparator](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
|
|
48263
48377
|
* a new record will be created using the typed string as the [displayField](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-displayField).
|
|
48264
48378
|
* ...
|
|
48265
48379
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-createOnUnmatched)
|
|
@@ -48759,7 +48873,7 @@ type ChecklistFilterComboConfig = {
|
|
|
48759
48873
|
required?: boolean
|
|
48760
48874
|
/**
|
|
48761
48875
|
* If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
48762
|
-
* the
|
|
48876
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
48763
48877
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
48764
48878
|
* behaviour will be activated.
|
|
48765
48879
|
*/
|
|
@@ -53073,7 +53187,7 @@ type GroupBarConfig = {
|
|
|
53073
53187
|
*/
|
|
53074
53188
|
title?: string
|
|
53075
53189
|
/**
|
|
53076
|
-
* Select/deselect all if
|
|
53190
|
+
* Select/deselect all if <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> is pressed when clicking
|
|
53077
53191
|
*/
|
|
53078
53192
|
toggleAllIfCtrlPressed?: boolean
|
|
53079
53193
|
/**
|
|
@@ -53833,7 +53947,7 @@ type TreeComboConfig = {
|
|
|
53833
53947
|
contentElementCls?: string|object
|
|
53834
53948
|
/**
|
|
53835
53949
|
* If configured as `true`, this means that when an unmatched string is typed into the
|
|
53836
|
-
* combo's input field, and
|
|
53950
|
+
* combo's input field, and <kbd>Enter</kbd>, or the [multiValueSeparator](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
|
|
53837
53951
|
* a new record will be created using the typed string as the [displayField](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-displayField).
|
|
53838
53952
|
* ...
|
|
53839
53953
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-createOnUnmatched)
|
|
@@ -54333,7 +54447,7 @@ type TreeComboConfig = {
|
|
|
54333
54447
|
required?: boolean
|
|
54334
54448
|
/**
|
|
54335
54449
|
* If this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
|
|
54336
|
-
* the
|
|
54450
|
+
* the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
|
|
54337
54451
|
* the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
54338
54452
|
* behaviour will be activated.
|
|
54339
54453
|
*/
|