@bryntum/grid-thin-trial 7.3.1 → 7.3.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 +157 -72
- package/lib/column/ChartColumn.js +1 -1
- package/lib/column/Column.js +1 -1
- package/lib/column/NumberColumn.js +1 -1
- package/lib/data/ColumnStore.js +1 -1
- package/lib/feature/CellEdit.js +1 -1
- package/lib/feature/CellTooltip.js +1 -1
- package/lib/feature/Filter.js +1 -1
- package/lib/feature/GridFeatureManager.js +1 -1
- package/lib/feature/Group.js +1 -1
- package/lib/feature/RowCopyPaste.js +1 -1
- package/lib/feature/RowExpander.js +1 -1
- package/lib/feature/base/CopyPasteBase.js +1 -1
- package/lib/feature/experimental/ExcelExporter.js +1 -1
- package/lib/feature/export/PdfExport.js +4 -4
- package/lib/feature/export/Print.js +1 -1
- package/lib/feature/export/exporter/ExporterBase.js +6 -6
- package/lib/row/Row.js +1 -1
- package/lib/view/Grid.js +1 -1
- package/lib/view/GridBase.js +1 -1
- package/lib/view/export/ExportDialog.js +1 -1
- package/locales/grid.locale.Ar.js +1 -1
- package/locales/grid.locale.Bg.js +1 -1
- package/locales/grid.locale.Ca.js +1 -1
- package/locales/grid.locale.Cs.js +1 -1
- package/locales/grid.locale.Da.js +1 -1
- package/locales/grid.locale.De.js +1 -1
- package/locales/grid.locale.El.js +1 -1
- package/locales/grid.locale.En.js +1 -1
- package/locales/grid.locale.EnGb.js +1 -1
- package/locales/grid.locale.Es.js +1 -1
- package/locales/grid.locale.Et.js +1 -1
- package/locales/grid.locale.Eu.js +1 -1
- package/locales/grid.locale.Fi.js +1 -1
- package/locales/grid.locale.FrFr.js +1 -1
- package/locales/grid.locale.Gl.js +1 -1
- package/locales/grid.locale.He.js +1 -1
- package/locales/grid.locale.Hi.js +1 -1
- package/locales/grid.locale.Hr.js +1 -1
- package/locales/grid.locale.Hu.js +1 -1
- package/locales/grid.locale.Id.js +1 -1
- package/locales/grid.locale.It.js +1 -1
- package/locales/grid.locale.Ja.js +1 -1
- package/locales/grid.locale.Kk.js +1 -1
- package/locales/grid.locale.Ko.js +1 -1
- package/locales/grid.locale.Lt.js +1 -1
- package/locales/grid.locale.Lv.js +1 -1
- package/locales/grid.locale.Ms.js +1 -1
- package/locales/grid.locale.Nl.js +1 -1
- package/locales/grid.locale.No.js +1 -1
- package/locales/grid.locale.Pl.js +1 -1
- package/locales/grid.locale.Pt.js +1 -1
- package/locales/grid.locale.PtBr.js +1 -1
- package/locales/grid.locale.Ro.js +1 -1
- package/locales/grid.locale.Ru.js +1 -1
- package/locales/grid.locale.Sk.js +1 -1
- package/locales/grid.locale.Sl.js +1 -1
- package/locales/grid.locale.Sr.js +1 -1
- package/locales/grid.locale.SrRs.js +1 -1
- package/locales/grid.locale.SvSE.js +1 -1
- package/locales/grid.locale.Th.js +1 -1
- package/locales/grid.locale.Tr.js +1 -1
- package/locales/grid.locale.Uk.js +1 -1
- package/locales/grid.locale.Vi.js +1 -1
- package/locales/grid.locale.ZhCn.js +1 -1
- package/locales/grid.locale.ZhTw.js +1 -1
- package/package.json +1 -1
package/grid.d.ts
CHANGED
|
@@ -673,7 +673,7 @@ type ActionColumnConfig = {
|
|
|
673
673
|
*/
|
|
674
674
|
alwaysClearCell?: boolean
|
|
675
675
|
/**
|
|
676
|
-
* The `aria-label` to use for this Column
|
|
676
|
+
* The `aria-label` to use for this Column's header element
|
|
677
677
|
*/
|
|
678
678
|
ariaLabel?: string
|
|
679
679
|
/**
|
|
@@ -1316,7 +1316,7 @@ type AggregateColumnConfig = {
|
|
|
1316
1316
|
*/
|
|
1317
1317
|
alwaysClearCell?: boolean
|
|
1318
1318
|
/**
|
|
1319
|
-
* The `aria-label` to use for this Column
|
|
1319
|
+
* The `aria-label` to use for this Column's header element
|
|
1320
1320
|
*/
|
|
1321
1321
|
ariaLabel?: string
|
|
1322
1322
|
/**
|
|
@@ -2057,7 +2057,7 @@ type ChartColumnConfig = {
|
|
|
2057
2057
|
*/
|
|
2058
2058
|
alwaysClearCell?: boolean
|
|
2059
2059
|
/**
|
|
2060
|
-
* The `aria-label` to use for this Column
|
|
2060
|
+
* The `aria-label` to use for this Column's header element
|
|
2061
2061
|
*/
|
|
2062
2062
|
ariaLabel?: string
|
|
2063
2063
|
/**
|
|
@@ -2795,7 +2795,7 @@ type CheckColumnConfig = {
|
|
|
2795
2795
|
*/
|
|
2796
2796
|
alwaysClearCell?: boolean
|
|
2797
2797
|
/**
|
|
2798
|
-
* The `aria-label` to use for this Column
|
|
2798
|
+
* The `aria-label` to use for this Column's header element
|
|
2799
2799
|
*/
|
|
2800
2800
|
ariaLabel?: string
|
|
2801
2801
|
/**
|
|
@@ -3557,7 +3557,7 @@ type ColorColumnConfig = {
|
|
|
3557
3557
|
*/
|
|
3558
3558
|
alwaysClearCell?: boolean
|
|
3559
3559
|
/**
|
|
3560
|
-
* The `aria-label` to use for this Column
|
|
3560
|
+
* The `aria-label` to use for this Column's header element
|
|
3561
3561
|
*/
|
|
3562
3562
|
ariaLabel?: string
|
|
3563
3563
|
/**
|
|
@@ -4252,7 +4252,7 @@ type ColumnConfig = {
|
|
|
4252
4252
|
*/
|
|
4253
4253
|
alwaysClearCell?: boolean
|
|
4254
4254
|
/**
|
|
4255
|
-
* The `aria-label` to use for this Column
|
|
4255
|
+
* The `aria-label` to use for this Column's header element
|
|
4256
4256
|
*/
|
|
4257
4257
|
ariaLabel?: string
|
|
4258
4258
|
/**
|
|
@@ -4826,7 +4826,7 @@ export class Column extends Model {
|
|
|
4826
4826
|
*/
|
|
4827
4827
|
alwaysClearCell: boolean
|
|
4828
4828
|
/**
|
|
4829
|
-
* The `aria-label` to use for this Column
|
|
4829
|
+
* The `aria-label` to use for this Column's header element
|
|
4830
4830
|
*/
|
|
4831
4831
|
ariaLabel: string
|
|
4832
4832
|
/**
|
|
@@ -5522,7 +5522,7 @@ type CurrencyColumnConfig = {
|
|
|
5522
5522
|
*/
|
|
5523
5523
|
alwaysClearCell?: boolean
|
|
5524
5524
|
/**
|
|
5525
|
-
* The `aria-label` to use for this Column
|
|
5525
|
+
* The `aria-label` to use for this Column's header element
|
|
5526
5526
|
*/
|
|
5527
5527
|
ariaLabel?: string
|
|
5528
5528
|
/**
|
|
@@ -6240,7 +6240,7 @@ type DateColumnConfig = {
|
|
|
6240
6240
|
*/
|
|
6241
6241
|
alwaysClearCell?: boolean
|
|
6242
6242
|
/**
|
|
6243
|
-
* The `aria-label` to use for this Column
|
|
6243
|
+
* The `aria-label` to use for this Column's header element
|
|
6244
6244
|
*/
|
|
6245
6245
|
ariaLabel?: string
|
|
6246
6246
|
/**
|
|
@@ -6965,7 +6965,7 @@ type NumberColumnConfig = {
|
|
|
6965
6965
|
*/
|
|
6966
6966
|
alwaysClearCell?: boolean
|
|
6967
6967
|
/**
|
|
6968
|
-
* The `aria-label` to use for this Column
|
|
6968
|
+
* The `aria-label` to use for this Column's header element
|
|
6969
6969
|
*/
|
|
6970
6970
|
ariaLabel?: string
|
|
6971
6971
|
/**
|
|
@@ -7705,7 +7705,7 @@ type PercentColumnConfig = {
|
|
|
7705
7705
|
*/
|
|
7706
7706
|
alwaysClearCell?: boolean
|
|
7707
7707
|
/**
|
|
7708
|
-
* The `aria-label` to use for this Column
|
|
7708
|
+
* The `aria-label` to use for this Column's header element
|
|
7709
7709
|
*/
|
|
7710
7710
|
ariaLabel?: string
|
|
7711
7711
|
/**
|
|
@@ -8431,7 +8431,7 @@ type RatingColumnConfig = {
|
|
|
8431
8431
|
*/
|
|
8432
8432
|
alwaysClearCell?: boolean
|
|
8433
8433
|
/**
|
|
8434
|
-
* The `aria-label` to use for this Column
|
|
8434
|
+
* The `aria-label` to use for this Column's header element
|
|
8435
8435
|
*/
|
|
8436
8436
|
ariaLabel?: string
|
|
8437
8437
|
/**
|
|
@@ -9154,7 +9154,7 @@ type RowNumberColumnConfig = {
|
|
|
9154
9154
|
*/
|
|
9155
9155
|
alwaysClearCell?: boolean
|
|
9156
9156
|
/**
|
|
9157
|
-
* The `aria-label` to use for this Column
|
|
9157
|
+
* The `aria-label` to use for this Column's header element
|
|
9158
9158
|
*/
|
|
9159
9159
|
ariaLabel?: string
|
|
9160
9160
|
/**
|
|
@@ -9715,7 +9715,7 @@ type SparklineColumnConfig = {
|
|
|
9715
9715
|
*/
|
|
9716
9716
|
alwaysClearCell?: boolean
|
|
9717
9717
|
/**
|
|
9718
|
-
* The `aria-label` to use for this Column
|
|
9718
|
+
* The `aria-label` to use for this Column's header element
|
|
9719
9719
|
*/
|
|
9720
9720
|
ariaLabel?: string
|
|
9721
9721
|
/**
|
|
@@ -10414,7 +10414,7 @@ type TemplateColumnConfig = {
|
|
|
10414
10414
|
*/
|
|
10415
10415
|
alwaysClearCell?: boolean
|
|
10416
10416
|
/**
|
|
10417
|
-
* The `aria-label` to use for this Column
|
|
10417
|
+
* The `aria-label` to use for this Column's header element
|
|
10418
10418
|
*/
|
|
10419
10419
|
ariaLabel?: string
|
|
10420
10420
|
/**
|
|
@@ -11100,7 +11100,7 @@ type TimeColumnConfig = {
|
|
|
11100
11100
|
*/
|
|
11101
11101
|
alwaysClearCell?: boolean
|
|
11102
11102
|
/**
|
|
11103
|
-
* The `aria-label` to use for this Column
|
|
11103
|
+
* The `aria-label` to use for this Column's header element
|
|
11104
11104
|
*/
|
|
11105
11105
|
ariaLabel?: string
|
|
11106
11106
|
/**
|
|
@@ -11783,7 +11783,7 @@ type TreeColumnConfig = {
|
|
|
11783
11783
|
*/
|
|
11784
11784
|
alwaysClearCell?: boolean
|
|
11785
11785
|
/**
|
|
11786
|
-
* The `aria-label` to use for this Column
|
|
11786
|
+
* The `aria-label` to use for this Column's header element
|
|
11787
11787
|
*/
|
|
11788
11788
|
ariaLabel?: string
|
|
11789
11789
|
/**
|
|
@@ -12519,7 +12519,7 @@ type WidgetColumnConfig = {
|
|
|
12519
12519
|
*/
|
|
12520
12520
|
alwaysClearCell?: boolean
|
|
12521
12521
|
/**
|
|
12522
|
-
* The `aria-label` to use for this Column
|
|
12522
|
+
* The `aria-label` to use for this Column's header element
|
|
12523
12523
|
*/
|
|
12524
12524
|
ariaLabel?: string
|
|
12525
12525
|
/**
|
|
@@ -16031,6 +16031,8 @@ type CellTooltipConfig = {
|
|
|
16031
16031
|
/**
|
|
16032
16032
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
16033
16033
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
16034
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
16035
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-appendTo)
|
|
16034
16036
|
*/
|
|
16035
16037
|
appendTo?: HTMLElement|string
|
|
16036
16038
|
/**
|
|
@@ -16098,9 +16100,10 @@ type CellTooltipConfig = {
|
|
|
16098
16100
|
catchEventHandlerExceptions?: boolean
|
|
16099
16101
|
/**
|
|
16100
16102
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
16101
|
-
*
|
|
16103
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-centered)
|
|
16104
|
+
* @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.
|
|
16102
16105
|
*/
|
|
16103
|
-
centered?: boolean
|
|
16106
|
+
centered?: boolean|object
|
|
16104
16107
|
/**
|
|
16105
16108
|
* The widget which this plugin is to attach to.
|
|
16106
16109
|
*/
|
|
@@ -16292,10 +16295,11 @@ type CellTooltipConfig = {
|
|
|
16292
16295
|
* @param {Core.widget.Tooltip} context.tip The tooltip instance
|
|
16293
16296
|
* @param {HTMLElement} context.element The Element for which the Tooltip is monitoring mouse movement
|
|
16294
16297
|
* @param {HTMLElement} context.activeTarget The target element that triggered the show
|
|
16298
|
+
* @param {HTMLElement} [context.forElement] Alias for `activeTarget`, provided for backward compatibility
|
|
16295
16299
|
* @param {Event} context.event The raw DOM event
|
|
16296
16300
|
* @returns {string,Promise<any>}
|
|
16297
16301
|
*/
|
|
16298
|
-
getHtml?: ((context: { tip: Tooltip, element: HTMLElement, activeTarget: HTMLElement, event: Event }) => Promise<string|Promise<any>>)|string
|
|
16302
|
+
getHtml?: ((context: { tip: Tooltip, element: HTMLElement, activeTarget: HTMLElement, forElement?: HTMLElement, event: Event }) => Promise<string|Promise<any>>)|string
|
|
16299
16303
|
/**
|
|
16300
16304
|
* A config [object](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
|
|
16301
16305
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-header)
|
|
@@ -16371,10 +16375,14 @@ type CellTooltipConfig = {
|
|
|
16371
16375
|
inputFieldAlign?: 'start'|'end'
|
|
16372
16376
|
/**
|
|
16373
16377
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
16378
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
16379
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-insertBefore)
|
|
16374
16380
|
*/
|
|
16375
16381
|
insertBefore?: HTMLElement|string
|
|
16376
16382
|
/**
|
|
16377
16383
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
16384
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
16385
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-insertFirst)
|
|
16378
16386
|
*/
|
|
16379
16387
|
insertFirst?: HTMLElement|string
|
|
16380
16388
|
/**
|
|
@@ -16400,7 +16408,7 @@ type CellTooltipConfig = {
|
|
|
16400
16408
|
*/
|
|
16401
16409
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
16402
16410
|
/**
|
|
16403
|
-
* Sets `labelWidth
|
|
16411
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
16404
16412
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-labelWidth)
|
|
16405
16413
|
*/
|
|
16406
16414
|
labelWidth?: number|null
|
|
@@ -16617,7 +16625,7 @@ type CellTooltipConfig = {
|
|
|
16617
16625
|
rtl?: boolean
|
|
16618
16626
|
/**
|
|
16619
16627
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
16620
|
-
* Valid values:
|
|
16628
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
16621
16629
|
*/
|
|
16622
16630
|
scrollAction?: 'hide'|'realign'|null
|
|
16623
16631
|
/**
|
|
@@ -26162,8 +26170,8 @@ type PdfExportConfig = {
|
|
|
26162
26170
|
*/
|
|
26163
26171
|
fileName?: string
|
|
26164
26172
|
/**
|
|
26165
|
-
* A template function used to generate a page footer. It is passed an object with
|
|
26166
|
-
* `totalPages
|
|
26173
|
+
* A template function used to generate a page footer. It is passed an object with `currentPage` and
|
|
26174
|
+
* `totalPages` properties.
|
|
26167
26175
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/PdfExport#config-footerTpl)
|
|
26168
26176
|
* @param {object} data Data object
|
|
26169
26177
|
* @param {number} data.currentPage Current page number
|
|
@@ -26172,8 +26180,8 @@ type PdfExportConfig = {
|
|
|
26172
26180
|
*/
|
|
26173
26181
|
footerTpl?: (data: { currentPage: number, totalPages: number }) => string
|
|
26174
26182
|
/**
|
|
26175
|
-
* A template function used to generate a page header. It is passed an object with
|
|
26176
|
-
* `totalPages
|
|
26183
|
+
* A template function used to generate a page header. It is passed an object with `currentPage` and
|
|
26184
|
+
* `totalPages` properties.
|
|
26177
26185
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/PdfExport#config-headerTpl)
|
|
26178
26186
|
* @param {object} data Data object
|
|
26179
26187
|
* @param {number} data.currentPage Current page number
|
|
@@ -26603,8 +26611,8 @@ type PrintConfig = {
|
|
|
26603
26611
|
*/
|
|
26604
26612
|
exporters?: Exporter[]
|
|
26605
26613
|
/**
|
|
26606
|
-
* A template function used to generate a page footer. It is passed an object with
|
|
26607
|
-
* `totalPages
|
|
26614
|
+
* A template function used to generate a page footer. It is passed an object with `currentPage` and
|
|
26615
|
+
* `totalPages` properties.
|
|
26608
26616
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/Print#config-footerTpl)
|
|
26609
26617
|
* @param {object} data Data object
|
|
26610
26618
|
* @param {number} data.currentPage Current page number
|
|
@@ -26613,8 +26621,8 @@ type PrintConfig = {
|
|
|
26613
26621
|
*/
|
|
26614
26622
|
footerTpl?: (data: { currentPage: number, totalPages: number }) => string
|
|
26615
26623
|
/**
|
|
26616
|
-
* A template function used to generate a page header. It is passed an object with
|
|
26617
|
-
* `totalPages
|
|
26624
|
+
* A template function used to generate a page header. It is passed an object with `currentPage` and
|
|
26625
|
+
* `totalPages` properties.
|
|
26618
26626
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/Print#config-headerTpl)
|
|
26619
26627
|
* @param {object} data Data object
|
|
26620
26628
|
* @param {number} data.currentPage Current page number
|
|
@@ -30553,6 +30561,8 @@ type GridConfig = {
|
|
|
30553
30561
|
/**
|
|
30554
30562
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
30555
30563
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
30564
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
30565
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-appendTo)
|
|
30556
30566
|
*/
|
|
30557
30567
|
appendTo?: HTMLElement|string
|
|
30558
30568
|
/**
|
|
@@ -30867,10 +30877,14 @@ type GridConfig = {
|
|
|
30867
30877
|
inputFieldAlign?: 'start'|'end'
|
|
30868
30878
|
/**
|
|
30869
30879
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
30880
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
30881
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-insertBefore)
|
|
30870
30882
|
*/
|
|
30871
30883
|
insertBefore?: HTMLElement|string
|
|
30872
30884
|
/**
|
|
30873
30885
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
30886
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
30887
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-insertFirst)
|
|
30874
30888
|
*/
|
|
30875
30889
|
insertFirst?: HTMLElement|string
|
|
30876
30890
|
/**
|
|
@@ -30883,7 +30897,7 @@ type GridConfig = {
|
|
|
30883
30897
|
*/
|
|
30884
30898
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
30885
30899
|
/**
|
|
30886
|
-
* Sets `labelWidth
|
|
30900
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
30887
30901
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-labelWidth)
|
|
30888
30902
|
*/
|
|
30889
30903
|
labelWidth?: number|null
|
|
@@ -34608,6 +34622,8 @@ type GridBaseConfig = {
|
|
|
34608
34622
|
/**
|
|
34609
34623
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
34610
34624
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
34625
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
34626
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-appendTo)
|
|
34611
34627
|
*/
|
|
34612
34628
|
appendTo?: HTMLElement|string
|
|
34613
34629
|
/**
|
|
@@ -34922,10 +34938,14 @@ type GridBaseConfig = {
|
|
|
34922
34938
|
inputFieldAlign?: 'start'|'end'
|
|
34923
34939
|
/**
|
|
34924
34940
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
34941
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
34942
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-insertBefore)
|
|
34925
34943
|
*/
|
|
34926
34944
|
insertBefore?: HTMLElement|string
|
|
34927
34945
|
/**
|
|
34928
34946
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
34947
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
34948
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-insertFirst)
|
|
34929
34949
|
*/
|
|
34930
34950
|
insertFirst?: HTMLElement|string
|
|
34931
34951
|
/**
|
|
@@ -34938,7 +34958,7 @@ type GridBaseConfig = {
|
|
|
34938
34958
|
*/
|
|
34939
34959
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
34940
34960
|
/**
|
|
34941
|
-
* Sets `labelWidth
|
|
34961
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
34942
34962
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-labelWidth)
|
|
34943
34963
|
*/
|
|
34944
34964
|
labelWidth?: number|null
|
|
@@ -38381,9 +38401,10 @@ type SubGridConfig = {
|
|
|
38381
38401
|
catchEventHandlerExceptions?: boolean
|
|
38382
38402
|
/**
|
|
38383
38403
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
38384
|
-
*
|
|
38404
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/SubGrid#config-centered)
|
|
38405
|
+
* @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.
|
|
38385
38406
|
*/
|
|
38386
|
-
centered?: boolean
|
|
38407
|
+
centered?: boolean|object
|
|
38387
38408
|
/**
|
|
38388
38409
|
* Custom CSS classes to add to element.
|
|
38389
38410
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -41080,6 +41101,8 @@ type TreeGridConfig = {
|
|
|
41080
41101
|
/**
|
|
41081
41102
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
41082
41103
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
41104
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
41105
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-appendTo)
|
|
41083
41106
|
*/
|
|
41084
41107
|
appendTo?: HTMLElement|string
|
|
41085
41108
|
/**
|
|
@@ -41394,10 +41417,14 @@ type TreeGridConfig = {
|
|
|
41394
41417
|
inputFieldAlign?: 'start'|'end'
|
|
41395
41418
|
/**
|
|
41396
41419
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
41420
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
41421
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-insertBefore)
|
|
41397
41422
|
*/
|
|
41398
41423
|
insertBefore?: HTMLElement|string
|
|
41399
41424
|
/**
|
|
41400
41425
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
41426
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
41427
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-insertFirst)
|
|
41401
41428
|
*/
|
|
41402
41429
|
insertFirst?: HTMLElement|string
|
|
41403
41430
|
/**
|
|
@@ -41410,7 +41437,7 @@ type TreeGridConfig = {
|
|
|
41410
41437
|
*/
|
|
41411
41438
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
41412
41439
|
/**
|
|
41413
|
-
* Sets `labelWidth
|
|
41440
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
41414
41441
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-labelWidth)
|
|
41415
41442
|
*/
|
|
41416
41443
|
labelWidth?: number|null
|
|
@@ -43391,6 +43418,8 @@ type ExportDialogConfig = {
|
|
|
43391
43418
|
/**
|
|
43392
43419
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
43393
43420
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
43421
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
43422
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-appendTo)
|
|
43394
43423
|
*/
|
|
43395
43424
|
appendTo?: HTMLElement|string
|
|
43396
43425
|
/**
|
|
@@ -43458,9 +43487,10 @@ type ExportDialogConfig = {
|
|
|
43458
43487
|
catchEventHandlerExceptions?: boolean
|
|
43459
43488
|
/**
|
|
43460
43489
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
43461
|
-
*
|
|
43490
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-centered)
|
|
43491
|
+
* @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.
|
|
43462
43492
|
*/
|
|
43463
|
-
centered?: boolean
|
|
43493
|
+
centered?: boolean|object
|
|
43464
43494
|
/**
|
|
43465
43495
|
* Grid instance to build export dialog for
|
|
43466
43496
|
*/
|
|
@@ -43692,10 +43722,14 @@ type ExportDialogConfig = {
|
|
|
43692
43722
|
inputFieldAlign?: 'start'|'end'
|
|
43693
43723
|
/**
|
|
43694
43724
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
43725
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
43726
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-insertBefore)
|
|
43695
43727
|
*/
|
|
43696
43728
|
insertBefore?: HTMLElement|string
|
|
43697
43729
|
/**
|
|
43698
43730
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
43731
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
43732
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-insertFirst)
|
|
43699
43733
|
*/
|
|
43700
43734
|
insertFirst?: HTMLElement|string
|
|
43701
43735
|
/**
|
|
@@ -43721,7 +43755,7 @@ type ExportDialogConfig = {
|
|
|
43721
43755
|
*/
|
|
43722
43756
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
43723
43757
|
/**
|
|
43724
|
-
* Sets `labelWidth
|
|
43758
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
43725
43759
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-labelWidth)
|
|
43726
43760
|
*/
|
|
43727
43761
|
labelWidth?: number|null
|
|
@@ -43926,7 +43960,7 @@ type ExportDialogConfig = {
|
|
|
43926
43960
|
rtl?: boolean
|
|
43927
43961
|
/**
|
|
43928
43962
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
43929
|
-
* Valid values:
|
|
43963
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
43930
43964
|
*/
|
|
43931
43965
|
scrollAction?: 'hide'|'realign'|null
|
|
43932
43966
|
/**
|
|
@@ -44276,7 +44310,7 @@ export class ExportDialog extends Popup {
|
|
|
44276
44310
|
/**
|
|
44277
44311
|
* Returns map of values of dialog fields.
|
|
44278
44312
|
*/
|
|
44279
|
-
|
|
44313
|
+
values: Record<string, object>
|
|
44280
44314
|
/**
|
|
44281
44315
|
* Fires before an object is destroyed.
|
|
44282
44316
|
* @param {object} event Event object
|
|
@@ -45390,6 +45424,8 @@ type AIFilterFieldConfig = {
|
|
|
45390
45424
|
/**
|
|
45391
45425
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
45392
45426
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
45427
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
45428
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-appendTo)
|
|
45393
45429
|
*/
|
|
45394
45430
|
appendTo?: HTMLElement|string
|
|
45395
45431
|
/**
|
|
@@ -45436,9 +45472,10 @@ type AIFilterFieldConfig = {
|
|
|
45436
45472
|
catchEventHandlerExceptions?: boolean
|
|
45437
45473
|
/**
|
|
45438
45474
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
45439
|
-
*
|
|
45475
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-centered)
|
|
45476
|
+
* @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.
|
|
45440
45477
|
*/
|
|
45441
|
-
centered?: boolean
|
|
45478
|
+
centered?: boolean|object
|
|
45442
45479
|
/**
|
|
45443
45480
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
45444
45481
|
* 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)
|
|
@@ -45539,7 +45576,7 @@ type AIFilterFieldConfig = {
|
|
|
45539
45576
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
45540
45577
|
/**
|
|
45541
45578
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
45542
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
45579
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
45543
45580
|
* property which controls when a drag should start.
|
|
45544
45581
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-draggable)
|
|
45545
45582
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -45654,10 +45691,14 @@ type AIFilterFieldConfig = {
|
|
|
45654
45691
|
inputWidth?: string|number
|
|
45655
45692
|
/**
|
|
45656
45693
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
45694
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
45695
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-insertBefore)
|
|
45657
45696
|
*/
|
|
45658
45697
|
insertBefore?: HTMLElement|string
|
|
45659
45698
|
/**
|
|
45660
45699
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
45700
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
45701
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-insertFirst)
|
|
45661
45702
|
*/
|
|
45662
45703
|
insertFirst?: HTMLElement|string
|
|
45663
45704
|
/**
|
|
@@ -45871,7 +45912,7 @@ type AIFilterFieldConfig = {
|
|
|
45871
45912
|
rtl?: boolean
|
|
45872
45913
|
/**
|
|
45873
45914
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
45874
|
-
* Valid values:
|
|
45915
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
45875
45916
|
*/
|
|
45876
45917
|
scrollAction?: 'hide'|'realign'|null
|
|
45877
45918
|
/**
|
|
@@ -46536,6 +46577,8 @@ type ChecklistFilterComboConfig = {
|
|
|
46536
46577
|
/**
|
|
46537
46578
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
46538
46579
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
46580
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
46581
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-appendTo)
|
|
46539
46582
|
*/
|
|
46540
46583
|
appendTo?: HTMLElement|string
|
|
46541
46584
|
/**
|
|
@@ -46595,9 +46638,10 @@ type ChecklistFilterComboConfig = {
|
|
|
46595
46638
|
catchEventHandlerExceptions?: boolean
|
|
46596
46639
|
/**
|
|
46597
46640
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
46598
|
-
*
|
|
46641
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-centered)
|
|
46642
|
+
* @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.
|
|
46599
46643
|
*/
|
|
46600
|
-
centered?: boolean
|
|
46644
|
+
centered?: boolean|object
|
|
46601
46645
|
/**
|
|
46602
46646
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
46603
46647
|
* 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)
|
|
@@ -46732,7 +46776,7 @@ type ChecklistFilterComboConfig = {
|
|
|
46732
46776
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
46733
46777
|
/**
|
|
46734
46778
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
46735
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
46779
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
46736
46780
|
* property which controls when a drag should start.
|
|
46737
46781
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-draggable)
|
|
46738
46782
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -46898,10 +46942,14 @@ type ChecklistFilterComboConfig = {
|
|
|
46898
46942
|
inputWidth?: string|number
|
|
46899
46943
|
/**
|
|
46900
46944
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
46945
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
46946
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-insertBefore)
|
|
46901
46947
|
*/
|
|
46902
46948
|
insertBefore?: HTMLElement|string
|
|
46903
46949
|
/**
|
|
46904
46950
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
46951
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
46952
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-insertFirst)
|
|
46905
46953
|
*/
|
|
46906
46954
|
insertFirst?: HTMLElement|string
|
|
46907
46955
|
/**
|
|
@@ -47175,7 +47223,7 @@ type ChecklistFilterComboConfig = {
|
|
|
47175
47223
|
rtl?: boolean
|
|
47176
47224
|
/**
|
|
47177
47225
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
47178
|
-
* Valid values:
|
|
47226
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
47179
47227
|
*/
|
|
47180
47228
|
scrollAction?: 'hide'|'realign'|null
|
|
47181
47229
|
/**
|
|
@@ -47778,6 +47826,8 @@ type GridChartDesignerConfig = {
|
|
|
47778
47826
|
/**
|
|
47779
47827
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
47780
47828
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
47829
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
47830
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-appendTo)
|
|
47781
47831
|
*/
|
|
47782
47832
|
appendTo?: HTMLElement|string
|
|
47783
47833
|
/**
|
|
@@ -47811,9 +47861,10 @@ type GridChartDesignerConfig = {
|
|
|
47811
47861
|
catchEventHandlerExceptions?: boolean
|
|
47812
47862
|
/**
|
|
47813
47863
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
47814
|
-
*
|
|
47864
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-centered)
|
|
47865
|
+
* @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.
|
|
47815
47866
|
*/
|
|
47816
|
-
centered?: boolean
|
|
47867
|
+
centered?: boolean|object
|
|
47817
47868
|
/**
|
|
47818
47869
|
* Custom CSS classes to add to element.
|
|
47819
47870
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -47886,7 +47937,7 @@ type GridChartDesignerConfig = {
|
|
|
47886
47937
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
47887
47938
|
/**
|
|
47888
47939
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
47889
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
47940
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
47890
47941
|
* property which controls when a drag should start.
|
|
47891
47942
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-draggable)
|
|
47892
47943
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -47953,10 +48004,14 @@ type GridChartDesignerConfig = {
|
|
|
47953
48004
|
ignoreParentReadOnly?: boolean
|
|
47954
48005
|
/**
|
|
47955
48006
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
48007
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
48008
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-insertBefore)
|
|
47956
48009
|
*/
|
|
47957
48010
|
insertBefore?: HTMLElement|string
|
|
47958
48011
|
/**
|
|
47959
48012
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
48013
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
48014
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-insertFirst)
|
|
47960
48015
|
*/
|
|
47961
48016
|
insertFirst?: HTMLElement|string
|
|
47962
48017
|
/**
|
|
@@ -48098,7 +48153,7 @@ type GridChartDesignerConfig = {
|
|
|
48098
48153
|
rtl?: boolean
|
|
48099
48154
|
/**
|
|
48100
48155
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
48101
|
-
* Valid values:
|
|
48156
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
48102
48157
|
*/
|
|
48103
48158
|
scrollAction?: 'hide'|'realign'|null
|
|
48104
48159
|
/**
|
|
@@ -48639,6 +48694,8 @@ type GridFieldFilterPickerConfig = {
|
|
|
48639
48694
|
/**
|
|
48640
48695
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
48641
48696
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
48697
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
48698
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-appendTo)
|
|
48642
48699
|
*/
|
|
48643
48700
|
appendTo?: HTMLElement|string
|
|
48644
48701
|
/**
|
|
@@ -48680,9 +48737,10 @@ type GridFieldFilterPickerConfig = {
|
|
|
48680
48737
|
catchEventHandlerExceptions?: boolean
|
|
48681
48738
|
/**
|
|
48682
48739
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
48683
|
-
*
|
|
48740
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-centered)
|
|
48741
|
+
* @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.
|
|
48684
48742
|
*/
|
|
48685
|
-
centered?: boolean
|
|
48743
|
+
centered?: boolean|object
|
|
48686
48744
|
/**
|
|
48687
48745
|
* Custom CSS classes to add to element.
|
|
48688
48746
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -48770,7 +48828,7 @@ type GridFieldFilterPickerConfig = {
|
|
|
48770
48828
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
48771
48829
|
/**
|
|
48772
48830
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
48773
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
48831
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
48774
48832
|
* property which controls when a drag should start.
|
|
48775
48833
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-draggable)
|
|
48776
48834
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -48873,10 +48931,14 @@ type GridFieldFilterPickerConfig = {
|
|
|
48873
48931
|
inputFieldAlign?: 'start'|'end'
|
|
48874
48932
|
/**
|
|
48875
48933
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
48934
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
48935
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-insertBefore)
|
|
48876
48936
|
*/
|
|
48877
48937
|
insertBefore?: HTMLElement|string
|
|
48878
48938
|
/**
|
|
48879
48939
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
48940
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
48941
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-insertFirst)
|
|
48880
48942
|
*/
|
|
48881
48943
|
insertFirst?: HTMLElement|string
|
|
48882
48944
|
/**
|
|
@@ -48902,7 +48964,7 @@ type GridFieldFilterPickerConfig = {
|
|
|
48902
48964
|
*/
|
|
48903
48965
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
48904
48966
|
/**
|
|
48905
|
-
* Sets `labelWidth
|
|
48967
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
48906
48968
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-labelWidth)
|
|
48907
48969
|
*/
|
|
48908
48970
|
labelWidth?: number|null
|
|
@@ -49088,7 +49150,7 @@ type GridFieldFilterPickerConfig = {
|
|
|
49088
49150
|
rtl?: boolean
|
|
49089
49151
|
/**
|
|
49090
49152
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
49091
|
-
* Valid values:
|
|
49153
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
49092
49154
|
*/
|
|
49093
49155
|
scrollAction?: 'hide'|'realign'|null
|
|
49094
49156
|
/**
|
|
@@ -49698,6 +49760,8 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
49698
49760
|
/**
|
|
49699
49761
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
49700
49762
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
49763
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
49764
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-appendTo)
|
|
49701
49765
|
*/
|
|
49702
49766
|
appendTo?: HTMLElement|string
|
|
49703
49767
|
/**
|
|
@@ -49755,9 +49819,10 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
49755
49819
|
catchEventHandlerExceptions?: boolean
|
|
49756
49820
|
/**
|
|
49757
49821
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
49758
|
-
*
|
|
49822
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-centered)
|
|
49823
|
+
* @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.
|
|
49759
49824
|
*/
|
|
49760
|
-
centered?: boolean
|
|
49825
|
+
centered?: boolean|object
|
|
49761
49826
|
/**
|
|
49762
49827
|
* Custom CSS classes to add to element.
|
|
49763
49828
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -49845,7 +49910,7 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
49845
49910
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
49846
49911
|
/**
|
|
49847
49912
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
49848
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
49913
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
49849
49914
|
* property which controls when a drag should start.
|
|
49850
49915
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-draggable)
|
|
49851
49916
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -49944,10 +50009,14 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
49944
50009
|
inputFieldAlign?: 'start'|'end'
|
|
49945
50010
|
/**
|
|
49946
50011
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
50012
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
50013
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-insertBefore)
|
|
49947
50014
|
*/
|
|
49948
50015
|
insertBefore?: HTMLElement|string
|
|
49949
50016
|
/**
|
|
49950
50017
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
50018
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
50019
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-insertFirst)
|
|
49951
50020
|
*/
|
|
49952
50021
|
insertFirst?: HTMLElement|string
|
|
49953
50022
|
/**
|
|
@@ -49973,7 +50042,7 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
49973
50042
|
*/
|
|
49974
50043
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
49975
50044
|
/**
|
|
49976
|
-
* Sets `labelWidth
|
|
50045
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
49977
50046
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-labelWidth)
|
|
49978
50047
|
*/
|
|
49979
50048
|
labelWidth?: number|null
|
|
@@ -50154,7 +50223,7 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
50154
50223
|
rtl?: boolean
|
|
50155
50224
|
/**
|
|
50156
50225
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
50157
|
-
* Valid values:
|
|
50226
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
50158
50227
|
*/
|
|
50159
50228
|
scrollAction?: 'hide'|'realign'|null
|
|
50160
50229
|
/**
|
|
@@ -50794,6 +50863,8 @@ type GroupBarConfig = {
|
|
|
50794
50863
|
/**
|
|
50795
50864
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
50796
50865
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
50866
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
50867
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-appendTo)
|
|
50797
50868
|
*/
|
|
50798
50869
|
appendTo?: HTMLElement|string
|
|
50799
50870
|
/**
|
|
@@ -50827,9 +50898,10 @@ type GroupBarConfig = {
|
|
|
50827
50898
|
catchEventHandlerExceptions?: boolean
|
|
50828
50899
|
/**
|
|
50829
50900
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
50830
|
-
*
|
|
50901
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-centered)
|
|
50902
|
+
* @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.
|
|
50831
50903
|
*/
|
|
50832
|
-
centered?: boolean
|
|
50904
|
+
centered?: boolean|object
|
|
50833
50905
|
/**
|
|
50834
50906
|
* Configure as `true` to clear selection when clicking on empty space inside the List´s element.
|
|
50835
50907
|
*/
|
|
@@ -50843,9 +50915,11 @@ type GroupBarConfig = {
|
|
|
50843
50915
|
/**
|
|
50844
50916
|
* If [closable](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-closable) is `true`, this is the name of a callback function to handle what the "close"
|
|
50845
50917
|
* action means. If not provided, the record representing the chip is removed from the store.
|
|
50918
|
+
* @param {Core.data.Model[]} records Records to be closed
|
|
50919
|
+
* @param {object} options Close options
|
|
50846
50920
|
* @returns {void}
|
|
50847
50921
|
*/
|
|
50848
|
-
closeHandler?: string|(() => void)
|
|
50922
|
+
closeHandler?: string|((records: Model[], options: object) => void)
|
|
50849
50923
|
/**
|
|
50850
50924
|
* Custom CSS classes to add to element.
|
|
50851
50925
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -50926,7 +51000,7 @@ type GroupBarConfig = {
|
|
|
50926
51000
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
50927
51001
|
/**
|
|
50928
51002
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
50929
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
51003
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
50930
51004
|
* property which controls when a drag should start.
|
|
50931
51005
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-draggable)
|
|
50932
51006
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -51020,10 +51094,14 @@ type GroupBarConfig = {
|
|
|
51020
51094
|
ignoreParentReadOnly?: boolean
|
|
51021
51095
|
/**
|
|
51022
51096
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
51097
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
51098
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-insertBefore)
|
|
51023
51099
|
*/
|
|
51024
51100
|
insertBefore?: HTMLElement|string
|
|
51025
51101
|
/**
|
|
51026
51102
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
51103
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
51104
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-insertFirst)
|
|
51027
51105
|
*/
|
|
51028
51106
|
insertFirst?: HTMLElement|string
|
|
51029
51107
|
/**
|
|
@@ -51188,7 +51266,7 @@ type GroupBarConfig = {
|
|
|
51188
51266
|
rtl?: boolean
|
|
51189
51267
|
/**
|
|
51190
51268
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
51191
|
-
* Valid values:
|
|
51269
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
51192
51270
|
*/
|
|
51193
51271
|
scrollAction?: 'hide'|'realign'|null
|
|
51194
51272
|
/**
|
|
@@ -51853,6 +51931,8 @@ type TreeComboConfig = {
|
|
|
51853
51931
|
/**
|
|
51854
51932
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
51855
51933
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
51934
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
51935
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-appendTo)
|
|
51856
51936
|
*/
|
|
51857
51937
|
appendTo?: HTMLElement|string
|
|
51858
51938
|
/**
|
|
@@ -51912,9 +51992,10 @@ type TreeComboConfig = {
|
|
|
51912
51992
|
catchEventHandlerExceptions?: boolean
|
|
51913
51993
|
/**
|
|
51914
51994
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
51915
|
-
*
|
|
51995
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-centered)
|
|
51996
|
+
* @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.
|
|
51916
51997
|
*/
|
|
51917
|
-
centered?: boolean
|
|
51998
|
+
centered?: boolean|object
|
|
51918
51999
|
/**
|
|
51919
52000
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
51920
52001
|
* 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)
|
|
@@ -52049,7 +52130,7 @@ type TreeComboConfig = {
|
|
|
52049
52130
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
52050
52131
|
/**
|
|
52051
52132
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
52052
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
52133
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
52053
52134
|
* property which controls when a drag should start.
|
|
52054
52135
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-draggable)
|
|
52055
52136
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -52215,10 +52296,14 @@ type TreeComboConfig = {
|
|
|
52215
52296
|
inputWidth?: string|number
|
|
52216
52297
|
/**
|
|
52217
52298
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
52299
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
52300
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-insertBefore)
|
|
52218
52301
|
*/
|
|
52219
52302
|
insertBefore?: HTMLElement|string
|
|
52220
52303
|
/**
|
|
52221
52304
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
52305
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
52306
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-insertFirst)
|
|
52222
52307
|
*/
|
|
52223
52308
|
insertFirst?: HTMLElement|string
|
|
52224
52309
|
/**
|
|
@@ -52491,7 +52576,7 @@ type TreeComboConfig = {
|
|
|
52491
52576
|
rtl?: boolean
|
|
52492
52577
|
/**
|
|
52493
52578
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
52494
|
-
* Valid values:
|
|
52579
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
52495
52580
|
*/
|
|
52496
52581
|
scrollAction?: 'hide'|'realign'|null
|
|
52497
52582
|
/**
|