@bryntum/grid-thin-trial 7.3.2 → 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/AGENTS.md +130 -0
- package/CLAUDE.md +130 -0
- package/grid.d.ts +117 -79
- package/lib/column/Column.js +1 -1
- package/lib/feature/ColumnAutoWidth.js +1 -1
- package/lib/feature/Filter.js +1 -1
- package/lib/feature/FilterBar.js +1 -1
- package/lib/feature/StickyCells.js +1 -1
- package/lib/feature/experimental/ExcelExporter.js +1 -1
- package/lib/feature/experimental/xlsproviders/WriteExcelFileProvider.js +1 -1
- package/lib/feature/experimental/xlsproviders/XlsProviderBase.js +1 -1
- package/lib/feature/export/PdfExport.js +4 -4
- package/lib/feature/export/exporter/ExporterBase.js +6 -6
- package/lib/localization/Ar.js +256 -225
- package/lib/localization/Bg.js +256 -225
- package/lib/localization/Ca.js +256 -225
- package/lib/localization/Cs.js +256 -225
- package/lib/localization/Da.js +256 -225
- package/lib/localization/De.js +256 -225
- package/lib/localization/El.js +256 -225
- package/lib/localization/En.js +256 -225
- package/lib/localization/EnGb.js +256 -225
- package/lib/localization/Es.js +256 -225
- package/lib/localization/Et.js +256 -225
- package/lib/localization/Eu.js +256 -225
- package/lib/localization/Fi.js +256 -225
- package/lib/localization/FrFr.js +256 -225
- package/lib/localization/Gl.js +256 -225
- package/lib/localization/He.js +256 -225
- package/lib/localization/Hi.js +256 -225
- package/lib/localization/Hr.js +256 -225
- package/lib/localization/Hu.js +256 -225
- package/lib/localization/Id.js +256 -225
- package/lib/localization/It.js +256 -225
- package/lib/localization/Ja.js +256 -225
- package/lib/localization/Kk.js +256 -225
- package/lib/localization/Ko.js +256 -225
- package/lib/localization/Lt.js +256 -225
- package/lib/localization/Lv.js +256 -225
- package/lib/localization/Ms.js +256 -225
- package/lib/localization/Nl.js +256 -225
- package/lib/localization/No.js +256 -225
- package/lib/localization/Pl.js +256 -225
- package/lib/localization/Pt.js +256 -225
- package/lib/localization/PtBr.js +256 -225
- package/lib/localization/Ro.js +256 -225
- package/lib/localization/Ru.js +256 -225
- package/lib/localization/Sk.js +256 -225
- package/lib/localization/Sl.js +256 -225
- package/lib/localization/Sr.js +256 -225
- package/lib/localization/SrRs.js +256 -225
- package/lib/localization/SvSE.js +256 -225
- package/lib/localization/Th.js +256 -225
- package/lib/localization/Tr.js +256 -225
- package/lib/localization/Uk.js +256 -225
- package/lib/localization/Vi.js +256 -225
- package/lib/localization/ZhCn.js +256 -225
- package/lib/localization/ZhTw.js +256 -225
- package/lib/view/Grid.js +1 -1
- package/lib/view/GridBase.js +1 -1
- package/lib/view/export/ExportDialog.js +1 -1
- package/lib/view/mixin/GridElementEvents.js +1 -1
- package/lib/widget/ChecklistFilterCombo.js +1 -1
- package/package.json +1 -1
package/grid.d.ts
CHANGED
|
@@ -243,6 +243,16 @@ type ExportConfig = {
|
|
|
243
243
|
* Set to true to output as a CSV file, or as an object where you can specify delimiters.
|
|
244
244
|
*/
|
|
245
245
|
csv?: boolean|object
|
|
246
|
+
/**
|
|
247
|
+
* MIME type used when creating the CSV Blob. Defaults to `text/csv`. Use
|
|
248
|
+
* `application/octet-stream` in Salesforce LWS environments.
|
|
249
|
+
*/
|
|
250
|
+
csvMimeType?: string
|
|
251
|
+
/**
|
|
252
|
+
* MIME type used when creating the XLSX download Blob. Use
|
|
253
|
+
* `application/octet-stream` in Salesforce LWS environments.
|
|
254
|
+
*/
|
|
255
|
+
xlsxMimeType?: string
|
|
246
256
|
}
|
|
247
257
|
|
|
248
258
|
type XLSColumn = {
|
|
@@ -673,7 +683,7 @@ type ActionColumnConfig = {
|
|
|
673
683
|
*/
|
|
674
684
|
alwaysClearCell?: boolean
|
|
675
685
|
/**
|
|
676
|
-
* The `aria-label` to use for this Column
|
|
686
|
+
* The `aria-label` to use for this Column's header element
|
|
677
687
|
*/
|
|
678
688
|
ariaLabel?: string
|
|
679
689
|
/**
|
|
@@ -1316,7 +1326,7 @@ type AggregateColumnConfig = {
|
|
|
1316
1326
|
*/
|
|
1317
1327
|
alwaysClearCell?: boolean
|
|
1318
1328
|
/**
|
|
1319
|
-
* The `aria-label` to use for this Column
|
|
1329
|
+
* The `aria-label` to use for this Column's header element
|
|
1320
1330
|
*/
|
|
1321
1331
|
ariaLabel?: string
|
|
1322
1332
|
/**
|
|
@@ -2057,7 +2067,7 @@ type ChartColumnConfig = {
|
|
|
2057
2067
|
*/
|
|
2058
2068
|
alwaysClearCell?: boolean
|
|
2059
2069
|
/**
|
|
2060
|
-
* The `aria-label` to use for this Column
|
|
2070
|
+
* The `aria-label` to use for this Column's header element
|
|
2061
2071
|
*/
|
|
2062
2072
|
ariaLabel?: string
|
|
2063
2073
|
/**
|
|
@@ -2795,7 +2805,7 @@ type CheckColumnConfig = {
|
|
|
2795
2805
|
*/
|
|
2796
2806
|
alwaysClearCell?: boolean
|
|
2797
2807
|
/**
|
|
2798
|
-
* The `aria-label` to use for this Column
|
|
2808
|
+
* The `aria-label` to use for this Column's header element
|
|
2799
2809
|
*/
|
|
2800
2810
|
ariaLabel?: string
|
|
2801
2811
|
/**
|
|
@@ -3557,7 +3567,7 @@ type ColorColumnConfig = {
|
|
|
3557
3567
|
*/
|
|
3558
3568
|
alwaysClearCell?: boolean
|
|
3559
3569
|
/**
|
|
3560
|
-
* The `aria-label` to use for this Column
|
|
3570
|
+
* The `aria-label` to use for this Column's header element
|
|
3561
3571
|
*/
|
|
3562
3572
|
ariaLabel?: string
|
|
3563
3573
|
/**
|
|
@@ -4252,7 +4262,7 @@ type ColumnConfig = {
|
|
|
4252
4262
|
*/
|
|
4253
4263
|
alwaysClearCell?: boolean
|
|
4254
4264
|
/**
|
|
4255
|
-
* The `aria-label` to use for this Column
|
|
4265
|
+
* The `aria-label` to use for this Column's header element
|
|
4256
4266
|
*/
|
|
4257
4267
|
ariaLabel?: string
|
|
4258
4268
|
/**
|
|
@@ -4826,7 +4836,7 @@ export class Column extends Model {
|
|
|
4826
4836
|
*/
|
|
4827
4837
|
alwaysClearCell: boolean
|
|
4828
4838
|
/**
|
|
4829
|
-
* The `aria-label` to use for this Column
|
|
4839
|
+
* The `aria-label` to use for this Column's header element
|
|
4830
4840
|
*/
|
|
4831
4841
|
ariaLabel: string
|
|
4832
4842
|
/**
|
|
@@ -5522,7 +5532,7 @@ type CurrencyColumnConfig = {
|
|
|
5522
5532
|
*/
|
|
5523
5533
|
alwaysClearCell?: boolean
|
|
5524
5534
|
/**
|
|
5525
|
-
* The `aria-label` to use for this Column
|
|
5535
|
+
* The `aria-label` to use for this Column's header element
|
|
5526
5536
|
*/
|
|
5527
5537
|
ariaLabel?: string
|
|
5528
5538
|
/**
|
|
@@ -6240,7 +6250,7 @@ type DateColumnConfig = {
|
|
|
6240
6250
|
*/
|
|
6241
6251
|
alwaysClearCell?: boolean
|
|
6242
6252
|
/**
|
|
6243
|
-
* The `aria-label` to use for this Column
|
|
6253
|
+
* The `aria-label` to use for this Column's header element
|
|
6244
6254
|
*/
|
|
6245
6255
|
ariaLabel?: string
|
|
6246
6256
|
/**
|
|
@@ -6965,7 +6975,7 @@ type NumberColumnConfig = {
|
|
|
6965
6975
|
*/
|
|
6966
6976
|
alwaysClearCell?: boolean
|
|
6967
6977
|
/**
|
|
6968
|
-
* The `aria-label` to use for this Column
|
|
6978
|
+
* The `aria-label` to use for this Column's header element
|
|
6969
6979
|
*/
|
|
6970
6980
|
ariaLabel?: string
|
|
6971
6981
|
/**
|
|
@@ -7705,7 +7715,7 @@ type PercentColumnConfig = {
|
|
|
7705
7715
|
*/
|
|
7706
7716
|
alwaysClearCell?: boolean
|
|
7707
7717
|
/**
|
|
7708
|
-
* The `aria-label` to use for this Column
|
|
7718
|
+
* The `aria-label` to use for this Column's header element
|
|
7709
7719
|
*/
|
|
7710
7720
|
ariaLabel?: string
|
|
7711
7721
|
/**
|
|
@@ -8431,7 +8441,7 @@ type RatingColumnConfig = {
|
|
|
8431
8441
|
*/
|
|
8432
8442
|
alwaysClearCell?: boolean
|
|
8433
8443
|
/**
|
|
8434
|
-
* The `aria-label` to use for this Column
|
|
8444
|
+
* The `aria-label` to use for this Column's header element
|
|
8435
8445
|
*/
|
|
8436
8446
|
ariaLabel?: string
|
|
8437
8447
|
/**
|
|
@@ -9154,7 +9164,7 @@ type RowNumberColumnConfig = {
|
|
|
9154
9164
|
*/
|
|
9155
9165
|
alwaysClearCell?: boolean
|
|
9156
9166
|
/**
|
|
9157
|
-
* The `aria-label` to use for this Column
|
|
9167
|
+
* The `aria-label` to use for this Column's header element
|
|
9158
9168
|
*/
|
|
9159
9169
|
ariaLabel?: string
|
|
9160
9170
|
/**
|
|
@@ -9715,7 +9725,7 @@ type SparklineColumnConfig = {
|
|
|
9715
9725
|
*/
|
|
9716
9726
|
alwaysClearCell?: boolean
|
|
9717
9727
|
/**
|
|
9718
|
-
* The `aria-label` to use for this Column
|
|
9728
|
+
* The `aria-label` to use for this Column's header element
|
|
9719
9729
|
*/
|
|
9720
9730
|
ariaLabel?: string
|
|
9721
9731
|
/**
|
|
@@ -10414,7 +10424,7 @@ type TemplateColumnConfig = {
|
|
|
10414
10424
|
*/
|
|
10415
10425
|
alwaysClearCell?: boolean
|
|
10416
10426
|
/**
|
|
10417
|
-
* The `aria-label` to use for this Column
|
|
10427
|
+
* The `aria-label` to use for this Column's header element
|
|
10418
10428
|
*/
|
|
10419
10429
|
ariaLabel?: string
|
|
10420
10430
|
/**
|
|
@@ -11100,7 +11110,7 @@ type TimeColumnConfig = {
|
|
|
11100
11110
|
*/
|
|
11101
11111
|
alwaysClearCell?: boolean
|
|
11102
11112
|
/**
|
|
11103
|
-
* The `aria-label` to use for this Column
|
|
11113
|
+
* The `aria-label` to use for this Column's header element
|
|
11104
11114
|
*/
|
|
11105
11115
|
ariaLabel?: string
|
|
11106
11116
|
/**
|
|
@@ -11783,7 +11793,7 @@ type TreeColumnConfig = {
|
|
|
11783
11793
|
*/
|
|
11784
11794
|
alwaysClearCell?: boolean
|
|
11785
11795
|
/**
|
|
11786
|
-
* The `aria-label` to use for this Column
|
|
11796
|
+
* The `aria-label` to use for this Column's header element
|
|
11787
11797
|
*/
|
|
11788
11798
|
ariaLabel?: string
|
|
11789
11799
|
/**
|
|
@@ -12519,7 +12529,7 @@ type WidgetColumnConfig = {
|
|
|
12519
12529
|
*/
|
|
12520
12530
|
alwaysClearCell?: boolean
|
|
12521
12531
|
/**
|
|
12522
|
-
* The `aria-label` to use for this Column
|
|
12532
|
+
* The `aria-label` to use for this Column's header element
|
|
12523
12533
|
*/
|
|
12524
12534
|
ariaLabel?: string
|
|
12525
12535
|
/**
|
|
@@ -16100,9 +16110,10 @@ type CellTooltipConfig = {
|
|
|
16100
16110
|
catchEventHandlerExceptions?: boolean
|
|
16101
16111
|
/**
|
|
16102
16112
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
16103
|
-
*
|
|
16113
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-centered)
|
|
16114
|
+
* @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
|
|
16104
16115
|
*/
|
|
16105
|
-
centered?: boolean
|
|
16116
|
+
centered?: boolean|object
|
|
16106
16117
|
/**
|
|
16107
16118
|
* The widget which this plugin is to attach to.
|
|
16108
16119
|
*/
|
|
@@ -16407,7 +16418,7 @@ type CellTooltipConfig = {
|
|
|
16407
16418
|
*/
|
|
16408
16419
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
16409
16420
|
/**
|
|
16410
|
-
* Sets `labelWidth
|
|
16421
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
16411
16422
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-labelWidth)
|
|
16412
16423
|
*/
|
|
16413
16424
|
labelWidth?: number|null
|
|
@@ -16624,7 +16635,7 @@ type CellTooltipConfig = {
|
|
|
16624
16635
|
rtl?: boolean
|
|
16625
16636
|
/**
|
|
16626
16637
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
16627
|
-
* Valid values:
|
|
16638
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
16628
16639
|
*/
|
|
16629
16640
|
scrollAction?: 'hide'|'realign'|null
|
|
16630
16641
|
/**
|
|
@@ -25607,6 +25618,11 @@ type ExcelExporterConfig = {
|
|
|
25607
25618
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-convertEmptyValueToEmptyString)
|
|
25608
25619
|
*/
|
|
25609
25620
|
convertEmptyValueToEmptyString?: boolean
|
|
25621
|
+
/**
|
|
25622
|
+
* MIME type used when creating the CSV Blob for download. Some environments (e.g. Salesforce Lightning Web
|
|
25623
|
+
* Security) block `text/csv` for `URL.createObjectURL`. Use `application/octet-stream` there instead.
|
|
25624
|
+
*/
|
|
25625
|
+
csvMimeType?: string
|
|
25610
25626
|
/**
|
|
25611
25627
|
* Defines how dates in a cell will be formatted
|
|
25612
25628
|
*/
|
|
@@ -25662,6 +25678,12 @@ type ExcelExporterConfig = {
|
|
|
25662
25678
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsProvider)
|
|
25663
25679
|
*/
|
|
25664
25680
|
xlsProvider?: typeof XlsProviderBase
|
|
25681
|
+
/**
|
|
25682
|
+
* MIME type used when creating the XLSX download Blob. Some environments (e.g. Salesforce Lightning Web
|
|
25683
|
+
* Security) block the default XLSX MIME type for `URL.createObjectURL`. Use `application/octet-stream` in such case
|
|
25684
|
+
* instead.
|
|
25685
|
+
*/
|
|
25686
|
+
xlsxMimeType?: string
|
|
25665
25687
|
/**
|
|
25666
25688
|
* Fires before an object is destroyed.
|
|
25667
25689
|
* @param {object} event Event object
|
|
@@ -25744,10 +25766,12 @@ export class ExcelExporter extends InstancePlugin {
|
|
|
25744
25766
|
* @param {boolean,object} [config.csv] Set to `true` to output as a CSV file, or as an object where you can specify delimiters.
|
|
25745
25767
|
* @param {string} [config.csv.columnDelimiter] The CSV delimiter to separate values on one line, defaults to `,`.
|
|
25746
25768
|
* @param {string} [config.csv.lineDelimiter] The CSV delimiter to separate lines, defaults to `\n`.
|
|
25769
|
+
* @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).
|
|
25770
|
+
* @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).
|
|
25747
25771
|
* @param {string[],object[]} [config.columns] An array of column configuration objects
|
|
25748
25772
|
* @param {Core.data.Model[]} [config.rows] An array of records to export
|
|
25749
25773
|
*/
|
|
25750
|
-
export(config: { filename?: string, dateFormat?: string, csv?: boolean|{ columnDelimiter?: string, lineDelimiter?: string }, columns?: string[]|object[], rows?: Model[] }): Promise<any>;
|
|
25774
|
+
export(config: { filename?: string, dateFormat?: string, csv?: boolean|{ columnDelimiter?: string, lineDelimiter?: string }, csvMimeType?: string, xlsxMimeType?: string, columns?: string[]|object[], rows?: Model[] }): Promise<any>;
|
|
25751
25775
|
}
|
|
25752
25776
|
|
|
25753
25777
|
/**
|
|
@@ -25971,9 +25995,10 @@ export class WriteExcelFileProvider {
|
|
|
25971
25995
|
* @param {object} config.sheet *deprecated, to be removed in 7.0* Object with columns and data
|
|
25972
25996
|
* @param {any[][]} config.sheet.data Array of rows, each row is an array of cells
|
|
25973
25997
|
* @param {XLSColumn[]} config.sheet.cols Array of columns
|
|
25974
|
-
* @param {string} config.MIME
|
|
25998
|
+
* @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).
|
|
25999
|
+
* @param {string} [config.MIME] *deprecated, use `mimeType` instead*
|
|
25975
26000
|
*/
|
|
25976
|
-
static write(config: { filename: string, rows: any[], columns: XLSColumn[], sheet: { data: any[], cols: XLSColumn[] },
|
|
26001
|
+
static write(config: { filename: string, rows: any[], columns: XLSColumn[], sheet: { data: any[], cols: XLSColumn[] }, mimeType: string, MIME?: string }): Promise<any>;
|
|
25977
26002
|
}
|
|
25978
26003
|
|
|
25979
26004
|
/**
|
|
@@ -25982,17 +26007,18 @@ export class WriteExcelFileProvider {
|
|
|
25982
26007
|
*/
|
|
25983
26008
|
export class XlsProviderBase {
|
|
25984
26009
|
/**
|
|
25985
|
-
* Implement this method to write data to an xls file
|
|
26010
|
+
* Implement this method to write data to an xls file. May return a Promise if the
|
|
26011
|
+
* implementation needs to perform asynchronous work (e.g. awaiting a 3rd-party library).
|
|
26012
|
+
* [ExcelExporter](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter) awaits the return value, so both sync
|
|
26013
|
+
* and async implementations are supported.
|
|
25986
26014
|
* @param {object} config
|
|
25987
26015
|
* @param {string} config.filename Name of the exported file
|
|
25988
26016
|
* @param {any[][]} config.rows Array of rows, each row is an array of cells
|
|
25989
26017
|
* @param {XLSColumn[]} config.columns Array of columns
|
|
25990
|
-
* @param {
|
|
25991
|
-
* @param {
|
|
25992
|
-
* @param {XLSColumn[]} config.sheet.cols Array of columns
|
|
25993
|
-
* @param {string} config.MIME File MIME type
|
|
26018
|
+
* @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).
|
|
26019
|
+
* @param {string} [config.MIME] *deprecated, use `mimeType` instead*
|
|
25994
26020
|
*/
|
|
25995
|
-
static write(config: { filename: string, rows: any[], columns: XLSColumn[],
|
|
26021
|
+
static write(config: { filename: string, rows: any[], columns: XLSColumn[], mimeType: string, MIME?: string }): Promise<void|any>;
|
|
25996
26022
|
}
|
|
25997
26023
|
|
|
25998
26024
|
/**
|
|
@@ -26169,8 +26195,8 @@ type PdfExportConfig = {
|
|
|
26169
26195
|
*/
|
|
26170
26196
|
fileName?: string
|
|
26171
26197
|
/**
|
|
26172
|
-
* A template function used to generate a page footer. It is passed an object with
|
|
26173
|
-
* `totalPages
|
|
26198
|
+
* A template function used to generate a page footer. It is passed an object with `currentPage` and
|
|
26199
|
+
* `totalPages` properties.
|
|
26174
26200
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/PdfExport#config-footerTpl)
|
|
26175
26201
|
* @param {object} data Data object
|
|
26176
26202
|
* @param {number} data.currentPage Current page number
|
|
@@ -26179,8 +26205,8 @@ type PdfExportConfig = {
|
|
|
26179
26205
|
*/
|
|
26180
26206
|
footerTpl?: (data: { currentPage: number, totalPages: number }) => string
|
|
26181
26207
|
/**
|
|
26182
|
-
* A template function used to generate a page header. It is passed an object with
|
|
26183
|
-
* `totalPages
|
|
26208
|
+
* A template function used to generate a page header. It is passed an object with `currentPage` and
|
|
26209
|
+
* `totalPages` properties.
|
|
26184
26210
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/PdfExport#config-headerTpl)
|
|
26185
26211
|
* @param {object} data Data object
|
|
26186
26212
|
* @param {number} data.currentPage Current page number
|
|
@@ -26610,8 +26636,8 @@ type PrintConfig = {
|
|
|
26610
26636
|
*/
|
|
26611
26637
|
exporters?: Exporter[]
|
|
26612
26638
|
/**
|
|
26613
|
-
* A template function used to generate a page footer. It is passed an object with
|
|
26614
|
-
* `totalPages
|
|
26639
|
+
* A template function used to generate a page footer. It is passed an object with `currentPage` and
|
|
26640
|
+
* `totalPages` properties.
|
|
26615
26641
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/Print#config-footerTpl)
|
|
26616
26642
|
* @param {object} data Data object
|
|
26617
26643
|
* @param {number} data.currentPage Current page number
|
|
@@ -26620,8 +26646,8 @@ type PrintConfig = {
|
|
|
26620
26646
|
*/
|
|
26621
26647
|
footerTpl?: (data: { currentPage: number, totalPages: number }) => string
|
|
26622
26648
|
/**
|
|
26623
|
-
* A template function used to generate a page header. It is passed an object with
|
|
26624
|
-
* `totalPages
|
|
26649
|
+
* A template function used to generate a page header. It is passed an object with `currentPage` and
|
|
26650
|
+
* `totalPages` properties.
|
|
26625
26651
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/Print#config-headerTpl)
|
|
26626
26652
|
* @param {object} data Data object
|
|
26627
26653
|
* @param {number} data.currentPage Current page number
|
|
@@ -30896,7 +30922,7 @@ type GridConfig = {
|
|
|
30896
30922
|
*/
|
|
30897
30923
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
30898
30924
|
/**
|
|
30899
|
-
* Sets `labelWidth
|
|
30925
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
30900
30926
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-labelWidth)
|
|
30901
30927
|
*/
|
|
30902
30928
|
labelWidth?: number|null
|
|
@@ -34957,7 +34983,7 @@ type GridBaseConfig = {
|
|
|
34957
34983
|
*/
|
|
34958
34984
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
34959
34985
|
/**
|
|
34960
|
-
* Sets `labelWidth
|
|
34986
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
34961
34987
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-labelWidth)
|
|
34962
34988
|
*/
|
|
34963
34989
|
labelWidth?: number|null
|
|
@@ -38400,9 +38426,10 @@ type SubGridConfig = {
|
|
|
38400
38426
|
catchEventHandlerExceptions?: boolean
|
|
38401
38427
|
/**
|
|
38402
38428
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
38403
|
-
*
|
|
38429
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/SubGrid#config-centered)
|
|
38430
|
+
* @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
|
|
38404
38431
|
*/
|
|
38405
|
-
centered?: boolean
|
|
38432
|
+
centered?: boolean|object
|
|
38406
38433
|
/**
|
|
38407
38434
|
* Custom CSS classes to add to element.
|
|
38408
38435
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -41435,7 +41462,7 @@ type TreeGridConfig = {
|
|
|
41435
41462
|
*/
|
|
41436
41463
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
41437
41464
|
/**
|
|
41438
|
-
* Sets `labelWidth
|
|
41465
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
41439
41466
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-labelWidth)
|
|
41440
41467
|
*/
|
|
41441
41468
|
labelWidth?: number|null
|
|
@@ -43485,9 +43512,10 @@ type ExportDialogConfig = {
|
|
|
43485
43512
|
catchEventHandlerExceptions?: boolean
|
|
43486
43513
|
/**
|
|
43487
43514
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
43488
|
-
*
|
|
43515
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-centered)
|
|
43516
|
+
* @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
|
|
43489
43517
|
*/
|
|
43490
|
-
centered?: boolean
|
|
43518
|
+
centered?: boolean|object
|
|
43491
43519
|
/**
|
|
43492
43520
|
* Grid instance to build export dialog for
|
|
43493
43521
|
*/
|
|
@@ -43752,7 +43780,7 @@ type ExportDialogConfig = {
|
|
|
43752
43780
|
*/
|
|
43753
43781
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
43754
43782
|
/**
|
|
43755
|
-
* Sets `labelWidth
|
|
43783
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
43756
43784
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-labelWidth)
|
|
43757
43785
|
*/
|
|
43758
43786
|
labelWidth?: number|null
|
|
@@ -43957,7 +43985,7 @@ type ExportDialogConfig = {
|
|
|
43957
43985
|
rtl?: boolean
|
|
43958
43986
|
/**
|
|
43959
43987
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
43960
|
-
* Valid values:
|
|
43988
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
43961
43989
|
*/
|
|
43962
43990
|
scrollAction?: 'hide'|'realign'|null
|
|
43963
43991
|
/**
|
|
@@ -44307,7 +44335,7 @@ export class ExportDialog extends Popup {
|
|
|
44307
44335
|
/**
|
|
44308
44336
|
* Returns map of values of dialog fields.
|
|
44309
44337
|
*/
|
|
44310
|
-
|
|
44338
|
+
values: Record<string, object>
|
|
44311
44339
|
/**
|
|
44312
44340
|
* Fires before an object is destroyed.
|
|
44313
44341
|
* @param {object} event Event object
|
|
@@ -45469,9 +45497,10 @@ type AIFilterFieldConfig = {
|
|
|
45469
45497
|
catchEventHandlerExceptions?: boolean
|
|
45470
45498
|
/**
|
|
45471
45499
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
45472
|
-
*
|
|
45500
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-centered)
|
|
45501
|
+
* @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
|
|
45473
45502
|
*/
|
|
45474
|
-
centered?: boolean
|
|
45503
|
+
centered?: boolean|object
|
|
45475
45504
|
/**
|
|
45476
45505
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
45477
45506
|
* to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
|
|
@@ -45485,6 +45514,7 @@ type AIFilterFieldConfig = {
|
|
|
45485
45514
|
* 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
|
|
45486
45515
|
* 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
|
|
45487
45516
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
45517
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-clearable)
|
|
45488
45518
|
*/
|
|
45489
45519
|
clearable?: boolean|FieldTriggerConfig
|
|
45490
45520
|
/**
|
|
@@ -45572,7 +45602,7 @@ type AIFilterFieldConfig = {
|
|
|
45572
45602
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
45573
45603
|
/**
|
|
45574
45604
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
45575
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
45605
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
45576
45606
|
* property which controls when a drag should start.
|
|
45577
45607
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-draggable)
|
|
45578
45608
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -45908,7 +45938,7 @@ type AIFilterFieldConfig = {
|
|
|
45908
45938
|
rtl?: boolean
|
|
45909
45939
|
/**
|
|
45910
45940
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
45911
|
-
* Valid values:
|
|
45941
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
45912
45942
|
*/
|
|
45913
45943
|
scrollAction?: 'hide'|'realign'|null
|
|
45914
45944
|
/**
|
|
@@ -46634,9 +46664,10 @@ type ChecklistFilterComboConfig = {
|
|
|
46634
46664
|
catchEventHandlerExceptions?: boolean
|
|
46635
46665
|
/**
|
|
46636
46666
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
46637
|
-
*
|
|
46667
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-centered)
|
|
46668
|
+
* @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
|
|
46638
46669
|
*/
|
|
46639
|
-
centered?: boolean
|
|
46670
|
+
centered?: boolean|object
|
|
46640
46671
|
/**
|
|
46641
46672
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
46642
46673
|
* to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
|
|
@@ -46668,6 +46699,7 @@ type ChecklistFilterComboConfig = {
|
|
|
46668
46699
|
* 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
|
|
46669
46700
|
* 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
|
|
46670
46701
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
46702
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-clearable)
|
|
46671
46703
|
*/
|
|
46672
46704
|
clearable?: boolean|FieldTriggerConfig
|
|
46673
46705
|
/**
|
|
@@ -46771,7 +46803,7 @@ type ChecklistFilterComboConfig = {
|
|
|
46771
46803
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
46772
46804
|
/**
|
|
46773
46805
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
46774
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
46806
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
46775
46807
|
* property which controls when a drag should start.
|
|
46776
46808
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-draggable)
|
|
46777
46809
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -47218,7 +47250,7 @@ type ChecklistFilterComboConfig = {
|
|
|
47218
47250
|
rtl?: boolean
|
|
47219
47251
|
/**
|
|
47220
47252
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
47221
|
-
* Valid values:
|
|
47253
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
47222
47254
|
*/
|
|
47223
47255
|
scrollAction?: 'hide'|'realign'|null
|
|
47224
47256
|
/**
|
|
@@ -47856,9 +47888,10 @@ type GridChartDesignerConfig = {
|
|
|
47856
47888
|
catchEventHandlerExceptions?: boolean
|
|
47857
47889
|
/**
|
|
47858
47890
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
47859
|
-
*
|
|
47891
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-centered)
|
|
47892
|
+
* @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
|
|
47860
47893
|
*/
|
|
47861
|
-
centered?: boolean
|
|
47894
|
+
centered?: boolean|object
|
|
47862
47895
|
/**
|
|
47863
47896
|
* Custom CSS classes to add to element.
|
|
47864
47897
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -47931,7 +47964,7 @@ type GridChartDesignerConfig = {
|
|
|
47931
47964
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
47932
47965
|
/**
|
|
47933
47966
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
47934
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
47967
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
47935
47968
|
* property which controls when a drag should start.
|
|
47936
47969
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-draggable)
|
|
47937
47970
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -48147,7 +48180,7 @@ type GridChartDesignerConfig = {
|
|
|
48147
48180
|
rtl?: boolean
|
|
48148
48181
|
/**
|
|
48149
48182
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
48150
|
-
* Valid values:
|
|
48183
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
48151
48184
|
*/
|
|
48152
48185
|
scrollAction?: 'hide'|'realign'|null
|
|
48153
48186
|
/**
|
|
@@ -48731,9 +48764,10 @@ type GridFieldFilterPickerConfig = {
|
|
|
48731
48764
|
catchEventHandlerExceptions?: boolean
|
|
48732
48765
|
/**
|
|
48733
48766
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
48734
|
-
*
|
|
48767
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-centered)
|
|
48768
|
+
* @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
|
|
48735
48769
|
*/
|
|
48736
|
-
centered?: boolean
|
|
48770
|
+
centered?: boolean|object
|
|
48737
48771
|
/**
|
|
48738
48772
|
* Custom CSS classes to add to element.
|
|
48739
48773
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -48821,7 +48855,7 @@ type GridFieldFilterPickerConfig = {
|
|
|
48821
48855
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
48822
48856
|
/**
|
|
48823
48857
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
48824
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
48858
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
48825
48859
|
* property which controls when a drag should start.
|
|
48826
48860
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-draggable)
|
|
48827
48861
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -48957,7 +48991,7 @@ type GridFieldFilterPickerConfig = {
|
|
|
48957
48991
|
*/
|
|
48958
48992
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
48959
48993
|
/**
|
|
48960
|
-
* Sets `labelWidth
|
|
48994
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
48961
48995
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-labelWidth)
|
|
48962
48996
|
*/
|
|
48963
48997
|
labelWidth?: number|null
|
|
@@ -49143,7 +49177,7 @@ type GridFieldFilterPickerConfig = {
|
|
|
49143
49177
|
rtl?: boolean
|
|
49144
49178
|
/**
|
|
49145
49179
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
49146
|
-
* Valid values:
|
|
49180
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
49147
49181
|
*/
|
|
49148
49182
|
scrollAction?: 'hide'|'realign'|null
|
|
49149
49183
|
/**
|
|
@@ -49812,9 +49846,10 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
49812
49846
|
catchEventHandlerExceptions?: boolean
|
|
49813
49847
|
/**
|
|
49814
49848
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
49815
|
-
*
|
|
49849
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-centered)
|
|
49850
|
+
* @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
|
|
49816
49851
|
*/
|
|
49817
|
-
centered?: boolean
|
|
49852
|
+
centered?: boolean|object
|
|
49818
49853
|
/**
|
|
49819
49854
|
* Custom CSS classes to add to element.
|
|
49820
49855
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -49902,7 +49937,7 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
49902
49937
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
49903
49938
|
/**
|
|
49904
49939
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
49905
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
49940
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
49906
49941
|
* property which controls when a drag should start.
|
|
49907
49942
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-draggable)
|
|
49908
49943
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -50034,7 +50069,7 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
50034
50069
|
*/
|
|
50035
50070
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
50036
50071
|
/**
|
|
50037
|
-
* Sets `labelWidth
|
|
50072
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
50038
50073
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-labelWidth)
|
|
50039
50074
|
*/
|
|
50040
50075
|
labelWidth?: number|null
|
|
@@ -50215,7 +50250,7 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
50215
50250
|
rtl?: boolean
|
|
50216
50251
|
/**
|
|
50217
50252
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
50218
|
-
* Valid values:
|
|
50253
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
50219
50254
|
*/
|
|
50220
50255
|
scrollAction?: 'hide'|'realign'|null
|
|
50221
50256
|
/**
|
|
@@ -50890,9 +50925,10 @@ type GroupBarConfig = {
|
|
|
50890
50925
|
catchEventHandlerExceptions?: boolean
|
|
50891
50926
|
/**
|
|
50892
50927
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
50893
|
-
*
|
|
50928
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-centered)
|
|
50929
|
+
* @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
|
|
50894
50930
|
*/
|
|
50895
|
-
centered?: boolean
|
|
50931
|
+
centered?: boolean|object
|
|
50896
50932
|
/**
|
|
50897
50933
|
* Configure as `true` to clear selection when clicking on empty space inside the List´s element.
|
|
50898
50934
|
*/
|
|
@@ -50991,7 +51027,7 @@ type GroupBarConfig = {
|
|
|
50991
51027
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
50992
51028
|
/**
|
|
50993
51029
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
50994
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
51030
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
50995
51031
|
* property which controls when a drag should start.
|
|
50996
51032
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-draggable)
|
|
50997
51033
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -51257,7 +51293,7 @@ type GroupBarConfig = {
|
|
|
51257
51293
|
rtl?: boolean
|
|
51258
51294
|
/**
|
|
51259
51295
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
51260
|
-
* Valid values:
|
|
51296
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
51261
51297
|
*/
|
|
51262
51298
|
scrollAction?: 'hide'|'realign'|null
|
|
51263
51299
|
/**
|
|
@@ -51983,9 +52019,10 @@ type TreeComboConfig = {
|
|
|
51983
52019
|
catchEventHandlerExceptions?: boolean
|
|
51984
52020
|
/**
|
|
51985
52021
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
51986
|
-
*
|
|
52022
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-centered)
|
|
52023
|
+
* @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
|
|
51987
52024
|
*/
|
|
51988
|
-
centered?: boolean
|
|
52025
|
+
centered?: boolean|object
|
|
51989
52026
|
/**
|
|
51990
52027
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
51991
52028
|
* to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
|
|
@@ -52017,6 +52054,7 @@ type TreeComboConfig = {
|
|
|
52017
52054
|
* 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
|
|
52018
52055
|
* 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
|
|
52019
52056
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
52057
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-clearable)
|
|
52020
52058
|
*/
|
|
52021
52059
|
clearable?: boolean|FieldTriggerConfig
|
|
52022
52060
|
/**
|
|
@@ -52120,7 +52158,7 @@ type TreeComboConfig = {
|
|
|
52120
52158
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
52121
52159
|
/**
|
|
52122
52160
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
52123
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
52161
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
52124
52162
|
* property which controls when a drag should start.
|
|
52125
52163
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-draggable)
|
|
52126
52164
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -52566,7 +52604,7 @@ type TreeComboConfig = {
|
|
|
52566
52604
|
rtl?: boolean
|
|
52567
52605
|
/**
|
|
52568
52606
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
52569
|
-
* Valid values:
|
|
52607
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
52570
52608
|
*/
|
|
52571
52609
|
scrollAction?: 'hide'|'realign'|null
|
|
52572
52610
|
/**
|