@bryntum/grid-trial 7.2.2 → 7.2.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/grid.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /*!
2
2
  *
3
- * Bryntum Grid 7.2.2 (TRIAL VERSION)
3
+ * Bryntum Grid 7.2.3 (TRIAL VERSION)
4
4
  *
5
5
  * Copyright(c) 2026 Bryntum AB
6
6
  * https://bryntum.com/contact
@@ -2420,6 +2420,12 @@ type GlobalEventsListenersTypes = {
2420
2420
  * @param {string} event.theme The new theme name
2421
2421
  */
2422
2422
  theme: (event: { source: typeof GlobalEvents, theme: string }) => void
2423
+ /**
2424
+ * Fired when the browser zoom level is changed by the user
2425
+ * @param {object} event Event object
2426
+ * @param {typeof GlobalEvents} event.source
2427
+ */
2428
+ zoomChange: (event: { source: typeof GlobalEvents }) => void
2423
2429
  }
2424
2430
 
2425
2431
  /**
@@ -2458,6 +2464,12 @@ type GlobalEventsListeners = {
2458
2464
  * @param {string} event.theme The new theme name
2459
2465
  */
2460
2466
  theme?: ((event: { source: typeof GlobalEvents, theme: string }) => void)|string
2467
+ /**
2468
+ * Fired when the browser zoom level is changed by the user
2469
+ * @param {object} event Event object
2470
+ * @param {typeof GlobalEvents} event.source
2471
+ */
2472
+ zoomChange?: ((event: { source: typeof GlobalEvents }) => void)|string
2461
2473
  }
2462
2474
 
