@bryntum/grid-trial 7.3.3 → 7.3.4

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
@@ -1781,6 +1781,16 @@ type ExportConfig = {
1781
1781
  * Set to true to output as a CSV file, or as an object where you can specify delimiters.
1782
1782
  */
1783
1783
  csv?: boolean|object
1784
+ /**
1785
+ * MIME type used when creating the CSV Blob. Defaults to `text/csv`. Use
1786
+ * `application/octet-stream` in Salesforce LWS environments.
1787
+ */
1788
+ csvMimeType?: string
1789
+ /**
1790
+ * MIME type used when creating the XLSX download Blob. Use
1791
+ * `application/octet-stream` in Salesforce LWS environments.
1792
+ */
1793
+ xlsxMimeType?: string
1784
1794
  }
1785
1795
 
1786
1796
  type XLSColumn = {
@@ -8151,6 +8161,14 @@ type ArrayDataFieldConfig = {
8151
8161
  * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/ArrayDataField#config-complexMapping)
8152
8162
  */
8153
8163
  complexMapping?: boolean
8164
+ /**
8165
+ * A function which transforms a data value into the desired form for storage in the record's data object.
8166
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/ArrayDataField#config-convert)
8167
+ * @param {any} value The value to convert for storage in a record.
8168
+ * @param {object} data The raw record data object
8169
+ * @returns {any} The converted value.
8170
+ */
8171
+ convert?: (value: any, data: object) => any
8154
8172
  /**
8155
8173
  * The property in a record's data object that contains the field's value.
8156
8174
  * Defaults to the field's `name`.
@@ -8208,6 +8226,14 @@ type ArrayDataFieldConfig = {
8208
8226
  * Set to `true` for the field's set accessor to ignore attempts to set this field.
8209
8227
  */
8210
8228
  readOnly?: boolean
8229
+ /**
8230
+ * A function which transforms a data value into the desired form for transmitting to a server.
8231
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/ArrayDataField#config-serialize)
8232
+ * @param {any} value The value to serialize
8233
+ * @param {Core.data.Model} record The record that contains the value being serialized.
8234
+ * @returns {any} The serialized value.
8235
+ */
8236
+ serialize?: (value: any, record: Model) => any
8211
8237
  }
8212
8238
 
8213
8239
  /**
@@ -8276,6 +8302,14 @@ type BooleanDataFieldConfig = {
8276
8302
  * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/BooleanDataField#config-complexMapping)
8277
8303
  */
8278
8304
  complexMapping?: boolean
8305
+ /**
8306
+ * A function which transforms a data value into the desired form for storage in the record's data object.
8307
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/BooleanDataField#config-convert)
8308
+ * @param {any} value The value to convert for storage in a record.
8309
+ * @param {object} data The raw record data object
8310
+ * @returns {any} The converted value.
8311
+ */
8312
+ convert?: (value: any, data: object) => any
8279
8313
  /**
8280
8314
  * The property in a record's data object that contains the field's value.
8281
8315
  * Defaults to the field's `name`.
@@ -8334,6 +8368,14 @@ type BooleanDataFieldConfig = {
8334
8368
  * Set to `true` for the field's set accessor to ignore attempts to set this field.
8335
8369
  */
8336
8370
  readOnly?: boolean
8371
+ /**
8372
+ * A function which transforms a data value into the desired form for transmitting to a server.
8373
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/BooleanDataField#config-serialize)
8374
+ * @param {any} value The value to serialize
8375
+ * @param {Core.data.Model} record The record that contains the value being serialized.
8376
+ * @returns {any} The serialized value.
8377
+ */
8378
+ serialize?: (value: any, record: Model) => any
8337
8379
  }
8338
8380
 
8339
8381
  /**
@@ -8406,6 +8448,14 @@ type DataFieldConfig = {
8406
8448
  * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/DataField#config-complexMapping)
8407
8449
  */
8408
8450
  complexMapping?: boolean
8451
+ /**
8452
+ * A function which transforms a data value into the desired form for storage in the record's data object.
8453
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/DataField#config-convert)
8454
+ * @param {any} value The value to convert for storage in a record.
8455
+ * @param {object} data The raw record data object
8456
+ * @returns {any} The converted value.
8457
+ */
8458
+ convert?: (value: any, data: object) => any
8409
8459
  /**
8410
8460
  * The property in a record's data object that contains the field's value.
8411
8461
  * Defaults to the field's `name`.
@@ -8463,6 +8513,14 @@ type DataFieldConfig = {
8463
8513
  * Set to `true` for the field's set accessor to ignore attempts to set this field.
8464
8514
  */
