@bryntum/grid-angular-thin 7.3.0 → 7.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -5
- package/bundles/bryntum-grid-angular-thin.umd.js +15 -3
- package/bundles/bryntum-grid-angular-thin.umd.js.map +1 -1
- package/esm2015/lib/bryntum-a-i-filter-field.component.js +6 -2
- package/esm2015/lib/bryntum-checklist-filter-combo.component.js +6 -2
- package/esm2015/lib/bryntum-grid-base.component.js +1 -1
- package/esm2015/lib/bryntum-grid-chart-designer.component.js +1 -1
- package/esm2015/lib/bryntum-grid-field-filter-picker-group.component.js +1 -1
- package/esm2015/lib/bryntum-grid-field-filter-picker.component.js +1 -1
- package/esm2015/lib/bryntum-grid.component.js +1 -1
- package/esm2015/lib/bryntum-group-bar.component.js +1 -1
- package/esm2015/lib/bryntum-tree-combo.component.js +6 -2
- package/esm2015/lib/bryntum-tree-grid.component.js +1 -1
- package/fesm2015/bryntum-grid-angular-thin.js +15 -3
- package/fesm2015/bryntum-grid-angular-thin.js.map +1 -1
- package/lib/bryntum-a-i-filter-field.component.d.ts +17 -1
- package/lib/bryntum-checklist-filter-combo.component.d.ts +17 -1
- package/lib/bryntum-grid-base.component.d.ts +6 -0
- package/lib/bryntum-grid-chart-designer.component.d.ts +6 -0
- package/lib/bryntum-grid-field-filter-picker-group.component.d.ts +6 -0
- package/lib/bryntum-grid-field-filter-picker.component.d.ts +6 -0
- package/lib/bryntum-grid.component.d.ts +6 -0
- package/lib/bryntum-group-bar.component.d.ts +10 -2
- package/lib/bryntum-tree-combo.component.d.ts +17 -1
- package/lib/bryntum-tree-grid.component.d.ts +6 -0
- package/package.json +1 -1
- package/src/lib/bryntum-a-i-filter-field.component.ts +19 -1
- package/src/lib/bryntum-checklist-filter-combo.component.ts +19 -1
- package/src/lib/bryntum-grid-base.component.ts +31 -25
- package/src/lib/bryntum-grid-chart-designer.component.ts +7 -1
- package/src/lib/bryntum-grid-field-filter-picker-group.component.ts +8 -2
- package/src/lib/bryntum-grid-field-filter-picker.component.ts +7 -1
- package/src/lib/bryntum-grid.component.ts +31 -25
- package/src/lib/bryntum-group-bar.component.ts +12 -4
- package/src/lib/bryntum-theme-combo.component.ts +0 -1
- package/src/lib/bryntum-tree-combo.component.ts +19 -1
- package/src/lib/bryntum-tree-grid.component.ts +31 -25
|
@@ -48,6 +48,8 @@ export type BryntumGridBaseProps = {
|
|
|
48
48
|
/**
|
|
49
49
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
50
50
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
51
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
52
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-appendTo)
|
|
51
53
|
*/
|
|
52
54
|
appendTo ? : HTMLElement|string
|
|
53
55
|
/**
|
|
@@ -359,10 +361,14 @@ export type BryntumGridBaseProps = {
|
|
|
359
361
|
inputFieldAlign ? : 'start'|'end'
|
|
360
362
|
/**
|
|
361
363
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
364
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
365
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-insertBefore)
|
|
362
366
|
*/
|
|
363
367
|
insertBefore ? : HTMLElement|string
|
|
364
368
|
/**
|
|
365
369
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
370
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
371
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-insertFirst)
|
|
366
372
|
*/
|
|
367
373
|
insertFirst ? : HTMLElement|string
|
|
368
374
|
/**
|
|
@@ -1620,7 +1626,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
1620
1626
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
1621
1627
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
1622
1628
|
*/
|
|
1623
|
-
@Output() onBeforeCancelCellEdit: any = new EventEmitter<((event: { source: Grid, editorContext: GridLocation }) =>
|
|
1629
|
+
@Output() onBeforeCancelCellEdit: any = new EventEmitter<((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string>();
|
|
1624
1630
|
/**
|
|
1625
1631
|
* Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
|
|
1626
1632
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
|
|
@@ -1635,7 +1641,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
1635
1641
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
1636
1642
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
1637
1643
|
*/
|
|
1638
|
-
@Output() onBeforeCellEditStart: any = new EventEmitter<((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
1644
|
+
@Output() onBeforeCellEditStart: any = new EventEmitter<((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string>();
|
|
1639
1645
|
/**
|
|
1640
1646
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
1641
1647
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -1643,7 +1649,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
1643
1649
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
1644
1650
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
|
|
1645
1651
|
*/
|
|
1646
|
-
@Output() onBeforeCellRangeDelete: any = new EventEmitter<((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
1652
|
+
@Output() onBeforeCellRangeDelete: any = new EventEmitter<((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string>();
|
|
1647
1653
|
/**
|
|
1648
1654
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
1649
1655
|
* @param {object} event Event object
|
|
@@ -1651,7 +1657,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
1651
1657
|
* @param {string} event.field The field being changed
|
|
1652
1658
|
* @param {any} event.value The value being set
|
|
1653
1659
|
*/
|
|
1654
|
-
@Output() onBeforeCellRangeEdit: any = new EventEmitter<((event: { record: Model, field: string, value: any }) =>
|
|
1660
|
+
@Output() onBeforeCellRangeEdit: any = new EventEmitter<((event: { record: Model, field: string, value: any }) => boolean|void)|string>();
|
|
1655
1661
|
/**
|
|
1656
1662
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
1657
1663
|
* @param {object} event Event object
|
|
@@ -1667,7 +1673,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
1667
1673
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
1668
1674
|
* @param {Event} event.event The browser event.
|
|
1669
1675
|
*/
|
|
1670
|
-
@Output() onBeforeColumnDragStart: any = new EventEmitter<((event: { source: Grid, column: Column, event: Event }) =>
|
|
1676
|
+
@Output() onBeforeColumnDragStart: any = new EventEmitter<((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string>();
|
|
1671
1677
|
/**
|
|
1672
1678
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
1673
1679
|
* @param {object} event Event object
|
|
@@ -1678,7 +1684,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
1678
1684
|
* @param {Event} event.event The browser event.
|
|
1679
1685
|
* @param {string} event.region The region where the column was dropped.
|
|
1680
1686
|
*/
|
|
1681
|
-
@Output() onBeforeColumnDropFinalize: any = new EventEmitter<((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
1687
|
+
@Output() onBeforeColumnDropFinalize: any = new EventEmitter<((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string>();
|
|
1682
1688
|
/**
|
|
1683
1689
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
1684
1690
|
* `false`.
|
|
@@ -1687,7 +1693,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
1687
1693
|
* @param {Grid.column.Column} event.column The column
|
|
1688
1694
|
* @param {Event} event.domEvent The browser event
|
|
1689
1695
|
*/
|
|
1690
|
-
@Output() onBeforeColumnResize: any = new EventEmitter<((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
1696
|
+
@Output() onBeforeColumnResize: any = new EventEmitter<((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string>();
|
|
1691
1697
|
/**
|
|
1692
1698
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
1693
1699
|
* @param {object} event Event object
|
|
@@ -1707,7 +1713,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
1707
1713
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
1708
1714
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
1709
1715
|
*/
|
|
1710
|
-
@Output() onBeforeCSVExport: any = new EventEmitter<((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
1716
|
+
@Output() onBeforeCSVExport: any = new EventEmitter<((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string>();
|
|
1711
1717
|
/**
|
|
1712
1718
|
* Fires before an object is destroyed.
|
|
1713
1719
|
* @param {object} event Event object
|
|
@@ -1721,14 +1727,14 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
1721
1727
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
1722
1728
|
* @param {any[][]} event.rows An array of records to export
|
|
1723
1729
|
*/
|
|
1724
|
-
@Output() onBeforeExcelExport: any = new EventEmitter<((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
1730
|
+
@Output() onBeforeExcelExport: any = new EventEmitter<((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string>();
|
|
1725
1731
|
/**
|
|
1726
1732
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
1727
1733
|
* @param {object} event Event object
|
|
1728
1734
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
1729
1735
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
1730
1736
|
*/
|
|
1731
|
-
@Output() onBeforeFillHandleDragStart: any = new EventEmitter<((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
1737
|
+
@Output() onBeforeFillHandleDragStart: any = new EventEmitter<((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string>();
|
|
1732
1738
|
/**
|
|
1733
1739
|
* Fires on the owning Grid before the cell editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
1734
1740
|
* @param {object} event Event object
|
|
@@ -1749,7 +1755,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
1749
1755
|
* @param {object} event Event object
|
|
1750
1756
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
1751
1757
|
*/
|
|
1752
|
-
@Output() onBeforeHide: any = new EventEmitter<((event: { source: Widget }) =>
|
|
1758
|
+
@Output() onBeforeHide: any = new EventEmitter<((event: { source: Widget }) => boolean|void)|string>();
|
|
1753
1759
|
/**
|
|
1754
1760
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
1755
1761
|
* @param {object} event Event object
|
|
@@ -1765,7 +1771,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
1765
1771
|
* @param {object} event Event object
|
|
1766
1772
|
* @param {PdfExportConfig} event.config Export config
|
|
1767
1773
|
*/
|
|
1768
|
-
@Output() onBeforePdfExport: any = new EventEmitter<((event: { config: PdfExportConfig }) =>
|
|
1774
|
+
@Output() onBeforePdfExport: any = new EventEmitter<((event: { config: PdfExportConfig }) => boolean|void)|string>();
|
|
1769
1775
|
/**
|
|
1770
1776
|
* Fires before a row is rendered.
|
|
1771
1777
|
* @param {object} event Event object
|
|
@@ -1808,7 +1814,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
1808
1814
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
1809
1815
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
1810
1816
|
*/
|
|
1811
|
-
@Output() onBeforeSelectionChange: any = new EventEmitter<((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
1817
|
+
@Output() onBeforeSelectionChange: any = new EventEmitter<((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string>();
|
|
1812
1818
|
/**
|
|
1813
1819
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
1814
1820
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -1829,19 +1835,19 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
1829
1835
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
1830
1836
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
1831
1837
|
*/
|
|
1832
|
-
@Output() onBeforeStartRowEdit: any = new EventEmitter<((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
1838
|
+
@Output() onBeforeStartRowEdit: any = new EventEmitter<((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string>();
|
|
1833
1839
|
/**
|
|
1834
1840
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
1835
1841
|
* @param {object} event Event object
|
|
1836
1842
|
* @param {GridStateInfo} event.state State object config
|
|
1837
1843
|
*/
|
|
1838
|
-
@Output() onBeforeStateApply: any = new EventEmitter<((event: { state: GridStateInfo }) =>
|
|
1844
|
+
@Output() onBeforeStateApply: any = new EventEmitter<((event: { state: GridStateInfo }) => boolean|void)|string>();
|
|
1839
1845
|
/**
|
|
1840
1846
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
1841
1847
|
* @param {object} event Event object
|
|
1842
1848
|
* @param {GridStateInfo} event.state State object config
|
|
1843
1849
|
*/
|
|
1844
|
-
@Output() onBeforeStateSave: any = new EventEmitter<((event: { state: GridStateInfo }) =>
|
|
1850
|
+
@Output() onBeforeStateSave: any = new EventEmitter<((event: { state: GridStateInfo }) => boolean|void)|string>();
|
|
1845
1851
|
/**
|
|
1846
1852
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
1847
1853
|
* Returning `false` from a listener prevents the operation
|
|
@@ -1851,7 +1857,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
1851
1857
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
1852
1858
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
1853
1859
|
*/
|
|
1854
|
-
@Output() onBeforeToggleGroup: any = new EventEmitter<((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
1860
|
+
@Output() onBeforeToggleGroup: any = new EventEmitter<((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string>();
|
|
1855
1861
|
/**
|
|
1856
1862
|
* Fired before a parent node record toggles its collapsed state.
|
|
1857
1863
|
* @param {object} event Event object
|
|
@@ -1920,7 +1926,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
1920
1926
|
* @param {Grid.column.Column} event.column Column
|
|
1921
1927
|
* @param {Core.data.Model} event.record Record
|
|
1922
1928
|
*/
|
|
1923
|
-
@Output() onCellMenuBeforeShow: any = new EventEmitter<((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
1929
|
+
@Output() onCellMenuBeforeShow: any = new EventEmitter<((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string>();
|
|
1924
1930
|
/**
|
|
1925
1931
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
1926
1932
|
* @param {object} event Event object
|
|
@@ -2047,7 +2053,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
2047
2053
|
* @param {Event} event.event The browser event.
|
|
2048
2054
|
* @param {string} event.region The region where the column was dropped.
|
|
2049
2055
|
*/
|
|
2050
|
-
@Output() onColumnDrop: any = new EventEmitter<((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
2056
|
+
@Output() onColumnDrop: any = new EventEmitter<((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string>();
|
|
2051
2057
|
/**
|
|
2052
2058
|
* This event is fired after a resize gesture is completed.
|
|
2053
2059
|
* @param {object} event Event object
|
|
@@ -2187,7 +2193,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
2187
2193
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
2188
2194
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
2189
2195
|
*/
|
|
2190
|
-
@Output() onFillHandleDragStart: any = new EventEmitter<((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
2196
|
+
@Output() onFillHandleDragStart: any = new EventEmitter<((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string>();
|
|
2191
2197
|
/**
|
|
2192
2198
|
* Fires on the owning Grid when cell editing is finished
|
|
2193
2199
|
* @param {object} event Event object
|
|
@@ -2235,7 +2241,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
2235
2241
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
2236
2242
|
* @param {MouseEvent,TouchEvent} event.event
|
|
2237
2243
|
*/
|
|
2238
|
-
@Output() onGridRowBeforeDragStart: any = new EventEmitter<((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
2244
|
+
@Output() onGridRowBeforeDragStart: any = new EventEmitter<((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string>();
|
|
2239
2245
|
/**
|
|
2240
2246
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
2241
2247
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -2302,7 +2308,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
2302
2308
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
2303
2309
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
2304
2310
|
*/
|
|
2305
|
-
@Output() onHeaderClick: any = new EventEmitter<((event: { domEvent: Event, column: Column }) =>
|
|
2311
|
+
@Output() onHeaderClick: any = new EventEmitter<((event: { domEvent: Event, column: Column }) => boolean|void)|string>();
|
|
2306
2312
|
/**
|
|
2307
2313
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
2308
2314
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu#config-processItems).
|
|
@@ -2313,7 +2319,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
2313
2319
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
2314
2320
|
* @param {Grid.column.Column} event.column Column
|
|
2315
2321
|
*/
|
|
2316
|
-
@Output() onHeaderMenuBeforeShow: any = new EventEmitter<((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
2322
|
+
@Output() onHeaderMenuBeforeShow: any = new EventEmitter<((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string>();
|
|
2317
2323
|
/**
|
|
2318
2324
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
2319
2325
|
* @param {object} event Event object
|
|
@@ -2524,7 +2530,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
2524
2530
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
2525
2531
|
* @param {Event} event.domEvent The native DOM event
|
|
2526
2532
|
*/
|
|
2527
|
-
@Output() onSplitterCollapseClick: any = new EventEmitter<((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
2533
|
+
@Output() onSplitterCollapseClick: any = new EventEmitter<((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string>();
|
|
2528
2534
|
/**
|
|
2529
2535
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
2530
2536
|
* @param {object} event Event object
|
|
@@ -2549,7 +2555,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
2549
2555
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
2550
2556
|
* @param {Event} event.domEvent The native DOM event
|
|
2551
2557
|
*/
|
|
2552
|
-
@Output() onSplitterExpandClick: any = new EventEmitter<((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
2558
|
+
@Output() onSplitterExpandClick: any = new EventEmitter<((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string>();
|
|
2553
2559
|
/**
|
|
2554
2560
|
* Fires on the owning Grid when editing starts
|
|
2555
2561
|
* @param {object} event Event object
|
|
@@ -40,6 +40,8 @@ export type BryntumGridChartDesignerProps = {
|
|
|
40
40
|
/**
|
|
41
41
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
42
42
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
43
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
44
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-appendTo)
|
|
43
45
|
*/
|
|
44
46
|
appendTo ? : HTMLElement|string
|
|
45
47
|
/**
|
|
@@ -217,10 +219,14 @@ export type BryntumGridChartDesignerProps = {
|
|
|
217
219
|
ignoreParentReadOnly ? : boolean
|
|
218
220
|
/**
|
|
219
221
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
222
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
223
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-insertBefore)
|
|
220
224
|
*/
|
|
221
225
|
insertBefore ? : HTMLElement|string
|
|
222
226
|
/**
|
|
223
227
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
228
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
229
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-insertFirst)
|
|
224
230
|
*/
|
|
225
231
|
insertFirst ? : HTMLElement|string
|
|
226
232
|
/**
|
|
@@ -746,7 +752,7 @@ export class BryntumGridChartDesignerComponent implements OnInit, OnDestroy {
|
|
|
746
752
|
* @param {object} event Event object
|
|
747
753
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
748
754
|
*/
|
|
749
|
-
@Output() onBeforeHide: any = new EventEmitter<((event: { source: Widget }) =>
|
|
755
|
+
@Output() onBeforeHide: any = new EventEmitter<((event: { source: Widget }) => boolean|void)|string>();
|
|
750
756
|
/**
|
|
751
757
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
752
758
|
* @param {object} event Event object
|
|
@@ -50,6 +50,8 @@ export type BryntumGridFieldFilterPickerGroupProps = {
|
|
|
50
50
|
/**
|
|
51
51
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
52
52
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
53
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
54
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-appendTo)
|
|
53
55
|
*/
|
|
54
56
|
appendTo ? : HTMLElement|string
|
|
55
57
|
/**
|
|
@@ -298,10 +300,14 @@ export type BryntumGridFieldFilterPickerGroupProps = {
|
|
|
298
300
|
inputFieldAlign ? : 'start'|'end'
|
|
299
301
|
/**
|
|
300
302
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
303
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
304
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-insertBefore)
|
|
301
305
|
*/
|
|
302
306
|
insertBefore ? : HTMLElement|string
|
|
303
307
|
/**
|
|
304
308
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
309
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
310
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-insertFirst)
|
|
305
311
|
*/
|
|
306
312
|
insertFirst ? : HTMLElement|string
|
|
307
313
|
/**
|
|
@@ -1005,7 +1011,7 @@ export class BryntumGridFieldFilterPickerGroupComponent implements OnInit, OnDes
|
|
|
1005
1011
|
* @param {Core.widget.FieldFilterPicker} event.source The FieldFilterPicker instance that fired the event.
|
|
1006
1012
|
* @param {CollectionFilterConfig} event.filter The [CollectionFilter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) configuration object for the filter represented by this [FieldFilterPicker](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPicker).
|
|
1007
1013
|
*/
|
|
1008
|
-
@Output() onBeforeAddFilter: any = new EventEmitter<((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) =>
|
|
1014
|
+
@Output() onBeforeAddFilter: any = new EventEmitter<((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) => boolean|void)|string>();
|
|
1009
1015
|
/**
|
|
1010
1016
|
* Fires before an object is destroyed.
|
|
1011
1017
|
* @param {object} event Event object
|
|
@@ -1017,7 +1023,7 @@ export class BryntumGridFieldFilterPickerGroupComponent implements OnInit, OnDes
|
|
|
1017
1023
|
* @param {object} event Event object
|
|
1018
1024
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
1019
1025
|
*/
|
|
1020
|
-
@Output() onBeforeHide: any = new EventEmitter<((event: { source: Widget }) =>
|
|
1026
|
+
@Output() onBeforeHide: any = new EventEmitter<((event: { source: Widget }) => boolean|void)|string>();
|
|
1021
1027
|
/**
|
|
1022
1028
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
1023
1029
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -47,6 +47,8 @@ export type BryntumGridFieldFilterPickerProps = {
|
|
|
47
47
|
/**
|
|
48
48
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
49
49
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
50
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
51
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-appendTo)
|
|
50
52
|
*/
|
|
51
53
|
appendTo ? : HTMLElement|string
|
|
52
54
|
/**
|
|
@@ -283,10 +285,14 @@ export type BryntumGridFieldFilterPickerProps = {
|
|
|
283
285
|
inputFieldAlign ? : 'start'|'end'
|
|
284
286
|
/**
|
|
285
287
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
288
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
289
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-insertBefore)
|
|
286
290
|
*/
|
|
287
291
|
insertBefore ? : HTMLElement|string
|
|
288
292
|
/**
|
|
289
293
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
294
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
295
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-insertFirst)
|
|
290
296
|
*/
|
|
291
297
|
insertFirst ? : HTMLElement|string
|
|
292
298
|
/**
|
|
@@ -1003,7 +1009,7 @@ export class BryntumGridFieldFilterPickerComponent implements OnInit, OnDestroy
|
|
|
1003
1009
|
* @param {object} event Event object
|
|
1004
1010
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
1005
1011
|
*/
|
|
1006
|
-
@Output() onBeforeHide: any = new EventEmitter<((event: { source: Widget }) =>
|
|
1012
|
+
@Output() onBeforeHide: any = new EventEmitter<((event: { source: Widget }) => boolean|void)|string>();
|
|
1007
1013
|
/**
|
|
1008
1014
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
1009
1015
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -48,6 +48,8 @@ export type BryntumGridProps = {
|
|
|
48
48
|
/**
|
|
49
49
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
50
50
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
51
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
52
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-appendTo)
|
|
51
53
|
*/
|
|
52
54
|
appendTo ? : HTMLElement|string
|
|
53
55
|
/**
|
|
@@ -359,10 +361,14 @@ export type BryntumGridProps = {
|
|
|
359
361
|
inputFieldAlign ? : 'start'|'end'
|
|
360
362
|
/**
|
|
361
363
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
364
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
365
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-insertBefore)
|
|
362
366
|
*/
|
|
363
367
|
insertBefore ? : HTMLElement|string
|
|
364
368
|
/**
|
|
365
369
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
370
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
371
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-insertFirst)
|
|
366
372
|
*/
|
|
367
373
|
insertFirst ? : HTMLElement|string
|
|
368
374
|
/**
|
|
@@ -1624,7 +1630,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
1624
1630
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
1625
1631
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
1626
1632
|
*/
|
|
1627
|
-
@Output() onBeforeCancelCellEdit: any = new EventEmitter<((event: { source: Grid, editorContext: GridLocation }) =>
|
|
1633
|
+
@Output() onBeforeCancelCellEdit: any = new EventEmitter<((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string>();
|
|
1628
1634
|
/**
|
|
1629
1635
|
* Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
|
|
1630
1636
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-beforeCancelRowEdit)
|
|
@@ -1639,7 +1645,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
1639
1645
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
1640
1646
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
1641
1647
|
*/
|
|
1642
|
-
@Output() onBeforeCellEditStart: any = new EventEmitter<((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
1648
|
+
@Output() onBeforeCellEditStart: any = new EventEmitter<((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string>();
|
|
1643
1649
|
/**
|
|
1644
1650
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
1645
1651
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -1647,7 +1653,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
1647
1653
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
1648
1654
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
|
|
1649
1655
|
*/
|
|
1650
|
-
@Output() onBeforeCellRangeDelete: any = new EventEmitter<((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
1656
|
+
@Output() onBeforeCellRangeDelete: any = new EventEmitter<((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string>();
|
|
1651
1657
|
/**
|
|
1652
1658
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
1653
1659
|
* @param {object} event Event object
|
|
@@ -1655,7 +1661,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
1655
1661
|
* @param {string} event.field The field being changed
|
|
1656
1662
|
* @param {any} event.value The value being set
|
|
1657
1663
|
*/
|
|
1658
|
-
@Output() onBeforeCellRangeEdit: any = new EventEmitter<((event: { record: Model, field: string, value: any }) =>
|
|
1664
|
+
@Output() onBeforeCellRangeEdit: any = new EventEmitter<((event: { record: Model, field: string, value: any }) => boolean|void)|string>();
|
|
1659
1665
|
/**
|
|
1660
1666
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
1661
1667
|
* @param {object} event Event object
|
|
@@ -1671,7 +1677,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
1671
1677
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
1672
1678
|
* @param {Event} event.event The browser event.
|
|
1673
1679
|
*/
|
|
1674
|
-
@Output() onBeforeColumnDragStart: any = new EventEmitter<((event: { source: Grid, column: Column, event: Event }) =>
|
|
1680
|
+
@Output() onBeforeColumnDragStart: any = new EventEmitter<((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string>();
|
|
1675
1681
|
/**
|
|
1676
1682
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
1677
1683
|
* @param {object} event Event object
|
|
@@ -1682,7 +1688,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
1682
1688
|
* @param {Event} event.event The browser event.
|
|
1683
1689
|
* @param {string} event.region The region where the column was dropped.
|
|
1684
1690
|
*/
|
|
1685
|
-
@Output() onBeforeColumnDropFinalize: any = new EventEmitter<((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
1691
|
+
@Output() onBeforeColumnDropFinalize: any = new EventEmitter<((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string>();
|
|
1686
1692
|
/**
|
|
1687
1693
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
1688
1694
|
* `false`.
|
|
@@ -1691,7 +1697,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
1691
1697
|
* @param {Grid.column.Column} event.column The column
|
|
1692
1698
|
* @param {Event} event.domEvent The browser event
|
|
1693
1699
|
*/
|
|
1694
|
-
@Output() onBeforeColumnResize: any = new EventEmitter<((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
1700
|
+
@Output() onBeforeColumnResize: any = new EventEmitter<((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string>();
|
|
1695
1701
|
/**
|
|
1696
1702
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
1697
1703
|
* @param {object} event Event object
|
|
@@ -1711,7 +1717,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
1711
1717
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
1712
1718
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
1713
1719
|
*/
|
|
1714
|
-
@Output() onBeforeCSVExport: any = new EventEmitter<((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
1720
|
+
@Output() onBeforeCSVExport: any = new EventEmitter<((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string>();
|
|
1715
1721
|
/**
|
|
1716
1722
|
* Fires before an object is destroyed.
|
|
1717
1723
|
* @param {object} event Event object
|
|
@@ -1725,14 +1731,14 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
1725
1731
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
1726
1732
|
* @param {any[][]} event.rows An array of records to export
|
|
1727
1733
|
*/
|
|
1728
|
-
@Output() onBeforeExcelExport: any = new EventEmitter<((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
1734
|
+
@Output() onBeforeExcelExport: any = new EventEmitter<((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string>();
|
|
1729
1735
|
/**
|
|
1730
1736
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
1731
1737
|
* @param {object} event Event object
|
|
1732
1738
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
1733
1739
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
1734
1740
|
*/
|
|
1735
|
-
@Output() onBeforeFillHandleDragStart: any = new EventEmitter<((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
1741
|
+
@Output() onBeforeFillHandleDragStart: any = new EventEmitter<((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string>();
|
|
1736
1742
|
/**
|
|
1737
1743
|
* Fires on the owning Grid before the cell editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
1738
1744
|
* @param {object} event Event object
|
|
@@ -1753,7 +1759,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
1753
1759
|
* @param {object} event Event object
|
|
1754
1760
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
1755
1761
|
*/
|
|
1756
|
-
@Output() onBeforeHide: any = new EventEmitter<((event: { source: Widget }) =>
|
|
1762
|
+
@Output() onBeforeHide: any = new EventEmitter<((event: { source: Widget }) => boolean|void)|string>();
|
|
1757
1763
|
/**
|
|
1758
1764
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
1759
1765
|
* @param {object} event Event object
|
|
@@ -1769,7 +1775,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
1769
1775
|
* @param {object} event Event object
|
|
1770
1776
|
* @param {PdfExportConfig} event.config Export config
|
|
1771
1777
|
*/
|
|
1772
|
-
@Output() onBeforePdfExport: any = new EventEmitter<((event: { config: PdfExportConfig }) =>
|
|
1778
|
+
@Output() onBeforePdfExport: any = new EventEmitter<((event: { config: PdfExportConfig }) => boolean|void)|string>();
|
|
1773
1779
|
/**
|
|
1774
1780
|
* Fires before a row is rendered.
|
|
1775
1781
|
* @param {object} event Event object
|
|
@@ -1812,7 +1818,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
1812
1818
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
1813
1819
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
1814
1820
|
*/
|
|
1815
|
-
@Output() onBeforeSelectionChange: any = new EventEmitter<((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
1821
|
+
@Output() onBeforeSelectionChange: any = new EventEmitter<((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string>();
|
|
1816
1822
|
/**
|
|
1817
1823
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
1818
1824
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -1833,19 +1839,19 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
1833
1839
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
1834
1840
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
1835
1841
|
*/
|
|
1836
|
-
@Output() onBeforeStartRowEdit: any = new EventEmitter<((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
1842
|
+
@Output() onBeforeStartRowEdit: any = new EventEmitter<((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string>();
|
|
1837
1843
|
/**
|
|
1838
1844
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
1839
1845
|
* @param {object} event Event object
|
|
1840
1846
|
* @param {GridStateInfo} event.state State object config
|
|
1841
1847
|
*/
|
|
1842
|
-
@Output() onBeforeStateApply: any = new EventEmitter<((event: { state: GridStateInfo }) =>
|
|
1848
|
+
@Output() onBeforeStateApply: any = new EventEmitter<((event: { state: GridStateInfo }) => boolean|void)|string>();
|
|
1843
1849
|
/**
|
|
1844
1850
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
1845
1851
|
* @param {object} event Event object
|
|
1846
1852
|
* @param {GridStateInfo} event.state State object config
|
|
1847
1853
|
*/
|
|
1848
|
-
@Output() onBeforeStateSave: any = new EventEmitter<((event: { state: GridStateInfo }) =>
|
|
1854
|
+
@Output() onBeforeStateSave: any = new EventEmitter<((event: { state: GridStateInfo }) => boolean|void)|string>();
|
|
1849
1855
|
/**
|
|
1850
1856
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
1851
1857
|
* Returning `false` from a listener prevents the operation
|
|
@@ -1855,7 +1861,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
1855
1861
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
1856
1862
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
1857
1863
|
*/
|
|
1858
|
-
@Output() onBeforeToggleGroup: any = new EventEmitter<((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
1864
|
+
@Output() onBeforeToggleGroup: any = new EventEmitter<((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string>();
|
|
1859
1865
|
/**
|
|
1860
1866
|
* Fired before a parent node record toggles its collapsed state.
|
|
1861
1867
|
* @param {object} event Event object
|
|
@@ -1924,7 +1930,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
1924
1930
|
* @param {Grid.column.Column} event.column Column
|
|
1925
1931
|
* @param {Core.data.Model} event.record Record
|
|
1926
1932
|
*/
|
|
1927
|
-
@Output() onCellMenuBeforeShow: any = new EventEmitter<((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
1933
|
+
@Output() onCellMenuBeforeShow: any = new EventEmitter<((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string>();
|
|
1928
1934
|
/**
|
|
1929
1935
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
1930
1936
|
* @param {object} event Event object
|
|
@@ -2051,7 +2057,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
2051
2057
|
* @param {Event} event.event The browser event.
|
|
2052
2058
|
* @param {string} event.region The region where the column was dropped.
|
|
2053
2059
|
*/
|
|
2054
|
-
@Output() onColumnDrop: any = new EventEmitter<((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
2060
|
+
@Output() onColumnDrop: any = new EventEmitter<((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string>();
|
|
2055
2061
|
/**
|
|
2056
2062
|
* This event is fired after a resize gesture is completed.
|
|
2057
2063
|
* @param {object} event Event object
|
|
@@ -2191,7 +2197,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
2191
2197
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
2192
2198
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
2193
2199
|
*/
|
|
2194
|
-
@Output() onFillHandleDragStart: any = new EventEmitter<((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
2200
|
+
@Output() onFillHandleDragStart: any = new EventEmitter<((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string>();
|
|
2195
2201
|
/**
|
|
2196
2202
|
* Fires on the owning Grid when cell editing is finished
|
|
2197
2203
|
* @param {object} event Event object
|
|
@@ -2239,7 +2245,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
2239
2245
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
2240
2246
|
* @param {MouseEvent,TouchEvent} event.event
|
|
2241
2247
|
*/
|
|
2242
|
-
@Output() onGridRowBeforeDragStart: any = new EventEmitter<((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
2248
|
+
@Output() onGridRowBeforeDragStart: any = new EventEmitter<((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string>();
|
|
2243
2249
|
/**
|
|
2244
2250
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
2245
2251
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -2306,7 +2312,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
2306
2312
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
2307
2313
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
2308
2314
|
*/
|
|
2309
|
-
@Output() onHeaderClick: any = new EventEmitter<((event: { domEvent: Event, column: Column }) =>
|
|
2315
|
+
@Output() onHeaderClick: any = new EventEmitter<((event: { domEvent: Event, column: Column }) => boolean|void)|string>();
|
|
2310
2316
|
/**
|
|
2311
2317
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
2312
2318
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu#config-processItems).
|
|
@@ -2317,7 +2323,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
2317
2323
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
2318
2324
|
* @param {Grid.column.Column} event.column Column
|
|
2319
2325
|
*/
|
|
2320
|
-
@Output() onHeaderMenuBeforeShow: any = new EventEmitter<((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
2326
|
+
@Output() onHeaderMenuBeforeShow: any = new EventEmitter<((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string>();
|
|
2321
2327
|
/**
|
|
2322
2328
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
2323
2329
|
* @param {object} event Event object
|
|
@@ -2528,7 +2534,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
2528
2534
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
2529
2535
|
* @param {Event} event.domEvent The native DOM event
|
|
2530
2536
|
*/
|
|
2531
|
-
@Output() onSplitterCollapseClick: any = new EventEmitter<((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
2537
|
+
@Output() onSplitterCollapseClick: any = new EventEmitter<((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string>();
|
|
2532
2538
|
/**
|
|
2533
2539
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
2534
2540
|
* @param {object} event Event object
|
|
@@ -2553,7 +2559,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
2553
2559
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
2554
2560
|
* @param {Event} event.domEvent The native DOM event
|
|
2555
2561
|
*/
|
|
2556
|
-
@Output() onSplitterExpandClick: any = new EventEmitter<((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
2562
|
+
@Output() onSplitterExpandClick: any = new EventEmitter<((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string>();
|
|
2557
2563
|
/**
|
|
2558
2564
|
* Fires on the owning Grid when editing starts
|
|
2559
2565
|
* @param {object} event Event object
|