2463
2475
  export class GlobalEventsSingleton {
@@ -2506,6 +2518,12 @@ export class GlobalEventsSingleton {
2506
2518
  * @param {string} event.theme The new theme name
2507
2519
  */
2508
2520
  onTheme: ((event: { source: typeof GlobalEvents, theme: string }) => void)|string
2521
+ /**
2522
+ * Fired when the browser zoom level is changed by the user
2523
+ * @param {object} event Event object
2524
+ * @param {typeof GlobalEvents} event.source
2525
+ */
2526
+ onZoomChange: ((event: { source: typeof GlobalEvents }) => void)|string
2509
2527
  /**
2510
2528
  * Adds an event listener. This method accepts parameters in the following format:
2511
2529
  * @param {BryntumListenerConfig,string} config An object containing listener definitions, or the event name to listen for
@@ -7111,6 +7129,11 @@ export class Store extends Base {
7111
7129
  * Setting `autoCommit` to `true` automatically commits changes to records.
7112
7130
  */
7113
7131
  autoCommit: boolean
7132
+ /**
7133
+ * Returns the root store in the chain — the store that is not itself chained. For a store chained
7134
+ * off another chained store, this walks up the full chain. Returns `this` if the store is not chained.
7135
+ */
7136
+ readonly baseStore: Store
7114
7137
  /**
7115
7138
  * Set to `true` to call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
7116
7139
  */
@@ -7198,6 +7221,11 @@ export class Store extends Base {
7198
7221
  * Yields `true` if this Store is loaded page by page. See the [remotePaging](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StorePaging#config-remotePaging) config.
7199
7222
  */
7200
7223
  readonly isPaged: boolean
7224
+ /**
7225
+ * Returns `true` if the data in this store depends on a remote data source. That is this
7226
+ * Store is an AjaxStore, or uses [requestData](https://bryntum.com/products/grid/docs/api/Core/data/Store#config-requestData), or is chained off an AjaxStore.
7227
+ */
7228
+ readonly isRemoteLoad: boolean
7201
7229
  /**
7202
7230
  * Is store sorted?
7203
7231
  */
@@ -10032,6 +10060,11 @@ export class StoreChainedClass {
10032
10060
  * Identifies an object as an instance of [StoreChained](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreChained) class, or subclass thereof.
10033
10061
  */
10034
10062
  static readonly isStoreChained: boolean
10063
+ /**
10064
+ * Returns the root store in the chain — the store that is not itself chained. For a store chained
10065
+ * off another chained store, this walks up the full chain. Returns `this` if the store is not chained.
10066
+ */
10067
+ readonly baseStore: Store
10035
10068
  /**
10036
10069
  * Is this a chained store?
10037
10070
  */
@@ -16038,7 +16071,8 @@ export class ObjectHelper {
16038
16071
  }
16039
16072
 
16040
16073
  /**
16041
- * Helper for string manipulation.
16074
+ * A static utility class providing common string manipulation methods such as HTML encoding, camelCase
16075
+ * conversion, regular expression escaping, and markdown-to-HTML processing.
16042
16076
  * ...
16043
16077
  * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/helper/StringHelper)
16044
16078
  */
@@ -16622,8 +16656,9 @@ export class Rectangle {
16622
16656
  * @param {HTMLElement,Core.widget.Widget,Core.widget.Mask,string} element The element (or selector) to calculate the Rectangle for.
16623
16657
  * @param {HTMLElement,string} relativeTo Optionally, a parent element (or selector) in whose space to calculate the Rectangle.
16624
16658
  * @param {boolean} ignorePageScroll Use browser viewport based coordinates.
16659
+ * @param {boolean} rtl Pass `true` when the `relativeTo` element uses RTL direction. Normalizes the negative `scrollLeft` values that browsers use in RTL mode so that content-space coordinates are correct.
16625
16660
  */
16626
- static from(element: HTMLElement|Widget|Mask|string, relativeTo?: HTMLElement|string, ignorePageScroll?: boolean): Rectangle;
16661
+ static from(element: HTMLElement|Widget|Mask|string, relativeTo?: HTMLElement|string, ignorePageScroll?: boolean, rtl?: boolean): Rectangle;
16627
16662
  /**
16628
16663
  * Returns the Rectangle in viewport coordinates of the passed element.
16629
16664
  * @param {HTMLElement} element The element to calculate the Rectangle for.
@@ -17157,8 +17192,8 @@ export class Scroller extends Base {
17157
17192
  resumeEvents(): boolean;
17158
17193
  /**
17159
17194
  * Scrolls by the passed deltas according to the passed options.
17160
- * @param {number} xDelta How far to scroll in the X axis.
17161
- * @param {number} yDelta How far to scroll in the Y axis.
17195
+ * @param {number} xDelta How far to scroll along the X axis.
17196
+ * @param {number} yDelta How far to scroll along the Y axis.
17162
17197
  * @param {object,boolean} options How to scroll. May be passed as `true` to animate.
17163
17198
  */
17164
17199
  scrollBy(xDelta?: number, yDelta?: number, options?: {
@@ -42889,7 +42924,7 @@ type DateTimeFieldConfig = {
42889
42924
  value?: string
42890
42925
  /**
42891
42926
  * The week start day in the [picker](https://bryntum.com/products/grid/docs/api/Core/widget/DateField#config-picker), 0 meaning Sunday, 6 meaning Saturday.
42892
- * Uses localized value per default.
42927
+ * Uses a localized value by default.
42893
42928
  */
42894
42929
  weekStartDay?: number
42895
42930
  /**
@@ -107637,8 +107672,9 @@ type ActionColumnConfig = {
107637
107672
  * @param {object} renderData
107638
107673
  * @param {Grid.column.Column} renderData.column This column
107639
107674
  * @param {HTMLElement} renderData.headerElement The header element
107675
+ * @returns {string,object,void,void} The text or markup to show in the column header
107640
107676
  */
107641
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
107677
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
107642
107678
  /**
107643
107679
  * An array of the widgets to append to the column header. These widgets have this Column instance
107644
107680
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -108356,8 +108392,9 @@ type AggregateColumnConfig = {
108356
108392
  * @param {object} renderData
108357
108393
  * @param {Grid.column.Column} renderData.column This column
108358
108394
  * @param {HTMLElement} renderData.headerElement The header element
108395
+ * @returns {string,object,void,void} The text or markup to show in the column header
108359
108396
  */
108360
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
108397
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
108361
108398
  /**
108362
108399
  * An array of the widgets to append to the column header. These widgets have this Column instance
108363
108400
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -109126,8 +109163,9 @@ type ChartColumnConfig = {
109126
109163
  * @param {object} renderData
109127
109164
  * @param {Grid.column.Column} renderData.column This column
109128
109165
  * @param {HTMLElement} renderData.headerElement The header element
109166
+ * @returns {string,object,void,void} The text or markup to show in the column header
109129
109167
  */
109130
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
109168
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
109131
109169
  /**
109132
109170
  * An array of the widgets to append to the column header. These widgets have this Column instance
109133
109171
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -109901,8 +109939,9 @@ type CheckColumnConfig = {
109901
109939
  * @param {object} renderData
109902
109940
  * @param {Grid.column.Column} renderData.column This column
109903
109941
  * @param {HTMLElement} renderData.headerElement The header element
109942
+ * @returns {string,object,void,void} The text or markup to show in the column header
109904
109943
  */
109905
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
109944
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
109906
109945
  /**
109907
109946
  * An array of the widgets to append to the column header. These widgets have this Column instance
109908
109947
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -110691,8 +110730,9 @@ type ColorColumnConfig = {
110691
110730
  * @param {object} renderData
110692
110731
  * @param {Grid.column.Column} renderData.column This column
110693
110732
  * @param {HTMLElement} renderData.headerElement The header element
110733
+ * @returns {string,object,void,void} The text or markup to show in the column header
110694
110734
  */
110695
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
110735
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
110696
110736
  /**
110697
110737
  * An array of the widgets to append to the column header. These widgets have this Column instance
110698
110738
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -111426,8 +111466,9 @@ type ColumnConfig = {
111426
111466
  * @param {object} renderData
111427
111467
  * @param {Grid.column.Column} renderData.column This column
111428
111468
  * @param {HTMLElement} renderData.headerElement The header element
111469
+ * @returns {string,object,void,void} The text or markup to show in the column header
111429
111470
  */
111430
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
111471
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
111431
111472
  /**
111432
111473
  * An array of the widgets to append to the column header. These widgets have this Column instance
111433
111474
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -111975,7 +112016,7 @@ export class Column extends Model {
111975
112016
  /**
111976
112017
  * Renderer function for the column header.
111977
112018
  */
111978
- headerRenderer: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
112019
+ headerRenderer: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
111979
112020
  /**
111980
112021
  * An array of the widgets to append to the column header. These widgets have this Column instance
111981
112022
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -112723,8 +112764,9 @@ type CurrencyColumnConfig = {
112723
112764
  * @param {object} renderData
112724
112765
  * @param {Grid.column.Column} renderData.column This column
112725
112766
  * @param {HTMLElement} renderData.headerElement The header element
112767
+ * @returns {string,object,void,void} The text or markup to show in the column header
112726
112768
  */
112727
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
112769
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
112728
112770
  /**
112729
112771
  * An array of the widgets to append to the column header. These widgets have this Column instance
112730
112772
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -113475,8 +113517,9 @@ type DateColumnConfig = {
113475
113517
  * @param {object} renderData
113476
113518
  * @param {Grid.column.Column} renderData.column This column
113477
113519
  * @param {HTMLElement} renderData.headerElement The header element
113520
+ * @returns {string,object,void,void} The text or markup to show in the column header
113478
113521
  */
113479
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
113522
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
113480
113523
  /**
113481
113524
  * An array of the widgets to append to the column header. These widgets have this Column instance
113482
113525
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -114238,8 +114281,9 @@ type NumberColumnConfig = {
114238
114281
  * @param {object} renderData
114239
114282
  * @param {Grid.column.Column} renderData.column This column
114240
114283
  * @param {HTMLElement} renderData.headerElement The header element
114284
+ * @returns {string,object,void,void} The text or markup to show in the column header
114241
114285
  */
114242
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
114286
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
114243
114287
  /**
114244
114288
  * An array of the widgets to append to the column header. These widgets have this Column instance
114245
114289
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -115017,8 +115061,9 @@ type PercentColumnConfig = {
115017
115061
  * @param {object} renderData
115018
115062
  * @param {Grid.column.Column} renderData.column This column
115019
115063
  * @param {HTMLElement} renderData.headerElement The header element
115064
+ * @returns {string,object,void,void} The text or markup to show in the column header
115020
115065
  */
115021
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
115066
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
115022
115067
  /**
115023
115068
  * An array of the widgets to append to the column header. These widgets have this Column instance
115024
115069
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -115795,8 +115840,9 @@ type RatingColumnConfig = {
115795
115840
  * @param {object} renderData
115796
115841
  * @param {Grid.column.Column} renderData.column This column
115797
115842
  * @param {HTMLElement} renderData.headerElement The header element
115843
+ * @returns {string,object,void,void} The text or markup to show in the column header
115798
115844
  */
115799
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
115845
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
115800
115846
  /**
115801
115847
  * An array of the widgets to append to the column header. These widgets have this Column instance
115802
115848
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -116475,8 +116521,9 @@ type RowNumberColumnConfig = {
116475
116521
  * @param {object} renderData
116476
116522
  * @param {Grid.column.Column} renderData.column This column
116477
116523
  * @param {HTMLElement} renderData.headerElement The header element
116524
+ * @returns {string,object,void,void} The text or markup to show in the column header
116478
116525
  */
116479
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
116526
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
116480
116527
  /**
116481
116528
  * An array of the widgets to append to the column header. These widgets have this Column instance
116482
116529
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -117143,8 +117190,9 @@ type SparklineColumnConfig = {
117143
117190
  * @param {object} renderData
117144
117191
  * @param {Grid.column.Column} renderData.column This column
117145
117192
  * @param {HTMLElement} renderData.headerElement The header element
117193
+ * @returns {string,object,void,void} The text or markup to show in the column header
117146
117194
  */
117147
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
117195
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
117148
117196
  /**
117149
117197
  * An array of the widgets to append to the column header. These widgets have this Column instance
117150
117198
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -117867,8 +117915,9 @@ type TemplateColumnConfig = {
117867
117915
  * @param {object} renderData
117868
117916
  * @param {Grid.column.Column} renderData.column This column
117869
117917
  * @param {HTMLElement} renderData.headerElement The header element
117918
+ * @returns {string,object,void,void} The text or markup to show in the column header
117870
117919
  */
117871
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
117920
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
117872
117921
  /**
117873
117922
  * An array of the widgets to append to the column header. These widgets have this Column instance
117874
117923
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -118596,8 +118645,9 @@ type TimeColumnConfig = {
118596
118645
  * @param {object} renderData
118597
118646
  * @param {Grid.column.Column} renderData.column This column
118598
118647
  * @param {HTMLElement} renderData.headerElement The header element
118648
+ * @returns {string,object,void,void} The text or markup to show in the column header
118599
118649
  */
118600
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
118650
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
118601
118651
  /**
118602
118652
  * An array of the widgets to append to the column header. These widgets have this Column instance
118603
118653
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -119328,8 +119378,9 @@ type TreeColumnConfig = {
119328
119378
  * @param {object} renderData
119329
119379
  * @param {Grid.column.Column} renderData.column This column
119330
119380
  * @param {HTMLElement} renderData.headerElement The header element
119381
+ * @returns {string,object,void,void} The text or markup to show in the column header
119331
119382
  */
119332
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
119383
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
119333
119384
  /**
119334
119385
  * An array of the widgets to append to the column header. These widgets have this Column instance
119335
119386
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -120087,8 +120138,9 @@ type WidgetColumnConfig = {
120087
120138
  * @param {object} renderData
120088
120139
  * @param {Grid.column.Column} renderData.column This column
120089
120140
  * @param {HTMLElement} renderData.headerElement The header element
120141
+ * @returns {string,object,void,void} The text or markup to show in the column header
120090
120142
  */
120091
- headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|null|void
120143
+ headerRenderer?: (renderData: { column: Column, headerElement: HTMLElement }) => string|object|void
120092
120144
  /**
120093
120145
  * An array of the widgets to append to the column header. These widgets have this Column instance
120094
120146
  * as their `owner` which can be used to reference the column, and the owning Grid via `this.owner.grid`.
@@ -121932,16 +121984,11 @@ export class ColumnStore extends Store {
121932
121984
  */
121933
121985
  static registerColumnType(columnClass: Function, simpleRenderer?: boolean): void;
121934
121986
  /**
121935
- * Get column by field. To be sure that you are getting exactly the intended column, use [Store#getById()](https://bryntum.com/products/grid/docs/api/Core/data/Store#function-getById) with the
121936
- * columns id instead.
121987
+ * Get column by field. To be sure that you are getting exactly the intended column, use
121988
+ * [getById](https://bryntum.com/products/grid/docs/api/Core/data/Store#function-getById) with the columns id instead.
121937
121989
  * @param {string} field Field name
121938
121990
  */
121939
121991
  get(field: string): Column;
121940
- /**
121941
- * Get column by id.
121942
- * @param {string,number} id
121943
- */
121944
- getById(id: string|number): Column;
121945
121992
  /**
121946
121993
  * indexOf extended to also accept a columns field, for backward compatibility.
121947
121994
  * @param {Core.data.Model,string} recordOrId
@@ -1,6 +1,6 @@
1
1
  /*!
2
2
  *
3
- * Bryntum Grid 7.2.2 (TRIAL VERSION)
3
+ * Bryntum Grid 7.2.3 (TRIAL VERSION)
4
4
  *
5
5
  * Copyright(c) 2026 Bryntum AB
6
6
  * https://bryntum.com/contact