@bryntum/grid-thin-trial 7.1.1 → 7.1.3
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/README.md +277 -20
- package/grid.css +10 -1
- package/grid.css.map +2 -2
- package/grid.d.ts +445 -263
- package/lib/column/ActionColumn.js +1 -1
- package/lib/column/CheckColumn.js +1 -1
- package/lib/column/Column.js +1 -1
- package/lib/column/DateColumn.js +1 -1
- package/lib/column/NumberColumn.js +1 -1
- package/lib/column/TimeColumn.js +1 -1
- package/lib/column/TreeColumn.css +2 -1
- package/lib/data/ColumnStore.js +1 -1
- package/lib/feature/CellEdit.js +1 -1
- package/lib/feature/ColumnResize.css +1 -0
- package/lib/feature/Filter.css +1 -0
- package/lib/feature/Filter.js +1 -1
- package/lib/feature/FilterBar.js +1 -1
- package/lib/feature/Group.css +2 -0
- package/lib/feature/GroupSummary.js +1 -1
- package/lib/feature/RowReorder.css +1 -0
- package/lib/feature/RowReorder.js +1 -1
- package/lib/feature/Sort.css +1 -0
- package/lib/feature/Summary.js +1 -1
- package/lib/feature/TreeGroup.js +1 -1
- package/lib/feature/export/PdfExport.js +4 -4
- package/lib/feature/export/mixin/PrintMixin.js +1 -1
- package/lib/row/Row.js +1 -1
- package/lib/row/RowManager.js +1 -1
- package/lib/util/GridLocation.js +1 -1
- package/lib/util/SubGridScroller.js +1 -1
- package/lib/view/GridBase.css +2 -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/TreeGrid.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/GridSubGrids.js +1 -1
- package/lib/widget/GroupBar.css +1 -0
- package/package.json +1 -1
- package/postinstall.cjs +4 -5
package/grid.d.ts
CHANGED
|
@@ -26,10 +26,16 @@ type ActionConfig = {
|
|
|
26
26
|
*/
|
|
27
27
|
cls?: string
|
|
28
28
|
/**
|
|
29
|
-
* A text to use for the action element
|
|
30
|
-
* action
|
|
29
|
+
* A text to use for the action element's `aria-label` value. If not provided, the
|
|
30
|
+
* action's `tooltip` will be used as the `aria-label` (if present).
|
|
31
31
|
*/
|
|
32
32
|
ariaLabel?: string
|
|
33
|
+
/**
|
|
34
|
+
* A value to use for the action element's `aria-haspopup` attribute.
|
|
35
|
+
* Set to indicate that the action triggers a popup. This helps assistive technologies inform users that activating
|
|
36
|
+
* the action will display a popup element.
|
|
37
|
+
*/
|
|
38
|
+
ariaHasPopup?: 'true'|'false'|'menu'|'listbox'|'tree'|'grid'|'dialog'|boolean
|
|
33
39
|
/**
|
|
34
40
|
* Tooltip text, or a config object which can reconfigure the shared
|
|
35
41
|
* tooltip by setting boolean, numeric and string config values, or a function to return the tooltip text, passed the
|
|
@@ -289,7 +295,7 @@ type EmptyTextDomConfig = DomConfig & {
|
|
|
289
295
|
/**
|
|
290
296
|
* The grid region to add the empty text to
|
|
291
297
|
*/
|
|
292
|
-
region?: string
|
|
298
|
+
region?: 'locked'|'normal'|string
|
|
293
299
|
}
|
|
294
300
|
|
|
295
301
|
type GridScrollOptions = {
|
|
@@ -2958,7 +2964,7 @@ type CheckColumnConfig = {
|
|
|
2958
2964
|
*/
|
|
2959
2965
|
cellMenuItems?: Record<string, MenuItemEntry>
|
|
2960
2966
|
/**
|
|
2961
|
-
* The `aria-label`
|
|
2967
|
+
* The `aria-label` used for the default checkbox widget in this column’s cells.
|
|
2962
2968
|
*/
|
|
2963
2969
|
checkAriaLabel?: string
|
|
2964
2970
|
/**
|
|
@@ -3517,7 +3523,7 @@ export class CheckColumn extends WidgetColumn {
|
|
|
3517
3523
|
*/
|
|
3518
3524
|
static readonly isCheckColumn: boolean
|
|
3519
3525
|
/**
|
|
3520
|
-
* The `aria-label`
|
|
3526
|
+
* The `aria-label` used for the default checkbox widget in this column’s cells.
|
|
3521
3527
|
*/
|
|
3522
3528
|
checkAriaLabel: string
|
|
3523
3529
|
/**
|
|
@@ -6886,8 +6892,8 @@ type DateColumnConfig = {
|
|
|
6886
6892
|
*/
|
|
6887
6893
|
remoteChildCount?: number
|
|
6888
6894
|
/**
|
|
6889
|
-
* Renderer function, used to style the date displayed in the cell. Can also affect other aspects of
|
|
6890
|
-
*
|
|
6895
|
+
* Renderer function, used to style the date displayed in the cell. Can also affect other aspects of the cell,
|
|
6896
|
+
* such as styling.
|
|
6891
6897
|
* ...
|
|
6892
6898
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn#config-renderer)
|
|
6893
6899
|
* @param {object} renderData Object containing renderer parameters
|
|
@@ -7048,9 +7054,9 @@ type DateColumnConfig = {
|
|
|
7048
7054
|
}
|
|
7049
7055
|
|
|
7050
7056
|
/**
|
|
7051
|
-
* A column that displays a date in the specified [format](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn#config-format). By default `L` format is used, which
|
|
7052
|
-
*
|
|
7053
|
-
*
|
|
7057
|
+
* A column that displays a date in the specified [format](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn#config-format). By default `L` format is used, which contains
|
|
7058
|
+
* the following info: full year, 2-digit month, and 2-digit day. Depending on the browser locale, the formatted date
|
|
7059
|
+
* might look different. [Intl.DateTimeFormat API](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat)
|
|
7054
7060
|
* is used to format the date. Here is an example of possible outputs depending on the browser locale:
|
|
7055
7061
|
* ...
|
|
7056
7062
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/column/DateColumn)
|
|
@@ -7084,8 +7090,8 @@ export class DateColumn extends Column {
|
|
|
7084
7090
|
*/
|
|
7085
7091
|
min: string|Date
|
|
7086
7092
|
/**
|
|
7087
|
-
* Renderer function, used to style the date displayed in the cell. Can also affect other aspects of
|
|
7088
|
-
*
|
|
7093
|
+
* Renderer function, used to style the date displayed in the cell. Can also affect other aspects of the cell,
|
|
7094
|
+
* such as styling.
|
|
7089
7095
|
*/
|
|
7090
7096
|
renderer: (renderData: { cellElement: HTMLElement, value: Date|null|undefined, record: Model, column: Column, grid: Grid, row: Row, size: { height: number, configuredHeight: number }, isExport: boolean, isMeasuring: boolean }) => string|DomConfig|DomConfig[]|void
|
|
7091
7097
|
/**
|
|
@@ -11754,7 +11760,8 @@ type TimeColumnConfig = {
|
|
|
11754
11760
|
*/
|
|
11755
11761
|
flex?: number|string
|
|
11756
11762
|
/**
|
|
11757
|
-
* Time format
|
|
11763
|
+
* Time format for time displayed in cell and editor
|
|
11764
|
+
* (see [format](https://bryntum.com/products/grid/docs/api/Core/helper/DateHelper#function-format-static) for formatting options)
|
|
11758
11765
|
*/
|
|
11759
11766
|
format?: string
|
|
11760
11767
|
/**
|
|
@@ -12151,7 +12158,8 @@ export class TimeColumn extends Column {
|
|
|
12151
12158
|
*/
|
|
12152
12159
|
static readonly isTimeColumn: boolean
|
|
12153
12160
|
/**
|
|
12154
|
-
* Time format
|
|
12161
|
+
* Time format for time displayed in cell and editor
|
|
12162
|
+
* (see [format](https://bryntum.com/products/grid/docs/api/Core/helper/DateHelper#function-format-static) for formatting options)
|
|
12155
12163
|
*/
|
|
12156
12164
|
format: string
|
|
12157
12165
|
/**
|
|
@@ -14409,7 +14417,9 @@ type ColumnStoreConfig = {
|
|
|
14409
14417
|
*/
|
|
14410
14418
|
pageStartParamName?: string
|
|
14411
14419
|
/**
|
|
14412
|
-
* Specify true to reapply filters when a record is added to the store.
|
|
14420
|
+
* Specify `true` to reapply filters when a record is added to or moved within the store.
|
|
14421
|
+
* This includes tree node operations like indent/outdent in Gantt, or any move operation
|
|
14422
|
+
* that changes a node's parent.
|
|
14413
14423
|
*/
|
|
14414
14424
|
reapplyFilterOnAdd?: boolean
|
|
14415
14425
|
/**
|
|
@@ -27066,9 +27076,9 @@ export class PdfExport extends InstancePlugin {
|
|
|
27066
27076
|
/**
|
|
27067
27077
|
* Starts the export process. Accepts a config object which overrides any default configs.
|
|
27068
27078
|
* <strong>NOTE</strong>. Component should not be interacted with when export is in progress
|
|
27069
|
-
* @param {
|
|
27079
|
+
* @param {PdfExportConfig} config
|
|
27070
27080
|
*/
|
|
27071
|
-
export(config:
|
|
27081
|
+
export(config: PdfExportConfig): Promise<any>;
|
|
27072
27082
|
/**
|
|
27073
27083
|
* This method accepts all stylesheets (link and style tags) which are supposed to be put on the page. Use
|
|
27074
27084
|
* this hook method to filter or modify them.
|
|
@@ -27480,9 +27490,9 @@ export class Print extends PdfExport {
|
|
|
27480
27490
|
/**
|
|
27481
27491
|
* Starts the print process. Accepts a config object which overrides any default configs.
|
|
27482
27492
|
* <strong>NOTE</strong> Component should not be interacted with when print is in progress
|
|
27483
|
-
* @param {
|
|
27493
|
+
* @param {PrintConfig} config
|
|
27484
27494
|
*/
|
|
27485
|
-
print(config:
|
|
27495
|
+
print(config: PrintConfig): Promise<any>;
|
|
27486
27496
|
/**
|
|
27487
27497
|
* Shows the [print dialog](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog)
|
|
27488
27498
|
*/
|
|
@@ -28832,9 +28842,9 @@ export class PrintMixinClass {
|
|
|
28832
28842
|
/**
|
|
28833
28843
|
* Starts the print process. Accepts a config object which overrides any default configs.
|
|
28834
28844
|
* <strong>NOTE</strong> Component should not be interacted with when print is in progress
|
|
28835
|
-
* @param {
|
|
28845
|
+
* @param {PrintConfig} config
|
|
28836
28846
|
*/
|
|
28837
|
-
print(config:
|
|
28847
|
+
print(config: PrintConfig): Promise<any>;
|
|
28838
28848
|
/**
|
|
28839
28849
|
* Shows the [print dialog](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog)
|
|
28840
28850
|
*/
|
|
@@ -29022,6 +29032,10 @@ export class GridLocation {
|
|
|
29022
29032
|
* The cell DOM element which this `GridLocation` references.
|
|
29023
29033
|
*/
|
|
29024
29034
|
readonly cell: HTMLElement
|
|
29035
|
+
/**
|
|
29036
|
+
* Yields the [Column](https://bryntum.com/products/grid/docs/api/Grid/column/Column) of this location.
|
|
29037
|
+
*/
|
|
29038
|
+
readonly column: Column
|
|
29025
29039
|
/**
|
|
29026
29040
|
* Yields the column index of this location.
|
|
29027
29041
|
*/
|
|
@@ -29030,6 +29044,10 @@ export class GridLocation {
|
|
|
29030
29044
|
* This property is `true` if the focus is inside the cell, not *on* the cell.
|
|
29031
29045
|
*/
|
|
29032
29046
|
readonly containsFocus: boolean
|
|
29047
|
+
/**
|
|
29048
|
+
* The grid which this `GridLocation` references.
|
|
29049
|
+
*/
|
|
29050
|
+
readonly grid: Grid
|
|
29033
29051
|
/**
|
|
29034
29052
|
* This property is `true` if the focus target is not the cell itself.
|
|
29035
29053
|
*/
|
|
@@ -29046,6 +29064,10 @@ export class GridLocation {
|
|
|
29046
29064
|
* Yields `true` if the cell and row are selectable.
|
|
29047
29065
|
*/
|
|
29048
29066
|
readonly isSelectable: boolean
|
|
29067
|
+
/**
|
|
29068
|
+
* Yields the [Model](https://bryntum.com/products/grid/docs/api/Core/data/Model) of this location, or `null` if the location is a column header.
|
|
29069
|
+
*/
|
|
29070
|
+
readonly record: Model
|
|
29049
29071
|
/**
|
|
29050
29072
|
* Yields the row index of this location.
|
|
29051
29073
|
*/
|
|
@@ -29190,6 +29212,14 @@ type GridListenersTypes = {
|
|
|
29190
29212
|
* @param {any} event.value The value being set
|
|
29191
29213
|
*/
|
|
29192
29214
|
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
|
|
29215
|
+
/**
|
|
29216
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
29217
|
+
* @param {object} event Event object
|
|
29218
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
29219
|
+
* @param {Grid.column.Column} event.column The column
|
|
29220
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
29221
|
+
*/
|
|
29222
|
+
beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
29193
29223
|
/**
|
|
29194
29224
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
29195
29225
|
* @param {object} event Event object
|
|
@@ -29284,24 +29314,24 @@ type GridListenersTypes = {
|
|
|
29284
29314
|
/**
|
|
29285
29315
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
29286
29316
|
* @param {object} event Event object
|
|
29287
|
-
* @param {
|
|
29317
|
+
* @param {PdfExportConfig} event.config Export config
|
|
29288
29318
|
*/
|
|
29289
|
-
beforePdfExport: (event: { config:
|
|
29319
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
|
|
29290
29320
|
/**
|
|
29291
29321
|
* Fires before a row is rendered.
|
|
29292
29322
|
* @param {object} event Event object
|
|
29293
|
-
* @param {Grid.view.
|
|
29294
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
29295
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
29296
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
29323
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
29324
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
29325
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
29326
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
29297
29327
|
*/
|
|
29298
|
-
beforeRenderRow: (event: { source:
|
|
29328
|
+
beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
29299
29329
|
/**
|
|
29300
29330
|
* Grid rows are about to be rendered
|
|
29301
29331
|
* @param {object} event Event object
|
|
29302
|
-
* @param {Grid.view.
|
|
29332
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
29303
29333
|
*/
|
|
29304
|
-
beforeRenderRows: (event: { source:
|
|
29334
|
+
beforeRenderRows: (event: { source: GridBase }) => void
|
|
29305
29335
|
/**
|
|
29306
29336
|
* This event fires before row collapse is started.
|
|
29307
29337
|
* ...
|
|
@@ -29532,6 +29562,14 @@ type GridListenersTypes = {
|
|
|
29532
29562
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
29533
29563
|
*/
|
|
29534
29564
|
collapseNode: (event: { source: Grid, record: Model }) => void
|
|
29565
|
+
/**
|
|
29566
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
29567
|
+
* @param {object} event Event object
|
|
29568
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
29569
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
29570
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
29571
|
+
*/
|
|
29572
|
+
columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
29535
29573
|
/**
|
|
29536
29574
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
29537
29575
|
* to indicate whether the drop position is valid or not.
|
|
@@ -29613,14 +29651,14 @@ type GridListenersTypes = {
|
|
|
29613
29651
|
* ...
|
|
29614
29652
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
|
|
29615
29653
|
* @param {object} event Event object
|
|
29616
|
-
* @param {Grid.view.
|
|
29654
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
29617
29655
|
* @param {Core.data.Store} event.store The originating store
|
|
29618
29656
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
29619
29657
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
29620
29658
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
29621
29659
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
29622
29660
|
*/
|
|
29623
|
-
dataChange: (event: { source:
|
|
29661
|
+
dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
|
|
29624
29662
|
/**
|
|
29625
29663
|
* Fires when an object is destroyed.
|
|
29626
29664
|
* @param {object} event Event object
|
|
@@ -29928,18 +29966,18 @@ type GridListenersTypes = {
|
|
|
29928
29966
|
/**
|
|
29929
29967
|
* Fires after a row is rendered.
|
|
29930
29968
|
* @param {object} event Event object
|
|
29931
|
-
* @param {Grid.view.
|
|
29932
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
29933
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
29934
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
29969
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
29970
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
29971
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
29972
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
29935
29973
|
*/
|
|
29936
|
-
renderRow: (event: { source:
|
|
29974
|
+
renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
29937
29975
|
/**
|
|
29938
29976
|
* Grid rows have been rendered
|
|
29939
29977
|
* @param {object} event Event object
|
|
29940
|
-
* @param {Grid.view.
|
|
29978
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
29941
29979
|
*/
|
|
29942
|
-
renderRows: (event: { source:
|
|
29980
|
+
renderRows: (event: { source: GridBase }) => void
|
|
29943
29981
|
/**
|
|
29944
29982
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
29945
29983
|
* @param {object} event Event object
|
|
@@ -29999,10 +30037,10 @@ type GridListenersTypes = {
|
|
|
29999
30037
|
/**
|
|
30000
30038
|
* Grid has scrolled vertically
|
|
30001
30039
|
* @param {object} event Event object
|
|
30002
|
-
* @param {Grid.view.
|
|
30040
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
30003
30041
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
30004
30042
|
*/
|
|
30005
|
-
scroll: (event: { source:
|
|
30043
|
+
scroll: (event: { source: GridBase, scrollTop: number }) => void
|
|
30006
30044
|
/**
|
|
30007
30045
|
* The selection has been changed.
|
|
30008
30046
|
* @param {object} event Event object
|
|
@@ -30090,17 +30128,17 @@ type GridListenersTypes = {
|
|
|
30090
30128
|
/**
|
|
30091
30129
|
* Fires after a sub grid is collapsed.
|
|
30092
30130
|
* @param {object} event Event object
|
|
30093
|
-
* @param {Grid.view.
|
|
30131
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
30094
30132
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
30095
30133
|
*/
|
|
30096
|
-
subGridCollapse: (event: { source:
|
|
30134
|
+
subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
30097
30135
|
/**
|
|
30098
30136
|
* Fires after a sub grid is expanded.
|
|
30099
30137
|
* @param {object} event Event object
|
|
30100
|
-
* @param {Grid.view.
|
|
30138
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
30101
30139
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
30102
30140
|
*/
|
|
30103
|
-
subGridExpand: (event: { source:
|
|
30141
|
+
subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
30104
30142
|
/**
|
|
30105
30143
|
* Fired when one or more groups are expanded or collapsed
|
|
30106
30144
|
* @param {object} event Event object
|
|
@@ -30193,6 +30231,14 @@ type GridListeners = {
|
|
|
30193
30231
|
* @param {any} event.value The value being set
|
|
30194
30232
|
*/
|
|
30195
30233
|
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
30234
|
+
/**
|
|
30235
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
30236
|
+
* @param {object} event Event object
|
|
30237
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
30238
|
+
* @param {Grid.column.Column} event.column The column
|
|
30239
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
30240
|
+
*/
|
|
30241
|
+
beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
30196
30242
|
/**
|
|
30197
30243
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
30198
30244
|
* @param {object} event Event object
|
|
@@ -30287,24 +30333,24 @@ type GridListeners = {
|
|
|
30287
30333
|
/**
|
|
30288
30334
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
30289
30335
|
* @param {object} event Event object
|
|
30290
|
-
* @param {
|
|
30336
|
+
* @param {PdfExportConfig} event.config Export config
|
|
30291
30337
|
*/
|
|
30292
|
-
beforePdfExport?: ((event: { config:
|
|
30338
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
30293
30339
|
/**
|
|
30294
30340
|
* Fires before a row is rendered.
|
|
30295
30341
|
* @param {object} event Event object
|
|
30296
|
-
* @param {Grid.view.
|
|
30297
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
30298
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
30299
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
30342
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
30343
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
30344
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
30345
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
30300
30346
|
*/
|
|
30301
|
-
beforeRenderRow?: ((event: { source:
|
|
30347
|
+
beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
30302
30348
|
/**
|
|
30303
30349
|
* Grid rows are about to be rendered
|
|
30304
30350
|
* @param {object} event Event object
|
|
30305
|
-
* @param {Grid.view.
|
|
30351
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
30306
30352
|
*/
|
|
30307
|
-
beforeRenderRows?: ((event: { source:
|
|
30353
|
+
beforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
30308
30354
|
/**
|
|
30309
30355
|
* This event fires before row collapse is started.
|
|
30310
30356
|
* ...
|
|
@@ -30535,6 +30581,14 @@ type GridListeners = {
|
|
|
30535
30581
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
30536
30582
|
*/
|
|
30537
30583
|
collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
30584
|
+
/**
|
|
30585
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
30586
|
+
* @param {object} event Event object
|
|
30587
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
30588
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
30589
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
30590
|
+
*/
|
|
30591
|
+
columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
30538
30592
|
/**
|
|
30539
30593
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
30540
30594
|
* to indicate whether the drop position is valid or not.
|
|
@@ -30616,14 +30670,14 @@ type GridListeners = {
|
|
|
30616
30670
|
* ...
|
|
30617
30671
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
|
|
30618
30672
|
* @param {object} event Event object
|
|
30619
|
-
* @param {Grid.view.
|
|
30673
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
30620
30674
|
* @param {Core.data.Store} event.store The originating store
|
|
30621
30675
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
30622
30676
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
30623
30677
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
30624
30678
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
30625
30679
|
*/
|
|
30626
|
-
dataChange?: ((event: { source:
|
|
30680
|
+
dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
30627
30681
|
/**
|
|
30628
30682
|
* Fires when an object is destroyed.
|
|
30629
30683
|
* @param {object} event Event object
|
|
@@ -30931,18 +30985,18 @@ type GridListeners = {
|
|
|
30931
30985
|
/**
|
|
30932
30986
|
* Fires after a row is rendered.
|
|
30933
30987
|
* @param {object} event Event object
|
|
30934
|
-
* @param {Grid.view.
|
|
30935
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
30936
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
30937
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
30988
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
30989
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
30990
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
30991
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
30938
30992
|
*/
|
|
30939
|
-
renderRow?: ((event: { source:
|
|
30993
|
+
renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
30940
30994
|
/**
|
|
30941
30995
|
* Grid rows have been rendered
|
|
30942
30996
|
* @param {object} event Event object
|
|
30943
|
-
* @param {Grid.view.
|
|
30997
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
30944
30998
|
*/
|
|
30945
|
-
renderRows?: ((event: { source:
|
|
30999
|
+
renderRows?: ((event: { source: GridBase }) => void)|string
|
|
30946
31000
|
/**
|
|
30947
31001
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
30948
31002
|
* @param {object} event Event object
|
|
@@ -31002,10 +31056,10 @@ type GridListeners = {
|
|
|
31002
31056
|
/**
|
|
31003
31057
|
* Grid has scrolled vertically
|
|
31004
31058
|
* @param {object} event Event object
|
|
31005
|
-
* @param {Grid.view.
|
|
31059
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
31006
31060
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
31007
31061
|
*/
|
|
31008
|
-
scroll?: ((event: { source:
|
|
31062
|
+
scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
31009
31063
|
/**
|
|
31010
31064
|
* The selection has been changed.
|
|
31011
31065
|
* @param {object} event Event object
|
|
@@ -31093,17 +31147,17 @@ type GridListeners = {
|
|
|
31093
31147
|
/**
|
|
31094
31148
|
* Fires after a sub grid is collapsed.
|
|
31095
31149
|
* @param {object} event Event object
|
|
31096
|
-
* @param {Grid.view.
|
|
31150
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
31097
31151
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
31098
31152
|
*/
|
|
31099
|
-
subGridCollapse?: ((event: { source:
|
|
31153
|
+
subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
31100
31154
|
/**
|
|
31101
31155
|
* Fires after a sub grid is expanded.
|
|
31102
31156
|
* @param {object} event Event object
|
|
31103
|
-
* @param {Grid.view.
|
|
31157
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
31104
31158
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
31105
31159
|
*/
|
|
31106
|
-
subGridExpand?: ((event: { source:
|
|
31160
|
+
subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
31107
31161
|
/**
|
|
31108
31162
|
* Fired when one or more groups are expanded or collapsed
|
|
31109
31163
|
* @param {object} event Event object
|
|
@@ -32031,6 +32085,14 @@ type GridConfig = {
|
|
|
32031
32085
|
* @param {any} event.value The value being set
|
|
32032
32086
|
*/
|
|
32033
32087
|
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
32088
|
+
/**
|
|
32089
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
32090
|
+
* @param {object} event Event object
|
|
32091
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
32092
|
+
* @param {Grid.column.Column} event.column The column
|
|
32093
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
32094
|
+
*/
|
|
32095
|
+
onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
32034
32096
|
/**
|
|
32035
32097
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
32036
32098
|
* @param {object} event Event object
|
|
@@ -32125,24 +32187,24 @@ type GridConfig = {
|
|
|
32125
32187
|
/**
|
|
32126
32188
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
32127
32189
|
* @param {object} event Event object
|
|
32128
|
-
* @param {
|
|
32190
|
+
* @param {PdfExportConfig} event.config Export config
|
|
32129
32191
|
*/
|
|
32130
|
-
onBeforePdfExport?: ((event: { config:
|
|
32192
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
32131
32193
|
/**
|
|
32132
32194
|
* Fires before a row is rendered.
|
|
32133
32195
|
* @param {object} event Event object
|
|
32134
|
-
* @param {Grid.view.
|
|
32135
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
32136
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
32137
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
32196
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
32197
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
32198
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
32199
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
32138
32200
|
*/
|
|
32139
|
-
onBeforeRenderRow?: ((event: { source:
|
|
32201
|
+
onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
32140
32202
|
/**
|
|
32141
32203
|
* Grid rows are about to be rendered
|
|
32142
32204
|
* @param {object} event Event object
|
|
32143
|
-
* @param {Grid.view.
|
|
32205
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
32144
32206
|
*/
|
|
32145
|
-
onBeforeRenderRows?: ((event: { source:
|
|
32207
|
+
onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
32146
32208
|
/**
|
|
32147
32209
|
* This event fires before row collapse is started.
|
|
32148
32210
|
* ...
|
|
@@ -32373,6 +32435,14 @@ type GridConfig = {
|
|
|
32373
32435
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
32374
32436
|
*/
|
|
32375
32437
|
onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
32438
|
+
/**
|
|
32439
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
32440
|
+
* @param {object} event Event object
|
|
32441
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
32442
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
32443
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
32444
|
+
*/
|
|
32445
|
+
onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
32376
32446
|
/**
|
|
32377
32447
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
32378
32448
|
* to indicate whether the drop position is valid or not.
|
|
@@ -32454,14 +32524,14 @@ type GridConfig = {
|
|
|
32454
32524
|
* ...
|
|
32455
32525
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
|
|
32456
32526
|
* @param {object} event Event object
|
|
32457
|
-
* @param {Grid.view.
|
|
32527
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
32458
32528
|
* @param {Core.data.Store} event.store The originating store
|
|
32459
32529
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
32460
32530
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
32461
32531
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
32462
32532
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
32463
32533
|
*/
|
|
32464
|
-
onDataChange?: ((event: { source:
|
|
32534
|
+
onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
32465
32535
|
/**
|
|
32466
32536
|
* Fires when an object is destroyed.
|
|
32467
32537
|
* @param {object} event Event object
|
|
@@ -32769,18 +32839,18 @@ type GridConfig = {
|
|
|
32769
32839
|
/**
|
|
32770
32840
|
* Fires after a row is rendered.
|
|
32771
32841
|
* @param {object} event Event object
|
|
32772
|
-
* @param {Grid.view.
|
|
32773
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
32774
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
32775
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
32842
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
32843
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
32844
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
32845
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
32776
32846
|
*/
|
|
32777
|
-
onRenderRow?: ((event: { source:
|
|
32847
|
+
onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
32778
32848
|
/**
|
|
32779
32849
|
* Grid rows have been rendered
|
|
32780
32850
|
* @param {object} event Event object
|
|
32781
|
-
* @param {Grid.view.
|
|
32851
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
32782
32852
|
*/
|
|
32783
|
-
onRenderRows?: ((event: { source:
|
|
32853
|
+
onRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
32784
32854
|
/**
|
|
32785
32855
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
32786
32856
|
* @param {object} event Event object
|
|
@@ -32840,10 +32910,10 @@ type GridConfig = {
|
|
|
32840
32910
|
/**
|
|
32841
32911
|
* Grid has scrolled vertically
|
|
32842
32912
|
* @param {object} event Event object
|
|
32843
|
-
* @param {Grid.view.
|
|
32913
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
32844
32914
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
32845
32915
|
*/
|
|
32846
|
-
onScroll?: ((event: { source:
|
|
32916
|
+
onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
32847
32917
|
/**
|
|
32848
32918
|
* The selection has been changed.
|
|
32849
32919
|
* @param {object} event Event object
|
|
@@ -32931,17 +33001,17 @@ type GridConfig = {
|
|
|
32931
33001
|
/**
|
|
32932
33002
|
* Fires after a sub grid is collapsed.
|
|
32933
33003
|
* @param {object} event Event object
|
|
32934
|
-
* @param {Grid.view.
|
|
33004
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
32935
33005
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
32936
33006
|
*/
|
|
32937
|
-
onSubGridCollapse?: ((event: { source:
|
|
33007
|
+
onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
32938
33008
|
/**
|
|
32939
33009
|
* Fires after a sub grid is expanded.
|
|
32940
33010
|
* @param {object} event Event object
|
|
32941
|
-
* @param {Grid.view.
|
|
33011
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
32942
33012
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
32943
33013
|
*/
|
|
32944
|
-
onSubGridExpand?: ((event: { source:
|
|
33014
|
+
onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
32945
33015
|
/**
|
|
32946
33016
|
* Fired when one or more groups are expanded or collapsed
|
|
32947
33017
|
* @param {object} event Event object
|
|
@@ -33253,6 +33323,14 @@ type GridBaseListenersTypes = {
|
|
|
33253
33323
|
* @param {any} event.value The value being set
|
|
33254
33324
|
*/
|
|
33255
33325
|
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
|
|
33326
|
+
/**
|
|
33327
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
33328
|
+
* @param {object} event Event object
|
|
33329
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
33330
|
+
* @param {Grid.column.Column} event.column The column
|
|
33331
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
33332
|
+
*/
|
|
33333
|
+
beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
33256
33334
|
/**
|
|
33257
33335
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
33258
33336
|
* @param {object} event Event object
|
|
@@ -33347,24 +33425,24 @@ type GridBaseListenersTypes = {
|
|
|
33347
33425
|
/**
|
|
33348
33426
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
33349
33427
|
* @param {object} event Event object
|
|
33350
|
-
* @param {
|
|
33428
|
+
* @param {PdfExportConfig} event.config Export config
|
|
33351
33429
|
*/
|
|
33352
|
-
beforePdfExport: (event: { config:
|
|
33430
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
|
|
33353
33431
|
/**
|
|
33354
33432
|
* Fires before a row is rendered.
|
|
33355
33433
|
* @param {object} event Event object
|
|
33356
|
-
* @param {Grid.view.
|
|
33357
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
33358
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
33359
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
33434
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
33435
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
33436
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
33437
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
33360
33438
|
*/
|
|
33361
|
-
beforeRenderRow: (event: { source:
|
|
33439
|
+
beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
33362
33440
|
/**
|
|
33363
33441
|
* Grid rows are about to be rendered
|
|
33364
33442
|
* @param {object} event Event object
|
|
33365
|
-
* @param {Grid.view.
|
|
33443
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
33366
33444
|
*/
|
|
33367
|
-
beforeRenderRows: (event: { source:
|
|
33445
|
+
beforeRenderRows: (event: { source: GridBase }) => void
|
|
33368
33446
|
/**
|
|
33369
33447
|
* This event fires before row collapse is started.
|
|
33370
33448
|
* ...
|
|
@@ -33595,6 +33673,14 @@ type GridBaseListenersTypes = {
|
|
|
33595
33673
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
33596
33674
|
*/
|
|
33597
33675
|
collapseNode: (event: { source: Grid, record: Model }) => void
|
|
33676
|
+
/**
|
|
33677
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
33678
|
+
* @param {object} event Event object
|
|
33679
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
33680
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
33681
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
33682
|
+
*/
|
|
33683
|
+
columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
33598
33684
|
/**
|
|
33599
33685
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
33600
33686
|
* to indicate whether the drop position is valid or not.
|
|
@@ -33676,14 +33762,14 @@ type GridBaseListenersTypes = {
|
|
|
33676
33762
|
* ...
|
|
33677
33763
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
|
|
33678
33764
|
* @param {object} event Event object
|
|
33679
|
-
* @param {Grid.view.
|
|
33765
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
33680
33766
|
* @param {Core.data.Store} event.store The originating store
|
|
33681
33767
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
33682
33768
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
33683
33769
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
33684
33770
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
33685
33771
|
*/
|
|
33686
|
-
dataChange: (event: { source:
|
|
33772
|
+
dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
|
|
33687
33773
|
/**
|
|
33688
33774
|
* Fires when an object is destroyed.
|
|
33689
33775
|
* @param {object} event Event object
|
|
@@ -33991,18 +34077,18 @@ type GridBaseListenersTypes = {
|
|
|
33991
34077
|
/**
|
|
33992
34078
|
* Fires after a row is rendered.
|
|
33993
34079
|
* @param {object} event Event object
|
|
33994
|
-
* @param {Grid.view.
|
|
33995
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
33996
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
33997
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
34080
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
34081
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
34082
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
34083
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
33998
34084
|
*/
|
|
33999
|
-
renderRow: (event: { source:
|
|
34085
|
+
renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
34000
34086
|
/**
|
|
34001
34087
|
* Grid rows have been rendered
|
|
34002
34088
|
* @param {object} event Event object
|
|
34003
|
-
* @param {Grid.view.
|
|
34089
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
34004
34090
|
*/
|
|
34005
|
-
renderRows: (event: { source:
|
|
34091
|
+
renderRows: (event: { source: GridBase }) => void
|
|
34006
34092
|
/**
|
|
34007
34093
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
34008
34094
|
* @param {object} event Event object
|
|
@@ -34062,10 +34148,10 @@ type GridBaseListenersTypes = {
|
|
|
34062
34148
|
/**
|
|
34063
34149
|
* Grid has scrolled vertically
|
|
34064
34150
|
* @param {object} event Event object
|
|
34065
|
-
* @param {Grid.view.
|
|
34151
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
34066
34152
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
34067
34153
|
*/
|
|
34068
|
-
scroll: (event: { source:
|
|
34154
|
+
scroll: (event: { source: GridBase, scrollTop: number }) => void
|
|
34069
34155
|
/**
|
|
34070
34156
|
* The selection has been changed.
|
|
34071
34157
|
* @param {object} event Event object
|
|
@@ -34153,17 +34239,17 @@ type GridBaseListenersTypes = {
|
|
|
34153
34239
|
/**
|
|
34154
34240
|
* Fires after a sub grid is collapsed.
|
|
34155
34241
|
* @param {object} event Event object
|
|
34156
|
-
* @param {Grid.view.
|
|
34242
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
34157
34243
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
34158
34244
|
*/
|
|
34159
|
-
subGridCollapse: (event: { source:
|
|
34245
|
+
subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
34160
34246
|
/**
|
|
34161
34247
|
* Fires after a sub grid is expanded.
|
|
34162
34248
|
* @param {object} event Event object
|
|
34163
|
-
* @param {Grid.view.
|
|
34249
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
34164
34250
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
34165
34251
|
*/
|
|
34166
|
-
subGridExpand: (event: { source:
|
|
34252
|
+
subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
34167
34253
|
/**
|
|
34168
34254
|
* Fired when one or more groups are expanded or collapsed
|
|
34169
34255
|
* @param {object} event Event object
|
|
@@ -34256,6 +34342,14 @@ type GridBaseListeners = {
|
|
|
34256
34342
|
* @param {any} event.value The value being set
|
|
34257
34343
|
*/
|
|
34258
34344
|
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
34345
|
+
/**
|
|
34346
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
34347
|
+
* @param {object} event Event object
|
|
34348
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
34349
|
+
* @param {Grid.column.Column} event.column The column
|
|
34350
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
34351
|
+
*/
|
|
34352
|
+
beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
34259
34353
|
/**
|
|
34260
34354
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
34261
34355
|
* @param {object} event Event object
|
|
@@ -34350,24 +34444,24 @@ type GridBaseListeners = {
|
|
|
34350
34444
|
/**
|
|
34351
34445
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
34352
34446
|
* @param {object} event Event object
|
|
34353
|
-
* @param {
|
|
34447
|
+
* @param {PdfExportConfig} event.config Export config
|
|
34354
34448
|
*/
|
|
34355
|
-
beforePdfExport?: ((event: { config:
|
|
34449
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
34356
34450
|
/**
|
|
34357
34451
|
* Fires before a row is rendered.
|
|
34358
34452
|
* @param {object} event Event object
|
|
34359
|
-
* @param {Grid.view.
|
|
34360
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
34361
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
34362
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
34453
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
34454
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
34455
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
34456
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
34363
34457
|
*/
|
|
34364
|
-
beforeRenderRow?: ((event: { source:
|
|
34458
|
+
beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
34365
34459
|
/**
|
|
34366
34460
|
* Grid rows are about to be rendered
|
|
34367
34461
|
* @param {object} event Event object
|
|
34368
|
-
* @param {Grid.view.
|
|
34462
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
34369
34463
|
*/
|
|
34370
|
-
beforeRenderRows?: ((event: { source:
|
|
34464
|
+
beforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
34371
34465
|
/**
|
|
34372
34466
|
* This event fires before row collapse is started.
|
|
34373
34467
|
* ...
|
|
@@ -34598,6 +34692,14 @@ type GridBaseListeners = {
|
|
|
34598
34692
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
34599
34693
|
*/
|
|
34600
34694
|
collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
34695
|
+
/**
|
|
34696
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
34697
|
+
* @param {object} event Event object
|
|
34698
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
34699
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
34700
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
34701
|
+
*/
|
|
34702
|
+
columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
34601
34703
|
/**
|
|
34602
34704
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
34603
34705
|
* to indicate whether the drop position is valid or not.
|
|
@@ -34679,14 +34781,14 @@ type GridBaseListeners = {
|
|
|
34679
34781
|
* ...
|
|
34680
34782
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
|
|
34681
34783
|
* @param {object} event Event object
|
|
34682
|
-
* @param {Grid.view.
|
|
34784
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
34683
34785
|
* @param {Core.data.Store} event.store The originating store
|
|
34684
34786
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
34685
34787
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
34686
34788
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
34687
34789
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
34688
34790
|
*/
|
|
34689
|
-
dataChange?: ((event: { source:
|
|
34791
|
+
dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
34690
34792
|
/**
|
|
34691
34793
|
* Fires when an object is destroyed.
|
|
34692
34794
|
* @param {object} event Event object
|
|
@@ -34994,18 +35096,18 @@ type GridBaseListeners = {
|
|
|
34994
35096
|
/**
|
|
34995
35097
|
* Fires after a row is rendered.
|
|
34996
35098
|
* @param {object} event Event object
|
|
34997
|
-
* @param {Grid.view.
|
|
34998
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
34999
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
35000
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
35099
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
35100
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
35101
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
35102
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
35001
35103
|
*/
|
|
35002
|
-
renderRow?: ((event: { source:
|
|
35104
|
+
renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
35003
35105
|
/**
|
|
35004
35106
|
* Grid rows have been rendered
|
|
35005
35107
|
* @param {object} event Event object
|
|
35006
|
-
* @param {Grid.view.
|
|
35108
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
35007
35109
|
*/
|
|
35008
|
-
renderRows?: ((event: { source:
|
|
35110
|
+
renderRows?: ((event: { source: GridBase }) => void)|string
|
|
35009
35111
|
/**
|
|
35010
35112
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
35011
35113
|
* @param {object} event Event object
|
|
@@ -35065,10 +35167,10 @@ type GridBaseListeners = {
|
|
|
35065
35167
|
/**
|
|
35066
35168
|
* Grid has scrolled vertically
|
|
35067
35169
|
* @param {object} event Event object
|
|
35068
|
-
* @param {Grid.view.
|
|
35170
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
35069
35171
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
35070
35172
|
*/
|
|
35071
|
-
scroll?: ((event: { source:
|
|
35173
|
+
scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
35072
35174
|
/**
|
|
35073
35175
|
* The selection has been changed.
|
|
35074
35176
|
* @param {object} event Event object
|
|
@@ -35156,17 +35258,17 @@ type GridBaseListeners = {
|
|
|
35156
35258
|
/**
|
|
35157
35259
|
* Fires after a sub grid is collapsed.
|
|
35158
35260
|
* @param {object} event Event object
|
|
35159
|
-
* @param {Grid.view.
|
|
35261
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
35160
35262
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
35161
35263
|
*/
|
|
35162
|
-
subGridCollapse?: ((event: { source:
|
|
35264
|
+
subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
35163
35265
|
/**
|
|
35164
35266
|
* Fires after a sub grid is expanded.
|
|
35165
35267
|
* @param {object} event Event object
|
|
35166
|
-
* @param {Grid.view.
|
|
35268
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
35167
35269
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
35168
35270
|
*/
|
|
35169
|
-
subGridExpand?: ((event: { source:
|
|
35271
|
+
subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
35170
35272
|
/**
|
|
35171
35273
|
* Fired when one or more groups are expanded or collapsed
|
|
35172
35274
|
* @param {object} event Event object
|
|
@@ -36093,6 +36195,14 @@ type GridBaseConfig = {
|
|
|
36093
36195
|
* @param {any} event.value The value being set
|
|
36094
36196
|
*/
|
|
36095
36197
|
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
36198
|
+
/**
|
|
36199
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
36200
|
+
* @param {object} event Event object
|
|
36201
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
36202
|
+
* @param {Grid.column.Column} event.column The column
|
|
36203
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
36204
|
+
*/
|
|
36205
|
+
onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
36096
36206
|
/**
|
|
36097
36207
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
36098
36208
|
* @param {object} event Event object
|
|
@@ -36187,24 +36297,24 @@ type GridBaseConfig = {
|
|
|
36187
36297
|
/**
|
|
36188
36298
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
36189
36299
|
* @param {object} event Event object
|
|
36190
|
-
* @param {
|
|
36300
|
+
* @param {PdfExportConfig} event.config Export config
|
|
36191
36301
|
*/
|
|
36192
|
-
onBeforePdfExport?: ((event: { config:
|
|
36302
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
36193
36303
|
/**
|
|
36194
36304
|
* Fires before a row is rendered.
|
|
36195
36305
|
* @param {object} event Event object
|
|
36196
|
-
* @param {Grid.view.
|
|
36197
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
36198
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
36199
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
36306
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
36307
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
36308
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
36309
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
36200
36310
|
*/
|
|
36201
|
-
onBeforeRenderRow?: ((event: { source:
|
|
36311
|
+
onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
36202
36312
|
/**
|
|
36203
36313
|
* Grid rows are about to be rendered
|
|
36204
36314
|
* @param {object} event Event object
|
|
36205
|
-
* @param {Grid.view.
|
|
36315
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
36206
36316
|
*/
|
|
36207
|
-
onBeforeRenderRows?: ((event: { source:
|
|
36317
|
+
onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
36208
36318
|
/**
|
|
36209
36319
|
* This event fires before row collapse is started.
|
|
36210
36320
|
* ...
|
|
@@ -36435,6 +36545,14 @@ type GridBaseConfig = {
|
|
|
36435
36545
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
36436
36546
|
*/
|
|
36437
36547
|
onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
36548
|
+
/**
|
|
36549
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
36550
|
+
* @param {object} event Event object
|
|
36551
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
36552
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
36553
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
36554
|
+
*/
|
|
36555
|
+
onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
36438
36556
|
/**
|
|
36439
36557
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
36440
36558
|
* to indicate whether the drop position is valid or not.
|
|
@@ -36516,14 +36634,14 @@ type GridBaseConfig = {
|
|
|
36516
36634
|
* ...
|
|
36517
36635
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
|
|
36518
36636
|
* @param {object} event Event object
|
|
36519
|
-
* @param {Grid.view.
|
|
36637
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
36520
36638
|
* @param {Core.data.Store} event.store The originating store
|
|
36521
36639
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
36522
36640
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
36523
36641
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
36524
36642
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
36525
36643
|
*/
|
|
36526
|
-
onDataChange?: ((event: { source:
|
|
36644
|
+
onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
36527
36645
|
/**
|
|
36528
36646
|
* Fires when an object is destroyed.
|
|
36529
36647
|
* @param {object} event Event object
|
|
@@ -36831,18 +36949,18 @@ type GridBaseConfig = {
|
|
|
36831
36949
|
/**
|
|
36832
36950
|
* Fires after a row is rendered.
|
|
36833
36951
|
* @param {object} event Event object
|
|
36834
|
-
* @param {Grid.view.
|
|
36835
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
36836
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
36837
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
36952
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
36953
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
36954
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
36955
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
36838
36956
|
*/
|
|
36839
|
-
onRenderRow?: ((event: { source:
|
|
36957
|
+
onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
36840
36958
|
/**
|
|
36841
36959
|
* Grid rows have been rendered
|
|
36842
36960
|
* @param {object} event Event object
|
|
36843
|
-
* @param {Grid.view.
|
|
36961
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
36844
36962
|
*/
|
|
36845
|
-
onRenderRows?: ((event: { source:
|
|
36963
|
+
onRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
36846
36964
|
/**
|
|
36847
36965
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
36848
36966
|
* @param {object} event Event object
|
|
@@ -36902,10 +37020,10 @@ type GridBaseConfig = {
|
|
|
36902
37020
|
/**
|
|
36903
37021
|
* Grid has scrolled vertically
|
|
36904
37022
|
* @param {object} event Event object
|
|
36905
|
-
* @param {Grid.view.
|
|
37023
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
36906
37024
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
36907
37025
|
*/
|
|
36908
|
-
onScroll?: ((event: { source:
|
|
37026
|
+
onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
36909
37027
|
/**
|
|
36910
37028
|
* The selection has been changed.
|
|
36911
37029
|
* @param {object} event Event object
|
|
@@ -36993,17 +37111,17 @@ type GridBaseConfig = {
|
|
|
36993
37111
|
/**
|
|
36994
37112
|
* Fires after a sub grid is collapsed.
|
|
36995
37113
|
* @param {object} event Event object
|
|
36996
|
-
* @param {Grid.view.
|
|
37114
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
36997
37115
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
36998
37116
|
*/
|
|
36999
|
-
onSubGridCollapse?: ((event: { source:
|
|
37117
|
+
onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
37000
37118
|
/**
|
|
37001
37119
|
* Fires after a sub grid is expanded.
|
|
37002
37120
|
* @param {object} event Event object
|
|
37003
|
-
* @param {Grid.view.
|
|
37121
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
37004
37122
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
37005
37123
|
*/
|
|
37006
|
-
onSubGridExpand?: ((event: { source:
|
|
37124
|
+
onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
37007
37125
|
/**
|
|
37008
37126
|
* Fired when one or more groups are expanded or collapsed
|
|
37009
37127
|
* @param {object} event Event object
|
|
@@ -37425,6 +37543,14 @@ export class GridBase extends Panel {
|
|
|
37425
37543
|
* @param {any} event.value The value being set
|
|
37426
37544
|
*/
|
|
37427
37545
|
onBeforeCellRangeEdit: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
37546
|
+
/**
|
|
37547
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
37548
|
+
* @param {object} event Event object
|
|
37549
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
37550
|
+
* @param {Grid.column.Column} event.column The column
|
|
37551
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
37552
|
+
*/
|
|
37553
|
+
onBeforeColumnCollapseToggle: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
37428
37554
|
/**
|
|
37429
37555
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
37430
37556
|
* @param {object} event Event object
|
|
@@ -37513,24 +37639,24 @@ export class GridBase extends Panel {
|
|
|
37513
37639
|
/**
|
|
37514
37640
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
37515
37641
|
* @param {object} event Event object
|
|
37516
|
-
* @param {
|
|
37642
|
+
* @param {PdfExportConfig} event.config Export config
|
|
37517
37643
|
*/
|
|
37518
|
-
onBeforePdfExport: ((event: { config:
|
|
37644
|
+
onBeforePdfExport: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
37519
37645
|
/**
|
|
37520
37646
|
* Fires before a row is rendered.
|
|
37521
37647
|
* @param {object} event Event object
|
|
37522
|
-
* @param {Grid.view.
|
|
37523
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
37524
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
37525
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
37648
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
37649
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
37650
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
37651
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
37526
37652
|
*/
|
|
37527
|
-
onBeforeRenderRow: ((event: { source:
|
|
37653
|
+
onBeforeRenderRow: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
37528
37654
|
/**
|
|
37529
37655
|
* Grid rows are about to be rendered
|
|
37530
37656
|
* @param {object} event Event object
|
|
37531
|
-
* @param {Grid.view.
|
|
37657
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
37532
37658
|
*/
|
|
37533
|
-
onBeforeRenderRows: ((event: { source:
|
|
37659
|
+
onBeforeRenderRows: ((event: { source: GridBase }) => void)|string
|
|
37534
37660
|
/**
|
|
37535
37661
|
* This event fires before row collapse is started.
|
|
37536
37662
|
* ...
|
|
@@ -37741,6 +37867,14 @@ export class GridBase extends Panel {
|
|
|
37741
37867
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
37742
37868
|
*/
|
|
37743
37869
|
onCollapseNode: ((event: { source: Grid, record: Model }) => void)|string
|
|
37870
|
+
/**
|
|
37871
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
37872
|
+
* @param {object} event Event object
|
|
37873
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
37874
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
37875
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
37876
|
+
*/
|
|
37877
|
+
onColumnCollapseToggle: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
37744
37878
|
/**
|
|
37745
37879
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
37746
37880
|
* to indicate whether the drop position is valid or not.
|
|
@@ -37805,14 +37939,14 @@ export class GridBase extends Panel {
|
|
|
37805
37939
|
* ...
|
|
37806
37940
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
|
|
37807
37941
|
* @param {object} event Event object
|
|
37808
|
-
* @param {Grid.view.
|
|
37942
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
37809
37943
|
* @param {Core.data.Store} event.store The originating store
|
|
37810
37944
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
37811
37945
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
37812
37946
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
37813
37947
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
37814
37948
|
*/
|
|
37815
|
-
onDataChange: ((event: { source:
|
|
37949
|
+
onDataChange: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
37816
37950
|
/**
|
|
37817
37951
|
* Fires when an object is destroyed.
|
|
37818
37952
|
* @param {object} event Event object
|
|
@@ -38050,18 +38184,18 @@ export class GridBase extends Panel {
|
|
|
38050
38184
|
/**
|
|
38051
38185
|
* Fires after a row is rendered.
|
|
38052
38186
|
* @param {object} event Event object
|
|
38053
|
-
* @param {Grid.view.
|
|
38054
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
38055
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
38056
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
38187
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
38188
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
38189
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
38190
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
38057
38191
|
*/
|
|
38058
|
-
onRenderRow: ((event: { source:
|
|
38192
|
+
onRenderRow: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
38059
38193
|
/**
|
|
38060
38194
|
* Grid rows have been rendered
|
|
38061
38195
|
* @param {object} event Event object
|
|
38062
|
-
* @param {Grid.view.
|
|
38196
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
38063
38197
|
*/
|
|
38064
|
-
onRenderRows: ((event: { source:
|
|
38198
|
+
onRenderRows: ((event: { source: GridBase }) => void)|string
|
|
38065
38199
|
/**
|
|
38066
38200
|
* Grid resize lead to a new responsive level being applied
|
|
38067
38201
|
* @param {object} event Event object
|
|
@@ -38111,10 +38245,10 @@ export class GridBase extends Panel {
|
|
|
38111
38245
|
/**
|
|
38112
38246
|
* Grid has scrolled vertically
|
|
38113
38247
|
* @param {object} event Event object
|
|
38114
|
-
* @param {Grid.view.
|
|
38248
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
38115
38249
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
38116
38250
|
*/
|
|
38117
|
-
onScroll: ((event: { source:
|
|
38251
|
+
onScroll: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
38118
38252
|
/**
|
|
38119
38253
|
* The selection has been changed.
|
|
38120
38254
|
* @param {object} event Event object
|
|
@@ -38196,17 +38330,17 @@ export class GridBase extends Panel {
|
|
|
38196
38330
|
/**
|
|
38197
38331
|
* Fires after a sub grid is collapsed.
|
|
38198
38332
|
* @param {object} event Event object
|
|
38199
|
-
* @param {Grid.view.
|
|
38333
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
38200
38334
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
38201
38335
|
*/
|
|
38202
|
-
onSubGridCollapse: ((event: { source:
|
|
38336
|
+
onSubGridCollapse: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
38203
38337
|
/**
|
|
38204
38338
|
* Fires after a sub grid is expanded.
|
|
38205
38339
|
* @param {object} event Event object
|
|
38206
|
-
* @param {Grid.view.
|
|
38340
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
38207
38341
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
38208
38342
|
*/
|
|
38209
|
-
onSubGridExpand: ((event: { source:
|
|
38343
|
+
onSubGridExpand: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
38210
38344
|
/**
|
|
38211
38345
|
* Fired when one or more groups are expanded or collapsed
|
|
38212
38346
|
* @param {object} event Event object
|
|
@@ -38518,9 +38652,9 @@ export class GridBase extends Panel {
|
|
|
38518
38652
|
/**
|
|
38519
38653
|
* Starts the print process. Accepts a config object which overrides any default configs.
|
|
38520
38654
|
* <strong>NOTE</strong> Component should not be interacted with when print is in progress
|
|
38521
|
-
* @param {
|
|
38655
|
+
* @param {PrintConfig} config
|
|
38522
38656
|
*/
|
|
38523
|
-
print(config:
|
|
38657
|
+
print(config: PrintConfig): Promise<any>;
|
|
38524
38658
|
/**
|
|
38525
38659
|
* Triggers a render of all the cells in a column.
|
|
38526
38660
|
* @param {Grid.column.Column,Grid.column.Column[]} column
|
|
@@ -39728,6 +39862,14 @@ type TreeGridListenersTypes = {
|
|
|
39728
39862
|
* @param {any} event.value The value being set
|
|
39729
39863
|
*/
|
|
39730
39864
|
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
|
|
39865
|
+
/**
|
|
39866
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
39867
|
+
* @param {object} event Event object
|
|
39868
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
39869
|
+
* @param {Grid.column.Column} event.column The column
|
|
39870
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
39871
|
+
*/
|
|
39872
|
+
beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
39731
39873
|
/**
|
|
39732
39874
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
39733
39875
|
* @param {object} event Event object
|
|
@@ -39822,24 +39964,24 @@ type TreeGridListenersTypes = {
|
|
|
39822
39964
|
/**
|
|
39823
39965
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
39824
39966
|
* @param {object} event Event object
|
|
39825
|
-
* @param {
|
|
39967
|
+
* @param {PdfExportConfig} event.config Export config
|
|
39826
39968
|
*/
|
|
39827
|
-
beforePdfExport: (event: { config:
|
|
39969
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
|
|
39828
39970
|
/**
|
|
39829
39971
|
* Fires before a row is rendered.
|
|
39830
39972
|
* @param {object} event Event object
|
|
39831
|
-
* @param {Grid.view.
|
|
39832
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
39833
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
39834
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
39973
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
39974
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
39975
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
39976
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
39835
39977
|
*/
|
|
39836
|
-
beforeRenderRow: (event: { source:
|
|
39978
|
+
beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
39837
39979
|
/**
|
|
39838
39980
|
* Grid rows are about to be rendered
|
|
39839
39981
|
* @param {object} event Event object
|
|
39840
|
-
* @param {Grid.view.
|
|
39982
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
39841
39983
|
*/
|
|
39842
|
-
beforeRenderRows: (event: { source:
|
|
39984
|
+
beforeRenderRows: (event: { source: GridBase }) => void
|
|
39843
39985
|
/**
|
|
39844
39986
|
* This event fires before row collapse is started.
|
|
39845
39987
|
* ...
|
|
@@ -40070,6 +40212,14 @@ type TreeGridListenersTypes = {
|
|
|
40070
40212
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
40071
40213
|
*/
|
|
40072
40214
|
collapseNode: (event: { source: Grid, record: Model }) => void
|
|
40215
|
+
/**
|
|
40216
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
40217
|
+
* @param {object} event Event object
|
|
40218
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
40219
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
40220
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
40221
|
+
*/
|
|
40222
|
+
columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
40073
40223
|
/**
|
|
40074
40224
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
40075
40225
|
* to indicate whether the drop position is valid or not.
|
|
@@ -40151,14 +40301,14 @@ type TreeGridListenersTypes = {
|
|
|
40151
40301
|
* ...
|
|
40152
40302
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
|
|
40153
40303
|
* @param {object} event Event object
|
|
40154
|
-
* @param {Grid.view.
|
|
40304
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
40155
40305
|
* @param {Core.data.Store} event.store The originating store
|
|
40156
40306
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
40157
40307
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
40158
40308
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
40159
40309
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
40160
40310
|
*/
|
|
40161
|
-
dataChange: (event: { source:
|
|
40311
|
+
dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
|
|
40162
40312
|
/**
|
|
40163
40313
|
* Fires when an object is destroyed.
|
|
40164
40314
|
* @param {object} event Event object
|
|
@@ -40466,18 +40616,18 @@ type TreeGridListenersTypes = {
|
|
|
40466
40616
|
/**
|
|
40467
40617
|
* Fires after a row is rendered.
|
|
40468
40618
|
* @param {object} event Event object
|
|
40469
|
-
* @param {Grid.view.
|
|
40470
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
40471
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
40472
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
40619
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
40620
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
40621
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
40622
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
40473
40623
|
*/
|
|
40474
|
-
renderRow: (event: { source:
|
|
40624
|
+
renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
40475
40625
|
/**
|
|
40476
40626
|
* Grid rows have been rendered
|
|
40477
40627
|
* @param {object} event Event object
|
|
40478
|
-
* @param {Grid.view.
|
|
40628
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
40479
40629
|
*/
|
|
40480
|
-
renderRows: (event: { source:
|
|
40630
|
+
renderRows: (event: { source: GridBase }) => void
|
|
40481
40631
|
/**
|
|
40482
40632
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
40483
40633
|
* @param {object} event Event object
|
|
@@ -40537,10 +40687,10 @@ type TreeGridListenersTypes = {
|
|
|
40537
40687
|
/**
|
|
40538
40688
|
* Grid has scrolled vertically
|
|
40539
40689
|
* @param {object} event Event object
|
|
40540
|
-
* @param {Grid.view.
|
|
40690
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
40541
40691
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
40542
40692
|
*/
|
|
40543
|
-
scroll: (event: { source:
|
|
40693
|
+
scroll: (event: { source: GridBase, scrollTop: number }) => void
|
|
40544
40694
|
/**
|
|
40545
40695
|
* The selection has been changed.
|
|
40546
40696
|
* @param {object} event Event object
|
|
@@ -40628,17 +40778,17 @@ type TreeGridListenersTypes = {
|
|
|
40628
40778
|
/**
|
|
40629
40779
|
* Fires after a sub grid is collapsed.
|
|
40630
40780
|
* @param {object} event Event object
|
|
40631
|
-
* @param {Grid.view.
|
|
40781
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
40632
40782
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
40633
40783
|
*/
|
|
40634
|
-
subGridCollapse: (event: { source:
|
|
40784
|
+
subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
40635
40785
|
/**
|
|
40636
40786
|
* Fires after a sub grid is expanded.
|
|
40637
40787
|
* @param {object} event Event object
|
|
40638
|
-
* @param {Grid.view.
|
|
40788
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
40639
40789
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
40640
40790
|
*/
|
|
40641
|
-
subGridExpand: (event: { source:
|
|
40791
|
+
subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
40642
40792
|
/**
|
|
40643
40793
|
* Fired when one or more groups are expanded or collapsed
|
|
40644
40794
|
* @param {object} event Event object
|
|
@@ -40731,6 +40881,14 @@ type TreeGridListeners = {
|
|
|
40731
40881
|
* @param {any} event.value The value being set
|
|
40732
40882
|
*/
|
|
40733
40883
|
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
40884
|
+
/**
|
|
40885
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
40886
|
+
* @param {object} event Event object
|
|
40887
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
40888
|
+
* @param {Grid.column.Column} event.column The column
|
|
40889
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
40890
|
+
*/
|
|
40891
|
+
beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
40734
40892
|
/**
|
|
40735
40893
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
40736
40894
|
* @param {object} event Event object
|
|
@@ -40825,24 +40983,24 @@ type TreeGridListeners = {
|
|
|
40825
40983
|
/**
|
|
40826
40984
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
40827
40985
|
* @param {object} event Event object
|
|
40828
|
-
* @param {
|
|
40986
|
+
* @param {PdfExportConfig} event.config Export config
|
|
40829
40987
|
*/
|
|
40830
|
-
beforePdfExport?: ((event: { config:
|
|
40988
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
40831
40989
|
/**
|
|
40832
40990
|
* Fires before a row is rendered.
|
|
40833
40991
|
* @param {object} event Event object
|
|
40834
|
-
* @param {Grid.view.
|
|
40835
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
40836
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
40837
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
40992
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
40993
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
40994
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
40995
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
40838
40996
|
*/
|
|
40839
|
-
beforeRenderRow?: ((event: { source:
|
|
40997
|
+
beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
40840
40998
|
/**
|
|
40841
40999
|
* Grid rows are about to be rendered
|
|
40842
41000
|
* @param {object} event Event object
|
|
40843
|
-
* @param {Grid.view.
|
|
41001
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
40844
41002
|
*/
|
|
40845
|
-
beforeRenderRows?: ((event: { source:
|
|
41003
|
+
beforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
40846
41004
|
/**
|
|
40847
41005
|
* This event fires before row collapse is started.
|
|
40848
41006
|
* ...
|
|
@@ -41073,6 +41231,14 @@ type TreeGridListeners = {
|
|
|
41073
41231
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
41074
41232
|
*/
|
|
41075
41233
|
collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
41234
|
+
/**
|
|
41235
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
41236
|
+
* @param {object} event Event object
|
|
41237
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
41238
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
41239
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
41240
|
+
*/
|
|
41241
|
+
columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
41076
41242
|
/**
|
|
41077
41243
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
41078
41244
|
* to indicate whether the drop position is valid or not.
|
|
@@ -41154,14 +41320,14 @@ type TreeGridListeners = {
|
|
|
41154
41320
|
* ...
|
|
41155
41321
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
|
|
41156
41322
|
* @param {object} event Event object
|
|
41157
|
-
* @param {Grid.view.
|
|
41323
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
41158
41324
|
* @param {Core.data.Store} event.store The originating store
|
|
41159
41325
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
41160
41326
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
41161
41327
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
41162
41328
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
41163
41329
|
*/
|
|
41164
|
-
dataChange?: ((event: { source:
|
|
41330
|
+
dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
41165
41331
|
/**
|
|
41166
41332
|
* Fires when an object is destroyed.
|
|
41167
41333
|
* @param {object} event Event object
|
|
@@ -41469,18 +41635,18 @@ type TreeGridListeners = {
|
|
|
41469
41635
|
/**
|
|
41470
41636
|
* Fires after a row is rendered.
|
|
41471
41637
|
* @param {object} event Event object
|
|
41472
|
-
* @param {Grid.view.
|
|
41473
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
41474
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
41475
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
41638
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
41639
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
41640
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
41641
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
41476
41642
|
*/
|
|
41477
|
-
renderRow?: ((event: { source:
|
|
41643
|
+
renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
41478
41644
|
/**
|
|
41479
41645
|
* Grid rows have been rendered
|
|
41480
41646
|
* @param {object} event Event object
|
|
41481
|
-
* @param {Grid.view.
|
|
41647
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
41482
41648
|
*/
|
|
41483
|
-
renderRows?: ((event: { source:
|
|
41649
|
+
renderRows?: ((event: { source: GridBase }) => void)|string
|
|
41484
41650
|
/**
|
|
41485
41651
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
41486
41652
|
* @param {object} event Event object
|
|
@@ -41540,10 +41706,10 @@ type TreeGridListeners = {
|
|
|
41540
41706
|
/**
|
|
41541
41707
|
* Grid has scrolled vertically
|
|
41542
41708
|
* @param {object} event Event object
|
|
41543
|
-
* @param {Grid.view.
|
|
41709
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
41544
41710
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
41545
41711
|
*/
|
|
41546
|
-
scroll?: ((event: { source:
|
|
41712
|
+
scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
41547
41713
|
/**
|
|
41548
41714
|
* The selection has been changed.
|
|
41549
41715
|
* @param {object} event Event object
|
|
@@ -41631,17 +41797,17 @@ type TreeGridListeners = {
|
|
|
41631
41797
|
/**
|
|
41632
41798
|
* Fires after a sub grid is collapsed.
|
|
41633
41799
|
* @param {object} event Event object
|
|
41634
|
-
* @param {Grid.view.
|
|
41800
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
41635
41801
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
41636
41802
|
*/
|
|
41637
|
-
subGridCollapse?: ((event: { source:
|
|
41803
|
+
subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
41638
41804
|
/**
|
|
41639
41805
|
* Fires after a sub grid is expanded.
|
|
41640
41806
|
* @param {object} event Event object
|
|
41641
|
-
* @param {Grid.view.
|
|
41807
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
41642
41808
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
41643
41809
|
*/
|
|
41644
|
-
subGridExpand?: ((event: { source:
|
|
41810
|
+
subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
41645
41811
|
/**
|
|
41646
41812
|
* Fired when one or more groups are expanded or collapsed
|
|
41647
41813
|
* @param {object} event Event object
|
|
@@ -42569,6 +42735,14 @@ type TreeGridConfig = {
|
|
|
42569
42735
|
* @param {any} event.value The value being set
|
|
42570
42736
|
*/
|
|
42571
42737
|
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
42738
|
+
/**
|
|
42739
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
42740
|
+
* @param {object} event Event object
|
|
42741
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
42742
|
+
* @param {Grid.column.Column} event.column The column
|
|
42743
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
42744
|
+
*/
|
|
42745
|
+
onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
42572
42746
|
/**
|
|
42573
42747
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
42574
42748
|
* @param {object} event Event object
|
|
@@ -42663,24 +42837,24 @@ type TreeGridConfig = {
|
|
|
42663
42837
|
/**
|
|
42664
42838
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
42665
42839
|
* @param {object} event Event object
|
|
42666
|
-
* @param {
|
|
42840
|
+
* @param {PdfExportConfig} event.config Export config
|
|
42667
42841
|
*/
|
|
42668
|
-
onBeforePdfExport?: ((event: { config:
|
|
42842
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
42669
42843
|
/**
|
|
42670
42844
|
* Fires before a row is rendered.
|
|
42671
42845
|
* @param {object} event Event object
|
|
42672
|
-
* @param {Grid.view.
|
|
42673
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
42674
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
42675
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
42846
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
42847
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
42848
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
42849
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
42676
42850
|
*/
|
|
42677
|
-
onBeforeRenderRow?: ((event: { source:
|
|
42851
|
+
onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
42678
42852
|
/**
|
|
42679
42853
|
* Grid rows are about to be rendered
|
|
42680
42854
|
* @param {object} event Event object
|
|
42681
|
-
* @param {Grid.view.
|
|
42855
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
42682
42856
|
*/
|
|
42683
|
-
onBeforeRenderRows?: ((event: { source:
|
|
42857
|
+
onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
42684
42858
|
/**
|
|
42685
42859
|
* This event fires before row collapse is started.
|
|
42686
42860
|
* ...
|
|
@@ -42911,6 +43085,14 @@ type TreeGridConfig = {
|
|
|
42911
43085
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
42912
43086
|
*/
|
|
42913
43087
|
onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
43088
|
+
/**
|
|
43089
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
43090
|
+
* @param {object} event Event object
|
|
43091
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
43092
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
43093
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
43094
|
+
*/
|
|
43095
|
+
onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
42914
43096
|
/**
|
|
42915
43097
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
42916
43098
|
* to indicate whether the drop position is valid or not.
|
|
@@ -42992,14 +43174,14 @@ type TreeGridConfig = {
|
|
|
42992
43174
|
* ...
|
|
42993
43175
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
|
|
42994
43176
|
* @param {object} event Event object
|
|
42995
|
-
* @param {Grid.view.
|
|
43177
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
42996
43178
|
* @param {Core.data.Store} event.store The originating store
|
|
42997
43179
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
42998
43180
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
42999
43181
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
43000
43182
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
43001
43183
|
*/
|
|
43002
|
-
onDataChange?: ((event: { source:
|
|
43184
|
+
onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
43003
43185
|
/**
|
|
43004
43186
|
* Fires when an object is destroyed.
|
|
43005
43187
|
* @param {object} event Event object
|
|
@@ -43307,18 +43489,18 @@ type TreeGridConfig = {
|
|
|
43307
43489
|
/**
|
|
43308
43490
|
* Fires after a row is rendered.
|
|
43309
43491
|
* @param {object} event Event object
|
|
43310
|
-
* @param {Grid.view.
|
|
43311
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
43312
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
43313
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
43492
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
43493
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
43494
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
43495
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
43314
43496
|
*/
|
|
43315
|
-
onRenderRow?: ((event: { source:
|
|
43497
|
+
onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
43316
43498
|
/**
|
|
43317
43499
|
* Grid rows have been rendered
|
|
43318
43500
|
* @param {object} event Event object
|
|
43319
|
-
* @param {Grid.view.
|
|
43501
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
43320
43502
|
*/
|
|
43321
|
-
onRenderRows?: ((event: { source:
|
|
43503
|
+
onRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
43322
43504
|
/**
|
|
43323
43505
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
43324
43506
|
* @param {object} event Event object
|
|
@@ -43378,10 +43560,10 @@ type TreeGridConfig = {
|
|
|
43378
43560
|
/**
|
|
43379
43561
|
* Grid has scrolled vertically
|
|
43380
43562
|
* @param {object} event Event object
|
|
43381
|
-
* @param {Grid.view.
|
|
43563
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
43382
43564
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
43383
43565
|
*/
|
|
43384
|
-
onScroll?: ((event: { source:
|
|
43566
|
+
onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
43385
43567
|
/**
|
|
43386
43568
|
* The selection has been changed.
|
|
43387
43569
|
* @param {object} event Event object
|
|
@@ -43469,17 +43651,17 @@ type TreeGridConfig = {
|
|
|
43469
43651
|
/**
|
|
43470
43652
|
* Fires after a sub grid is collapsed.
|
|
43471
43653
|
* @param {object} event Event object
|
|
43472
|
-
* @param {Grid.view.
|
|
43654
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
43473
43655
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
43474
43656
|
*/
|
|
43475
|
-
onSubGridCollapse?: ((event: { source:
|
|
43657
|
+
onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
43476
43658
|
/**
|
|
43477
43659
|
* Fires after a sub grid is expanded.
|
|
43478
43660
|
* @param {object} event Event object
|
|
43479
|
-
* @param {Grid.view.
|
|
43661
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
43480
43662
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
43481
43663
|
*/
|
|
43482
|
-
onSubGridExpand?: ((event: { source:
|
|
43664
|
+
onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
43483
43665
|
/**
|
|
43484
43666
|
* Fired when one or more groups are expanded or collapsed
|
|
43485
43667
|
* @param {object} event Event object
|