8465
8515
  readOnly?: boolean
8516
+ /**
8517
+ * A function which transforms a data value into the desired form for transmitting to a server.
8518
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/DataField#config-serialize)
8519
+ * @param {any} value The value to serialize
8520
+ * @param {Core.data.Model} record The record that contains the value being serialized.
8521
+ * @returns {any} The serialized value.
8522
+ */
8523
+ serialize?: (value: any, record: Model) => any
8466
8524
  }
8467
8525
 
8468
8526
  /**
@@ -8567,6 +8625,14 @@ type DateDataFieldConfig = {
8567
8625
  * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/DateDataField#config-complexMapping)
8568
8626
  */
8569
8627
  complexMapping?: boolean
8628
+ /**
8629
+ * A function which transforms a data value into the desired form for storage in the record's data object.
8630
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/DateDataField#config-convert)
8631
+ * @param {any} value The value to convert for storage in a record.
8632
+ * @param {object} data The raw record data object
8633
+ * @returns {any} The converted value.
8634
+ */
8635
+ convert?: (value: any, data: object) => any
8570
8636
  /**
8571
8637
  * The property in a record's data object that contains the field's value.
8572
8638
  * Defaults to the field's `name`.
@@ -8629,6 +8695,14 @@ type DateDataFieldConfig = {
8629
8695
  * Set to `true` for the field's set accessor to ignore attempts to set this field.
8630
8696
  */
8631
8697
  readOnly?: boolean
8698
+ /**
8699
+ * A function which transforms a data value into the desired form for transmitting to a server.
8700
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/DateDataField#config-serialize)
8701
+ * @param {any} value The value to serialize
8702
+ * @param {Core.data.Model} record The record that contains the value being serialized.
8703
+ * @returns {any} The serialized value.
8704
+ */
8705
+ serialize?: (value: any, record: Model) => any
8632
8706
  }
8633
8707
 
8634
8708
  /**
@@ -8702,6 +8776,14 @@ type DurationUnitDataFieldConfig = {
8702
8776
  * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/DurationUnitDataField#config-complexMapping)
8703
8777
  */
8704
8778
  complexMapping?: boolean
8779
+ /**
8780
+ * A function which transforms a data value into the desired form for storage in the record's data object.
8781
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/DurationUnitDataField#config-convert)
8782
+ * @param {any} value The value to convert for storage in a record.
8783
+ * @param {object} data The raw record data object
8784
+ * @returns {any} The converted value.
8785
+ */
8786
+ convert?: (value: any, data: object) => any
8705
8787
  /**
8706
8788
  * The property in a record's data object that contains the field's value.
8707
8789
  * Defaults to the field's `name`.
@@ -8759,6 +8841,14 @@ type DurationUnitDataFieldConfig = {
8759
8841
  * Set to `true` for the field's set accessor to ignore attempts to set this field.
8760
8842
  */
8761
8843
  readOnly?: boolean
8844
+ /**
8845
+ * A function which transforms a data value into the desired form for transmitting to a server.
8846
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/DurationUnitDataField#config-serialize)
8847
+ * @param {any} value The value to serialize
8848
+ * @param {Core.data.Model} record The record that contains the value being serialized.
8849
+ * @returns {any} The serialized value.
8850
+ */
8851
+ serialize?: (value: any, record: Model) => any
8762
8852
  }
8763
8853
 
8764
8854
  /**
@@ -8827,6 +8917,14 @@ type IntegerDataFieldConfig = {
8827
8917
  * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/IntegerDataField#config-complexMapping)
8828
8918
  */
8829
8919
  complexMapping?: boolean
8920
+ /**
8921
+ * A function which transforms a data value into the desired form for storage in the record's data object.
8922
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/IntegerDataField#config-convert)
8923
+ * @param {any} value The value to convert for storage in a record.
8924
+ * @param {object} data The raw record data object
8925
+ * @returns {any} The converted value.
8926
+ */
8927
+ convert?: (value: any, data: object) => any
8830
8928
  /**
8831
8929
  * The property in a record's data object that contains the field's value.
8832
8930
  * Defaults to the field's `name`.
@@ -8888,6 +8986,14 @@ type IntegerDataFieldConfig = {
8888
8986
  * The `Math` method to use to ensure fractional component is removed.
8889
8987
  */
