@bryntum/grid-trial 7.1.1 → 7.1.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/grid.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /*!
2
2
  *
3
- * Bryntum Grid 7.1.1 (TRIAL VERSION)
3
+ * Bryntum Grid 7.1.2 (TRIAL VERSION)
4
4
  *
5
5
  * Copyright(c) 2026 Bryntum AB
6
6
  * https://bryntum.com/contact
@@ -1542,10 +1542,16 @@ type ActionConfig = {
1542
1542
  */
1543
1543
  cls?: string
1544
1544
  /**
1545
- * A text to use for the action element´s `aria-label` value. If not provided, the
1546
- * action´s `tooltip` will be used as the `aria-label` (if present).
1545
+ * A text to use for the action element's `aria-label` value. If not provided, the
1546
+ * action's `tooltip` will be used as the `aria-label` (if present).
1547
1547
  */
1548
1548
  ariaLabel?: string
1549
+ /**
1550
+ * A value to use for the action element's `aria-haspopup` attribute.
1551
+ * Set to indicate that the action triggers a popup. This helps assistive technologies inform users that activating
1552
+ * the action will display a popup element.
1553
+ */
1554
+ ariaHasPopup?: 'true'|'false'|'menu'|'listbox'|'tree'|'grid'|'dialog'|boolean
1549
1555
  /**
1550
1556
  * Tooltip text, or a config object which can reconfigure the shared
1551
1557
  * tooltip by setting boolean, numeric and string config values, or a function to return the tooltip text, passed the
@@ -1805,7 +1811,7 @@ type EmptyTextDomConfig = DomConfig & {
1805
1811
  /**
1806
1812
  * The grid region to add the empty text to
1807
1813
  */
1808
- region?: string
1814
+ region?: 'locked'|'normal'|string
1809
1815
  }
1810
1816
 