8890
8988
  rounding?: 'round'|'floor'|'ceil'
8989
+ /**
8990
+ * A function which transforms a data value into the desired form for transmitting to a server.
8991
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/IntegerDataField#config-serialize)
8992
+ * @param {any} value The value to serialize
8993
+ * @param {Core.data.Model} record The record that contains the value being serialized.
8994
+ * @returns {any} The serialized value.
8995
+ */
8996
+ serialize?: (value: any, record: Model) => any
8891
8997
  }
8892
8998
 
8893
8999
  /**
@@ -8961,6 +9067,14 @@ type NumberDataFieldConfig = {
8961
9067
  * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/NumberDataField#config-complexMapping)
8962
9068
  */
8963
9069
  complexMapping?: boolean
9070
+ /**
9071
+ * A function which transforms a data value into the desired form for storage in the record's data object.
9072
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/NumberDataField#config-convert)
9073
+ * @param {any} value The value to convert for storage in a record.
9074
+ * @param {object} data The raw record data object
9075
+ * @returns {any} The converted value.
9076
+ */
9077
+ convert?: (value: any, data: object) => any
8964
9078
  /**
8965
9079
  * The property in a record's data object that contains the field's value.
8966
9080
  * Defaults to the field's `name`.
@@ -9023,6 +9137,14 @@ type NumberDataFieldConfig = {
9023
9137
  * Set to `true` for the field's set accessor to ignore attempts to set this field.
9024
9138
  */
9025
9139
  readOnly?: boolean
9140
+ /**
9141
+ * A function which transforms a data value into the desired form for transmitting to a server.
9142
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/NumberDataField#config-serialize)
9143
+ * @param {any} value The value to serialize
9144
+ * @param {Core.data.Model} record The record that contains the value being serialized.
9145
+ * @returns {any} The serialized value.
9146
+ */
9147
+ serialize?: (value: any, record: Model) => any
9026
9148
  }
9027
9149
 
9028
9150
  /**
@@ -9096,6 +9218,14 @@ type ObjectDataFieldConfig = {
9096
9218
  * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/ObjectDataField#config-complexMapping)
9097
9219
  */
9098
9220
  complexMapping?: boolean
9221
+ /**
9222
+ * A function which transforms a data value into the desired form for storage in the record's data object.
9223
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/ObjectDataField#config-convert)
9224
+ * @param {any} value The value to convert for storage in a record.
9225
+ * @param {object} data The raw record data object
9226
+ * @returns {any} The converted value.
9227
+ */
9228
+ convert?: (value: any, data: object) => any
9099
9229
  /**
9100
9230
  * The property in a record's data object that contains the field's value.
9101
9231
  * Defaults to the field's `name`.
@@ -9153,6 +9283,14 @@ type ObjectDataFieldConfig = {
9153
9283
  * Set to `true` for the field's set accessor to ignore attempts to set this field.
9154
9284
  */
9155
9285
  readOnly?: boolean
9286
+ /**
9287
+ * A function which transforms a data value into the desired form for transmitting to a server.
9288
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/ObjectDataField#config-serialize)
9289
+ * @param {any} value The value to serialize
9290
+ * @param {Core.data.Model} record The record that contains the value being serialized.
9291
+ * @returns {any} The serialized value.
9292
+ */
9293
+ serialize?: (value: any, record: Model) => any
9156
9294
  }
9157
9295
 
9158
9296
  /**
@@ -9221,6 +9359,14 @@ type StoreDataFieldConfig = {
9221
9359
  * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/StoreDataField#config-complexMapping)
9222
9360
  */
9223
9361
  complexMapping?: boolean
9362
+ /**
9363
+ * A function which transforms a data value into the desired form for storage in the record's data object.
9364
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/StoreDataField#config-convert)
9365
+ * @param {any} value The value to convert for storage in a record.
9366
+ * @param {object} data The raw record data object
9367
+ * @returns {any} The converted value.
9368
+ */
9369
+ convert?: (value: any, data: object) => any
9224
9370
  /**
9225
9371
  * The property in a record's data object that contains the field's value.
9226
9372
  * Defaults to the field's `name`.
@@ -9284,6 +9430,14 @@ type StoreDataFieldConfig = {
9284
9430
  * Set to `true` for the field's set accessor to ignore attempts to set this field.
9285
9431
  */
9286
9432
  readOnly?: boolean
9433
+ /**
9434
+ * A function which transforms a data value into the desired form for transmitting to a server.
9435
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/StoreDataField#config-serialize)
9436
+ * @param {any} value The value to serialize
9437
+ * @param {Core.data.Model} record The record that contains the value being serialized.
9438
+ * @returns {any} The serialized value.
9439
+ */
9440
+ serialize?: (value: any, record: Model) => any
9287
9441
  /**
9288
9442
  * Optional store configuration object to apply when creating the store.
9289
9443
  * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/StoreDataField#config-store)
@@ -9367,6 +9521,14 @@ type StringDataFieldConfig = {
9367
9521
  * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/StringDataField#config-complexMapping)
9368
9522
  */
9369
9523
  complexMapping?: boolean
9524
+ /**
9525
+ * A function which transforms a data value into the desired form for storage in the record's data object.
9526
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/StringDataField#config-convert)
9527
+ * @param {any} value The value to convert for storage in a record.
9528
+ * @param {object} data The raw record data object
9529
+ * @returns {any} The converted value.
9530
+ */
9531
+ convert?: (value: any, data: object) => any
9370
9532
  /**
9371
9533
  * The property in a record's data object that contains the field's value.
9372
9534
  * Defaults to the field's `name`.
@@ -9424,6 +9586,14 @@ type StringDataFieldConfig = {
9424
9586
  * Set to `true` for the field's set accessor to ignore attempts to set this field.
9425
9587
  */
9426
9588
  readOnly?: boolean
9589
+ /**
9590
+ * A function which transforms a data value into the desired form for transmitting to a server.
9591
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/StringDataField#config-serialize)
9592
+ * @param {any} value The value to serialize
9593
+ * @param {Core.data.Model} record The record that contains the value being serialized.
9594
+ * @returns {any} The serialized value.
9595
+ */
9596
+ serialize?: (value: any, record: Model) => any
9427
9597
  }
9428
9598
 
9429
9599
  /**
@@ -14526,8 +14696,9 @@ export class DomHelper {
14526
14696
  * Resolves element from point, checking shadow DOM if required
14527
14697
  * @param {number} x
14528
14698
  * @param {number} y
14699
+ * @param {Document,ShadowRoot} [root] Root node to resolve from. Defaults to the document. Pass a widget's `documentRoot` to keep hit testing inside its shadow tree (required for LWC / Salesforce).
14529
14700
  */
14530
- static elementFromPoint(x: number, y: number): HTMLElement;
14701
+ static elementFromPoint(x: number, y: number, root?: Document|ShadowRoot): HTMLElement;
14531
14702
  /**
14532
14703
  * Iterates over the direct child elements of the specified element.
14533
14704
  * @param {HTMLElement} element Parent element
@@ -16061,6 +16232,11 @@ export class DataGenerator {
16061
16232
  * Array with available food values
16062
16233
  */
16063
16234
  static readonly foods: string[]
16235
+ /**
16236
+ * Array with hex color values, parallel to [colors](https://bryntum.com/products/grid/docs/api/Core/helper/util/DataGenerator#property-colors-static) (same length and
16237
+ * order). Use the index of a name in `colors` to look up its hex value here.
16238
+ */
16239
+ static readonly hexColors: string[]
16064
16240
  /**
16065
16241
  * Array with available skill values
16066
16242
  */