1811
1817
  type GridScrollOptions = {
@@ -3486,7 +3492,9 @@ type AjaxStoreConfig = {
3486
3492
  */
3487
3493
  readUrl?: string
3488
3494
  /**
3489
- * Specify true to reapply filters when a record is added to the store.
3495
+ * Specify `true` to reapply filters when a record is added to or moved within the store.
3496
+ * This includes tree node operations like indent/outdent in Gantt, or any move operation
3497
+ * that changes a node's parent.
3490
3498
  */
3491
3499
  reapplyFilterOnAdd?: boolean
3492
3500
  /**
@@ -4727,6 +4735,16 @@ export class Duration {
4727
4735
  * @param {number,string,object,Core.data.Duration} source The data to be converted into a Duration.
4728
4736
  */
4729
4737
  static from(source: number|string|object|Duration): Duration;
4738
+ /**
4739
+ * Returns a new Duration which is the sum of this Duration and the passed Duration. The returned Duration unit is the same as this Duration's unit.
4740
+ * @param {Core.data.Duration} otherDuration
4741
+ */
4742
+ add(otherDuration: Duration): Duration;
4743
+ /**
4744
+ * Returns a new Duration which is the difference between this Duration and the passed Duration. The returned Duration unit is the same as this Duration's unit.
4745
+ * @param {Core.data.Duration} otherDuration
4746
+ */
4747
+ diff(otherDuration: Duration): Duration;
4730
4748
  /**
4731
4749
  * Returns truthy value if this Duration equals the passed value.
4732
4750
  * @param {Core.data.Duration} value
@@ -6196,7 +6214,9 @@ type StoreConfig = {
6196
6214
  */
6197
6215
  pageStartParamName?: string
6198
6216
  /**
6199
- * Specify true to reapply filters when a record is added to the store.
6217
+ * Specify `true` to reapply filters when a record is added to or moved within the store.
6218
+ * This includes tree node operations like indent/outdent in Gantt, or any move operation
6219
+ * that changes a node's parent.
6200
6220
  */
6201
6221
  reapplyFilterOnAdd?: boolean
6202
6222
  /**
@@ -7379,7 +7399,7 @@ export class Store extends Base {
7379
7399
  * <strong>It will not remove other filters applied to the store!</strong>
7380
7400
  * @param {object,CollectionFilterConfig,CollectionFilterConfig[],Function} newFilters A [filter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) config, or an array of [filter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) configs, or a function to use for filtering, or a special object like: `{ replace : true, filters : newFilters }`
7381
7401
  */
7382
- filter(newFilters: {
7402
+ filter(newFilters?: {
7383
7403
  replace?: boolean
7384
7404
  silent?: boolean
7385
7405
  filters?: CollectionFilterConfig|CollectionFilterConfig[]|Function
@@ -9765,7 +9785,9 @@ type StoreFilterClassConfig = {
9765
9785
  */
9766
9786
  filters?: CollectionFilterConfig|CollectionFilterConfig[]
9767
9787
  /**
9768
- * Specify true to reapply filters when a record is added to the store.
9788
+ * Specify `true` to reapply filters when a record is added to or moved within the store.
9789
+ * This includes tree node operations like indent/outdent in Gantt, or any move operation
9790
+ * that changes a node's parent.
9769
9791
  */
9770
9792
  reapplyFilterOnAdd?: boolean
9771
9793
  /**
@@ -9861,7 +9883,7 @@ export class StoreFilterClass {
9861
9883
  * <strong>It will not remove other filters applied to the store!</strong>
9862
9884
  * @param {object,CollectionFilterConfig,CollectionFilterConfig[],Function} newFilters A [filter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) config, or an array of [filter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) configs, or a function to use for filtering, or a special object like: `{ replace : true, filters : newFilters }`
9863
9885
  */
9864
- filter(newFilters: {
9886
+ filter(newFilters?: {
9865
9887
  replace?: boolean
9866
9888
  silent?: boolean
9867
9889
  filters?: CollectionFilterConfig|CollectionFilterConfig[]|Function
@@ -10879,6 +10901,44 @@ export class TreeNodeClass {
10879
10901
 
10880
10902
  export const TreeNode : <T extends AnyConstructor<Base>>(base : T) => AnyConstructor<InstanceType<T> & TreeNodeClass>
10881
10903
 
10904
+ /**
10905
+ * Type with configuration options for [RevisionTransaction](https://bryntum.com/products/grid/docs/api/Core/data/stm/RevisionTransaction) class.
10906
+ */
10907
+ type RevisionTransactionConfig = {
10908
+ /**
10909
+ * Transaction title
10910
+ */
10911
+ title?: string
10912
+ }
10913
+
10914
+ /**
10915
+ * Transaction with additional metadata utilized by the Revisions feature
10916
+ * ...
10917
+ * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/data/stm/RevisionTransaction)
10918
+ */
10919
+ export class RevisionTransaction extends Transaction {
10920
+ /**
10921
+ * Identifies an object as an instance of [RevisionTransaction](https://bryntum.com/products/grid/docs/api/Core/data/stm/RevisionTransaction) class, or subclass thereof.
10922
+ */
10923
+ static readonly isRevisionTransaction: boolean
10924
+ /**
10925
+ * Identifies an object as an instance of [RevisionTransaction](https://bryntum.com/products/grid/docs/api/Core/data/stm/RevisionTransaction) class, or subclass thereof.
10926
+ */
10927
+ readonly isRevisionTransaction: boolean
10928
+ /**
10929
+ * Creates an instance of the class using the supplied configuration
10930
+ * @param {RevisionTransactionConfig} config
10931
+ */
10932
+ constructor(config?: RevisionTransactionConfig);
10933
+ /**
10934
+ * Creates [RevisionTransaction](https://bryntum.com/products/grid/docs/api/Core/data/stm/RevisionTransaction) from [Transaction](#Core/data/stm/Transaction)
10935
+ * with additional metadata utilized by the revisions feature
10936
+ * @param {Core.data.stm.Transaction[]} transactions Transactions to group into revision
10937
+ * @param {object} config Additional config to apply to revision transaction
10938
+ */
10939
+ static from(transactions: Transaction[], config: object): RevisionTransaction;
10940
+ }
10941
+
10882
10942
  /**
10883
10943
  * Type with available listeners functions for [StateTrackingManager](https://bryntum.com/products/grid/docs/api/Core/data/stm/StateTrackingManager) class.
10884
10944
  * Could be used for callbacks typings in TypeScript application.
@@ -11458,7 +11518,7 @@ type TransactionConfig = {
11458
11518
  }
11459
11519
 
11460
11520
  /**
11461
- * STM transaction class, holds list of actions constituting a transaction.
11521
+ * STM transaction class holds a list of actions constituting a transaction.
11462
11522
  * ...
11463
11523
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/data/stm/Transaction)
11464
11524
  */
@@ -15446,7 +15506,8 @@ export class ObjectHelper {
15446
15506
  */
15447
15507
  static toFixed(number: number, digits: number): string;
15448
15508
  /**
15449
- * Creates a new object where key is a property in array item (`ref` by default) or index in the array and value is array item.
15509
+ * Creates a new object where key is a property in array item (`ref` by default) or index in the array and value is
15510
+ * array item.
15450
15511
  * @param {object[]} arrayOfItems Array to transform.
15451
15512
  * @param {string} prop Property to read the key from. `ref` by default.
15452
15513
  */
@@ -17468,15 +17529,15 @@ export class LoadMaskableClass {
17468
17529
  export const LoadMaskable : <T extends AnyConstructor<Base>>(base : T) => AnyConstructor<InstanceType<T> & LoadMaskableClass>
17469
17530
 
17470
17531
  /**
17471
- * Simplifies overriding class methods by allowing methods from another class to be used as overrides.
17472
- * Overrides are defined as own classes. They must at a minimum contain a static getter named targetClass, which
17473
- * should return the class to override. Apply the override by calling [apply()](https://bryntum.com/products/grid/docs/api/Core/mixin/Override#function-apply-static).
17532
+ * Simplifies overriding class methods by allowing methods from another class to be used as overrides. Overrides are
17533
+ * defined as own classes. They must at a minimum contain a static getter named `target´, which should return an object
17534
+ * with the class to override. Apply the override by calling [apply()](https://bryntum.com/products/grid/docs/api/Core/mixin/Override#function-apply-static).
17474
17535
  * ...
17475
17536
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/mixin/Override)
17476
17537
  */
17477
17538
  export class Override {
17478
17539
  /**
17479
- * Apply override. We strongly suggest that you at least specify a maxVersion for your overrides.
17540
+ * Apply override. We strongly suggest that you at least specify `maxVersion` for your overrides.
17480
17541
  * @param {object} override An override class definition
17481
17542
  */
17482
17543
  static apply(override: object): void;
@@ -106038,7 +106099,7 @@ type CheckColumnConfig = {
106038
106099
  */
106039
106100
  cellMenuItems?: Record<string, MenuItemEntry>
106040
106101
  /**
106041
- * The `aria-label` to use for the default checkbox widget of cells in this Column
106102
+ * The `aria-label` used for the default checkbox widget in this column’s cells.
106042
106103
  */
106043
106104
  checkAriaLabel?: string
106044
106105
  /**
@@ -106597,7 +106658,7 @@ export class CheckColumn extends WidgetColumn {
106597
106658
  */
106598
106659
  static readonly isCheckColumn: boolean
106599
106660
  /**
106600
- * The `aria-label` to use for the default checkbox widget of cells in this Column
106661
+ * The `aria-label` used for the default checkbox widget in this column’s cells.
106601
106662
  */
106602
106663
  checkAriaLabel: string
106603
106664
  /**
@@ -114834,7 +114895,8 @@ type TimeColumnConfig = {
114834
114895
  */
114835
114896
  flex?: number|string
114836
114897
  /**
114837
- * Time format
114898
+ * Time format for time displayed in cell and editor
114899
+ * (see [format](https://bryntum.com/products/grid/docs/api/Core/helper/DateHelper#function-format-static) for formatting options)
114838
114900
  */
114839
114901
  format?: string
114840
114902
  /**
@@ -115231,7 +115293,8 @@ export class TimeColumn extends Column {
115231
115293
  */
115232
115294
  static readonly isTimeColumn: boolean
115233
115295
  /**
115234
- * Time format
115296
+ * Time format for time displayed in cell and editor
115297
+ * (see [format](https://bryntum.com/products/grid/docs/api/Core/helper/DateHelper#function-format-static) for formatting options)
115235
115298
  */
115236
115299
  format: string
115237
115300
  /**
@@ -117521,7 +117584,9 @@ type ColumnStoreConfig = {
117521
117584
  */
117522
117585
  pageStartParamName?: string
117523
117586
  /**
117524
- * Specify true to reapply filters when a record is added to the store.
117587
+ * Specify `true` to reapply filters when a record is added to or moved within the store.
117588
+ * This includes tree node operations like indent/outdent in Gantt, or any move operation
117589
+ * that changes a node's parent.
117525
117590
  */
117526
117591
  reapplyFilterOnAdd?: boolean
117527
117592
  /**
@@ -130178,9 +130243,9 @@ export class PdfExport extends InstancePlugin {
130178
130243
  /**
130179
130244
  * Starts the export process. Accepts a config object which overrides any default configs.
130180
130245
  * <strong>NOTE</strong>. Component should not be interacted with when export is in progress
130181
- * @param {object} config
130246
+ * @param {PdfExportConfig} config
130182
130247
  */
130183
- export(config: object): Promise<any>;
130248
+ export(config: PdfExportConfig): Promise<any>;
130184
130249
  /**
130185
130250
  * This method accepts all stylesheets (link and style tags) which are supposed to be put on the page. Use
130186
130251
  * this hook method to filter or modify them.
@@ -130592,9 +130657,9 @@ export class Print extends PdfExport {
130592
130657
  /**
130593
130658
  * Starts the print process. Accepts a config object which overrides any default configs.
130594
130659
  * <strong>NOTE</strong> Component should not be interacted with when print is in progress
130595
- * @param {object} config
130660
+ * @param {PrintConfig} config
130596
130661
  */
130597
- print(config: object): Promise<any>;
130662
+ print(config: PrintConfig): Promise<any>;
130598
130663
  /**
130599
130664
  * Shows the [print dialog](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog)
130600
130665
  */
@@ -131944,9 +132009,9 @@ export class PrintMixinClass {
131944
132009
  /**
131945
132010
  * Starts the print process. Accepts a config object which overrides any default configs.
131946
132011
  * <strong>NOTE</strong> Component should not be interacted with when print is in progress
131947
- * @param {object} config
132012
+ * @param {PrintConfig} config
131948
132013
  */
131949
- print(config: object): Promise<any>;
132014
+ print(config: PrintConfig): Promise<any>;
131950
132015
  /**
131951
132016
  * Shows the [print dialog](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog)
131952
132017
  */
@@ -132134,6 +132199,10 @@ export class GridLocation {
132134
132199
  * The cell DOM element which this `GridLocation` references.
132135
132200
  */
132136
132201
  readonly cell: HTMLElement
132202
+ /**
132203
+ * Yields the [Column](https://bryntum.com/products/grid/docs/api/Grid/column/Column) of this location.
132204
+ */
132205
+ readonly column: Column
132137
132206
  /**
132138
132207
  * Yields the column index of this location.
132139
132208
  */
@@ -132142,6 +132211,10 @@ export class GridLocation {
132142
132211
  * This property is `true` if the focus is inside the cell, not *on* the cell.
132143
132212
  */
132144
132213
  readonly containsFocus: boolean
132214
+ /**
132215
+ * The grid which this `GridLocation` references.
132216
+ */
132217
+ readonly grid: Grid
132145
132218
  /**
132146
132219
  * This property is `true` if the focus target is not the cell itself.
132147
132220
  */
@@ -132158,6 +132231,10 @@ export class GridLocation {
132158
132231
  * Yields `true` if the cell and row are selectable.
132159
132232
  */
132160
132233
  readonly isSelectable: boolean
132234
+ /**
132235
+ * 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.
132236
+ */
132237
+ readonly record: Model
132161
132238
  /**
132162
132239
  * Yields the row index of this location.
132163
132240
  */
@@ -132396,9 +132473,9 @@ type GridListenersTypes = {
132396
132473
  /**
132397
132474
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
132398
132475
  * @param {object} event Event object
132399
- * @param {object} event.config Export config
132476
+ * @param {PdfExportConfig} event.config Export config
132400
132477
  */
132401
- beforePdfExport: (event: { config: object }) => Promise<boolean>|boolean|void
132478
+ beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
132402
132479
  /**
132403
132480
  * Fires before a row is rendered.
132404
132481
  * @param {object} event Event object
@@ -133399,9 +133476,9 @@ type GridListeners = {
133399
133476
  /**
133400
133477
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
133401
133478
  * @param {object} event Event object
133402
- * @param {object} event.config Export config
133479
+ * @param {PdfExportConfig} event.config Export config
133403
133480
  */
133404
- beforePdfExport?: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
133481
+ beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
133405
133482
  /**
133406
133483
  * Fires before a row is rendered.
133407
133484
  * @param {object} event Event object
@@ -135237,9 +135314,9 @@ type GridConfig = {
135237
135314
  /**
135238
135315
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
135239
135316
  * @param {object} event Event object
135240
- * @param {object} event.config Export config
135317
+ * @param {PdfExportConfig} event.config Export config
135241
135318
  */
135242
- onBeforePdfExport?: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
135319
+ onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
135243
135320
  /**
135244
135321
  * Fires before a row is rendered.
135245
135322
  * @param {object} event Event object
@@ -136459,9 +136536,9 @@ type GridBaseListenersTypes = {
136459
136536
  /**
136460
136537
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
136461
136538
  * @param {object} event Event object
136462
- * @param {object} event.config Export config
136539
+ * @param {PdfExportConfig} event.config Export config
136463
136540
  */
136464
- beforePdfExport: (event: { config: object }) => Promise<boolean>|boolean|void
136541
+ beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
136465
136542
  /**
136466
136543
  * Fires before a row is rendered.
136467
136544
  * @param {object} event Event object
@@ -137462,9 +137539,9 @@ type GridBaseListeners = {
137462
137539
  /**
137463
137540
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
137464
137541
  * @param {object} event Event object
137465
- * @param {object} event.config Export config
137542
+ * @param {PdfExportConfig} event.config Export config
137466
137543
  */
137467
- beforePdfExport?: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
137544
+ beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
137468
137545
  /**
137469
137546
  * Fires before a row is rendered.
137470
137547
  * @param {object} event Event object
@@ -139299,9 +139376,9 @@ type GridBaseConfig = {
139299
139376
  /**
139300
139377
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
139301
139378
  * @param {object} event Event object
139302
- * @param {object} event.config Export config
139379
+ * @param {PdfExportConfig} event.config Export config
139303
139380
  */
139304
- onBeforePdfExport?: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
139381
+ onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
139305
139382
  /**
139306
139383
  * Fires before a row is rendered.
139307
139384
  * @param {object} event Event object
@@ -140625,9 +140702,9 @@ export class GridBase extends Panel {
140625
140702
  /**
140626
140703
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
140627
140704
  * @param {object} event Event object
140628
- * @param {object} event.config Export config
140705
+ * @param {PdfExportConfig} event.config Export config
140629
140706
  */
140630
- onBeforePdfExport: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
140707
+ onBeforePdfExport: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
140631
140708
  /**
140632
140709
  * Fires before a row is rendered.
140633
140710
  * @param {object} event Event object
@@ -141630,9 +141707,9 @@ export class GridBase extends Panel {
141630
141707
  /**
141631
141708
  * Starts the print process. Accepts a config object which overrides any default configs.
141632
141709
  * <strong>NOTE</strong> Component should not be interacted with when print is in progress
141633
- * @param {object} config
141710
+ * @param {PrintConfig} config
141634
141711
  */
141635
- print(config: object): Promise<any>;
141712
+ print(config: PrintConfig): Promise<any>;
141636
141713
  /**
141637
141714
  * Triggers a render of all the cells in a column.
141638
141715
  * @param {Grid.column.Column,Grid.column.Column[]} column
@@ -142934,9 +143011,9 @@ type TreeGridListenersTypes = {
142934
143011
  /**
142935
143012
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
142936
143013
  * @param {object} event Event object
142937
- * @param {object} event.config Export config
143014
+ * @param {PdfExportConfig} event.config Export config
142938
143015
  */
142939
- beforePdfExport: (event: { config: object }) => Promise<boolean>|boolean|void
143016
+ beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
142940
143017
  /**
142941
143018
  * Fires before a row is rendered.
142942
143019
  * @param {object} event Event object
@@ -143937,9 +144014,9 @@ type TreeGridListeners = {
143937
144014
  /**
143938
144015
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
143939
144016
  * @param {object} event Event object
143940
- * @param {object} event.config Export config
144017
+ * @param {PdfExportConfig} event.config Export config
143941
144018
  */
143942
- beforePdfExport?: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
144019
+ beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
143943
144020
  /**
143944
144021
  * Fires before a row is rendered.
143945
144022
  * @param {object} event Event object
@@ -145775,9 +145852,9 @@ type TreeGridConfig = {
145775
145852
  /**
145776
145853
  * Fires on the owning Grid before export started. Return `false` to cancel the export.
145777
145854
  * @param {object} event Event object
145778
- * @param {object} event.config Export config
145855
+ * @param {PdfExportConfig} event.config Export config
145779
145856
  */
145780
- onBeforePdfExport?: ((event: { config: object }) => Promise<boolean>|boolean|void)|string
145857
+ onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
145781
145858
  /**
145782
145859
  * Fires before a row is rendered.
145783
145860
  * @param {object} event Event object
@@ -1,6 +1,6 @@
1
1
  /*!
2
2
  *
3
- * Bryntum Grid 7.1.1 (TRIAL VERSION)
3
+ * Bryntum Grid 7.1.2 (TRIAL VERSION)
4
4
  *
5
5
  * Copyright(c) 2026 Bryntum AB
6
6
  * https://bryntum.com/contact