@@ -16131,6 +16307,10 @@ export class DataGenerator {
16131
16307
  * [More...](https://bryntum.com/products/grid/docs/api/Core/helper/util/DomClassList)
16132
16308
  */
16133
16309
  export class DomClassList {
16310
+ /**
16311
+ * The number of CSS class names in this `DomClassList`.
16312
+ */
16313
+ readonly length: number
16134
16314
  /**
16135
16315
  * Get/set string value.
16136
16316
  * Class names separated with space.
@@ -16145,6 +16325,12 @@ export class DomClassList {
16145
16325
  * @param {string,object} classes The CSS classes as strings or objects.
16146
16326
  */
16147
16327
  constructor(classes: string|object);
16328
+ /**
16329
+ * Converts a class name of any understood type to a desired form.
16330
+ * @param {string,string[],object,Set<any>,Map<any, any>,HTMLElement} cls
16331
+ * @param {string} as Pass `'object'` to return an object with the class names as its keys (all keys will have a value of `true`), or pass `'array'` to return an array of class names, or pass `'string'` (the default) to return a space-separated string of class names.
16332
+ */
16333
+ static normalize(cls: string|string[]|object|Set<any>|Map<any, any>|HTMLElement, as?: string): string|string[]|object;
16148
16334
  /**
16149
16335
  * Add CSS class(es)
16150
16336
  * [More...](https://bryntum.com/products/grid/docs/api/Core/helper/util/DomClassList#function-add)
@@ -20267,6 +20453,7 @@ type BooleanComboConfig = {
20267
20453
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
20268
20454
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
20269
20455
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
20456
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-clearable)
20270
20457
  */
20271
20458
  clearable?: boolean|FieldTriggerConfig
20272
20459
  /**
@@ -31525,6 +31712,7 @@ type ColorFieldConfig = {
31525
31712
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
31526
31713
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
31527
31714
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
31715
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-clearable)
31528
31716
  */
31529
31717
  clearable?: boolean|FieldTriggerConfig
31530
31718
  /**
@@ -33791,6 +33979,7 @@ type ComboConfig = {
33791
33979
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
33792
33980
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
33793
33981
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
33982
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-clearable)
33794
33983
  */
33795
33984
  clearable?: boolean|FieldTriggerConfig
33796
33985
  /**
@@ -37387,6 +37576,7 @@ type DateFieldConfig = {
37387
37576
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
37388
37577
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
37389
37578
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
37579
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateField#config-clearable)
37390
37580
  */
37391
37581
  clearable?: boolean|FieldTriggerConfig
37392
37582
  /**
@@ -40170,6 +40360,7 @@ type DateRangeFieldConfig = {
40170
40360
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
40171
40361
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
40172
40362
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
40363
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateRangeField#config-clearable)
40173
40364
  */
40174
40365
  clearable?: boolean|FieldTriggerConfig
40175
40366
  /**
@@ -42775,6 +42966,7 @@ type DateTimeFieldConfig = {
42775
42966
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
42776
42967
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
42777
42968
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
42969
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateTimeField#config-clearable)
42778
42970
  */
42779
42971
  clearable?: boolean|FieldTriggerConfig
42780
42972
  /**
@@ -46055,6 +46247,7 @@ type DisplayFieldConfig = {
46055
46247
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
46056
46248
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
46057
46249
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
46250
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-clearable)
46058
46251
  */
46059
46252
  clearable?: boolean|FieldTriggerConfig
46060
46253
  /**
@@ -47185,6 +47378,7 @@ type DurationFieldConfig = {
47185
47378
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
47186
47379
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
47187
47380
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
47381
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DurationField#config-clearable)
47188
47382
  */
47189
47383
  clearable?: boolean|FieldTriggerConfig
47190
47384
  /**
@@ -49746,6 +49940,7 @@ type FieldConfig = {
49746
49940
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
49747
49941
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
49748
49942
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
49943
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
49749
49944
  */
49750
49945
  clearable?: boolean|FieldTriggerConfig
49751
49946
  /**
@@ -55395,6 +55590,7 @@ type FileFieldConfig = {
55395
55590
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
55396
55591
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
55397
55592
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
55593
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-clearable)
55398
55594
  */
55399
55595
  clearable?: boolean|FieldTriggerConfig
55400
55596
  /**
@@ -57549,6 +57745,7 @@ type FilterFieldConfig = {
57549
57745
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
57550
57746
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
57551
57747
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
57748
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-clearable)
57552
57749
  */
57553
57750
  clearable?: boolean|FieldTriggerConfig
57554
57751
  /**
@@ -68161,6 +68358,7 @@ type NumberFieldConfig = {
68161
68358
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
68162
68359
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
68163
68360
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
68361
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-clearable)
68164
68362
  */
68165
68363
  clearable?: boolean|FieldTriggerConfig
68166
68364
  /**
@@ -71682,6 +71880,7 @@ type PasswordFieldConfig = {
71682
71880
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
71683
71881
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
71684
71882
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
71883
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PasswordField#config-clearable)
71685
71884
  */
71686
71885
  clearable?: boolean|FieldTriggerConfig
71687
71886
  /**
@@ -72800,6 +72999,7 @@ type PickerFieldConfig = {
72800
72999
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
72801
73000
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
72802
73001
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
73002
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PickerField#config-clearable)
72803
73003
  */
72804
73004
  clearable?: boolean|FieldTriggerConfig
72805
73005
  /**
@@ -78495,6 +78695,7 @@ type RichTextFieldConfig = {
78495
78695
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
78496
78696
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
78497
78697
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
78698
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/RichTextField#config-clearable)
78498
78699
  */
78499
78700
  clearable?: boolean|FieldTriggerConfig
78500
78701
  /**
@@ -86097,6 +86298,7 @@ type TextAreaFieldConfig = {
86097
86298
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
86098
86299
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
86099
86300
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
86301
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-clearable)
86100
86302
  */
86101
86303
  clearable?: boolean|FieldTriggerConfig
86102
86304
  /**
@@ -87234,6 +87436,7 @@ type TextAreaPickerFieldConfig = {
87234
87436
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
87235
87437
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
87236
87438
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
87439
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaPickerField#config-clearable)
87237
87440
  */
87238
87441
  clearable?: boolean|FieldTriggerConfig
87239
87442
  /**
@@ -88374,6 +88577,7 @@ type TextFieldConfig = {
88374
88577
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
88375
88578
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
88376
88579
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
88580
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-clearable)
88377
88581
  */
88378
88582
  clearable?: boolean|FieldTriggerConfig
88379
88583
  /**
@@ -89526,6 +89730,7 @@ type TimeFieldConfig = {
89526
89730
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
89527
89731
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
89528
89732
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
89733
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-clearable)
89529
89734
  */
89530
89735
  clearable?: boolean|FieldTriggerConfig
89531
89736
  /**
@@ -130510,6 +130715,11 @@ type ExcelExporterConfig = {
130510
130715
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-convertEmptyValueToEmptyString)
130511
130716
  */
130512
130717
  convertEmptyValueToEmptyString?: boolean
130718
+ /**
130719
+ * MIME type used when creating the CSV Blob for download. Some environments (e.g. Salesforce Lightning Web
130720
+ * Security) block `text/csv` for `URL.createObjectURL`. Use `application/octet-stream` there instead.
130721
+ */
130722
+ csvMimeType?: string
130513
130723
  /**
130514
130724
  * Defines how dates in a cell will be formatted
130515
130725
  */
@@ -130565,6 +130775,12 @@ type ExcelExporterConfig = {
130565
130775
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsProvider)
130566
130776
  */
130567
130777
  xlsProvider?: typeof XlsProviderBase
130778
+ /**
130779
+ * MIME type used when creating the XLSX download Blob. Some environments (e.g. Salesforce Lightning Web
130780
+ * Security) block the default XLSX MIME type for `URL.createObjectURL`. Use `application/octet-stream` in such case
130781
+ * instead.
130782
+ */
130783
+ xlsxMimeType?: string
130568
130784
  /**
130569
130785
  * Fires before an object is destroyed.
130570
130786
  * @param {object} event Event object
@@ -130647,10 +130863,12 @@ export class ExcelExporter extends InstancePlugin {
130647
130863
  * @param {boolean,object} [config.csv] Set to `true` to output as a CSV file, or as an object where you can specify delimiters.
130648
130864
  * @param {string} [config.csv.columnDelimiter] The CSV delimiter to separate values on one line, defaults to `,`.
130649
130865
  * @param {string} [config.csv.lineDelimiter] The CSV delimiter to separate lines, defaults to `\n`.
130866
+ * @param {string} [config.csvMimeType] MIME type used when creating the CSV Blob. Overrides [csvMimeType](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-csvMimeType).
130867
+ * @param {string} [config.xlsxMimeType] MIME type used when creating the XLSX download Blob. Overrides [xlsxMimeType](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsxMimeType).
130650
130868
  * @param {string[],object[]} [config.columns] An array of column configuration objects
130651
130869
  * @param {Core.data.Model[]} [config.rows] An array of records to export
130652
130870
  */
130653
- export(config: { filename?: string, dateFormat?: string, csv?: boolean|{ columnDelimiter?: string, lineDelimiter?: string }, columns?: string[]|object[], rows?: Model[] }): Promise<any>;
130871
+ export(config: { filename?: string, dateFormat?: string, csv?: boolean|{ columnDelimiter?: string, lineDelimiter?: string }, csvMimeType?: string, xlsxMimeType?: string, columns?: string[]|object[], rows?: Model[] }): Promise<any>;
130654
130872
  }
130655
130873
 
130656
130874
  /**
@@ -130874,9 +131092,10 @@ export class WriteExcelFileProvider {
130874
131092
  * @param {object} config.sheet *deprecated, to be removed in 7.0* Object with columns and data
130875
131093
  * @param {any[][]} config.sheet.data Array of rows, each row is an array of cells
130876
131094
  * @param {XLSColumn[]} config.sheet.cols Array of columns
130877
- * @param {string} config.MIME File MIME type
131095
+ * @param {string} config.mimeType MIME type used when creating the download Blob, passed from [xlsxMimeType](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsxMimeType).
131096
+ * @param {string} [config.MIME] *deprecated, use `mimeType` instead*
130878
131097
  */
130879
- static write(config: { filename: string, rows: any[], columns: XLSColumn[], sheet: { data: any[], cols: XLSColumn[] }, MIME: string }): void;
131098
+ static write(config: { filename: string, rows: any[], columns: XLSColumn[], sheet: { data: any[], cols: XLSColumn[] }, mimeType: string, MIME?: string }): Promise<any>;
130880
131099
  }
130881
131100
 
130882
131101
  /**
@@ -130885,17 +131104,18 @@ export class WriteExcelFileProvider {
130885
131104
  */
130886
131105
  export class XlsProviderBase {
130887
131106
  /**
130888
- * Implement this method to write data to an xls file
131107
+ * Implement this method to write data to an xls file. May return a Promise if the
131108
+ * implementation needs to perform asynchronous work (e.g. awaiting a 3rd-party library).
131109
+ * [ExcelExporter](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter) awaits the return value, so both sync
131110
+ * and async implementations are supported.
130889
131111
  * @param {object} config
130890
131112
  * @param {string} config.filename Name of the exported file
130891
131113
  * @param {any[][]} config.rows Array of rows, each row is an array of cells
130892
131114
  * @param {XLSColumn[]} config.columns Array of columns
130893
- * @param {object} config.sheet *deprecated, to be removed in 7.0* Object with columns and data
130894
- * @param {any[][]} config.sheet.data Array of rows, each row is an array of cells
130895
- * @param {XLSColumn[]} config.sheet.cols Array of columns
130896
- * @param {string} config.MIME File MIME type
131115
+ * @param {string} config.mimeType MIME type to use when creating the download Blob. Configured via [xlsxMimeType](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsxMimeType).
131116
+ * @param {string} [config.MIME] *deprecated, use `mimeType` instead*
130897
131117
  */
130898
- static write(config: { filename: string, rows: any[], columns: XLSColumn[], sheet: { data: any[], cols: XLSColumn[] }, MIME: string }): void;
131118
+ static write(config: { filename: string, rows: any[], columns: XLSColumn[], mimeType: string, MIME?: string }): Promise<void|any>;
130899
131119
  }
130900
131120
 
130901
131121
  /**
@@ -150391,6 +150611,7 @@ type AIFilterFieldConfig = {
150391
150611
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
150392
150612
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
150393
150613
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
150614
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-clearable)
150394
150615
  */
150395
150616
  clearable?: boolean|FieldTriggerConfig
150396
150617
  /**
@@ -151575,6 +151796,7 @@ type ChecklistFilterComboConfig = {
151575
151796
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
151576
151797
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
151577
151798
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
151799
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-clearable)
151578
151800
  */
151579
151801
  clearable?: boolean|FieldTriggerConfig
151580
151802
  /**
@@ -156929,6 +157151,7 @@ type TreeComboConfig = {
156929
157151
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
156930
157152
  * in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
156931
157153
  * configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
157154
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-clearable)
156932
157155
  */
156933
157156
  clearable?: boolean|FieldTriggerConfig
156934
157157
  /**