@bryntum/grid-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 +80 -0
- package/CLAUDE.md +80 -0
- package/README.md +22 -0
- package/grid.css +1 -1
- package/grid.d.ts +798 -440
- package/grid.module.js +40 -40
- package/grid.thin.d.ts +117 -79
- package/grid.umd.js +48 -48
- package/package.json +1 -1
package/grid.d.ts
CHANGED
|
@@ -688,6 +688,28 @@ type FetchOptions = {
|
|
|
688
688
|
abortController?: AbortController
|
|
689
689
|
}
|
|
690
690
|
|
|
691
|
+
/**
|
|
692
|
+
* A `Response` type which extends the native [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
|
|
693
|
+
* with Bryntum properties.
|
|
694
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/helper/AjaxHelper#typedef-AjaxResponse)
|
|
695
|
+
*/
|
|
696
|
+
type AjaxResponse = Response & {
|
|
697
|
+
/**
|
|
698
|
+
* The parsed JSON response body. Set when the `parseJson` option was passed to the request.
|
|
699
|
+
* Will be `null` if the body could not be parsed as JSON.
|
|
700
|
+
*/
|
|
701
|
+
parsedJson?: any
|
|
702
|
+
/**
|
|
703
|
+
* The error thrown while parsing the JSON body, set when JSON parsing failed.
|
|
704
|
+
*/
|
|
705
|
+
error?: Error
|
|
706
|
+
/**
|
|
707
|
+
* The response body as text. Set on responses produced by
|
|
708
|
+
* [mocked URLs](https://bryntum.com/products/grid/docs/api/Core/helper/AjaxHelper#function-mockUrl-static).
|
|
709
|
+
*/
|
|
710
|
+
responseText?: string
|
|
711
|
+
}
|
|
712
|
+
|
|
691
713
|
/**
|
|
692
714
|
* A string defining a duration unit. Valid values are:
|
|
693
715
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/helper/DateHelper#typedef-DurationUnit)
|
|
@@ -1284,6 +1306,22 @@ type HintActions = {
|
|
|
1284
1306
|
fn?: () => void
|
|
1285
1307
|
}
|
|
1286
1308
|
|
|
1309
|
+
/**
|
|
1310
|
+
* Result object yielded by the [prompt](https://bryntum.com/products/grid/docs/api/Core/widget/MessageDialog#function-prompt) Promise.
|
|
1311
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/MessageDialog#typedef-MessageDialogPromptResult)
|
|
1312
|
+
*/
|
|
1313
|
+
type MessageDialogPromptResult = {
|
|
1314
|
+
/**
|
|
1315
|
+
* The identifier of the button that was pressed
|
|
1316
|
+
* ([okButton](https://bryntum.com/products/grid/docs/api/Core/widget/MessageDialog#property-okButton) or [cancelButton](#Core/widget/MessageDialog#property-cancelButton)).
|
|
1317
|
+
*/
|
|
1318
|
+
button: number
|
|
1319
|
+
/**
|
|
1320
|
+
* The text entered by the user in the text field.
|
|
1321
|
+
*/
|
|
1322
|
+
text: string
|
|
1323
|
+
}
|
|
1324
|
+
|
|
1287
1325
|
/**
|
|
1288
1326
|
* An object that describes a Panel's header.
|
|
1289
1327
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#typedef-PanelHeader)
|
|
@@ -1743,6 +1781,16 @@ type ExportConfig = {
|
|
|
1743
1781
|
* Set to true to output as a CSV file, or as an object where you can specify delimiters.
|
|
1744
1782
|
*/
|
|
1745
1783
|
csv?: boolean|object
|
|
1784
|
+
/**
|
|
1785
|
+
* MIME type used when creating the CSV Blob. Defaults to `text/csv`. Use
|
|
1786
|
+
* `application/octet-stream` in Salesforce LWS environments.
|
|
1787
|
+
*/
|
|
1788
|
+
csvMimeType?: string
|
|
1789
|
+
/**
|
|
1790
|
+
* MIME type used when creating the XLSX download Blob. Use
|
|
1791
|
+
* `application/octet-stream` in Salesforce LWS environments.
|
|
1792
|
+
*/
|
|
1793
|
+
xlsxMimeType?: string
|
|
1746
1794
|
}
|
|
1747
1795
|
|
|
1748
1796
|
type XLSColumn = {
|
|
@@ -3501,6 +3549,22 @@ type AjaxStoreConfig = {
|
|
|
3501
3549
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/AjaxStore#config-dontRelayToMaster)
|
|
3502
3550
|
*/
|
|
3503
3551
|
dontRelayToMaster?: string
|
|
3552
|
+
/**
|
|
3553
|
+
* A provided function which creates an array of values for the [filterParamName](https://bryntum.com/products/grid/docs/api/Core/data/AjaxStore#config-filterParamName) to pass
|
|
3554
|
+
* any filters to the server upon load.
|
|
3555
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/AjaxStore#config-encodeFilterParams)
|
|
3556
|
+
* @param {Core.util.CollectionFilter[]} filters The filters to encode.
|
|
3557
|
+
* @returns {string} The encoded value for the filter parameter.
|
|
3558
|
+
*/
|
|
3559
|
+
encodeFilterParams?: (filters: CollectionFilter[]) => string
|
|
3560
|
+
/**
|
|
3561
|
+
* A provided function which creates an array of values for the {#config-sortParamName} to pass
|
|
3562
|
+
* any sorters to the server upon load.
|
|
3563
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/AjaxStore#config-encodeSorterParams)
|
|
3564
|
+
* @param {Sorter[]} sorters The sorters to encode.
|
|
3565
|
+
* @returns {string} The encoded value for the sort parameter.
|
|
3566
|
+
*/
|
|
3567
|
+
encodeSorterParams?: (sorters: Sorter[]) => string
|
|
3504
3568
|
/**
|
|
3505
3569
|
* If `true`, collapsed records in original tree will be excluded from the chained store.
|
|
3506
3570
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/AjaxStore#config-excludeCollapsedRecords)
|
|
@@ -3850,7 +3914,7 @@ type AjaxStoreConfig = {
|
|
|
3850
3914
|
*/
|
|
3851
3915
|
useRawData?: boolean|{ disableDuplicateIdCheck?: boolean, disableDefaultValue?: boolean, disableTypeConversion?: boolean }
|
|
3852
3916
|
/**
|
|
3853
|
-
* Set to
|
|
3917
|
+
* Set to `true` to use restful [httpMethods](https://bryntum.com/products/grid/docs/api/Core/data/AjaxStore#config-httpMethods)
|
|
3854
3918
|
*/
|
|
3855
3919
|
useRestfulMethods?: boolean
|
|
3856
3920
|
/**
|
|
@@ -4577,27 +4641,13 @@ export class AjaxStore extends Store {
|
|
|
4577
4641
|
* [updateUrl](https://bryntum.com/products/grid/docs/api/Core/data/AjaxStore#config-updateUrl) and [deleteUrl](#Core/data/AjaxStore#config-deleteUrl))
|
|
4578
4642
|
*/
|
|
4579
4643
|
commit(): Promise<any|boolean>;
|
|
4580
|
-
/**
|
|
4581
|
-
* A provided function which creates an array of values for the [filterParamName](https://bryntum.com/products/grid/docs/api/Core/data/AjaxStore#config-filterParamName) to pass
|
|
4582
|
-
* any filters to the server upon load.
|
|
4583
|
-
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/AjaxStore#function-encodeFilterParams)
|
|
4584
|
-
* @param {Core.util.CollectionFilter[]} filters The filters to encode.
|
|
4585
|
-
*/
|
|
4586
|
-
encodeFilterParams(filters: CollectionFilter[]): void;
|
|
4587
|
-
/**
|
|
4588
|
-
* A provided function which creates an array of values for the {#config-sortParamName} to pass
|
|
4589
|
-
* any sorters to the server upon load.
|
|
4590
|
-
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/AjaxStore#function-encodeSorterParams)
|
|
4591
|
-
* @param {Sorter[]} sorters The sorters to encode.
|
|
4592
|
-
*/
|
|
4593
|
-
encodeSorterParams(sorters: Sorter[]): void;
|
|
4594
4644
|
/**
|
|
4595
4645
|
* Load data from the [readUrl](https://bryntum.com/products/grid/docs/api/Core/data/AjaxStore#config-readUrl). If configured as [lazyLoad](#Core/data/AjaxStore#config-lazyLoad), this will load 1 chunk of
|
|
4596
4646
|
* records starting from index 0. If the store has previously been loaded, it will first be cleared of all records
|
|
4597
4647
|
* and all lazy load cache.
|
|
4598
4648
|
* @param {object} [params] A hash of parameters to append to querystring (will also append Store#params)
|
|
4599
4649
|
*/
|
|
4600
|
-
load(params?: object): Promise<
|
|
4650
|
+
load(params?: object): Promise<object>;
|
|
4601
4651
|
/**
|
|
4602
4652
|
* Loads children into specified parent record. Parent records id is sent as a param (param name configured with
|
|
4603
4653
|
* [parentIdParamName](https://bryntum.com/products/grid/docs/api/Core/data/AjaxStore#config-parentIdParamName).
|
|
@@ -5063,7 +5113,7 @@ export class Model extends Base {
|
|
|
5063
5113
|
*/
|
|
5064
5114
|
readonly copyOf: Model
|
|
5065
5115
|
/**
|
|
5066
|
-
* Count all children (including sub-children) for a node (in its `firstStore
|
|
5116
|
+
* Count all children (including sub-children) for a node (in its `firstStore`)
|
|
5067
5117
|
*/
|
|
5068
5118
|
descendantCount: number
|
|
5069
5119
|
/**
|
|
@@ -6798,7 +6848,7 @@ type StoreConfig = {
|
|
|
6798
6848
|
|
|
6799
6849
|
/**
|
|
6800
6850
|
* The Store represents a data container which holds flat data or tree structures. An item in the Store is often called
|
|
6801
|
-
* a
|
|
6851
|
+
* a `record` and it is simply an instance of the [Model](https://bryntum.com/products/grid/docs/api/Core/data/Model) (or any subclass thereof).
|
|
6802
6852
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/Store)
|
|
6803
6853
|
*/
|
|
6804
6854
|
export class Store extends Base {
|
|
@@ -8027,7 +8077,7 @@ export class Wbs {
|
|
|
8027
8077
|
*/
|
|
8028
8078
|
readonly value: string
|
|
8029
8079
|
/**
|
|
8030
|
-
* Compares two WBS values, returning 0 if equal, -1 if `lhs` is less than `rhs
|
|
8080
|
+
* Compares two WBS values, returning 0 if equal, -1 if `lhs` is less than `rhs`, or 1 if `lhs` is greater than `rhs`.
|
|
8031
8081
|
* @param {string,Core.data.Wbs} lhs
|
|
8032
8082
|
* @param {string,Core.data.Wbs} rhs
|
|
8033
8083
|
*/
|
|
@@ -8111,6 +8161,14 @@ type ArrayDataFieldConfig = {
|
|
|
8111
8161
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/ArrayDataField#config-complexMapping)
|
|
8112
8162
|
*/
|
|
8113
8163
|
complexMapping?: boolean
|
|
8164
|
+
/**
|
|
8165
|
+
* A function which transforms a data value into the desired form for storage in the record's data object.
|
|
8166
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/ArrayDataField#config-convert)
|
|
8167
|
+
* @param {any} value The value to convert for storage in a record.
|
|
8168
|
+
* @param {object} data The raw record data object
|
|
8169
|
+
* @returns {any} The converted value.
|
|
8170
|
+
*/
|
|
8171
|
+
convert?: (value: any, data: object) => any
|
|
8114
8172
|
/**
|
|
8115
8173
|
* The property in a record's data object that contains the field's value.
|
|
8116
8174
|
* Defaults to the field's `name`.
|
|
@@ -8168,6 +8226,14 @@ type ArrayDataFieldConfig = {
|
|
|
8168
8226
|
* Set to `true` for the field's set accessor to ignore attempts to set this field.
|
|
8169
8227
|
*/
|
|
8170
8228
|
readOnly?: boolean
|
|
8229
|
+
/**
|
|
8230
|
+
* A function which transforms a data value into the desired form for transmitting to a server.
|
|
8231
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/ArrayDataField#config-serialize)
|
|
8232
|
+
* @param {any} value The value to serialize
|
|
8233
|
+
* @param {Core.data.Model} record The record that contains the value being serialized.
|
|
8234
|
+
* @returns {any} The serialized value.
|
|
8235
|
+
*/
|
|
8236
|
+
serialize?: (value: any, record: Model) => any
|
|
8171
8237
|
}
|
|
8172
8238
|
|
|
8173
8239
|
/**
|
|
@@ -8236,6 +8302,14 @@ type BooleanDataFieldConfig = {
|
|
|
8236
8302
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/BooleanDataField#config-complexMapping)
|
|
8237
8303
|
*/
|
|
8238
8304
|
complexMapping?: boolean
|
|
8305
|
+
/**
|
|
8306
|
+
* A function which transforms a data value into the desired form for storage in the record's data object.
|
|
8307
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/BooleanDataField#config-convert)
|
|
8308
|
+
* @param {any} value The value to convert for storage in a record.
|
|
8309
|
+
* @param {object} data The raw record data object
|
|
8310
|
+
* @returns {any} The converted value.
|
|
8311
|
+
*/
|
|
8312
|
+
convert?: (value: any, data: object) => any
|
|
8239
8313
|
/**
|
|
8240
8314
|
* The property in a record's data object that contains the field's value.
|
|
8241
8315
|
* Defaults to the field's `name`.
|
|
@@ -8294,6 +8368,14 @@ type BooleanDataFieldConfig = {
|
|
|
8294
8368
|
* Set to `true` for the field's set accessor to ignore attempts to set this field.
|
|
8295
8369
|
*/
|
|
8296
8370
|
readOnly?: boolean
|
|
8371
|
+
/**
|
|
8372
|
+
* A function which transforms a data value into the desired form for transmitting to a server.
|
|
8373
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/BooleanDataField#config-serialize)
|
|
8374
|
+
* @param {any} value The value to serialize
|
|
8375
|
+
* @param {Core.data.Model} record The record that contains the value being serialized.
|
|
8376
|
+
* @returns {any} The serialized value.
|
|
8377
|
+
*/
|
|
8378
|
+
serialize?: (value: any, record: Model) => any
|
|
8297
8379
|
}
|
|
8298
8380
|
|
|
8299
8381
|
/**
|
|
@@ -8366,6 +8448,14 @@ type DataFieldConfig = {
|
|
|
8366
8448
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/DataField#config-complexMapping)
|
|
8367
8449
|
*/
|
|
8368
8450
|
complexMapping?: boolean
|
|
8451
|
+
/**
|
|
8452
|
+
* A function which transforms a data value into the desired form for storage in the record's data object.
|
|
8453
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/DataField#config-convert)
|
|
8454
|
+
* @param {any} value The value to convert for storage in a record.
|
|
8455
|
+
* @param {object} data The raw record data object
|
|
8456
|
+
* @returns {any} The converted value.
|
|
8457
|
+
*/
|
|
8458
|
+
convert?: (value: any, data: object) => any
|
|
8369
8459
|
/**
|
|
8370
8460
|
* The property in a record's data object that contains the field's value.
|
|
8371
8461
|
* Defaults to the field's `name`.
|
|
@@ -8423,6 +8513,14 @@ type DataFieldConfig = {
|
|
|
8423
8513
|
* Set to `true` for the field's set accessor to ignore attempts to set this field.
|
|
8424
8514
|
*/
|
|
8425
8515
|
readOnly?: boolean
|
|
8516
|
+
/**
|
|
8517
|
+
* A function which transforms a data value into the desired form for transmitting to a server.
|
|
8518
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/DataField#config-serialize)
|
|
8519
|
+
* @param {any} value The value to serialize
|
|
8520
|
+
* @param {Core.data.Model} record The record that contains the value being serialized.
|
|
8521
|
+
* @returns {any} The serialized value.
|
|
8522
|
+
*/
|
|
8523
|
+
serialize?: (value: any, record: Model) => any
|
|
8426
8524
|
}
|
|
8427
8525
|
|
|
8428
8526
|
/**
|
|
@@ -8527,6 +8625,14 @@ type DateDataFieldConfig = {
|
|
|
8527
8625
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/DateDataField#config-complexMapping)
|
|
8528
8626
|
*/
|
|
8529
8627
|
complexMapping?: boolean
|
|
8628
|
+
/**
|
|
8629
|
+
* A function which transforms a data value into the desired form for storage in the record's data object.
|
|
8630
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/DateDataField#config-convert)
|
|
8631
|
+
* @param {any} value The value to convert for storage in a record.
|
|
8632
|
+
* @param {object} data The raw record data object
|
|
8633
|
+
* @returns {any} The converted value.
|
|
8634
|
+
*/
|
|
8635
|
+
convert?: (value: any, data: object) => any
|
|
8530
8636
|
/**
|
|
8531
8637
|
* The property in a record's data object that contains the field's value.
|
|
8532
8638
|
* Defaults to the field's `name`.
|
|
@@ -8589,6 +8695,14 @@ type DateDataFieldConfig = {
|
|
|
8589
8695
|
* Set to `true` for the field's set accessor to ignore attempts to set this field.
|
|
8590
8696
|
*/
|
|
8591
8697
|
readOnly?: boolean
|
|
8698
|
+
/**
|
|
8699
|
+
* A function which transforms a data value into the desired form for transmitting to a server.
|
|
8700
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/DateDataField#config-serialize)
|
|
8701
|
+
* @param {any} value The value to serialize
|
|
8702
|
+
* @param {Core.data.Model} record The record that contains the value being serialized.
|
|
8703
|
+
* @returns {any} The serialized value.
|
|
8704
|
+
*/
|
|
8705
|
+
serialize?: (value: any, record: Model) => any
|
|
8592
8706
|
}
|
|
8593
8707
|
|
|
8594
8708
|
/**
|
|
@@ -8662,6 +8776,14 @@ type DurationUnitDataFieldConfig = {
|
|
|
8662
8776
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/DurationUnitDataField#config-complexMapping)
|
|
8663
8777
|
*/
|
|
8664
8778
|
complexMapping?: boolean
|
|
8779
|
+
/**
|
|
8780
|
+
* A function which transforms a data value into the desired form for storage in the record's data object.
|
|
8781
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/DurationUnitDataField#config-convert)
|
|
8782
|
+
* @param {any} value The value to convert for storage in a record.
|
|
8783
|
+
* @param {object} data The raw record data object
|
|
8784
|
+
* @returns {any} The converted value.
|
|
8785
|
+
*/
|
|
8786
|
+
convert?: (value: any, data: object) => any
|
|
8665
8787
|
/**
|
|
8666
8788
|
* The property in a record's data object that contains the field's value.
|
|
8667
8789
|
* Defaults to the field's `name`.
|
|
@@ -8719,6 +8841,14 @@ type DurationUnitDataFieldConfig = {
|
|
|
8719
8841
|
* Set to `true` for the field's set accessor to ignore attempts to set this field.
|
|
8720
8842
|
*/
|
|
8721
8843
|
readOnly?: boolean
|
|
8844
|
+
/**
|
|
8845
|
+
* A function which transforms a data value into the desired form for transmitting to a server.
|
|
8846
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/DurationUnitDataField#config-serialize)
|
|
8847
|
+
* @param {any} value The value to serialize
|
|
8848
|
+
* @param {Core.data.Model} record The record that contains the value being serialized.
|
|
8849
|
+
* @returns {any} The serialized value.
|
|
8850
|
+
*/
|
|
8851
|
+
serialize?: (value: any, record: Model) => any
|
|
8722
8852
|
}
|
|
8723
8853
|
|
|
8724
8854
|
/**
|
|
@@ -8787,6 +8917,14 @@ type IntegerDataFieldConfig = {
|
|
|
8787
8917
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/IntegerDataField#config-complexMapping)
|
|
8788
8918
|
*/
|
|
8789
8919
|
complexMapping?: boolean
|
|
8920
|
+
/**
|
|
8921
|
+
* A function which transforms a data value into the desired form for storage in the record's data object.
|
|
8922
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/IntegerDataField#config-convert)
|
|
8923
|
+
* @param {any} value The value to convert for storage in a record.
|
|
8924
|
+
* @param {object} data The raw record data object
|
|
8925
|
+
* @returns {any} The converted value.
|
|
8926
|
+
*/
|
|
8927
|
+
convert?: (value: any, data: object) => any
|
|
8790
8928
|
/**
|
|
8791
8929
|
* The property in a record's data object that contains the field's value.
|
|
8792
8930
|
* Defaults to the field's `name`.
|
|
@@ -8848,6 +8986,14 @@ type IntegerDataFieldConfig = {
|
|
|
8848
8986
|
* The `Math` method to use to ensure fractional component is removed.
|
|
8849
8987
|
*/
|
|
8850
8988
|
rounding?: 'round'|'floor'|'ceil'
|
|
8989
|
+
/**
|
|
8990
|
+
* A function which transforms a data value into the desired form for transmitting to a server.
|
|
8991
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/IntegerDataField#config-serialize)
|
|
8992
|
+
* @param {any} value The value to serialize
|
|
8993
|
+
* @param {Core.data.Model} record The record that contains the value being serialized.
|
|
8994
|
+
* @returns {any} The serialized value.
|
|
8995
|
+
*/
|
|
8996
|
+
serialize?: (value: any, record: Model) => any
|
|
8851
8997
|
}
|
|
8852
8998
|
|
|
8853
8999
|
/**
|
|
@@ -8921,6 +9067,14 @@ type NumberDataFieldConfig = {
|
|
|
8921
9067
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/NumberDataField#config-complexMapping)
|
|
8922
9068
|
*/
|
|
8923
9069
|
complexMapping?: boolean
|
|
9070
|
+
/**
|
|
9071
|
+
* A function which transforms a data value into the desired form for storage in the record's data object.
|
|
9072
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/NumberDataField#config-convert)
|
|
9073
|
+
* @param {any} value The value to convert for storage in a record.
|
|
9074
|
+
* @param {object} data The raw record data object
|
|
9075
|
+
* @returns {any} The converted value.
|
|
9076
|
+
*/
|
|
9077
|
+
convert?: (value: any, data: object) => any
|
|
8924
9078
|
/**
|
|
8925
9079
|
* The property in a record's data object that contains the field's value.
|
|
8926
9080
|
* Defaults to the field's `name`.
|
|
@@ -8983,6 +9137,14 @@ type NumberDataFieldConfig = {
|
|
|
8983
9137
|
* Set to `true` for the field's set accessor to ignore attempts to set this field.
|
|
8984
9138
|
*/
|
|
8985
9139
|
readOnly?: boolean
|
|
9140
|
+
/**
|
|
9141
|
+
* A function which transforms a data value into the desired form for transmitting to a server.
|
|
9142
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/NumberDataField#config-serialize)
|
|
9143
|
+
* @param {any} value The value to serialize
|
|
9144
|
+
* @param {Core.data.Model} record The record that contains the value being serialized.
|
|
9145
|
+
* @returns {any} The serialized value.
|
|
9146
|
+
*/
|
|
9147
|
+
serialize?: (value: any, record: Model) => any
|
|
8986
9148
|
}
|
|
8987
9149
|
|
|
8988
9150
|
/**
|
|
@@ -9056,6 +9218,14 @@ type ObjectDataFieldConfig = {
|
|
|
9056
9218
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/ObjectDataField#config-complexMapping)
|
|
9057
9219
|
*/
|
|
9058
9220
|
complexMapping?: boolean
|
|
9221
|
+
/**
|
|
9222
|
+
* A function which transforms a data value into the desired form for storage in the record's data object.
|
|
9223
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/ObjectDataField#config-convert)
|
|
9224
|
+
* @param {any} value The value to convert for storage in a record.
|
|
9225
|
+
* @param {object} data The raw record data object
|
|
9226
|
+
* @returns {any} The converted value.
|
|
9227
|
+
*/
|
|
9228
|
+
convert?: (value: any, data: object) => any
|
|
9059
9229
|
/**
|
|
9060
9230
|
* The property in a record's data object that contains the field's value.
|
|
9061
9231
|
* Defaults to the field's `name`.
|
|
@@ -9113,6 +9283,14 @@ type ObjectDataFieldConfig = {
|
|
|
9113
9283
|
* Set to `true` for the field's set accessor to ignore attempts to set this field.
|
|
9114
9284
|
*/
|
|
9115
9285
|
readOnly?: boolean
|
|
9286
|
+
/**
|
|
9287
|
+
* A function which transforms a data value into the desired form for transmitting to a server.
|
|
9288
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/ObjectDataField#config-serialize)
|
|
9289
|
+
* @param {any} value The value to serialize
|
|
9290
|
+
* @param {Core.data.Model} record The record that contains the value being serialized.
|
|
9291
|
+
* @returns {any} The serialized value.
|
|
9292
|
+
*/
|
|
9293
|
+
serialize?: (value: any, record: Model) => any
|
|
9116
9294
|
}
|
|
9117
9295
|
|
|
9118
9296
|
/**
|
|
@@ -9181,6 +9359,14 @@ type StoreDataFieldConfig = {
|
|
|
9181
9359
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/StoreDataField#config-complexMapping)
|
|
9182
9360
|
*/
|
|
9183
9361
|
complexMapping?: boolean
|
|
9362
|
+
/**
|
|
9363
|
+
* A function which transforms a data value into the desired form for storage in the record's data object.
|
|
9364
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/StoreDataField#config-convert)
|
|
9365
|
+
* @param {any} value The value to convert for storage in a record.
|
|
9366
|
+
* @param {object} data The raw record data object
|
|
9367
|
+
* @returns {any} The converted value.
|
|
9368
|
+
*/
|
|
9369
|
+
convert?: (value: any, data: object) => any
|
|
9184
9370
|
/**
|
|
9185
9371
|
* The property in a record's data object that contains the field's value.
|
|
9186
9372
|
* Defaults to the field's `name`.
|
|
@@ -9244,6 +9430,14 @@ type StoreDataFieldConfig = {
|
|
|
9244
9430
|
* Set to `true` for the field's set accessor to ignore attempts to set this field.
|
|
9245
9431
|
*/
|
|
9246
9432
|
readOnly?: boolean
|
|
9433
|
+
/**
|
|
9434
|
+
* A function which transforms a data value into the desired form for transmitting to a server.
|
|
9435
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/StoreDataField#config-serialize)
|
|
9436
|
+
* @param {any} value The value to serialize
|
|
9437
|
+
* @param {Core.data.Model} record The record that contains the value being serialized.
|
|
9438
|
+
* @returns {any} The serialized value.
|
|
9439
|
+
*/
|
|
9440
|
+
serialize?: (value: any, record: Model) => any
|
|
9247
9441
|
/**
|
|
9248
9442
|
* Optional store configuration object to apply when creating the store.
|
|
9249
9443
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/StoreDataField#config-store)
|
|
@@ -9327,6 +9521,14 @@ type StringDataFieldConfig = {
|
|
|
9327
9521
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/StringDataField#config-complexMapping)
|
|
9328
9522
|
*/
|
|
9329
9523
|
complexMapping?: boolean
|
|
9524
|
+
/**
|
|
9525
|
+
* A function which transforms a data value into the desired form for storage in the record's data object.
|
|
9526
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/StringDataField#config-convert)
|
|
9527
|
+
* @param {any} value The value to convert for storage in a record.
|
|
9528
|
+
* @param {object} data The raw record data object
|
|
9529
|
+
* @returns {any} The converted value.
|
|
9530
|
+
*/
|
|
9531
|
+
convert?: (value: any, data: object) => any
|
|
9330
9532
|
/**
|
|
9331
9533
|
* The property in a record's data object that contains the field's value.
|
|
9332
9534
|
* Defaults to the field's `name`.
|
|
@@ -9384,6 +9586,14 @@ type StringDataFieldConfig = {
|
|
|
9384
9586
|
* Set to `true` for the field's set accessor to ignore attempts to set this field.
|
|
9385
9587
|
*/
|
|
9386
9588
|
readOnly?: boolean
|
|
9589
|
+
/**
|
|
9590
|
+
* A function which transforms a data value into the desired form for transmitting to a server.
|
|
9591
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/data/field/StringDataField#config-serialize)
|
|
9592
|
+
* @param {any} value The value to serialize
|
|
9593
|
+
* @param {Core.data.Model} record The record that contains the value being serialized.
|
|
9594
|
+
* @returns {any} The serialized value.
|
|
9595
|
+
*/
|
|
9596
|
+
serialize?: (value: any, record: Model) => any
|
|
9387
9597
|
}
|
|
9388
9598
|
|
|
9389
9599
|
/**
|
|
@@ -10849,7 +11059,7 @@ export class TreeNodeClass {
|
|
|
10849
11059
|
*/
|
|
10850
11060
|
readonly children: boolean|object[]|Model[]|ModelConfig[]
|
|
10851
11061
|
/**
|
|
10852
|
-
* Count all children (including sub-children) for a node (in its `firstStore
|
|
11062
|
+
* Count all children (including sub-children) for a node (in its `firstStore`)
|
|
10853
11063
|
*/
|
|
10854
11064
|
descendantCount: number
|
|
10855
11065
|
/**
|
|
@@ -11553,11 +11763,11 @@ export class StateTrackingManager extends Base {
|
|
|
11553
11763
|
* Redoes current undo/redo transaction.
|
|
11554
11764
|
* @param {number} [steps]
|
|
11555
11765
|
*/
|
|
11556
|
-
redo(steps?: number): Promise<
|
|
11766
|
+
redo(steps?: number): Promise<void>;
|
|
11557
11767
|
/**
|
|
11558
11768
|
* Redoes all transactions.
|
|
11559
11769
|
*/
|
|
11560
|
-
redoAll(): Promise<
|
|
11770
|
+
redoAll(): Promise<void>;
|
|
11561
11771
|
/**
|
|
11562
11772
|
* Rejects currently recorded transaction.
|
|
11563
11773
|
*/
|
|
@@ -11639,11 +11849,11 @@ export class StateTrackingManager extends Base {
|
|
|
11639
11849
|
* Undoes current undo/redo transaction.
|
|
11640
11850
|
* @param {number} [steps]
|
|
11641
11851
|
*/
|
|
11642
|
-
undo(steps?: number): Promise<
|
|
11852
|
+
undo(steps?: number): Promise<void>;
|
|
11643
11853
|
/**
|
|
11644
11854
|
* Undoes all transactions.
|
|
11645
11855
|
*/
|
|
11646
|
-
undoAll(): Promise<
|
|
11856
|
+
undoAll(): Promise<void>;
|
|
11647
11857
|
}
|
|
11648
11858
|
|
|
11649
11859
|
/**
|
|
@@ -13761,20 +13971,25 @@ export class AjaxHelper {
|
|
|
13761
13971
|
*/
|
|
13762
13972
|
static DEFAULT_FETCH_OPTIONS: FetchOptions
|
|
13763
13973
|
/**
|
|
13764
|
-
* Fetch the specified resource using the `fetch` API.
|
|
13974
|
+
* Fetch the specified resource using the `fetch` API. Resolves to a [AjaxResponse](https://bryntum.com/products/grid/docs/api/Core/helper/AjaxHelper#typedef-AjaxResponse) — the native
|
|
13975
|
+
* `Response` extended with `parsedJson` when `parseJson : true` is set in the [FetchOptions](https://bryntum.com/products/grid/docs/api/Core/helper/AjaxHelper#typedef-FetchOptions).
|
|
13976
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/helper/AjaxHelper#function-fetch)
|
|
13765
13977
|
* @param {string} url URL to fetch from
|
|
13766
13978
|
* @param {FetchOptions} [options] The options for the `fetch` API
|
|
13767
13979
|
*/
|
|
13768
|
-
static fetch(url: string, options?: FetchOptions): Promise<
|
|
13980
|
+
static fetch(url: string, options?: FetchOptions): Promise<AjaxResponse>;
|
|
13769
13981
|
/**
|
|
13770
|
-
* Make a request (using GET) to the specified url.
|
|
13982
|
+
* Make a request (using GET) to the specified url. Resolves to a [AjaxResponse](https://bryntum.com/products/grid/docs/api/Core/helper/AjaxHelper#typedef-AjaxResponse); pass `parseJson : true`
|
|
13983
|
+
* in the [FetchOptions](https://bryntum.com/products/grid/docs/api/Core/helper/AjaxHelper#typedef-FetchOptions) to have the response body parsed and exposed as `parsedJson`.
|
|
13984
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/helper/AjaxHelper#function-get)
|
|
13771
13985
|
* @param {string} url URL to `GET` from
|
|
13772
13986
|
* @param {FetchOptions} [options] The options for the `fetch` API
|
|
13773
13987
|
*/
|
|
13774
|
-
static get(url: string, options?: FetchOptions): Promise<
|
|
13988
|
+
static get(url: string, options?: FetchOptions): Promise<AjaxResponse>;
|
|
13775
13989
|
/**
|
|
13776
13990
|
* Registers the passed URL to return the passed mocked up Fetch Response object to the
|
|
13777
13991
|
* AjaxHelper's promise resolve function.
|
|
13992
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/helper/AjaxHelper#function-mockUrl)
|
|
13778
13993
|
* @param {string} url The url to return mock data for
|
|
13779
13994
|
* @param {object,Function} response A mocked up Fetch Response object which must contain at least a `responseText` property, or a function to which the `url` and a `params` object, and the `Fetch` `options` object is passed which returns that
|
|
13780
13995
|
* @param {string} [response.url] Fetch url
|
|
@@ -13786,12 +14001,14 @@ export class AjaxHelper {
|
|
|
13786
14001
|
*/
|
|
13787
14002
|
static mockUrl(url: string, response: object|((url?: string, responseText?: string, params?: object, synchronous?: boolean, delay?: number) => object)): void;
|
|
13788
14003
|
/**
|
|
13789
|
-
* POST data to the specified URL.
|
|
14004
|
+
* POST data to the specified URL. Resolves to a [AjaxResponse](https://bryntum.com/products/grid/docs/api/Core/helper/AjaxHelper#typedef-AjaxResponse); pass `parseJson : true` in the
|
|
14005
|
+
* [FetchOptions](https://bryntum.com/products/grid/docs/api/Core/helper/AjaxHelper#typedef-FetchOptions) to have the response body parsed and exposed as `parsedJson`.
|
|
14006
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/helper/AjaxHelper#function-post)
|
|
13790
14007
|
* @param {string} url URL to `POST` to
|
|
13791
14008
|
* @param {string,object,FormData} payload The data to post. If an object is supplied, it will be stringified
|
|
13792
14009
|
* @param {FetchOptions} [options] The options for the `fetch` API
|
|
13793
14010
|
*/
|
|
13794
|
-
static post(url: string, payload: string|object|FormData, options?: FetchOptions): Promise<
|
|
14011
|
+
static post(url: string, payload: string|object|FormData, options?: FetchOptions): Promise<AjaxResponse>;
|
|
13795
14012
|
}
|
|
13796
14013
|
|
|
13797
14014
|
/**
|
|
@@ -14479,8 +14696,9 @@ export class DomHelper {
|
|
|
14479
14696
|
* Resolves element from point, checking shadow DOM if required
|
|
14480
14697
|
* @param {number} x
|
|
14481
14698
|
* @param {number} y
|
|
14699
|
+
* @param {Document,ShadowRoot} [root] Root node to resolve from. Defaults to the document. Pass a widget's `documentRoot` to keep hit testing inside its shadow tree (required for LWC / Salesforce).
|
|
14482
14700
|
*/
|
|
14483
|
-
static elementFromPoint(x: number, y: number): HTMLElement;
|
|
14701
|
+
static elementFromPoint(x: number, y: number, root?: Document|ShadowRoot): HTMLElement;
|
|
14484
14702
|
/**
|
|
14485
14703
|
* Iterates over the direct child elements of the specified element.
|
|
14486
14704
|
* @param {HTMLElement} element Parent element
|
|
@@ -16014,6 +16232,11 @@ export class DataGenerator {
|
|
|
16014
16232
|
* Array with available food values
|
|
16015
16233
|
*/
|
|
16016
16234
|
static readonly foods: string[]
|
|
16235
|
+
/**
|
|
16236
|
+
* Array with hex color values, parallel to [colors](https://bryntum.com/products/grid/docs/api/Core/helper/util/DataGenerator#property-colors-static) (same length and
|
|
16237
|
+
* order). Use the index of a name in `colors` to look up its hex value here.
|
|
16238
|
+
*/
|
|
16239
|
+
static readonly hexColors: string[]
|
|
16017
16240
|
/**
|
|
16018
16241
|
* Array with available skill values
|
|
16019
16242
|
*/
|
|
@@ -16084,6 +16307,10 @@ export class DataGenerator {
|
|
|
16084
16307
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/helper/util/DomClassList)
|
|
16085
16308
|
*/
|
|
16086
16309
|
export class DomClassList {
|
|
16310
|
+
/**
|
|
16311
|
+
* The number of CSS class names in this `DomClassList`.
|
|
16312
|
+
*/
|
|
16313
|
+
readonly length: number
|
|
16087
16314
|
/**
|
|
16088
16315
|
* Get/set string value.
|
|
16089
16316
|
* Class names separated with space.
|
|
@@ -16098,6 +16325,12 @@ export class DomClassList {
|
|
|
16098
16325
|
* @param {string,object} classes The CSS classes as strings or objects.
|
|
16099
16326
|
*/
|
|
16100
16327
|
constructor(classes: string|object);
|
|
16328
|
+
/**
|
|
16329
|
+
* Converts a class name of any understood type to a desired form.
|
|
16330
|
+
* @param {string,string[],object,Set<any>,Map<any, any>,HTMLElement} cls
|
|
16331
|
+
* @param {string} as Pass `'object'` to return an object with the class names as its keys (all keys will have a value of `true`), or pass `'array'` to return an array of class names, or pass `'string'` (the default) to return a space-separated string of class names.
|
|
16332
|
+
*/
|
|
16333
|
+
static normalize(cls: string|string[]|object|Set<any>|Map<any, any>|HTMLElement, as?: string): string|string[]|object;
|
|
16101
16334
|
/**
|
|
16102
16335
|
* Add CSS class(es)
|
|
16103
16336
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/helper/util/DomClassList#function-add)
|
|
@@ -16494,7 +16727,7 @@ export class Rectangle {
|
|
|
16494
16727
|
* @param {number[]} [spec.anchorSize] The `[width, height]` of the anchor pointer when in `top` position. The width is the baseline length, and the height is the height of the arrow. If passed, the anchor position will be calculated to be at the centre of the overlap of the two aligned edges and returned in the `anchor` property of the resulting Rectangle: ```javascript { edge: 'top', // or 'right' or 'bottom' or 'left' x/y: offset // dimension to translate and value to translate by. } ```
|
|
16495
16728
|
* @param {object} [spec.anchorPosition] an `{ x: n, y: n }` anchor translation to be used <em>if the requested alignment succeeds without violating constraints</em>. If a fallback alignment is used, the anchor will be centered in the overlap of the aligned edges as usual.
|
|
16496
16729
|
* @param {boolean} [spec.overlap] True to allow this to overlap the target.
|
|
16497
|
-
* @param {string} spec.align The edge alignment specification string, specifying two points to bring together. Each point is described by an edge initial (`t` for top edge, `b` for bottom edge etc) followed by a percentage along that edge. So the form would be `[trblc][n]-[trblc][n].` The `n` is the percentage offset along that edge which defines the alignment point. This is not valid for alignment point `c` which means the center point. For example `t0-b0
|
|
16730
|
+
* @param {string} spec.align The edge alignment specification string, specifying two points to bring together. Each point is described by an edge initial (`t` for top edge, `b` for bottom edge etc) followed by a percentage along that edge. So the form would be `[trblc][n]-[trblc][n].` The `n` is the percentage offset along that edge which defines the alignment point. This is not valid for alignment point `c` which means the center point. For example `t0-b0` would align this Rectangle's top left corner with the bottom left corner of the `target`.
|
|
16498
16731
|
* @param {HTMLElement,Core.widget.Widget,Core.helper.util.Rectangle} [spec.constrainTo] The Widget or Element or Rectangle to constrain to. If the requested alignment cannot be constrained (it will first shrink the resulting Rectangle according to the `minWidth` and `minHeight` properties of this rectangle), then it will try aligning at other edges (honouring the `axisLock` option), and pick the fallback alignment which results in the shortest translation.
|
|
16499
16732
|
* @param {boolean} [spec.axisLock] Specify as a truthy value to fall back to aligning against the opposite edge first if the requested alignment cannot be constrained into the `constrainTo` option. If specified as `'flexible'`, then fallback will continue searching for solutions on the remaining two sides.
|
|
16500
16733
|
* @param {boolean,'min'} [spec.matchSize] When aligning edge-to-edge, match the length of the aligned-to edge of the target. Setting this value to `'min'` means that the resulting aligned Rectangle will *grow* to the size of the aligned-to edge if it is smaller, but will not *shrink* to match the aligned-to edge. This is only honored when `axisLock` is enabled and alignment succeeds on the requested axis. If <strong>not</strong> aligning edge-to-edge, `matchSize` matches both dimensions of the target.
|
|
@@ -17079,7 +17312,7 @@ export class LocaleManagerSingleton {
|
|
|
17079
17312
|
* Get/set currently used locale.
|
|
17080
17313
|
* Setter calls [applyLocale](https://bryntum.com/products/grid/docs/api/Core/localization/LocaleManager#function-applyLocale).
|
|
17081
17314
|
*/
|
|
17082
|
-
locale: string|Locale
|
|
17315
|
+
locale: string|Locale
|
|
17083
17316
|
/**
|
|
17084
17317
|
* Get/set currently registered locales.
|
|
17085
17318
|
* Alias for [LocaleHelper.locales](https://bryntum.com/products/grid/docs/api/Core/localization/LocaleHelper#property-locales-static).
|
|
@@ -17868,7 +18101,7 @@ export const LoadMaskable : <T extends AnyConstructor<Base>>(base : T) => AnyCon
|
|
|
17868
18101
|
|
|
17869
18102
|
/**
|
|
17870
18103
|
* Simplifies overriding class methods by allowing methods from another class to be used as overrides. Overrides are
|
|
17871
|
-
* defined as own classes. They must at a minimum contain a static getter named `target
|
|
18104
|
+
* defined as own classes. They must at a minimum contain a static getter named `target`, which should return an object
|
|
17872
18105
|
* with the class to override. Apply the override by calling [apply()](https://bryntum.com/products/grid/docs/api/Core/mixin/Override#function-apply-static).
|
|
17873
18106
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/mixin/Override)
|
|
17874
18107
|
*/
|
|
@@ -18325,9 +18558,9 @@ export class StateProvider {
|
|
|
18325
18558
|
* Initializes the default `StateProvider` instance for the page. This method can be passed an instance or one of
|
|
18326
18559
|
* the following type aliases:
|
|
18327
18560
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/state/StateProvider#function-setup)
|
|
18328
|
-
* @param {'local','memory',Core.state.StateProvider} inst The
|
|
18561
|
+
* @param {'local','memory',Core.state.StateProvider,StateProviderConfig} inst The storage type (`'local'` or `'memory'`), a `StateProviderConfig` object, or the `StateProvider` instance.
|
|
18329
18562
|
*/
|
|
18330
|
-
static setup(inst: 'local'|'memory'|StateProvider): StateProvider;
|
|
18563
|
+
static setup(inst: 'local'|'memory'|StateProvider|StateProviderConfig): StateProvider;
|
|
18331
18564
|
/**
|
|
18332
18565
|
* Adds an event listener. This method accepts parameters in the following format:
|
|
18333
18566
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/state/StateProvider#function-addListener)
|
|
@@ -20185,9 +20418,10 @@ type BooleanComboConfig = {
|
|
|
20185
20418
|
catchEventHandlerExceptions?: boolean
|
|
20186
20419
|
/**
|
|
20187
20420
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
20188
|
-
*
|
|
20421
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-centered)
|
|
20422
|
+
* @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.
|
|
20189
20423
|
*/
|
|
20190
|
-
centered?: boolean
|
|
20424
|
+
centered?: boolean|object
|
|
20191
20425
|
/**
|
|
20192
20426
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
20193
20427
|
* 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)
|
|
@@ -20219,6 +20453,7 @@ type BooleanComboConfig = {
|
|
|
20219
20453
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
20220
20454
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
20221
20455
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
20456
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-clearable)
|
|
20222
20457
|
*/
|
|
20223
20458
|
clearable?: boolean|FieldTriggerConfig
|
|
20224
20459
|
/**
|
|
@@ -20322,7 +20557,7 @@ type BooleanComboConfig = {
|
|
|
20322
20557
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
20323
20558
|
/**
|
|
20324
20559
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
20325
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
20560
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
20326
20561
|
* property which controls when a drag should start.
|
|
20327
20562
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-draggable)
|
|
20328
20563
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -20784,7 +21019,7 @@ type BooleanComboConfig = {
|
|
|
20784
21019
|
rtl?: boolean
|
|
20785
21020
|
/**
|
|
20786
21021
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
20787
|
-
* Valid values:
|
|
21022
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
20788
21023
|
*/
|
|
20789
21024
|
scrollAction?: 'hide'|'realign'|null
|
|
20790
21025
|
/**
|
|
@@ -21506,9 +21741,10 @@ type ButtonConfig = {
|
|
|
21506
21741
|
catchEventHandlerExceptions?: boolean
|
|
21507
21742
|
/**
|
|
21508
21743
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
21509
|
-
*
|
|
21744
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-centered)
|
|
21745
|
+
* @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.
|
|
21510
21746
|
*/
|
|
21511
|
-
centered?: boolean
|
|
21747
|
+
centered?: boolean|object
|
|
21512
21748
|
/**
|
|
21513
21749
|
* Custom CSS classes to add to element.
|
|
21514
21750
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -21581,7 +21817,7 @@ type ButtonConfig = {
|
|
|
21581
21817
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
21582
21818
|
/**
|
|
21583
21819
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
21584
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
21820
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
21585
21821
|
* property which controls when a drag should start.
|
|
21586
21822
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-draggable)
|
|
21587
21823
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -21837,7 +22073,7 @@ type ButtonConfig = {
|
|
|
21837
22073
|
rtl?: boolean
|
|
21838
22074
|
/**
|
|
21839
22075
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
21840
|
-
* Valid values:
|
|
22076
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
21841
22077
|
*/
|
|
21842
22078
|
scrollAction?: 'hide'|'realign'|null
|
|
21843
22079
|
/**
|
|
@@ -22661,9 +22897,10 @@ type ButtonGroupConfig = {
|
|
|
22661
22897
|
catchEventHandlerExceptions?: boolean
|
|
22662
22898
|
/**
|
|
22663
22899
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
22664
|
-
*
|
|
22900
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ButtonGroup#config-centered)
|
|
22901
|
+
* @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.
|
|
22665
22902
|
*/
|
|
22666
|
-
centered?: boolean
|
|
22903
|
+
centered?: boolean|object
|
|
22667
22904
|
/**
|
|
22668
22905
|
* Custom CSS class to add to element.
|
|
22669
22906
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ButtonGroup#config-cls)
|
|
@@ -22745,7 +22982,7 @@ type ButtonGroupConfig = {
|
|
|
22745
22982
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
22746
22983
|
/**
|
|
22747
22984
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
22748
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
22985
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
22749
22986
|
* property which controls when a drag should start.
|
|
22750
22987
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ButtonGroup#config-draggable)
|
|
22751
22988
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -22850,7 +23087,7 @@ type ButtonGroupConfig = {
|
|
|
22850
23087
|
*/
|
|
22851
23088
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
22852
23089
|
/**
|
|
22853
|
-
* Sets `labelWidth
|
|
23090
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
22854
23091
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ButtonGroup#config-labelWidth)
|
|
22855
23092
|
*/
|
|
22856
23093
|
labelWidth?: number|null
|
|
@@ -23019,7 +23256,7 @@ type ButtonGroupConfig = {
|
|
|
23019
23256
|
rtl?: boolean
|
|
23020
23257
|
/**
|
|
23021
23258
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
23022
|
-
* Valid values:
|
|
23259
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
23023
23260
|
*/
|
|
23024
23261
|
scrollAction?: 'hide'|'realign'|null
|
|
23025
23262
|
/**
|
|
@@ -23857,9 +24094,10 @@ type CalendarPanelConfig = {
|
|
|
23857
24094
|
cellRenderer?: ((context: { cell: HTMLElement, date: Date, day: number, rowIndex: number[], row: HTMLElement, source: CalendarPanel, cellIndex: number[], columnIndex: number[], visibleColumnIndex: number[] }) => string|DomConfig|void)|string
|
|
23858
24095
|
/**
|
|
23859
24096
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
23860
|
-
*
|
|
24097
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CalendarPanel#config-centered)
|
|
24098
|
+
* @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.
|
|
23861
24099
|
*/
|
|
23862
|
-
centered?: boolean
|
|
24100
|
+
centered?: boolean|object
|
|
23863
24101
|
/**
|
|
23864
24102
|
* Custom CSS classes to add to element.
|
|
23865
24103
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -23989,7 +24227,7 @@ type CalendarPanelConfig = {
|
|
|
23989
24227
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
23990
24228
|
/**
|
|
23991
24229
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
23992
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
24230
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
23993
24231
|
* property which controls when a drag should start.
|
|
23994
24232
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CalendarPanel#config-draggable)
|
|
23995
24233
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -24141,7 +24379,7 @@ type CalendarPanelConfig = {
|
|
|
24141
24379
|
*/
|
|
24142
24380
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
24143
24381
|
/**
|
|
24144
|
-
* Sets `labelWidth
|
|
24382
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
24145
24383
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CalendarPanel#config-labelWidth)
|
|
24146
24384
|
*/
|
|
24147
24385
|
labelWidth?: number|null
|
|
@@ -24339,7 +24577,7 @@ type CalendarPanelConfig = {
|
|
|
24339
24577
|
rtl?: boolean
|
|
24340
24578
|
/**
|
|
24341
24579
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
24342
|
-
* Valid values:
|
|
24580
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
24343
24581
|
*/
|
|
24344
24582
|
scrollAction?: 'hide'|'realign'|null
|
|
24345
24583
|
/**
|
|
@@ -25274,9 +25512,10 @@ type CarouselConfig = {
|
|
|
25274
25512
|
catchEventHandlerExceptions?: boolean
|
|
25275
25513
|
/**
|
|
25276
25514
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
25277
|
-
*
|
|
25515
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Carousel#config-centered)
|
|
25516
|
+
* @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.
|
|
25278
25517
|
*/
|
|
25279
|
-
centered?: boolean
|
|
25518
|
+
centered?: boolean|object
|
|
25280
25519
|
/**
|
|
25281
25520
|
* Custom CSS classes to add to element.
|
|
25282
25521
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -25393,7 +25632,7 @@ type CarouselConfig = {
|
|
|
25393
25632
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
25394
25633
|
/**
|
|
25395
25634
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
25396
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
25635
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
25397
25636
|
* property which controls when a drag should start.
|
|
25398
25637
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Carousel#config-draggable)
|
|
25399
25638
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -25542,7 +25781,7 @@ type CarouselConfig = {
|
|
|
25542
25781
|
*/
|
|
25543
25782
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
25544
25783
|
/**
|
|
25545
|
-
* Sets `labelWidth
|
|
25784
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
25546
25785
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Carousel#config-labelWidth)
|
|
25547
25786
|
*/
|
|
25548
25787
|
labelWidth?: number|null
|
|
@@ -25725,7 +25964,7 @@ type CarouselConfig = {
|
|
|
25725
25964
|
rtl?: boolean
|
|
25726
25965
|
/**
|
|
25727
25966
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
25728
|
-
* Valid values:
|
|
25967
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
25729
25968
|
*/
|
|
25730
25969
|
scrollAction?: 'hide'|'realign'|null
|
|
25731
25970
|
/**
|
|
@@ -26652,9 +26891,10 @@ type CheckboxConfig = {
|
|
|
26652
26891
|
catchEventHandlerExceptions?: boolean
|
|
26653
26892
|
/**
|
|
26654
26893
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
26655
|
-
*
|
|
26894
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Checkbox#config-centered)
|
|
26895
|
+
* @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.
|
|
26656
26896
|
*/
|
|
26657
|
-
centered?: boolean
|
|
26897
|
+
centered?: boolean|object
|
|
26658
26898
|
/**
|
|
26659
26899
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
26660
26900
|
* 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)
|
|
@@ -26752,7 +26992,7 @@ type CheckboxConfig = {
|
|
|
26752
26992
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
26753
26993
|
/**
|
|
26754
26994
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
26755
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
26995
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
26756
26996
|
* property which controls when a drag should start.
|
|
26757
26997
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Checkbox#config-draggable)
|
|
26758
26998
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -27060,7 +27300,7 @@ type CheckboxConfig = {
|
|
|
27060
27300
|
rtl?: boolean
|
|
27061
27301
|
/**
|
|
27062
27302
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
27063
|
-
* Valid values:
|
|
27303
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
27064
27304
|
*/
|
|
27065
27305
|
scrollAction?: 'hide'|'realign'|null
|
|
27066
27306
|
/**
|
|
@@ -27887,9 +28127,10 @@ type CheckboxGroupConfig = {
|
|
|
27887
28127
|
catchEventHandlerExceptions?: boolean
|
|
27888
28128
|
/**
|
|
27889
28129
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
27890
|
-
*
|
|
28130
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-centered)
|
|
28131
|
+
* @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.
|
|
27891
28132
|
*/
|
|
27892
|
-
centered?: boolean
|
|
28133
|
+
centered?: boolean|object
|
|
27893
28134
|
/**
|
|
27894
28135
|
* Custom CSS classes to add to element.
|
|
27895
28136
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -27984,7 +28225,7 @@ type CheckboxGroupConfig = {
|
|
|
27984
28225
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
27985
28226
|
/**
|
|
27986
28227
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
27987
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
28228
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
27988
28229
|
* property which controls when a drag should start.
|
|
27989
28230
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-draggable)
|
|
27990
28231
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -28137,7 +28378,7 @@ type CheckboxGroupConfig = {
|
|
|
28137
28378
|
*/
|
|
28138
28379
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
28139
28380
|
/**
|
|
28140
|
-
* Sets `labelWidth
|
|
28381
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
28141
28382
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-labelWidth)
|
|
28142
28383
|
*/
|
|
28143
28384
|
labelWidth?: number|null
|
|
@@ -28334,7 +28575,7 @@ type CheckboxGroupConfig = {
|
|
|
28334
28575
|
rtl?: boolean
|
|
28335
28576
|
/**
|
|
28336
28577
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
28337
|
-
* Valid values:
|
|
28578
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
28338
28579
|
*/
|
|
28339
28580
|
scrollAction?: 'hide'|'realign'|null
|
|
28340
28581
|
/**
|
|
@@ -29135,9 +29376,10 @@ type ChipViewConfig = {
|
|
|
29135
29376
|
catchEventHandlerExceptions?: boolean
|
|
29136
29377
|
/**
|
|
29137
29378
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
29138
|
-
*
|
|
29379
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-centered)
|
|
29380
|
+
* @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.
|
|
29139
29381
|
*/
|
|
29140
|
-
centered?: boolean
|
|
29382
|
+
centered?: boolean|object
|
|
29141
29383
|
/**
|
|
29142
29384
|
* Configure as `true` to clear selection when clicking on empty space inside the List´s element.
|
|
29143
29385
|
*/
|
|
@@ -29236,7 +29478,7 @@ type ChipViewConfig = {
|
|
|
29236
29478
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
29237
29479
|
/**
|
|
29238
29480
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
29239
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
29481
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
29240
29482
|
* property which controls when a drag should start.
|
|
29241
29483
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-draggable)
|
|
29242
29484
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -29502,7 +29744,7 @@ type ChipViewConfig = {
|
|
|
29502
29744
|
rtl?: boolean
|
|
29503
29745
|
/**
|
|
29504
29746
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
29505
|
-
* Valid values:
|
|
29747
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
29506
29748
|
*/
|
|
29507
29749
|
scrollAction?: 'hide'|'realign'|null
|
|
29508
29750
|
/**
|
|
@@ -30212,9 +30454,10 @@ type CodeEditorConfig = {
|
|
|
30212
30454
|
catchEventHandlerExceptions?: boolean
|
|
30213
30455
|
/**
|
|
30214
30456
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
30215
|
-
*
|
|
30457
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CodeEditor#config-centered)
|
|
30458
|
+
* @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.
|
|
30216
30459
|
*/
|
|
30217
|
-
centered?: boolean
|
|
30460
|
+
centered?: boolean|object
|
|
30218
30461
|
/**
|
|
30219
30462
|
* Custom CSS classes to add to element.
|
|
30220
30463
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -30314,7 +30557,7 @@ type CodeEditorConfig = {
|
|
|
30314
30557
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
30315
30558
|
/**
|
|
30316
30559
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
30317
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
30560
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
30318
30561
|
* property which controls when a drag should start.
|
|
30319
30562
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CodeEditor#config-draggable)
|
|
30320
30563
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -30457,7 +30700,7 @@ type CodeEditorConfig = {
|
|
|
30457
30700
|
*/
|
|
30458
30701
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
30459
30702
|
/**
|
|
30460
|
-
* Sets `labelWidth
|
|
30703
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
30461
30704
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CodeEditor#config-labelWidth)
|
|
30462
30705
|
*/
|
|
30463
30706
|
labelWidth?: number|null
|
|
@@ -30630,7 +30873,7 @@ type CodeEditorConfig = {
|
|
|
30630
30873
|
rtl?: boolean
|
|
30631
30874
|
/**
|
|
30632
30875
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
30633
|
-
* Valid values:
|
|
30876
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
30634
30877
|
*/
|
|
30635
30878
|
scrollAction?: 'hide'|'realign'|null
|
|
30636
30879
|
/**
|
|
@@ -31452,9 +31695,10 @@ type ColorFieldConfig = {
|
|
|
31452
31695
|
catchEventHandlerExceptions?: boolean
|
|
31453
31696
|
/**
|
|
31454
31697
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
31455
|
-
*
|
|
31698
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-centered)
|
|
31699
|
+
* @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.
|
|
31456
31700
|
*/
|
|
31457
|
-
centered?: boolean
|
|
31701
|
+
centered?: boolean|object
|
|
31458
31702
|
/**
|
|
31459
31703
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
31460
31704
|
* 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)
|
|
@@ -31468,6 +31712,7 @@ type ColorFieldConfig = {
|
|
|
31468
31712
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
31469
31713
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
31470
31714
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
31715
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-clearable)
|
|
31471
31716
|
*/
|
|
31472
31717
|
clearable?: boolean|FieldTriggerConfig
|
|
31473
31718
|
/**
|
|
@@ -31551,7 +31796,7 @@ type ColorFieldConfig = {
|
|
|
31551
31796
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
31552
31797
|
/**
|
|
31553
31798
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
31554
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
31799
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
31555
31800
|
* property which controls when a drag should start.
|
|
31556
31801
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-draggable)
|
|
31557
31802
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -31880,7 +32125,7 @@ type ColorFieldConfig = {
|
|
|
31880
32125
|
rtl?: boolean
|
|
31881
32126
|
/**
|
|
31882
32127
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
31883
|
-
* Valid values:
|
|
32128
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
31884
32129
|
*/
|
|
31885
32130
|
scrollAction?: 'hide'|'realign'|null
|
|
31886
32131
|
/**
|
|
@@ -32586,9 +32831,10 @@ type ColorPickerConfig = {
|
|
|
32586
32831
|
catchEventHandlerExceptions?: boolean
|
|
32587
32832
|
/**
|
|
32588
32833
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
32589
|
-
*
|
|
32834
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorPicker#config-centered)
|
|
32835
|
+
* @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.
|
|
32590
32836
|
*/
|
|
32591
|
-
centered?: boolean
|
|
32837
|
+
centered?: boolean|object
|
|
32592
32838
|
/**
|
|
32593
32839
|
* Configure as `true` to clear selection when clicking on empty space inside the List´s element.
|
|
32594
32840
|
*/
|
|
@@ -32692,7 +32938,7 @@ type ColorPickerConfig = {
|
|
|
32692
32938
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
32693
32939
|
/**
|
|
32694
32940
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
32695
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
32941
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
32696
32942
|
* property which controls when a drag should start.
|
|
32697
32943
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorPicker#config-draggable)
|
|
32698
32944
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -32951,7 +33197,7 @@ type ColorPickerConfig = {
|
|
|
32951
33197
|
rtl?: boolean
|
|
32952
33198
|
/**
|
|
32953
33199
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
32954
|
-
* Valid values:
|
|
33200
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
32955
33201
|
*/
|
|
32956
33202
|
scrollAction?: 'hide'|'realign'|null
|
|
32957
33203
|
/**
|
|
@@ -33698,9 +33944,10 @@ type ComboConfig = {
|
|
|
33698
33944
|
catchEventHandlerExceptions?: boolean
|
|
33699
33945
|
/**
|
|
33700
33946
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
33701
|
-
*
|
|
33947
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-centered)
|
|
33948
|
+
* @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.
|
|
33702
33949
|
*/
|
|
33703
|
-
centered?: boolean
|
|
33950
|
+
centered?: boolean|object
|
|
33704
33951
|
/**
|
|
33705
33952
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
33706
33953
|
* 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)
|
|
@@ -33732,6 +33979,7 @@ type ComboConfig = {
|
|
|
33732
33979
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
33733
33980
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
33734
33981
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
33982
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-clearable)
|
|
33735
33983
|
*/
|
|
33736
33984
|
clearable?: boolean|FieldTriggerConfig
|
|
33737
33985
|
/**
|
|
@@ -33835,7 +34083,7 @@ type ComboConfig = {
|
|
|
33835
34083
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
33836
34084
|
/**
|
|
33837
34085
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
33838
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
34086
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
33839
34087
|
* property which controls when a drag should start.
|
|
33840
34088
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-draggable)
|
|
33841
34089
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -34281,7 +34529,7 @@ type ComboConfig = {
|
|
|
34281
34529
|
rtl?: boolean
|
|
34282
34530
|
/**
|
|
34283
34531
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
34284
|
-
* Valid values:
|
|
34532
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
34285
34533
|
*/
|
|
34286
34534
|
scrollAction?: 'hide'|'realign'|null
|
|
34287
34535
|
/**
|
|
@@ -35084,9 +35332,10 @@ type ConfirmationBarConfig = {
|
|
|
35084
35332
|
catchEventHandlerExceptions?: boolean
|
|
35085
35333
|
/**
|
|
35086
35334
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
35087
|
-
*
|
|
35335
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ConfirmationBar#config-centered)
|
|
35336
|
+
* @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.
|
|
35088
35337
|
*/
|
|
35089
|
-
centered?: boolean
|
|
35338
|
+
centered?: boolean|object
|
|
35090
35339
|
/**
|
|
35091
35340
|
* Custom CSS classes to add to element.
|
|
35092
35341
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -35175,7 +35424,7 @@ type ConfirmationBarConfig = {
|
|
|
35175
35424
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
35176
35425
|
/**
|
|
35177
35426
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
35178
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
35427
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
35179
35428
|
* property which controls when a drag should start.
|
|
35180
35429
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ConfirmationBar#config-draggable)
|
|
35181
35430
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -35283,7 +35532,7 @@ type ConfirmationBarConfig = {
|
|
|
35283
35532
|
*/
|
|
35284
35533
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
35285
35534
|
/**
|
|
35286
|
-
* Sets `labelWidth
|
|
35535
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
35287
35536
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ConfirmationBar#config-labelWidth)
|
|
35288
35537
|
*/
|
|
35289
35538
|
labelWidth?: number|null
|
|
@@ -35458,7 +35707,7 @@ type ConfirmationBarConfig = {
|
|
|
35458
35707
|
rtl?: boolean
|
|
35459
35708
|
/**
|
|
35460
35709
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
35461
|
-
* Valid values:
|
|
35710
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
35462
35711
|
*/
|
|
35463
35712
|
scrollAction?: 'hide'|'realign'|null
|
|
35464
35713
|
/**
|
|
@@ -36133,9 +36382,10 @@ type ContainerConfig = {
|
|
|
36133
36382
|
catchEventHandlerExceptions?: boolean
|
|
36134
36383
|
/**
|
|
36135
36384
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
36136
|
-
*
|
|
36385
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-centered)
|
|
36386
|
+
* @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.
|
|
36137
36387
|
*/
|
|
36138
|
-
centered?: boolean
|
|
36388
|
+
centered?: boolean|object
|
|
36139
36389
|
/**
|
|
36140
36390
|
* Custom CSS classes to add to element.
|
|
36141
36391
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -36220,7 +36470,7 @@ type ContainerConfig = {
|
|
|
36220
36470
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
36221
36471
|
/**
|
|
36222
36472
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
36223
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
36473
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
36224
36474
|
* property which controls when a drag should start.
|
|
36225
36475
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-draggable)
|
|
36226
36476
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -36327,7 +36577,7 @@ type ContainerConfig = {
|
|
|
36327
36577
|
*/
|
|
36328
36578
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
36329
36579
|
/**
|
|
36330
|
-
* Sets `labelWidth
|
|
36580
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
36331
36581
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-labelWidth)
|
|
36332
36582
|
*/
|
|
36333
36583
|
labelWidth?: number|null
|
|
@@ -36497,7 +36747,7 @@ type ContainerConfig = {
|
|
|
36497
36747
|
rtl?: boolean
|
|
36498
36748
|
/**
|
|
36499
36749
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
36500
|
-
* Valid values:
|
|
36750
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
36501
36751
|
*/
|
|
36502
36752
|
scrollAction?: 'hide'|'realign'|null
|
|
36503
36753
|
/**
|
|
@@ -36763,7 +37013,7 @@ export class Container extends Widget {
|
|
|
36763
37013
|
*/
|
|
36764
37014
|
labelPosition: 'before'|'above'|'align-before'|'auto'|null
|
|
36765
37015
|
/**
|
|
36766
|
-
* Sets `labelWidth
|
|
37016
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
36767
37017
|
*/
|
|
36768
37018
|
labelWidth: number|null
|
|
36769
37019
|
/**
|
|
@@ -37309,9 +37559,10 @@ type DateFieldConfig = {
|
|
|
37309
37559
|
catchEventHandlerExceptions?: boolean
|
|
37310
37560
|
/**
|
|
37311
37561
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
37312
|
-
*
|
|
37562
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateField#config-centered)
|
|
37563
|
+
* @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.
|
|
37313
37564
|
*/
|
|
37314
|
-
centered?: boolean
|
|
37565
|
+
centered?: boolean|object
|
|
37315
37566
|
/**
|
|
37316
37567
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
37317
37568
|
* 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)
|
|
@@ -37325,6 +37576,7 @@ type DateFieldConfig = {
|
|
|
37325
37576
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
37326
37577
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
37327
37578
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
37579
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateField#config-clearable)
|
|
37328
37580
|
*/
|
|
37329
37581
|
clearable?: boolean|FieldTriggerConfig
|
|
37330
37582
|
/**
|
|
@@ -37407,7 +37659,7 @@ type DateFieldConfig = {
|
|
|
37407
37659
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
37408
37660
|
/**
|
|
37409
37661
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
37410
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
37662
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
37411
37663
|
* property which controls when a drag should start.
|
|
37412
37664
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateField#config-draggable)
|
|
37413
37665
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -37774,7 +38026,7 @@ type DateFieldConfig = {
|
|
|
37774
38026
|
rtl?: boolean
|
|
37775
38027
|
/**
|
|
37776
38028
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
37777
|
-
* Valid values:
|
|
38029
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
37778
38030
|
*/
|
|
37779
38031
|
scrollAction?: 'hide'|'realign'|null
|
|
37780
38032
|
/**
|
|
@@ -38678,9 +38930,10 @@ type DatePickerConfig = {
|
|
|
38678
38930
|
cellRenderer?: ((renderData: { cell: HTMLElement, innerCell: HTMLElement, cellPayload: HTMLElement, date: Date, day: number, rowIndex: number[], row: HTMLElement, source: CalendarPanel, cellIndex: number[], columnIndex: number[], visibleColumnIndex: number[] }) => string|DomConfig|void)|string
|
|
38679
38931
|
/**
|
|
38680
38932
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
38681
|
-
*
|
|
38933
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DatePicker#config-centered)
|
|
38934
|
+
* @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.
|
|
38682
38935
|
*/
|
|
38683
|
-
centered?: boolean
|
|
38936
|
+
centered?: boolean|object
|
|
38684
38937
|
/**
|
|
38685
38938
|
* Custom CSS classes to add to element.
|
|
38686
38939
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -38815,7 +39068,7 @@ type DatePickerConfig = {
|
|
|
38815
39068
|
dragSelect?: boolean
|
|
38816
39069
|
/**
|
|
38817
39070
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
38818
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
39071
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
38819
39072
|
* property which controls when a drag should start.
|
|
38820
39073
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DatePicker#config-draggable)
|
|
38821
39074
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -38986,7 +39239,7 @@ type DatePickerConfig = {
|
|
|
38986
39239
|
*/
|
|
38987
39240
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
38988
39241
|
/**
|
|
38989
|
-
* Sets `labelWidth
|
|
39242
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
38990
39243
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DatePicker#config-labelWidth)
|
|
38991
39244
|
*/
|
|
38992
39245
|
labelWidth?: number|null
|
|
@@ -39205,7 +39458,7 @@ type DatePickerConfig = {
|
|
|
39205
39458
|
rtl?: boolean
|
|
39206
39459
|
/**
|
|
39207
39460
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
39208
|
-
* Valid values:
|
|
39461
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
39209
39462
|
*/
|
|
39210
39463
|
scrollAction?: 'hide'|'realign'|null
|
|
39211
39464
|
/**
|
|
@@ -40090,9 +40343,10 @@ type DateRangeFieldConfig = {
|
|
|
40090
40343
|
catchEventHandlerExceptions?: boolean
|
|
40091
40344
|
/**
|
|
40092
40345
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
40093
|
-
*
|
|
40346
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateRangeField#config-centered)
|
|
40347
|
+
* @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.
|
|
40094
40348
|
*/
|
|
40095
|
-
centered?: boolean
|
|
40349
|
+
centered?: boolean|object
|
|
40096
40350
|
/**
|
|
40097
40351
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
40098
40352
|
* 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)
|
|
@@ -40106,6 +40360,7 @@ type DateRangeFieldConfig = {
|
|
|
40106
40360
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
40107
40361
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
40108
40362
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
40363
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateRangeField#config-clearable)
|
|
40109
40364
|
*/
|
|
40110
40365
|
clearable?: boolean|FieldTriggerConfig
|
|
40111
40366
|
/**
|
|
@@ -40202,7 +40457,7 @@ type DateRangeFieldConfig = {
|
|
|
40202
40457
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
40203
40458
|
/**
|
|
40204
40459
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
40205
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
40460
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
40206
40461
|
* property which controls when a drag should start.
|
|
40207
40462
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateRangeField#config-draggable)
|
|
40208
40463
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -40566,7 +40821,7 @@ type DateRangeFieldConfig = {
|
|
|
40566
40821
|
rtl?: boolean
|
|
40567
40822
|
/**
|
|
40568
40823
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
40569
|
-
* Valid values:
|
|
40824
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
40570
40825
|
*/
|
|
40571
40826
|
scrollAction?: 'hide'|'realign'|null
|
|
40572
40827
|
/**
|
|
@@ -41348,9 +41603,10 @@ type DateRangePickerConfig = {
|
|
|
41348
41603
|
cellRenderer?: ((context: { cell: HTMLElement, date: Date, day: number, rowIndex: number[], row: HTMLElement, source: CalendarPanel, cellIndex: number[], columnIndex: number[], visibleColumnIndex: number[] }) => string|DomConfig|void)|string
|
|
41349
41604
|
/**
|
|
41350
41605
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
41351
|
-
*
|
|
41606
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateRangePicker#config-centered)
|
|
41607
|
+
* @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.
|
|
41352
41608
|
*/
|
|
41353
|
-
centered?: boolean
|
|
41609
|
+
centered?: boolean|object
|
|
41354
41610
|
/**
|
|
41355
41611
|
* Custom CSS classes to add to element.
|
|
41356
41612
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -41488,7 +41744,7 @@ type DateRangePickerConfig = {
|
|
|
41488
41744
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
41489
41745
|
/**
|
|
41490
41746
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
41491
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
41747
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
41492
41748
|
* property which controls when a drag should start.
|
|
41493
41749
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateRangePicker#config-draggable)
|
|
41494
41750
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -41659,7 +41915,7 @@ type DateRangePickerConfig = {
|
|
|
41659
41915
|
*/
|
|
41660
41916
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
41661
41917
|
/**
|
|
41662
|
-
* Sets `labelWidth
|
|
41918
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
41663
41919
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateRangePicker#config-labelWidth)
|
|
41664
41920
|
*/
|
|
41665
41921
|
labelWidth?: number|null
|
|
@@ -41856,7 +42112,7 @@ type DateRangePickerConfig = {
|
|
|
41856
42112
|
rtl?: boolean
|
|
41857
42113
|
/**
|
|
41858
42114
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
41859
|
-
* Valid values:
|
|
42115
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
41860
42116
|
*/
|
|
41861
42117
|
scrollAction?: 'hide'|'realign'|null
|
|
41862
42118
|
/**
|
|
@@ -42693,9 +42949,10 @@ type DateTimeFieldConfig = {
|
|
|
42693
42949
|
catchEventHandlerExceptions?: boolean
|
|
42694
42950
|
/**
|
|
42695
42951
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
42696
|
-
*
|
|
42952
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateTimeField#config-centered)
|
|
42953
|
+
* @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.
|
|
42697
42954
|
*/
|
|
42698
|
-
centered?: boolean
|
|
42955
|
+
centered?: boolean|object
|
|
42699
42956
|
/**
|
|
42700
42957
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
42701
42958
|
* 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)
|
|
@@ -42709,6 +42966,7 @@ type DateTimeFieldConfig = {
|
|
|
42709
42966
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
42710
42967
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
42711
42968
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
42969
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateTimeField#config-clearable)
|
|
42712
42970
|
*/
|
|
42713
42971
|
clearable?: boolean|FieldTriggerConfig
|
|
42714
42972
|
/**
|
|
@@ -42795,7 +43053,7 @@ type DateTimeFieldConfig = {
|
|
|
42795
43053
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
42796
43054
|
/**
|
|
42797
43055
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
42798
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
43056
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
42799
43057
|
* property which controls when a drag should start.
|
|
42800
43058
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateTimeField#config-draggable)
|
|
42801
43059
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -43101,7 +43359,7 @@ type DateTimeFieldConfig = {
|
|
|
43101
43359
|
rtl?: boolean
|
|
43102
43360
|
/**
|
|
43103
43361
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
43104
|
-
* Valid values:
|
|
43362
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
43105
43363
|
*/
|
|
43106
43364
|
scrollAction?: 'hide'|'realign'|null
|
|
43107
43365
|
/**
|
|
@@ -43813,9 +44071,10 @@ type DemoCodeEditorConfig = {
|
|
|
43813
44071
|
catchEventHandlerExceptions?: boolean
|
|
43814
44072
|
/**
|
|
43815
44073
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
43816
|
-
*
|
|
44074
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DemoCodeEditor#config-centered)
|
|
44075
|
+
* @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.
|
|
43817
44076
|
*/
|
|
43818
|
-
centered?: boolean
|
|
44077
|
+
centered?: boolean|object
|
|
43819
44078
|
/**
|
|
43820
44079
|
* Custom CSS classes to add to element.
|
|
43821
44080
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -43915,7 +44174,7 @@ type DemoCodeEditorConfig = {
|
|
|
43915
44174
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
43916
44175
|
/**
|
|
43917
44176
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
43918
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
44177
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
43919
44178
|
* property which controls when a drag should start.
|
|
43920
44179
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DemoCodeEditor#config-draggable)
|
|
43921
44180
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -44058,7 +44317,7 @@ type DemoCodeEditorConfig = {
|
|
|
44058
44317
|
*/
|
|
44059
44318
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
44060
44319
|
/**
|
|
44061
|
-
* Sets `labelWidth
|
|
44320
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
44062
44321
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DemoCodeEditor#config-labelWidth)
|
|
44063
44322
|
*/
|
|
44064
44323
|
labelWidth?: number|null
|
|
@@ -44240,7 +44499,7 @@ type DemoCodeEditorConfig = {
|
|
|
44240
44499
|
rtl?: boolean
|
|
44241
44500
|
/**
|
|
44242
44501
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
44243
|
-
* Valid values:
|
|
44502
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
44244
44503
|
*/
|
|
44245
44504
|
scrollAction?: 'hide'|'realign'|null
|
|
44246
44505
|
/**
|
|
@@ -44949,9 +45208,10 @@ type DemoHeaderConfig = {
|
|
|
44949
45208
|
catchEventHandlerExceptions?: boolean
|
|
44950
45209
|
/**
|
|
44951
45210
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
44952
|
-
*
|
|
45211
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DemoHeader#config-centered)
|
|
45212
|
+
* @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.
|
|
44953
45213
|
*/
|
|
44954
|
-
centered?: boolean
|
|
45214
|
+
centered?: boolean|object
|
|
44955
45215
|
/**
|
|
44956
45216
|
* Custom CSS classes to add to element.
|
|
44957
45217
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -45036,7 +45296,7 @@ type DemoHeaderConfig = {
|
|
|
45036
45296
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
45037
45297
|
/**
|
|
45038
45298
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
45039
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
45299
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
45040
45300
|
* property which controls when a drag should start.
|
|
45041
45301
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DemoHeader#config-draggable)
|
|
45042
45302
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -45141,7 +45401,7 @@ type DemoHeaderConfig = {
|
|
|
45141
45401
|
*/
|
|
45142
45402
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
45143
45403
|
/**
|
|
45144
|
-
* Sets `labelWidth
|
|
45404
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
45145
45405
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DemoHeader#config-labelWidth)
|
|
45146
45406
|
*/
|
|
45147
45407
|
labelWidth?: number|null
|
|
@@ -45311,7 +45571,7 @@ type DemoHeaderConfig = {
|
|
|
45311
45571
|
rtl?: boolean
|
|
45312
45572
|
/**
|
|
45313
45573
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
45314
|
-
* Valid values:
|
|
45574
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
45315
45575
|
*/
|
|
45316
45576
|
scrollAction?: 'hide'|'realign'|null
|
|
45317
45577
|
/**
|
|
@@ -45970,9 +46230,10 @@ type DisplayFieldConfig = {
|
|
|
45970
46230
|
catchEventHandlerExceptions?: boolean
|
|
45971
46231
|
/**
|
|
45972
46232
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
45973
|
-
*
|
|
46233
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-centered)
|
|
46234
|
+
* @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.
|
|
45974
46235
|
*/
|
|
45975
|
-
centered?: boolean
|
|
46236
|
+
centered?: boolean|object
|
|
45976
46237
|
/**
|
|
45977
46238
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
45978
46239
|
* 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)
|
|
@@ -45986,6 +46247,7 @@ type DisplayFieldConfig = {
|
|
|
45986
46247
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
45987
46248
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
45988
46249
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
46250
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-clearable)
|
|
45989
46251
|
*/
|
|
45990
46252
|
clearable?: boolean|FieldTriggerConfig
|
|
45991
46253
|
/**
|
|
@@ -46068,7 +46330,7 @@ type DisplayFieldConfig = {
|
|
|
46068
46330
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
46069
46331
|
/**
|
|
46070
46332
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
46071
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
46333
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
46072
46334
|
* property which controls when a drag should start.
|
|
46073
46335
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DisplayField#config-draggable)
|
|
46074
46336
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -46387,7 +46649,7 @@ type DisplayFieldConfig = {
|
|
|
46387
46649
|
rtl?: boolean
|
|
46388
46650
|
/**
|
|
46389
46651
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
46390
|
-
* Valid values:
|
|
46652
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
46391
46653
|
*/
|
|
46392
46654
|
scrollAction?: 'hide'|'realign'|null
|
|
46393
46655
|
/**
|
|
@@ -47099,9 +47361,10 @@ type DurationFieldConfig = {
|
|
|
47099
47361
|
catchEventHandlerExceptions?: boolean
|
|
47100
47362
|
/**
|
|
47101
47363
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
47102
|
-
*
|
|
47364
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DurationField#config-centered)
|
|
47365
|
+
* @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.
|
|
47103
47366
|
*/
|
|
47104
|
-
centered?: boolean
|
|
47367
|
+
centered?: boolean|object
|
|
47105
47368
|
/**
|
|
47106
47369
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
47107
47370
|
* 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)
|
|
@@ -47115,6 +47378,7 @@ type DurationFieldConfig = {
|
|
|
47115
47378
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
47116
47379
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
47117
47380
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
47381
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DurationField#config-clearable)
|
|
47118
47382
|
*/
|
|
47119
47383
|
clearable?: boolean|FieldTriggerConfig
|
|
47120
47384
|
/**
|
|
@@ -47201,7 +47465,7 @@ type DurationFieldConfig = {
|
|
|
47201
47465
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
47202
47466
|
/**
|
|
47203
47467
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
47204
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
47468
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
47205
47469
|
* property which controls when a drag should start.
|
|
47206
47470
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DurationField#config-draggable)
|
|
47207
47471
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -47546,7 +47810,7 @@ type DurationFieldConfig = {
|
|
|
47546
47810
|
rtl?: boolean
|
|
47547
47811
|
/**
|
|
47548
47812
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
47549
|
-
* Valid values:
|
|
47813
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
47550
47814
|
*/
|
|
47551
47815
|
scrollAction?: 'hide'|'realign'|null
|
|
47552
47816
|
/**
|
|
@@ -48415,9 +48679,10 @@ type EditorConfig = {
|
|
|
48415
48679
|
catchEventHandlerExceptions?: boolean
|
|
48416
48680
|
/**
|
|
48417
48681
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
48418
|
-
*
|
|
48682
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-centered)
|
|
48683
|
+
* @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.
|
|
48419
48684
|
*/
|
|
48420
|
-
centered?: boolean
|
|
48685
|
+
centered?: boolean|object
|
|
48421
48686
|
/**
|
|
48422
48687
|
* Custom CSS classes to add to element.
|
|
48423
48688
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -48511,7 +48776,7 @@ type EditorConfig = {
|
|
|
48511
48776
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
48512
48777
|
/**
|
|
48513
48778
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
48514
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
48779
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
48515
48780
|
* property which controls when a drag should start.
|
|
48516
48781
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-draggable)
|
|
48517
48782
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -48638,7 +48903,7 @@ type EditorConfig = {
|
|
|
48638
48903
|
*/
|
|
48639
48904
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
48640
48905
|
/**
|
|
48641
|
-
* Sets `labelWidth
|
|
48906
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
48642
48907
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-labelWidth)
|
|
48643
48908
|
*/
|
|
48644
48909
|
labelWidth?: number|null
|
|
@@ -48820,7 +49085,7 @@ type EditorConfig = {
|
|
|
48820
49085
|
rtl?: boolean
|
|
48821
49086
|
/**
|
|
48822
49087
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
48823
|
-
* Valid values:
|
|
49088
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
48824
49089
|
*/
|
|
48825
49090
|
scrollAction?: 'hide'|'realign'|null
|
|
48826
49091
|
/**
|
|
@@ -49658,9 +49923,10 @@ type FieldConfig = {
|
|
|
49658
49923
|
catchEventHandlerExceptions?: boolean
|
|
49659
49924
|
/**
|
|
49660
49925
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
49661
|
-
*
|
|
49926
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-centered)
|
|
49927
|
+
* @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.
|
|
49662
49928
|
*/
|
|
49663
|
-
centered?: boolean
|
|
49929
|
+
centered?: boolean|object
|
|
49664
49930
|
/**
|
|
49665
49931
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
49666
49932
|
* 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)
|
|
@@ -49674,6 +49940,7 @@ type FieldConfig = {
|
|
|
49674
49940
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
49675
49941
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
49676
49942
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
49943
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-clearable)
|
|
49677
49944
|
*/
|
|
49678
49945
|
clearable?: boolean|FieldTriggerConfig
|
|
49679
49946
|
/**
|
|
@@ -49756,7 +50023,7 @@ type FieldConfig = {
|
|
|
49756
50023
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
49757
50024
|
/**
|
|
49758
50025
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
49759
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
50026
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
49760
50027
|
* property which controls when a drag should start.
|
|
49761
50028
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-draggable)
|
|
49762
50029
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -50075,7 +50342,7 @@ type FieldConfig = {
|
|
|
50075
50342
|
rtl?: boolean
|
|
50076
50343
|
/**
|
|
50077
50344
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
50078
|
-
* Valid values:
|
|
50345
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
50079
50346
|
*/
|
|
50080
50347
|
scrollAction?: 'hide'|'realign'|null
|
|
50081
50348
|
/**
|
|
@@ -50884,9 +51151,10 @@ type FieldContainerConfig = {
|
|
|
50884
51151
|
catchEventHandlerExceptions?: boolean
|
|
50885
51152
|
/**
|
|
50886
51153
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
50887
|
-
*
|
|
51154
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldContainer#config-centered)
|
|
51155
|
+
* @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.
|
|
50888
51156
|
*/
|
|
50889
|
-
centered?: boolean
|
|
51157
|
+
centered?: boolean|object
|
|
50890
51158
|
/**
|
|
50891
51159
|
* Custom CSS classes to add to element.
|
|
50892
51160
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -50976,7 +51244,7 @@ type FieldContainerConfig = {
|
|
|
50976
51244
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
50977
51245
|
/**
|
|
50978
51246
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
50979
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
51247
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
50980
51248
|
* property which controls when a drag should start.
|
|
50981
51249
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldContainer#config-draggable)
|
|
50982
51250
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -51083,7 +51351,7 @@ type FieldContainerConfig = {
|
|
|
51083
51351
|
*/
|
|
51084
51352
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
51085
51353
|
/**
|
|
51086
|
-
* Sets `labelWidth
|
|
51354
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
51087
51355
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldContainer#config-labelWidth)
|
|
51088
51356
|
*/
|
|
51089
51357
|
labelWidth?: number|null
|
|
@@ -51253,7 +51521,7 @@ type FieldContainerConfig = {
|
|
|
51253
51521
|
rtl?: boolean
|
|
51254
51522
|
/**
|
|
51255
51523
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
51256
|
-
* Valid values:
|
|
51524
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
51257
51525
|
*/
|
|
51258
51526
|
scrollAction?: 'hide'|'realign'|null
|
|
51259
51527
|
/**
|
|
@@ -51864,9 +52132,10 @@ type FieldFilterPickerConfig = {
|
|
|
51864
52132
|
catchEventHandlerExceptions?: boolean
|
|
51865
52133
|
/**
|
|
51866
52134
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
51867
|
-
*
|
|
52135
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPicker#config-centered)
|
|
52136
|
+
* @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.
|
|
51868
52137
|
*/
|
|
51869
|
-
centered?: boolean
|
|
52138
|
+
centered?: boolean|object
|
|
51870
52139
|
/**
|
|
51871
52140
|
* Custom CSS classes to add to element.
|
|
51872
52141
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -51954,7 +52223,7 @@ type FieldFilterPickerConfig = {
|
|
|
51954
52223
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
51955
52224
|
/**
|
|
51956
52225
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
51957
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
52226
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
51958
52227
|
* property which controls when a drag should start.
|
|
51959
52228
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPicker#config-draggable)
|
|
51960
52229
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -52082,7 +52351,7 @@ type FieldFilterPickerConfig = {
|
|
|
52082
52351
|
*/
|
|
52083
52352
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
52084
52353
|
/**
|
|
52085
|
-
* Sets `labelWidth
|
|
52354
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
52086
52355
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPicker#config-labelWidth)
|
|
52087
52356
|
*/
|
|
52088
52357
|
labelWidth?: number|null
|
|
@@ -52268,7 +52537,7 @@ type FieldFilterPickerConfig = {
|
|
|
52268
52537
|
rtl?: boolean
|
|
52269
52538
|
/**
|
|
52270
52539
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
52271
|
-
* Valid values:
|
|
52540
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
52272
52541
|
*/
|
|
52273
52542
|
scrollAction?: 'hide'|'realign'|null
|
|
52274
52543
|
/**
|
|
@@ -52956,9 +53225,10 @@ type FieldFilterPickerGroupConfig = {
|
|
|
52956
53225
|
catchEventHandlerExceptions?: boolean
|
|
52957
53226
|
/**
|
|
52958
53227
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
52959
|
-
*
|
|
53228
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPickerGroup#config-centered)
|
|
53229
|
+
* @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.
|
|
52960
53230
|
*/
|
|
52961
|
-
centered?: boolean
|
|
53231
|
+
centered?: boolean|object
|
|
52962
53232
|
/**
|
|
52963
53233
|
* Custom CSS classes to add to element.
|
|
52964
53234
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -53046,7 +53316,7 @@ type FieldFilterPickerGroupConfig = {
|
|
|
53046
53316
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
53047
53317
|
/**
|
|
53048
53318
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
53049
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
53319
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
53050
53320
|
* property which controls when a drag should start.
|
|
53051
53321
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPickerGroup#config-draggable)
|
|
53052
53322
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -53176,7 +53446,7 @@ type FieldFilterPickerGroupConfig = {
|
|
|
53176
53446
|
*/
|
|
53177
53447
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
53178
53448
|
/**
|
|
53179
|
-
* Sets `labelWidth
|
|
53449
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
53180
53450
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPickerGroup#config-labelWidth)
|
|
53181
53451
|
*/
|
|
53182
53452
|
labelWidth?: number|null
|
|
@@ -53357,7 +53627,7 @@ type FieldFilterPickerGroupConfig = {
|
|
|
53357
53627
|
rtl?: boolean
|
|
53358
53628
|
/**
|
|
53359
53629
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
53360
|
-
* Valid values:
|
|
53630
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
53361
53631
|
*/
|
|
53362
53632
|
scrollAction?: 'hide'|'realign'|null
|
|
53363
53633
|
/**
|
|
@@ -54102,9 +54372,10 @@ type FieldSetConfig = {
|
|
|
54102
54372
|
catchEventHandlerExceptions?: boolean
|
|
54103
54373
|
/**
|
|
54104
54374
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
54105
|
-
*
|
|
54375
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldSet#config-centered)
|
|
54376
|
+
* @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.
|
|
54106
54377
|
*/
|
|
54107
|
-
centered?: boolean
|
|
54378
|
+
centered?: boolean|object
|
|
54108
54379
|
/**
|
|
54109
54380
|
* Custom CSS classes to add to element.
|
|
54110
54381
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -54199,7 +54470,7 @@ type FieldSetConfig = {
|
|
|
54199
54470
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
54200
54471
|
/**
|
|
54201
54472
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
54202
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
54473
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
54203
54474
|
* property which controls when a drag should start.
|
|
54204
54475
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldSet#config-draggable)
|
|
54205
54476
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -54352,7 +54623,7 @@ type FieldSetConfig = {
|
|
|
54352
54623
|
*/
|
|
54353
54624
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
54354
54625
|
/**
|
|
54355
|
-
* Sets `labelWidth
|
|
54626
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
54356
54627
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldSet#config-labelWidth)
|
|
54357
54628
|
*/
|
|
54358
54629
|
labelWidth?: number|null
|
|
@@ -54522,7 +54793,7 @@ type FieldSetConfig = {
|
|
|
54522
54793
|
rtl?: boolean
|
|
54523
54794
|
/**
|
|
54524
54795
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
54525
|
-
* Valid values:
|
|
54796
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
54526
54797
|
*/
|
|
54527
54798
|
scrollAction?: 'hide'|'realign'|null
|
|
54528
54799
|
/**
|
|
@@ -55302,9 +55573,10 @@ type FileFieldConfig = {
|
|
|
55302
55573
|
catchEventHandlerExceptions?: boolean
|
|
55303
55574
|
/**
|
|
55304
55575
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
55305
|
-
*
|
|
55576
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-centered)
|
|
55577
|
+
* @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.
|
|
55306
55578
|
*/
|
|
55307
|
-
centered?: boolean
|
|
55579
|
+
centered?: boolean|object
|
|
55308
55580
|
/**
|
|
55309
55581
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
55310
55582
|
* 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)
|
|
@@ -55318,6 +55590,7 @@ type FileFieldConfig = {
|
|
|
55318
55590
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
55319
55591
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
55320
55592
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
55593
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-clearable)
|
|
55321
55594
|
*/
|
|
55322
55595
|
clearable?: boolean|FieldTriggerConfig
|
|
55323
55596
|
/**
|
|
@@ -55400,7 +55673,7 @@ type FileFieldConfig = {
|
|
|
55400
55673
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
55401
55674
|
/**
|
|
55402
55675
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
55403
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
55676
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
55404
55677
|
* property which controls when a drag should start.
|
|
55405
55678
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-draggable)
|
|
55406
55679
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -55725,7 +55998,7 @@ type FileFieldConfig = {
|
|
|
55725
55998
|
rtl?: boolean
|
|
55726
55999
|
/**
|
|
55727
56000
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
55728
|
-
* Valid values:
|
|
56001
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
55729
56002
|
*/
|
|
55730
56003
|
scrollAction?: 'hide'|'realign'|null
|
|
55731
56004
|
/**
|
|
@@ -56389,9 +56662,10 @@ type FilePickerConfig = {
|
|
|
56389
56662
|
catchEventHandlerExceptions?: boolean
|
|
56390
56663
|
/**
|
|
56391
56664
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
56392
|
-
*
|
|
56665
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilePicker#config-centered)
|
|
56666
|
+
* @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.
|
|
56393
56667
|
*/
|
|
56394
|
-
centered?: boolean
|
|
56668
|
+
centered?: boolean|object
|
|
56395
56669
|
/**
|
|
56396
56670
|
* Custom CSS classes to add to element.
|
|
56397
56671
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -56476,7 +56750,7 @@ type FilePickerConfig = {
|
|
|
56476
56750
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
56477
56751
|
/**
|
|
56478
56752
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
56479
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
56753
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
56480
56754
|
* property which controls when a drag should start.
|
|
56481
56755
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilePicker#config-draggable)
|
|
56482
56756
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -56587,7 +56861,7 @@ type FilePickerConfig = {
|
|
|
56587
56861
|
*/
|
|
56588
56862
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
56589
56863
|
/**
|
|
56590
|
-
* Sets `labelWidth
|
|
56864
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
56591
56865
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilePicker#config-labelWidth)
|
|
56592
56866
|
*/
|
|
56593
56867
|
labelWidth?: number|null
|
|
@@ -56757,7 +57031,7 @@ type FilePickerConfig = {
|
|
|
56757
57031
|
rtl?: boolean
|
|
56758
57032
|
/**
|
|
56759
57033
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
56760
|
-
* Valid values:
|
|
57034
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
56761
57035
|
*/
|
|
56762
57036
|
scrollAction?: 'hide'|'realign'|null
|
|
56763
57037
|
/**
|
|
@@ -57454,9 +57728,10 @@ type FilterFieldConfig = {
|
|
|
57454
57728
|
catchEventHandlerExceptions?: boolean
|
|
57455
57729
|
/**
|
|
57456
57730
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
57457
|
-
*
|
|
57731
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-centered)
|
|
57732
|
+
* @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.
|
|
57458
57733
|
*/
|
|
57459
|
-
centered?: boolean
|
|
57734
|
+
centered?: boolean|object
|
|
57460
57735
|
/**
|
|
57461
57736
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
57462
57737
|
* 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)
|
|
@@ -57470,6 +57745,7 @@ type FilterFieldConfig = {
|
|
|
57470
57745
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
57471
57746
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
57472
57747
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
57748
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-clearable)
|
|
57473
57749
|
*/
|
|
57474
57750
|
clearable?: boolean|FieldTriggerConfig
|
|
57475
57751
|
/**
|
|
@@ -57552,7 +57828,7 @@ type FilterFieldConfig = {
|
|
|
57552
57828
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
57553
57829
|
/**
|
|
57554
57830
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
57555
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
57831
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
57556
57832
|
* property which controls when a drag should start.
|
|
57557
57833
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-draggable)
|
|
57558
57834
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -57909,7 +58185,7 @@ type FilterFieldConfig = {
|
|
|
57909
58185
|
rtl?: boolean
|
|
57910
58186
|
/**
|
|
57911
58187
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
57912
|
-
* Valid values:
|
|
58188
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
57913
58189
|
*/
|
|
57914
58190
|
scrollAction?: 'hide'|'realign'|null
|
|
57915
58191
|
/**
|
|
@@ -58884,7 +59160,7 @@ type HintConfig = {
|
|
|
58884
59160
|
*/
|
|
58885
59161
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
58886
59162
|
/**
|
|
58887
|
-
* Sets `labelWidth
|
|
59163
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
58888
59164
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-labelWidth)
|
|
58889
59165
|
*/
|
|
58890
59166
|
labelWidth?: number|null
|
|
@@ -59103,7 +59379,7 @@ type HintConfig = {
|
|
|
59103
59379
|
rtl?: boolean
|
|
59104
59380
|
/**
|
|
59105
59381
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
59106
|
-
* Valid values:
|
|
59382
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
59107
59383
|
*/
|
|
59108
59384
|
scrollAction?: 'hide'|'realign'|null
|
|
59109
59385
|
/**
|
|
@@ -59767,9 +60043,10 @@ type LabelConfig = {
|
|
|
59767
60043
|
catchEventHandlerExceptions?: boolean
|
|
59768
60044
|
/**
|
|
59769
60045
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
59770
|
-
*
|
|
60046
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Label#config-centered)
|
|
60047
|
+
* @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.
|
|
59771
60048
|
*/
|
|
59772
|
-
centered?: boolean
|
|
60049
|
+
centered?: boolean|object
|
|
59773
60050
|
/**
|
|
59774
60051
|
* Custom CSS classes to add to element.
|
|
59775
60052
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -59842,7 +60119,7 @@ type LabelConfig = {
|
|
|
59842
60119
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
59843
60120
|
/**
|
|
59844
60121
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
59845
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
60122
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
59846
60123
|
* property which controls when a drag should start.
|
|
59847
60124
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Label#config-draggable)
|
|
59848
60125
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -60052,7 +60329,7 @@ type LabelConfig = {
|
|
|
60052
60329
|
rtl?: boolean
|
|
60053
60330
|
/**
|
|
60054
60331
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
60055
|
-
* Valid values:
|
|
60332
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
60056
60333
|
*/
|
|
60057
60334
|
scrollAction?: 'hide'|'realign'|null
|
|
60058
60335
|
/**
|
|
@@ -60677,9 +60954,10 @@ type ListConfig = {
|
|
|
60677
60954
|
catchEventHandlerExceptions?: boolean
|
|
60678
60955
|
/**
|
|
60679
60956
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
60680
|
-
*
|
|
60957
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/List#config-centered)
|
|
60958
|
+
* @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.
|
|
60681
60959
|
*/
|
|
60682
|
-
centered?: boolean
|
|
60960
|
+
centered?: boolean|object
|
|
60683
60961
|
/**
|
|
60684
60962
|
* Configure as `true` to clear selection when clicking on empty space inside the List´s element.
|
|
60685
60963
|
*/
|
|
@@ -60764,7 +61042,7 @@ type ListConfig = {
|
|
|
60764
61042
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
60765
61043
|
/**
|
|
60766
61044
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
60767
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
61045
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
60768
61046
|
* property which controls when a drag should start.
|
|
60769
61047
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/List#config-draggable)
|
|
60770
61048
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -61023,7 +61301,7 @@ type ListConfig = {
|
|
|
61023
61301
|
rtl?: boolean
|
|
61024
61302
|
/**
|
|
61025
61303
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
61026
|
-
* Valid values:
|
|
61304
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
61027
61305
|
*/
|
|
61028
61306
|
scrollAction?: 'hide'|'realign'|null
|
|
61029
61307
|
/**
|
|
@@ -61749,9 +62027,10 @@ type MaskConfig = {
|
|
|
61749
62027
|
catchEventHandlerExceptions?: boolean
|
|
61750
62028
|
/**
|
|
61751
62029
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
61752
|
-
*
|
|
62030
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Mask#config-centered)
|
|
62031
|
+
* @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.
|
|
61753
62032
|
*/
|
|
61754
|
-
centered?: boolean
|
|
62033
|
+
centered?: boolean|object
|
|
61755
62034
|
/**
|
|
61756
62035
|
* Custom CSS classes to add to element.
|
|
61757
62036
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -61824,7 +62103,7 @@ type MaskConfig = {
|
|
|
61824
62103
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
61825
62104
|
/**
|
|
61826
62105
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
61827
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
62106
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
61828
62107
|
* property which controls when a drag should start.
|
|
61829
62108
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Mask#config-draggable)
|
|
61830
62109
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -62051,7 +62330,7 @@ type MaskConfig = {
|
|
|
62051
62330
|
rtl?: boolean
|
|
62052
62331
|
/**
|
|
62053
62332
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
62054
|
-
* Valid values:
|
|
62333
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
62055
62334
|
*/
|
|
62056
62335
|
scrollAction?: 'hide'|'realign'|null
|
|
62057
62336
|
/**
|
|
@@ -62795,9 +63074,10 @@ type MenuConfig = {
|
|
|
62795
63074
|
catchEventHandlerExceptions?: boolean
|
|
62796
63075
|
/**
|
|
62797
63076
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
62798
|
-
*
|
|
63077
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-centered)
|
|
63078
|
+
* @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.
|
|
62799
63079
|
*/
|
|
62800
|
-
centered?: boolean
|
|
63080
|
+
centered?: boolean|object
|
|
62801
63081
|
/**
|
|
62802
63082
|
* Show a tool in the header to close this Popup.
|
|
62803
63083
|
* The tool is available in the [tools](https://bryntum.com/products/grid/docs/api/Core/widget/mixin/Toolable#property-tools) object
|
|
@@ -63058,7 +63338,7 @@ type MenuConfig = {
|
|
|
63058
63338
|
*/
|
|
63059
63339
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
63060
63340
|
/**
|
|
63061
|
-
* Sets `labelWidth
|
|
63341
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
63062
63342
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-labelWidth)
|
|
63063
63343
|
*/
|
|
63064
63344
|
labelWidth?: number|null
|
|
@@ -63263,7 +63543,7 @@ type MenuConfig = {
|
|
|
63263
63543
|
rtl?: boolean
|
|
63264
63544
|
/**
|
|
63265
63545
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
63266
|
-
* Valid values:
|
|
63546
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
63267
63547
|
*/
|
|
63268
63548
|
scrollAction?: 'hide'|'realign'|null
|
|
63269
63549
|
/**
|
|
@@ -64021,9 +64301,10 @@ type MenuItemConfig = {
|
|
|
64021
64301
|
catchEventHandlerExceptions?: boolean
|
|
64022
64302
|
/**
|
|
64023
64303
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
64024
|
-
*
|
|
64304
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/MenuItem#config-centered)
|
|
64305
|
+
* @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.
|
|
64025
64306
|
*/
|
|
64026
|
-
centered?: boolean
|
|
64307
|
+
centered?: boolean|object
|
|
64027
64308
|
/**
|
|
64028
64309
|
* If configured with a `Boolean` value, a checkbox is displayed
|
|
64029
64310
|
* as the start icon, and the [toggle](https://bryntum.com/products/grid/docs/api/Core/widget/MenuItem#event-toggle) event is fired
|
|
@@ -64110,7 +64391,7 @@ type MenuItemConfig = {
|
|
|
64110
64391
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
64111
64392
|
/**
|
|
64112
64393
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
64113
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
64394
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
64114
64395
|
* property which controls when a drag should start.
|
|
64115
64396
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/MenuItem#config-draggable)
|
|
64116
64397
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -64335,7 +64616,7 @@ type MenuItemConfig = {
|
|
|
64335
64616
|
rtl?: boolean
|
|
64336
64617
|
/**
|
|
64337
64618
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
64338
|
-
* Valid values:
|
|
64619
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
64339
64620
|
*/
|
|
64340
64621
|
scrollAction?: 'hide'|'realign'|null
|
|
64341
64622
|
/**
|
|
@@ -65040,7 +65321,7 @@ export class MessageDialogSingleton extends Popup {
|
|
|
65040
65321
|
* @param {string} [options.rootElement] The root element of this widget, defaults to document.body. Use this if you use the MessageDialog inside a web component ShadowRoot
|
|
65041
65322
|
* @param {string,ButtonConfig} [options.okButton] A text or config object to apply to the OK button.
|
|
65042
65323
|
*/
|
|
65043
|
-
alert(options: { modal?: boolean, title?: string, message?: string, rootElement?: string, okButton?: string|ButtonConfig }): Promise<
|
|
65324
|
+
alert(options: { modal?: boolean, title?: string, message?: string, rootElement?: string, okButton?: string|ButtonConfig }): Promise<void>;
|
|
65044
65325
|
/**
|
|
65045
65326
|
* Shows a confirm dialog with "Ok" and "Cancel" buttons. The returned promise resolves passing the button identifier
|
|
65046
65327
|
* of the button that was pressed ([okButton](https://bryntum.com/products/grid/docs/api/Core/widget/MessageDialog#property-okButton) or [cancelButton](#Core/widget/MessageDialog#property-cancelButton)).
|
|
@@ -65052,7 +65333,7 @@ export class MessageDialogSingleton extends Popup {
|
|
|
65052
65333
|
* @param {string,ButtonConfig} [options.cancelButton] A text or a config object to apply to the Cancel button.
|
|
65053
65334
|
* @param {string,ButtonConfig} [options.okButton] A text or config object to apply to the OK button.
|
|
65054
65335
|
*/
|
|
65055
|
-
confirm(options: { modal?: boolean, title?: string, message?: string, rootElement?: string, cancelButton?: string|ButtonConfig, okButton?: string|ButtonConfig }): Promise<
|
|
65336
|
+
confirm(options: { modal?: boolean, title?: string, message?: string, rootElement?: string, cancelButton?: string|ButtonConfig, okButton?: string|ButtonConfig }): Promise<number>;
|
|
65056
65337
|
/**
|
|
65057
65338
|
* Shows a popup with a basic [TextField](https://bryntum.com/products/grid/docs/api/Core/widget/TextField) along with a message. The returned promise resolves when
|
|
65058
65339
|
* the dialog is closed and yields an Object with a `button` ([okButton](https://bryntum.com/products/grid/docs/api/Core/widget/MessageDialog#property-okButton) or [cancelButton](#Core/widget/MessageDialog#property-cancelButton))
|
|
@@ -65066,7 +65347,7 @@ export class MessageDialogSingleton extends Popup {
|
|
|
65066
65347
|
* @param {string,ButtonConfig} [options.cancelButton] A text or a config object to apply to the Cancel button.
|
|
65067
65348
|
* @param {string,ButtonConfig} [options.okButton] A text or config object to apply to the OK button.
|
|
65068
65349
|
*/
|
|
65069
|
-
prompt(options: { modal?: boolean, title?: string, message?: string, rootElement?: string, textField?: TextFieldConfig, cancelButton?: string|ButtonConfig, okButton?: string|ButtonConfig }): Promise<
|
|
65350
|
+
prompt(options: { modal?: boolean, title?: string, message?: string, rootElement?: string, textField?: TextFieldConfig, cancelButton?: string|ButtonConfig, okButton?: string|ButtonConfig }): Promise<MessageDialogPromptResult>;
|
|
65070
65351
|
}
|
|
65071
65352
|
export const MessageDialog : MessageDialogSingleton
|
|
65072
65353
|
|
|
@@ -65499,9 +65780,10 @@ type MonthPickerConfig = {
|
|
|
65499
65780
|
catchEventHandlerExceptions?: boolean
|
|
65500
65781
|
/**
|
|
65501
65782
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
65502
|
-
*
|
|
65783
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/MonthPicker#config-centered)
|
|
65784
|
+
* @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.
|
|
65503
65785
|
*/
|
|
65504
|
-
centered?: boolean
|
|
65786
|
+
centered?: boolean|object
|
|
65505
65787
|
/**
|
|
65506
65788
|
* Custom CSS classes to add to element.
|
|
65507
65789
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -65596,7 +65878,7 @@ type MonthPickerConfig = {
|
|
|
65596
65878
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
65597
65879
|
/**
|
|
65598
65880
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
65599
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
65881
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
65600
65882
|
* property which controls when a drag should start.
|
|
65601
65883
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/MonthPicker#config-draggable)
|
|
65602
65884
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -65735,7 +66017,7 @@ type MonthPickerConfig = {
|
|
|
65735
66017
|
*/
|
|
65736
66018
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
65737
66019
|
/**
|
|
65738
|
-
* Sets `labelWidth
|
|
66020
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
65739
66021
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/MonthPicker#config-labelWidth)
|
|
65740
66022
|
*/
|
|
65741
66023
|
labelWidth?: number|null
|
|
@@ -65909,7 +66191,7 @@ type MonthPickerConfig = {
|
|
|
65909
66191
|
rtl?: boolean
|
|
65910
66192
|
/**
|
|
65911
66193
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
65912
|
-
* Valid values:
|
|
66194
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
65913
66195
|
*/
|
|
65914
66196
|
scrollAction?: 'hide'|'realign'|null
|
|
65915
66197
|
/**
|
|
@@ -66731,9 +67013,10 @@ type MultiDatePickerConfig = {
|
|
|
66731
67013
|
cellRenderer?: ((context: { cell: HTMLElement, date: Date, day: number, rowIndex: number[], row: HTMLElement, source: CalendarPanel, cellIndex: number[], columnIndex: number[], visibleColumnIndex: number[] }) => string|DomConfig|void)|string
|
|
66732
67014
|
/**
|
|
66733
67015
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
66734
|
-
*
|
|
67016
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/MultiDatePicker#config-centered)
|
|
67017
|
+
* @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.
|
|
66735
67018
|
*/
|
|
66736
|
-
centered?: boolean
|
|
67019
|
+
centered?: boolean|object
|
|
66737
67020
|
/**
|
|
66738
67021
|
* Custom CSS classes to add to element.
|
|
66739
67022
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -66858,7 +67141,7 @@ type MultiDatePickerConfig = {
|
|
|
66858
67141
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
66859
67142
|
/**
|
|
66860
67143
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
66861
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
67144
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
66862
67145
|
* property which controls when a drag should start.
|
|
66863
67146
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/MultiDatePicker#config-draggable)
|
|
66864
67147
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -67017,7 +67300,7 @@ type MultiDatePickerConfig = {
|
|
|
67017
67300
|
*/
|
|
67018
67301
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
67019
67302
|
/**
|
|
67020
|
-
* Sets `labelWidth
|
|
67303
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
67021
67304
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/MultiDatePicker#config-labelWidth)
|
|
67022
67305
|
*/
|
|
67023
67306
|
labelWidth?: number|null
|
|
@@ -67220,7 +67503,7 @@ type MultiDatePickerConfig = {
|
|
|
67220
67503
|
rtl?: boolean
|
|
67221
67504
|
/**
|
|
67222
67505
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
67223
|
-
* Valid values:
|
|
67506
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
67224
67507
|
*/
|
|
67225
67508
|
scrollAction?: 'hide'|'realign'|null
|
|
67226
67509
|
/**
|
|
@@ -68052,9 +68335,10 @@ type NumberFieldConfig = {
|
|
|
68052
68335
|
catchEventHandlerExceptions?: boolean
|
|
68053
68336
|
/**
|
|
68054
68337
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
68055
|
-
*
|
|
68338
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-centered)
|
|
68339
|
+
* @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.
|
|
68056
68340
|
*/
|
|
68057
|
-
centered?: boolean
|
|
68341
|
+
centered?: boolean|object
|
|
68058
68342
|
/**
|
|
68059
68343
|
* Controls how change events are triggered when stepping the value up or down using either spinners or
|
|
68060
68344
|
* arrow keys.
|
|
@@ -68074,6 +68358,7 @@ type NumberFieldConfig = {
|
|
|
68074
68358
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
68075
68359
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
68076
68360
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
68361
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-clearable)
|
|
68077
68362
|
*/
|
|
68078
68363
|
clearable?: boolean|FieldTriggerConfig
|
|
68079
68364
|
/**
|
|
@@ -68156,7 +68441,7 @@ type NumberFieldConfig = {
|
|
|
68156
68441
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
68157
68442
|
/**
|
|
68158
68443
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
68159
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
68444
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
68160
68445
|
* property which controls when a drag should start.
|
|
68161
68446
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-draggable)
|
|
68162
68447
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -68505,7 +68790,7 @@ type NumberFieldConfig = {
|
|
|
68505
68790
|
rtl?: boolean
|
|
68506
68791
|
/**
|
|
68507
68792
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
68508
|
-
* Valid values:
|
|
68793
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
68509
68794
|
*/
|
|
68510
68795
|
scrollAction?: 'hide'|'realign'|null
|
|
68511
68796
|
/**
|
|
@@ -69219,9 +69504,10 @@ type PagingToolbarConfig = {
|
|
|
69219
69504
|
catchEventHandlerExceptions?: boolean
|
|
69220
69505
|
/**
|
|
69221
69506
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
69222
|
-
*
|
|
69507
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-centered)
|
|
69508
|
+
* @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.
|
|
69223
69509
|
*/
|
|
69224
|
-
centered?: boolean
|
|
69510
|
+
centered?: boolean|object
|
|
69225
69511
|
/**
|
|
69226
69512
|
* Custom CSS classes to add to element.
|
|
69227
69513
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -69306,7 +69592,7 @@ type PagingToolbarConfig = {
|
|
|
69306
69592
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
69307
69593
|
/**
|
|
69308
69594
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
69309
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
69595
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
69310
69596
|
* property which controls when a drag should start.
|
|
69311
69597
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-draggable)
|
|
69312
69598
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -69417,7 +69703,7 @@ type PagingToolbarConfig = {
|
|
|
69417
69703
|
*/
|
|
69418
69704
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
69419
69705
|
/**
|
|
69420
|
-
* Sets `labelWidth
|
|
69706
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
69421
69707
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-labelWidth)
|
|
69422
69708
|
*/
|
|
69423
69709
|
labelWidth?: number|null
|
|
@@ -69595,7 +69881,7 @@ type PagingToolbarConfig = {
|
|
|
69595
69881
|
rtl?: boolean
|
|
69596
69882
|
/**
|
|
69597
69883
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
69598
|
-
* Valid values:
|
|
69884
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
69599
69885
|
*/
|
|
69600
69886
|
scrollAction?: 'hide'|'realign'|null
|
|
69601
69887
|
/**
|
|
@@ -70300,9 +70586,10 @@ type PanelConfig = {
|
|
|
70300
70586
|
catchEventHandlerExceptions?: boolean
|
|
70301
70587
|
/**
|
|
70302
70588
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
70303
|
-
*
|
|
70589
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-centered)
|
|
70590
|
+
* @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.
|
|
70304
70591
|
*/
|
|
70305
|
-
centered?: boolean
|
|
70592
|
+
centered?: boolean|object
|
|
70306
70593
|
/**
|
|
70307
70594
|
* Custom CSS classes to add to element.
|
|
70308
70595
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -70397,7 +70684,7 @@ type PanelConfig = {
|
|
|
70397
70684
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
70398
70685
|
/**
|
|
70399
70686
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
70400
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
70687
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
70401
70688
|
* property which controls when a drag should start.
|
|
70402
70689
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-draggable)
|
|
70403
70690
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -70536,7 +70823,7 @@ type PanelConfig = {
|
|
|
70536
70823
|
*/
|
|
70537
70824
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
70538
70825
|
/**
|
|
70539
|
-
* Sets `labelWidth
|
|
70826
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
70540
70827
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-labelWidth)
|
|
70541
70828
|
*/
|
|
70542
70829
|
labelWidth?: number|null
|
|
@@ -70706,7 +70993,7 @@ type PanelConfig = {
|
|
|
70706
70993
|
rtl?: boolean
|
|
70707
70994
|
/**
|
|
70708
70995
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
70709
|
-
* Valid values:
|
|
70996
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
70710
70997
|
*/
|
|
70711
70998
|
scrollAction?: 'hide'|'realign'|null
|
|
70712
70999
|
/**
|
|
@@ -71576,9 +71863,10 @@ type PasswordFieldConfig = {
|
|
|
71576
71863
|
catchEventHandlerExceptions?: boolean
|
|
71577
71864
|
/**
|
|
71578
71865
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
71579
|
-
*
|
|
71866
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PasswordField#config-centered)
|
|
71867
|
+
* @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.
|
|
71580
71868
|
*/
|
|
71581
|
-
centered?: boolean
|
|
71869
|
+
centered?: boolean|object
|
|
71582
71870
|
/**
|
|
71583
71871
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
71584
71872
|
* 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)
|
|
@@ -71592,6 +71880,7 @@ type PasswordFieldConfig = {
|
|
|
71592
71880
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
71593
71881
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
71594
71882
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
71883
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PasswordField#config-clearable)
|
|
71595
71884
|
*/
|
|
71596
71885
|
clearable?: boolean|FieldTriggerConfig
|
|
71597
71886
|
/**
|
|
@@ -71674,7 +71963,7 @@ type PasswordFieldConfig = {
|
|
|
71674
71963
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
71675
71964
|
/**
|
|
71676
71965
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
71677
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
71966
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
71678
71967
|
* property which controls when a drag should start.
|
|
71679
71968
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PasswordField#config-draggable)
|
|
71680
71969
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -71993,7 +72282,7 @@ type PasswordFieldConfig = {
|
|
|
71993
72282
|
rtl?: boolean
|
|
71994
72283
|
/**
|
|
71995
72284
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
71996
|
-
* Valid values:
|
|
72285
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
71997
72286
|
*/
|
|
71998
72287
|
scrollAction?: 'hide'|'realign'|null
|
|
71999
72288
|
/**
|
|
@@ -72693,9 +72982,10 @@ type PickerFieldConfig = {
|
|
|
72693
72982
|
catchEventHandlerExceptions?: boolean
|
|
72694
72983
|
/**
|
|
72695
72984
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
72696
|
-
*
|
|
72985
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PickerField#config-centered)
|
|
72986
|
+
* @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.
|
|
72697
72987
|
*/
|
|
72698
|
-
centered?: boolean
|
|
72988
|
+
centered?: boolean|object
|
|
72699
72989
|
/**
|
|
72700
72990
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
72701
72991
|
* 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)
|
|
@@ -72709,6 +72999,7 @@ type PickerFieldConfig = {
|
|
|
72709
72999
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
72710
73000
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
72711
73001
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
73002
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PickerField#config-clearable)
|
|
72712
73003
|
*/
|
|
72713
73004
|
clearable?: boolean|FieldTriggerConfig
|
|
72714
73005
|
/**
|
|
@@ -72791,7 +73082,7 @@ type PickerFieldConfig = {
|
|
|
72791
73082
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
72792
73083
|
/**
|
|
72793
73084
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
72794
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
73085
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
72795
73086
|
* property which controls when a drag should start.
|
|
72796
73087
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PickerField#config-draggable)
|
|
72797
73088
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -73130,7 +73421,7 @@ type PickerFieldConfig = {
|
|
|
73130
73421
|
rtl?: boolean
|
|
73131
73422
|
/**
|
|
73132
73423
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
73133
|
-
* Valid values:
|
|
73424
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
73134
73425
|
*/
|
|
73135
73426
|
scrollAction?: 'hide'|'realign'|null
|
|
73136
73427
|
/**
|
|
@@ -73874,9 +74165,10 @@ type PopupConfig = {
|
|
|
73874
74165
|
catchEventHandlerExceptions?: boolean
|
|
73875
74166
|
/**
|
|
73876
74167
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
73877
|
-
*
|
|
74168
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Popup#config-centered)
|
|
74169
|
+
* @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.
|
|
73878
74170
|
*/
|
|
73879
|
-
centered?: boolean
|
|
74171
|
+
centered?: boolean|object
|
|
73880
74172
|
/**
|
|
73881
74173
|
* Show a tool in the header to close this Popup.
|
|
73882
74174
|
* The tool is available in the [tools](https://bryntum.com/products/grid/docs/api/Core/widget/mixin/Toolable#property-tools) object
|
|
@@ -74133,7 +74425,7 @@ type PopupConfig = {
|
|
|
74133
74425
|
*/
|
|
74134
74426
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
74135
74427
|
/**
|
|
74136
|
-
* Sets `labelWidth
|
|
74428
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
74137
74429
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Popup#config-labelWidth)
|
|
74138
74430
|
*/
|
|
74139
74431
|
labelWidth?: number|null
|
|
@@ -74338,7 +74630,7 @@ type PopupConfig = {
|
|
|
74338
74630
|
rtl?: boolean
|
|
74339
74631
|
/**
|
|
74340
74632
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
74341
|
-
* Valid values:
|
|
74633
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
74342
74634
|
*/
|
|
74343
74635
|
scrollAction?: 'hide'|'realign'|null
|
|
74344
74636
|
/**
|
|
@@ -75031,9 +75323,10 @@ type ProgressBarConfig = {
|
|
|
75031
75323
|
catchEventHandlerExceptions?: boolean
|
|
75032
75324
|
/**
|
|
75033
75325
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
75034
|
-
*
|
|
75326
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ProgressBar#config-centered)
|
|
75327
|
+
* @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.
|
|
75035
75328
|
*/
|
|
75036
|
-
centered?: boolean
|
|
75329
|
+
centered?: boolean|object
|
|
75037
75330
|
/**
|
|
75038
75331
|
* Custom CSS classes to add to element.
|
|
75039
75332
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -75104,7 +75397,7 @@ type ProgressBarConfig = {
|
|
|
75104
75397
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
75105
75398
|
/**
|
|
75106
75399
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
75107
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
75400
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
75108
75401
|
* property which controls when a drag should start.
|
|
75109
75402
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ProgressBar#config-draggable)
|
|
75110
75403
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -75322,7 +75615,7 @@ type ProgressBarConfig = {
|
|
|
75322
75615
|
rtl?: boolean
|
|
75323
75616
|
/**
|
|
75324
75617
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
75325
|
-
* Valid values:
|
|
75618
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
75326
75619
|
*/
|
|
75327
75620
|
scrollAction?: 'hide'|'realign'|null
|
|
75328
75621
|
/**
|
|
@@ -76036,9 +76329,10 @@ type RadioConfig = {
|
|
|
76036
76329
|
catchEventHandlerExceptions?: boolean
|
|
76037
76330
|
/**
|
|
76038
76331
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
76039
|
-
*
|
|
76332
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Radio#config-centered)
|
|
76333
|
+
* @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.
|
|
76040
76334
|
*/
|
|
76041
|
-
centered?: boolean
|
|
76335
|
+
centered?: boolean|object
|
|
76042
76336
|
/**
|
|
76043
76337
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
76044
76338
|
* 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)
|
|
@@ -76136,7 +76430,7 @@ type RadioConfig = {
|
|
|
76136
76430
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
76137
76431
|
/**
|
|
76138
76432
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
76139
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
76433
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
76140
76434
|
* property which controls when a drag should start.
|
|
76141
76435
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Radio#config-draggable)
|
|
76142
76436
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -76444,7 +76738,7 @@ type RadioConfig = {
|
|
|
76444
76738
|
rtl?: boolean
|
|
76445
76739
|
/**
|
|
76446
76740
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
76447
|
-
* Valid values:
|
|
76741
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
76448
76742
|
*/
|
|
76449
76743
|
scrollAction?: 'hide'|'realign'|null
|
|
76450
76744
|
/**
|
|
@@ -77176,9 +77470,10 @@ type RadioGroupConfig = {
|
|
|
77176
77470
|
catchEventHandlerExceptions?: boolean
|
|
77177
77471
|
/**
|
|
77178
77472
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
77179
|
-
*
|
|
77473
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/RadioGroup#config-centered)
|
|
77474
|
+
* @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.
|
|
77180
77475
|
*/
|
|
77181
|
-
centered?: boolean
|
|
77476
|
+
centered?: boolean|object
|
|
77182
77477
|
/**
|
|
77183
77478
|
* Set this to `true` so that clicking the currently checked radio button will clear the check from all
|
|
77184
77479
|
* radio buttons in the group.
|
|
@@ -77278,7 +77573,7 @@ type RadioGroupConfig = {
|
|
|
77278
77573
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
77279
77574
|
/**
|
|
77280
77575
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
77281
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
77576
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
77282
77577
|
* property which controls when a drag should start.
|
|
77283
77578
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/RadioGroup#config-draggable)
|
|
77284
77579
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -77431,7 +77726,7 @@ type RadioGroupConfig = {
|
|
|
77431
77726
|
*/
|
|
77432
77727
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
77433
77728
|
/**
|
|
77434
|
-
* Sets `labelWidth
|
|
77729
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
77435
77730
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/RadioGroup#config-labelWidth)
|
|
77436
77731
|
*/
|
|
77437
77732
|
labelWidth?: number|null
|
|
@@ -77615,7 +77910,7 @@ type RadioGroupConfig = {
|
|
|
77615
77910
|
rtl?: boolean
|
|
77616
77911
|
/**
|
|
77617
77912
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
77618
|
-
* Valid values:
|
|
77913
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
77619
77914
|
*/
|
|
77620
77915
|
scrollAction?: 'hide'|'realign'|null
|
|
77621
77916
|
/**
|
|
@@ -78383,9 +78678,10 @@ type RichTextFieldConfig = {
|
|
|
78383
78678
|
catchEventHandlerExceptions?: boolean
|
|
78384
78679
|
/**
|
|
78385
78680
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
78386
|
-
*
|
|
78681
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/RichTextField#config-centered)
|
|
78682
|
+
* @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.
|
|
78387
78683
|
*/
|
|
78388
|
-
centered?: boolean
|
|
78684
|
+
centered?: boolean|object
|
|
78389
78685
|
/**
|
|
78390
78686
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
78391
78687
|
* 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)
|
|
@@ -78399,6 +78695,7 @@ type RichTextFieldConfig = {
|
|
|
78399
78695
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
78400
78696
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
78401
78697
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
78698
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/RichTextField#config-clearable)
|
|
78402
78699
|
*/
|
|
78403
78700
|
clearable?: boolean|FieldTriggerConfig
|
|
78404
78701
|
/**
|
|
@@ -78481,7 +78778,7 @@ type RichTextFieldConfig = {
|
|
|
78481
78778
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
78482
78779
|
/**
|
|
78483
78780
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
78484
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
78781
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
78485
78782
|
* property which controls when a drag should start.
|
|
78486
78783
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/RichTextField#config-draggable)
|
|
78487
78784
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -78800,7 +79097,7 @@ type RichTextFieldConfig = {
|
|
|
78800
79097
|
rtl?: boolean
|
|
78801
79098
|
/**
|
|
78802
79099
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
78803
|
-
* Valid values:
|
|
79100
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
78804
79101
|
*/
|
|
78805
79102
|
scrollAction?: 'hide'|'realign'|null
|
|
78806
79103
|
/**
|
|
@@ -79544,9 +79841,10 @@ type SlideToggleConfig = {
|
|
|
79544
79841
|
catchEventHandlerExceptions?: boolean
|
|
79545
79842
|
/**
|
|
79546
79843
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
79547
|
-
*
|
|
79844
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/SlideToggle#config-centered)
|
|
79845
|
+
* @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.
|
|
79548
79846
|
*/
|
|
79549
|
-
centered?: boolean
|
|
79847
|
+
centered?: boolean|object
|
|
79550
79848
|
/**
|
|
79551
79849
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
79552
79850
|
* 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)
|
|
@@ -79644,7 +79942,7 @@ type SlideToggleConfig = {
|
|
|
79644
79942
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
79645
79943
|
/**
|
|
79646
79944
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
79647
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
79945
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
79648
79946
|
* property which controls when a drag should start.
|
|
79649
79947
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/SlideToggle#config-draggable)
|
|
79650
79948
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -79952,7 +80250,7 @@ type SlideToggleConfig = {
|
|
|
79952
80250
|
rtl?: boolean
|
|
79953
80251
|
/**
|
|
79954
80252
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
79955
|
-
* Valid values:
|
|
80253
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
79956
80254
|
*/
|
|
79957
80255
|
scrollAction?: 'hide'|'realign'|null
|
|
79958
80256
|
/**
|
|
@@ -80599,9 +80897,10 @@ type SliderConfig = {
|
|
|
80599
80897
|
catchEventHandlerExceptions?: boolean
|
|
80600
80898
|
/**
|
|
80601
80899
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
80602
|
-
*
|
|
80900
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Slider#config-centered)
|
|
80901
|
+
* @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.
|
|
80603
80902
|
*/
|
|
80604
|
-
centered?: boolean
|
|
80903
|
+
centered?: boolean|object
|
|
80605
80904
|
/**
|
|
80606
80905
|
* Custom CSS classes to add to element.
|
|
80607
80906
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -80674,7 +80973,7 @@ type SliderConfig = {
|
|
|
80674
80973
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
80675
80974
|
/**
|
|
80676
80975
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
80677
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
80976
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
80678
80977
|
* property which controls when a drag should start.
|
|
80679
80978
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Slider#config-draggable)
|
|
80680
80979
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -80909,7 +81208,7 @@ type SliderConfig = {
|
|
|
80909
81208
|
rtl?: boolean
|
|
80910
81209
|
/**
|
|
80911
81210
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
80912
|
-
* Valid values:
|
|
81211
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
80913
81212
|
*/
|
|
80914
81213
|
scrollAction?: 'hide'|'realign'|null
|
|
80915
81214
|
/**
|
|
@@ -81600,9 +81899,10 @@ type SplitterConfig = {
|
|
|
81600
81899
|
catchEventHandlerExceptions?: boolean
|
|
81601
81900
|
/**
|
|
81602
81901
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
81603
|
-
*
|
|
81902
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Splitter#config-centered)
|
|
81903
|
+
* @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.
|
|
81604
81904
|
*/
|
|
81605
|
-
centered?: boolean
|
|
81905
|
+
centered?: boolean|object
|
|
81606
81906
|
/**
|
|
81607
81907
|
* Custom CSS classes to add to element.
|
|
81608
81908
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -81675,7 +81975,7 @@ type SplitterConfig = {
|
|
|
81675
81975
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
81676
81976
|
/**
|
|
81677
81977
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
81678
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
81978
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
81679
81979
|
* property which controls when a drag should start.
|
|
81680
81980
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Splitter#config-draggable)
|
|
81681
81981
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -81890,7 +82190,7 @@ type SplitterConfig = {
|
|
|
81890
82190
|
rtl?: boolean
|
|
81891
82191
|
/**
|
|
81892
82192
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
81893
|
-
* Valid values:
|
|
82193
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
81894
82194
|
*/
|
|
81895
82195
|
scrollAction?: 'hide'|'realign'|null
|
|
81896
82196
|
/**
|
|
@@ -82572,9 +82872,10 @@ type TabConfig = {
|
|
|
82572
82872
|
catchEventHandlerExceptions?: boolean
|
|
82573
82873
|
/**
|
|
82574
82874
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
82575
|
-
*
|
|
82875
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Tab#config-centered)
|
|
82876
|
+
* @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.
|
|
82576
82877
|
*/
|
|
82577
|
-
centered?: boolean
|
|
82878
|
+
centered?: boolean|object
|
|
82578
82879
|
/**
|
|
82579
82880
|
* Set to `true` to show a close icon to remove the tab from the owning TabPanel
|
|
82580
82881
|
*/
|
|
@@ -82651,7 +82952,7 @@ type TabConfig = {
|
|
|
82651
82952
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
82652
82953
|
/**
|
|
82653
82954
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
82654
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
82955
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
82655
82956
|
* property which controls when a drag should start.
|
|
82656
82957
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Tab#config-draggable)
|
|
82657
82958
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -82902,7 +83203,7 @@ type TabConfig = {
|
|
|
82902
83203
|
rtl?: boolean
|
|
82903
83204
|
/**
|
|
82904
83205
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
82905
|
-
* Valid values:
|
|
83206
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
82906
83207
|
*/
|
|
82907
83208
|
scrollAction?: 'hide'|'realign'|null
|
|
82908
83209
|
/**
|
|
@@ -83615,9 +83916,10 @@ type TabBarConfig = {
|
|
|
83615
83916
|
catchEventHandlerExceptions?: boolean
|
|
83616
83917
|
/**
|
|
83617
83918
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
83618
|
-
*
|
|
83919
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TabBar#config-centered)
|
|
83920
|
+
* @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.
|
|
83619
83921
|
*/
|
|
83620
|
-
centered?: boolean
|
|
83922
|
+
centered?: boolean|object
|
|
83621
83923
|
/**
|
|
83622
83924
|
* Custom CSS classes to add to element.
|
|
83623
83925
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -83702,7 +84004,7 @@ type TabBarConfig = {
|
|
|
83702
84004
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
83703
84005
|
/**
|
|
83704
84006
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
83705
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
84007
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
83706
84008
|
* property which controls when a drag should start.
|
|
83707
84009
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TabBar#config-draggable)
|
|
83708
84010
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -83819,7 +84121,7 @@ type TabBarConfig = {
|
|
|
83819
84121
|
*/
|
|
83820
84122
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
83821
84123
|
/**
|
|
83822
|
-
* Sets `labelWidth
|
|
84124
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
83823
84125
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TabBar#config-labelWidth)
|
|
83824
84126
|
*/
|
|
83825
84127
|
labelWidth?: number|null
|
|
@@ -83997,7 +84299,7 @@ type TabBarConfig = {
|
|
|
83997
84299
|
rtl?: boolean
|
|
83998
84300
|
/**
|
|
83999
84301
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
84000
|
-
* Valid values:
|
|
84302
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
84001
84303
|
*/
|
|
84002
84304
|
scrollAction?: 'hide'|'realign'|null
|
|
84003
84305
|
/**
|
|
@@ -84747,9 +85049,10 @@ type TabPanelConfig = {
|
|
|
84747
85049
|
catchEventHandlerExceptions?: boolean
|
|
84748
85050
|
/**
|
|
84749
85051
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
84750
|
-
*
|
|
85052
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TabPanel#config-centered)
|
|
85053
|
+
* @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.
|
|
84751
85054
|
*/
|
|
84752
|
-
centered?: boolean
|
|
85055
|
+
centered?: boolean|object
|
|
84753
85056
|
/**
|
|
84754
85057
|
* Custom CSS classes to add to element.
|
|
84755
85058
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -84844,7 +85147,7 @@ type TabPanelConfig = {
|
|
|
84844
85147
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
84845
85148
|
/**
|
|
84846
85149
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
84847
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
85150
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
84848
85151
|
* property which controls when a drag should start.
|
|
84849
85152
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TabPanel#config-draggable)
|
|
84850
85153
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -84983,7 +85286,7 @@ type TabPanelConfig = {
|
|
|
84983
85286
|
*/
|
|
84984
85287
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
84985
85288
|
/**
|
|
84986
|
-
* Sets `labelWidth
|
|
85289
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
84987
85290
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TabPanel#config-labelWidth)
|
|
84988
85291
|
*/
|
|
84989
85292
|
labelWidth?: number|null
|
|
@@ -85153,7 +85456,7 @@ type TabPanelConfig = {
|
|
|
85153
85456
|
rtl?: boolean
|
|
85154
85457
|
/**
|
|
85155
85458
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
85156
|
-
* Valid values:
|
|
85459
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
85157
85460
|
*/
|
|
85158
85461
|
scrollAction?: 'hide'|'realign'|null
|
|
85159
85462
|
/**
|
|
@@ -85978,9 +86281,10 @@ type TextAreaFieldConfig = {
|
|
|
85978
86281
|
catchEventHandlerExceptions?: boolean
|
|
85979
86282
|
/**
|
|
85980
86283
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
85981
|
-
*
|
|
86284
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-centered)
|
|
86285
|
+
* @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.
|
|
85982
86286
|
*/
|
|
85983
|
-
centered?: boolean
|
|
86287
|
+
centered?: boolean|object
|
|
85984
86288
|
/**
|
|
85985
86289
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
85986
86290
|
* 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)
|
|
@@ -85994,6 +86298,7 @@ type TextAreaFieldConfig = {
|
|
|
85994
86298
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
85995
86299
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
85996
86300
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
86301
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-clearable)
|
|
85997
86302
|
*/
|
|
85998
86303
|
clearable?: boolean|FieldTriggerConfig
|
|
85999
86304
|
/**
|
|
@@ -86076,7 +86381,7 @@ type TextAreaFieldConfig = {
|
|
|
86076
86381
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
86077
86382
|
/**
|
|
86078
86383
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
86079
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
86384
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
86080
86385
|
* property which controls when a drag should start.
|
|
86081
86386
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaField#config-draggable)
|
|
86082
86387
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -86404,7 +86709,7 @@ type TextAreaFieldConfig = {
|
|
|
86404
86709
|
rtl?: boolean
|
|
86405
86710
|
/**
|
|
86406
86711
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
86407
|
-
* Valid values:
|
|
86712
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
86408
86713
|
*/
|
|
86409
86714
|
scrollAction?: 'hide'|'realign'|null
|
|
86410
86715
|
/**
|
|
@@ -87114,9 +87419,10 @@ type TextAreaPickerFieldConfig = {
|
|
|
87114
87419
|
catchEventHandlerExceptions?: boolean
|
|
87115
87420
|
/**
|
|
87116
87421
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
87117
|
-
*
|
|
87422
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaPickerField#config-centered)
|
|
87423
|
+
* @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.
|
|
87118
87424
|
*/
|
|
87119
|
-
centered?: boolean
|
|
87425
|
+
centered?: boolean|object
|
|
87120
87426
|
/**
|
|
87121
87427
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
87122
87428
|
* 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)
|
|
@@ -87130,6 +87436,7 @@ type TextAreaPickerFieldConfig = {
|
|
|
87130
87436
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
87131
87437
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
87132
87438
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
87439
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaPickerField#config-clearable)
|
|
87133
87440
|
*/
|
|
87134
87441
|
clearable?: boolean|FieldTriggerConfig
|
|
87135
87442
|
/**
|
|
@@ -87212,7 +87519,7 @@ type TextAreaPickerFieldConfig = {
|
|
|
87212
87519
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
87213
87520
|
/**
|
|
87214
87521
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
87215
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
87522
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
87216
87523
|
* property which controls when a drag should start.
|
|
87217
87524
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextAreaPickerField#config-draggable)
|
|
87218
87525
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -87551,7 +87858,7 @@ type TextAreaPickerFieldConfig = {
|
|
|
87551
87858
|
rtl?: boolean
|
|
87552
87859
|
/**
|
|
87553
87860
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
87554
|
-
* Valid values:
|
|
87861
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
87555
87862
|
*/
|
|
87556
87863
|
scrollAction?: 'hide'|'realign'|null
|
|
87557
87864
|
/**
|
|
@@ -88253,9 +88560,10 @@ type TextFieldConfig = {
|
|
|
88253
88560
|
catchEventHandlerExceptions?: boolean
|
|
88254
88561
|
/**
|
|
88255
88562
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
88256
|
-
*
|
|
88563
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-centered)
|
|
88564
|
+
* @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.
|
|
88257
88565
|
*/
|
|
88258
|
-
centered?: boolean
|
|
88566
|
+
centered?: boolean|object
|
|
88259
88567
|
/**
|
|
88260
88568
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
88261
88569
|
* 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)
|
|
@@ -88269,6 +88577,7 @@ type TextFieldConfig = {
|
|
|
88269
88577
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
88270
88578
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
88271
88579
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
88580
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-clearable)
|
|
88272
88581
|
*/
|
|
88273
88582
|
clearable?: boolean|FieldTriggerConfig
|
|
88274
88583
|
/**
|
|
@@ -88351,7 +88660,7 @@ type TextFieldConfig = {
|
|
|
88351
88660
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
88352
88661
|
/**
|
|
88353
88662
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
88354
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
88663
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
88355
88664
|
* property which controls when a drag should start.
|
|
88356
88665
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TextField#config-draggable)
|
|
88357
88666
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -88683,7 +88992,7 @@ type TextFieldConfig = {
|
|
|
88683
88992
|
rtl?: boolean
|
|
88684
88993
|
/**
|
|
88685
88994
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
88686
|
-
* Valid values:
|
|
88995
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
88687
88996
|
*/
|
|
88688
88997
|
scrollAction?: 'hide'|'realign'|null
|
|
88689
88998
|
/**
|
|
@@ -89404,9 +89713,10 @@ type TimeFieldConfig = {
|
|
|
89404
89713
|
catchEventHandlerExceptions?: boolean
|
|
89405
89714
|
/**
|
|
89406
89715
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
89407
|
-
*
|
|
89716
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-centered)
|
|
89717
|
+
* @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.
|
|
89408
89718
|
*/
|
|
89409
|
-
centered?: boolean
|
|
89719
|
+
centered?: boolean|object
|
|
89410
89720
|
/**
|
|
89411
89721
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
89412
89722
|
* 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)
|
|
@@ -89420,6 +89730,7 @@ type TimeFieldConfig = {
|
|
|
89420
89730
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
89421
89731
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
89422
89732
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
89733
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-clearable)
|
|
89423
89734
|
*/
|
|
89424
89735
|
clearable?: boolean|FieldTriggerConfig
|
|
89425
89736
|
/**
|
|
@@ -89502,7 +89813,7 @@ type TimeFieldConfig = {
|
|
|
89502
89813
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
89503
89814
|
/**
|
|
89504
89815
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
89505
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
89816
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
89506
89817
|
* property which controls when a drag should start.
|
|
89507
89818
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimeField#config-draggable)
|
|
89508
89819
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -89866,7 +90177,7 @@ type TimeFieldConfig = {
|
|
|
89866
90177
|
rtl?: boolean
|
|
89867
90178
|
/**
|
|
89868
90179
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
89869
|
-
* Valid values:
|
|
90180
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
89870
90181
|
*/
|
|
89871
90182
|
scrollAction?: 'hide'|'realign'|null
|
|
89872
90183
|
/**
|
|
@@ -90570,9 +90881,10 @@ type TimePickerConfig = {
|
|
|
90570
90881
|
catchEventHandlerExceptions?: boolean
|
|
90571
90882
|
/**
|
|
90572
90883
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
90573
|
-
*
|
|
90884
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimePicker#config-centered)
|
|
90885
|
+
* @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.
|
|
90574
90886
|
*/
|
|
90575
|
-
centered?: boolean
|
|
90887
|
+
centered?: boolean|object
|
|
90576
90888
|
/**
|
|
90577
90889
|
* Custom CSS classes to add to element.
|
|
90578
90890
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -90657,7 +90969,7 @@ type TimePickerConfig = {
|
|
|
90657
90969
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
90658
90970
|
/**
|
|
90659
90971
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
90660
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
90972
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
90661
90973
|
* property which controls when a drag should start.
|
|
90662
90974
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimePicker#config-draggable)
|
|
90663
90975
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -90769,7 +91081,7 @@ type TimePickerConfig = {
|
|
|
90769
91081
|
*/
|
|
90770
91082
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
90771
91083
|
/**
|
|
90772
|
-
* Sets `labelWidth
|
|
91084
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
90773
91085
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/TimePicker#config-labelWidth)
|
|
90774
91086
|
*/
|
|
90775
91087
|
labelWidth?: number|null
|
|
@@ -90949,7 +91261,7 @@ type TimePickerConfig = {
|
|
|
90949
91261
|
rtl?: boolean
|
|
90950
91262
|
/**
|
|
90951
91263
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
90952
|
-
* Valid values:
|
|
91264
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
90953
91265
|
*/
|
|
90954
91266
|
scrollAction?: 'hide'|'realign'|null
|
|
90955
91267
|
/**
|
|
@@ -91542,9 +91854,10 @@ type ToastConfig = {
|
|
|
91542
91854
|
catchEventHandlerExceptions?: boolean
|
|
91543
91855
|
/**
|
|
91544
91856
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
91545
|
-
*
|
|
91857
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Toast#config-centered)
|
|
91858
|
+
* @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.
|
|
91546
91859
|
*/
|
|
91547
|
-
centered?: boolean
|
|
91860
|
+
centered?: boolean|object
|
|
91548
91861
|
/**
|
|
91549
91862
|
* Custom CSS classes to add to element.
|
|
91550
91863
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -91617,7 +91930,7 @@ type ToastConfig = {
|
|
|
91617
91930
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
91618
91931
|
/**
|
|
91619
91932
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
91620
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
91933
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
91621
91934
|
* property which controls when a drag should start.
|
|
91622
91935
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Toast#config-draggable)
|
|
91623
91936
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -91827,7 +92140,7 @@ type ToastConfig = {
|
|
|
91827
92140
|
rtl?: boolean
|
|
91828
92141
|
/**
|
|
91829
92142
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
91830
|
-
* Valid values:
|
|
92143
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
91831
92144
|
*/
|
|
91832
92145
|
scrollAction?: 'hide'|'realign'|null
|
|
91833
92146
|
/**
|
|
@@ -92406,9 +92719,10 @@ type ToolConfig = {
|
|
|
92406
92719
|
catchEventHandlerExceptions?: boolean
|
|
92407
92720
|
/**
|
|
92408
92721
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
92409
|
-
*
|
|
92722
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Tool#config-centered)
|
|
92723
|
+
* @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.
|
|
92410
92724
|
*/
|
|
92411
|
-
centered?: boolean
|
|
92725
|
+
centered?: boolean|object
|
|
92412
92726
|
/**
|
|
92413
92727
|
* Custom CSS classes to add to element.
|
|
92414
92728
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -92481,7 +92795,7 @@ type ToolConfig = {
|
|
|
92481
92795
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
92482
92796
|
/**
|
|
92483
92797
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
92484
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
92798
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
92485
92799
|
* property which controls when a drag should start.
|
|
92486
92800
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Tool#config-draggable)
|
|
92487
92801
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -92710,7 +93024,7 @@ type ToolConfig = {
|
|
|
92710
93024
|
rtl?: boolean
|
|
92711
93025
|
/**
|
|
92712
93026
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
92713
|
-
* Valid values:
|
|
93027
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
92714
93028
|
*/
|
|
92715
93029
|
scrollAction?: 'hide'|'realign'|null
|
|
92716
93030
|
/**
|
|
@@ -93345,9 +93659,10 @@ type ToolbarConfig = {
|
|
|
93345
93659
|
catchEventHandlerExceptions?: boolean
|
|
93346
93660
|
/**
|
|
93347
93661
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
93348
|
-
*
|
|
93662
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar#config-centered)
|
|
93663
|
+
* @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.
|
|
93349
93664
|
*/
|
|
93350
|
-
centered?: boolean
|
|
93665
|
+
centered?: boolean|object
|
|
93351
93666
|
/**
|
|
93352
93667
|
* Custom CSS classes to add to element.
|
|
93353
93668
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -93432,7 +93747,7 @@ type ToolbarConfig = {
|
|
|
93432
93747
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
93433
93748
|
/**
|
|
93434
93749
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
93435
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
93750
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
93436
93751
|
* property which controls when a drag should start.
|
|
93437
93752
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar#config-draggable)
|
|
93438
93753
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -93543,7 +93858,7 @@ type ToolbarConfig = {
|
|
|
93543
93858
|
*/
|
|
93544
93859
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
93545
93860
|
/**
|
|
93546
|
-
* Sets `labelWidth
|
|
93861
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
93547
93862
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar#config-labelWidth)
|
|
93548
93863
|
*/
|
|
93549
93864
|
labelWidth?: number|null
|
|
@@ -93721,7 +94036,7 @@ type ToolbarConfig = {
|
|
|
93721
94036
|
rtl?: boolean
|
|
93722
94037
|
/**
|
|
93723
94038
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
93724
|
-
* Valid values:
|
|
94039
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
93725
94040
|
*/
|
|
93726
94041
|
scrollAction?: 'hide'|'realign'|null
|
|
93727
94042
|
/**
|
|
@@ -94525,9 +94840,10 @@ type TooltipConfig = {
|
|
|
94525
94840
|
catchEventHandlerExceptions?: boolean
|
|
94526
94841
|
/**
|
|
94527
94842
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
94528
|
-
*
|
|
94843
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Tooltip#config-centered)
|
|
94844
|
+
* @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.
|
|
94529
94845
|
*/
|
|
94530
|
-
centered?: boolean
|
|
94846
|
+
centered?: boolean|object
|
|
94531
94847
|
/**
|
|
94532
94848
|
* Show a tool in the header to close this Popup.
|
|
94533
94849
|
* The tool is available in the [tools](https://bryntum.com/products/grid/docs/api/Core/widget/mixin/Toolable#property-tools) object
|
|
@@ -94829,7 +95145,7 @@ type TooltipConfig = {
|
|
|
94829
95145
|
*/
|
|
94830
95146
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
94831
95147
|
/**
|
|
94832
|
-
* Sets `labelWidth
|
|
95148
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
94833
95149
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Tooltip#config-labelWidth)
|
|
94834
95150
|
*/
|
|
94835
95151
|
labelWidth?: number|null
|
|
@@ -95046,7 +95362,7 @@ type TooltipConfig = {
|
|
|
95046
95362
|
rtl?: boolean
|
|
95047
95363
|
/**
|
|
95048
95364
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
95049
|
-
* Valid values:
|
|
95365
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
95050
95366
|
*/
|
|
95051
95367
|
scrollAction?: 'hide'|'realign'|null
|
|
95052
95368
|
/**
|
|
@@ -95776,9 +96092,10 @@ type WidgetConfig = {
|
|
|
95776
96092
|
catchEventHandlerExceptions?: boolean
|
|
95777
96093
|
/**
|
|
95778
96094
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
95779
|
-
*
|
|
96095
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-centered)
|
|
96096
|
+
* @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.
|
|
95780
96097
|
*/
|
|
95781
|
-
centered?: boolean
|
|
96098
|
+
centered?: boolean|object
|
|
95782
96099
|
/**
|
|
95783
96100
|
* Custom CSS classes to add to element.
|
|
95784
96101
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -95851,7 +96168,7 @@ type WidgetConfig = {
|
|
|
95851
96168
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
95852
96169
|
/**
|
|
95853
96170
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
95854
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
96171
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
95855
96172
|
* property which controls when a drag should start.
|
|
95856
96173
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-draggable)
|
|
95857
96174
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -96061,7 +96378,7 @@ type WidgetConfig = {
|
|
|
96061
96378
|
rtl?: boolean
|
|
96062
96379
|
/**
|
|
96063
96380
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
96064
|
-
* Valid values:
|
|
96381
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
96065
96382
|
*/
|
|
96066
96383
|
scrollAction?: 'hide'|'realign'|null
|
|
96067
96384
|
/**
|
|
@@ -96331,6 +96648,12 @@ export class Widget extends Base {
|
|
|
96331
96648
|
* An object providing the `record` and `column` for a widget embedded inside a [WidgetColumn](https://bryntum.com/products/grid/docs/api/Grid/column/WidgetColumn)
|
|
96332
96649
|
*/
|
|
96333
96650
|
readonly cellInfo: CellWidgetContext
|
|
96651
|
+
/**
|
|
96652
|
+
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
96653
|
+
*/
|
|
96654
|
+
centered: boolean|{
|
|
96655
|
+
once?: boolean
|
|
96656
|
+
}
|
|
96334
96657
|
/**
|
|
96335
96658
|
* Custom CSS classes to add to element.
|
|
96336
96659
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -97404,9 +97727,10 @@ type YearPickerConfig = {
|
|
|
97404
97727
|
catchEventHandlerExceptions?: boolean
|
|
97405
97728
|
/**
|
|
97406
97729
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
97407
|
-
*
|
|
97730
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/YearPicker#config-centered)
|
|
97731
|
+
* @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.
|
|
97408
97732
|
*/
|
|
97409
|
-
centered?: boolean
|
|
97733
|
+
centered?: boolean|object
|
|
97410
97734
|
/**
|
|
97411
97735
|
* Custom CSS classes to add to element.
|
|
97412
97736
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -97501,7 +97825,7 @@ type YearPickerConfig = {
|
|
|
97501
97825
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
97502
97826
|
/**
|
|
97503
97827
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
97504
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
97828
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
97505
97829
|
* property which controls when a drag should start.
|
|
97506
97830
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/YearPicker#config-draggable)
|
|
97507
97831
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -97640,7 +97964,7 @@ type YearPickerConfig = {
|
|
|
97640
97964
|
*/
|
|
97641
97965
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
97642
97966
|
/**
|
|
97643
|
-
* Sets `labelWidth
|
|
97967
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
97644
97968
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/YearPicker#config-labelWidth)
|
|
97645
97969
|
*/
|
|
97646
97970
|
labelWidth?: number|null
|
|
@@ -97818,7 +98142,7 @@ type YearPickerConfig = {
|
|
|
97818
98142
|
rtl?: boolean
|
|
97819
98143
|
/**
|
|
97820
98144
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
97821
|
-
* Valid values:
|
|
98145
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
97822
98146
|
*/
|
|
97823
98147
|
scrollAction?: 'hide'|'realign'|null
|
|
97824
98148
|
/**
|
|
@@ -98545,9 +98869,10 @@ type UndoRedoBaseConfig = {
|
|
|
98545
98869
|
catchEventHandlerExceptions?: boolean
|
|
98546
98870
|
/**
|
|
98547
98871
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
98548
|
-
*
|
|
98872
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/base/UndoRedoBase#config-centered)
|
|
98873
|
+
* @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.
|
|
98549
98874
|
*/
|
|
98550
|
-
centered?: boolean
|
|
98875
|
+
centered?: boolean|object
|
|
98551
98876
|
/**
|
|
98552
98877
|
* Custom CSS classes to add to element.
|
|
98553
98878
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -98630,7 +98955,7 @@ type UndoRedoBaseConfig = {
|
|
|
98630
98955
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
98631
98956
|
/**
|
|
98632
98957
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
98633
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
98958
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
98634
98959
|
* property which controls when a drag should start.
|
|
98635
98960
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/base/UndoRedoBase#config-draggable)
|
|
98636
98961
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -98737,7 +99062,7 @@ type UndoRedoBaseConfig = {
|
|
|
98737
99062
|
*/
|
|
98738
99063
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
98739
99064
|
/**
|
|
98740
|
-
* Sets `labelWidth
|
|
99065
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
98741
99066
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/base/UndoRedoBase#config-labelWidth)
|
|
98742
99067
|
*/
|
|
98743
99068
|
labelWidth?: number|null
|
|
@@ -98907,7 +99232,7 @@ type UndoRedoBaseConfig = {
|
|
|
98907
99232
|
rtl?: boolean
|
|
98908
99233
|
/**
|
|
98909
99234
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
98910
|
-
* Valid values:
|
|
99235
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
98911
99236
|
*/
|
|
98912
99237
|
scrollAction?: 'hide'|'realign'|null
|
|
98913
99238
|
/**
|
|
@@ -99504,9 +99829,10 @@ type AISettingsPanelConfig = {
|
|
|
99504
99829
|
catchEventHandlerExceptions?: boolean
|
|
99505
99830
|
/**
|
|
99506
99831
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
99507
|
-
*
|
|
99832
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/AISettingsPanel#config-centered)
|
|
99833
|
+
* @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.
|
|
99508
99834
|
*/
|
|
99509
|
-
centered?: boolean
|
|
99835
|
+
centered?: boolean|object
|
|
99510
99836
|
/**
|
|
99511
99837
|
* Custom CSS classes to add to element.
|
|
99512
99838
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -99591,7 +99917,7 @@ type AISettingsPanelConfig = {
|
|
|
99591
99917
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
99592
99918
|
/**
|
|
99593
99919
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
99594
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
99920
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
99595
99921
|
* property which controls when a drag should start.
|
|
99596
99922
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/AISettingsPanel#config-draggable)
|
|
99597
99923
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -99698,7 +100024,7 @@ type AISettingsPanelConfig = {
|
|
|
99698
100024
|
*/
|
|
99699
100025
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
99700
100026
|
/**
|
|
99701
|
-
* Sets `labelWidth
|
|
100027
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
99702
100028
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/AISettingsPanel#config-labelWidth)
|
|
99703
100029
|
*/
|
|
99704
100030
|
labelWidth?: number|null
|
|
@@ -99868,7 +100194,7 @@ type AISettingsPanelConfig = {
|
|
|
99868
100194
|
rtl?: boolean
|
|
99869
100195
|
/**
|
|
99870
100196
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
99871
|
-
* Valid values:
|
|
100197
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
99872
100198
|
*/
|
|
99873
100199
|
scrollAction?: 'hide'|'realign'|null
|
|
99874
100200
|
/**
|
|
@@ -100610,9 +100936,10 @@ type ChatPanelConfig = {
|
|
|
100610
100936
|
catchEventHandlerExceptions?: boolean
|
|
100611
100937
|
/**
|
|
100612
100938
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
100613
|
-
*
|
|
100939
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-centered)
|
|
100940
|
+
* @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.
|
|
100614
100941
|
*/
|
|
100615
|
-
centered?: boolean
|
|
100942
|
+
centered?: boolean|object
|
|
100616
100943
|
/**
|
|
100617
100944
|
* Custom CSS classes to add to element.
|
|
100618
100945
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -100707,7 +101034,7 @@ type ChatPanelConfig = {
|
|
|
100707
101034
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
100708
101035
|
/**
|
|
100709
101036
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
100710
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
101037
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
100711
101038
|
* property which controls when a drag should start.
|
|
100712
101039
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-draggable)
|
|
100713
101040
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -100855,7 +101182,7 @@ type ChatPanelConfig = {
|
|
|
100855
101182
|
*/
|
|
100856
101183
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
100857
101184
|
/**
|
|
100858
|
-
* Sets `labelWidth
|
|
101185
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
100859
101186
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-labelWidth)
|
|
100860
101187
|
*/
|
|
100861
101188
|
labelWidth?: number|null
|
|
@@ -101037,7 +101364,7 @@ type ChatPanelConfig = {
|
|
|
101037
101364
|
rtl?: boolean
|
|
101038
101365
|
/**
|
|
101039
101366
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
101040
|
-
* Valid values:
|
|
101367
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
101041
101368
|
*/
|
|
101042
101369
|
scrollAction?: 'hide'|'realign'|null
|
|
101043
101370
|
/**
|
|
@@ -102034,9 +102361,10 @@ type ConfirmationDialogConfig = {
|
|
|
102034
102361
|
catchEventHandlerExceptions?: boolean
|
|
102035
102362
|
/**
|
|
102036
102363
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
102037
|
-
*
|
|
102364
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ConfirmationDialog#config-centered)
|
|
102365
|
+
* @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.
|
|
102038
102366
|
*/
|
|
102039
|
-
centered?: boolean
|
|
102367
|
+
centered?: boolean|object
|
|
102040
102368
|
/**
|
|
102041
102369
|
* Custom CSS classes to add to element.
|
|
102042
102370
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -102101,7 +102429,7 @@ type ConfirmationDialogConfig = {
|
|
|
102101
102429
|
disabled?: boolean|'inert'
|
|
102102
102430
|
/**
|
|
102103
102431
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
102104
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
102432
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
102105
102433
|
* property which controls when a drag should start.
|
|
102106
102434
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ConfirmationDialog#config-draggable)
|
|
102107
102435
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -102209,7 +102537,7 @@ type ConfirmationDialogConfig = {
|
|
|
102209
102537
|
*/
|
|
102210
102538
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
102211
102539
|
/**
|
|
102212
|
-
* Sets `labelWidth
|
|
102540
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
102213
102541
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ConfirmationDialog#config-labelWidth)
|
|
102214
102542
|
*/
|
|
102215
102543
|
labelWidth?: number|null
|
|
@@ -102343,7 +102671,7 @@ type ConfirmationDialogConfig = {
|
|
|
102343
102671
|
rtl?: boolean
|
|
102344
102672
|
/**
|
|
102345
102673
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
102346
|
-
* Valid values:
|
|
102674
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
102347
102675
|
*/
|
|
102348
102676
|
scrollAction?: 'hide'|'realign'|null
|
|
102349
102677
|
/**
|
|
@@ -102931,9 +103259,10 @@ type HistogramConfig = {
|
|
|
102931
103259
|
catchEventHandlerExceptions?: boolean
|
|
102932
103260
|
/**
|
|
102933
103261
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
102934
|
-
*
|
|
103262
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/graph/Histogram#config-centered)
|
|
103263
|
+
* @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.
|
|
102935
103264
|
*/
|
|
102936
|
-
centered?: boolean
|
|
103265
|
+
centered?: boolean|object
|
|
102937
103266
|
/**
|
|
102938
103267
|
* Custom CSS classes to add to element.
|
|
102939
103268
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -103011,7 +103340,7 @@ type HistogramConfig = {
|
|
|
103011
103340
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
103012
103341
|
/**
|
|
103013
103342
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
103014
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
103343
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
103015
103344
|
* property which controls when a drag should start.
|
|
103016
103345
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/graph/Histogram#config-draggable)
|
|
103017
103346
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -103303,7 +103632,7 @@ type HistogramConfig = {
|
|
|
103303
103632
|
rtl?: boolean
|
|
103304
103633
|
/**
|
|
103305
103634
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
103306
|
-
* Valid values:
|
|
103635
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
103307
103636
|
*/
|
|
103308
103637
|
scrollAction?: 'hide'|'realign'|null
|
|
103309
103638
|
/**
|
|
@@ -103843,9 +104172,10 @@ type ScaleConfig = {
|
|
|
103843
104172
|
catchEventHandlerExceptions?: boolean
|
|
103844
104173
|
/**
|
|
103845
104174
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
103846
|
-
*
|
|
104175
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/graph/Scale#config-centered)
|
|
104176
|
+
* @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.
|
|
103847
104177
|
*/
|
|
103848
|
-
centered?: boolean
|
|
104178
|
+
centered?: boolean|object
|
|
103849
104179
|
/**
|
|
103850
104180
|
* Custom CSS classes to add to element.
|
|
103851
104181
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -103918,7 +104248,7 @@ type ScaleConfig = {
|
|
|
103918
104248
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
103919
104249
|
/**
|
|
103920
104250
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
103921
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
104251
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
103922
104252
|
* property which controls when a drag should start.
|
|
103923
104253
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/graph/Scale#config-draggable)
|
|
103924
104254
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -104132,7 +104462,7 @@ type ScaleConfig = {
|
|
|
104132
104462
|
rtl?: boolean
|
|
104133
104463
|
/**
|
|
104134
104464
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
104135
|
-
* Valid values:
|
|
104465
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
104136
104466
|
*/
|
|
104137
104467
|
scrollAction?: 'hide'|'realign'|null
|
|
104138
104468
|
/**
|
|
@@ -105422,7 +105752,7 @@ type ActionColumnConfig = {
|
|
|
105422
105752
|
*/
|
|
105423
105753
|
alwaysClearCell?: boolean
|
|
105424
105754
|
/**
|
|
105425
|
-
* The `aria-label` to use for this Column
|
|
105755
|
+
* The `aria-label` to use for this Column's header element
|
|
105426
105756
|
*/
|
|
105427
105757
|
ariaLabel?: string
|
|
105428
105758
|
/**
|
|
@@ -106065,7 +106395,7 @@ type AggregateColumnConfig = {
|
|
|
106065
106395
|
*/
|
|
106066
106396
|
alwaysClearCell?: boolean
|
|
106067
106397
|
/**
|
|
106068
|
-
* The `aria-label` to use for this Column
|
|
106398
|
+
* The `aria-label` to use for this Column's header element
|
|
106069
106399
|
*/
|
|
106070
106400
|
ariaLabel?: string
|
|
106071
106401
|
/**
|
|
@@ -106806,7 +107136,7 @@ type ChartColumnConfig = {
|
|
|
106806
107136
|
*/
|
|
106807
107137
|
alwaysClearCell?: boolean
|
|
106808
107138
|
/**
|
|
106809
|
-
* The `aria-label` to use for this Column
|
|
107139
|
+
* The `aria-label` to use for this Column's header element
|
|
106810
107140
|
*/
|
|
106811
107141
|
ariaLabel?: string
|
|
106812
107142
|
/**
|
|
@@ -107544,7 +107874,7 @@ type CheckColumnConfig = {
|
|
|
107544
107874
|
*/
|
|
107545
107875
|
alwaysClearCell?: boolean
|
|
107546
107876
|
/**
|
|
107547
|
-
* The `aria-label` to use for this Column
|
|
107877
|
+
* The `aria-label` to use for this Column's header element
|
|
107548
107878
|
*/
|
|
107549
107879
|
ariaLabel?: string
|
|
107550
107880
|
/**
|
|
@@ -108306,7 +108636,7 @@ type ColorColumnConfig = {
|
|
|
108306
108636
|
*/
|
|
108307
108637
|
alwaysClearCell?: boolean
|
|
108308
108638
|
/**
|
|
108309
|
-
* The `aria-label` to use for this Column
|
|
108639
|
+
* The `aria-label` to use for this Column's header element
|
|
108310
108640
|
*/
|
|
108311
108641
|
ariaLabel?: string
|
|
108312
108642
|
/**
|
|
@@ -109001,7 +109331,7 @@ type ColumnConfig = {
|
|
|
109001
109331
|
*/
|
|
109002
109332
|
alwaysClearCell?: boolean
|
|
109003
109333
|
/**
|
|
109004
|
-
* The `aria-label` to use for this Column
|
|
109334
|
+
* The `aria-label` to use for this Column's header element
|
|
109005
109335
|
*/
|
|
109006
109336
|
ariaLabel?: string
|
|
109007
109337
|
/**
|
|
@@ -109575,7 +109905,7 @@ export class Column extends Model {
|
|
|
109575
109905
|
*/
|
|
109576
109906
|
alwaysClearCell: boolean
|
|
109577
109907
|
/**
|
|
109578
|
-
* The `aria-label` to use for this Column
|
|
109908
|
+
* The `aria-label` to use for this Column's header element
|
|
109579
109909
|
*/
|
|
109580
109910
|
ariaLabel: string
|
|
109581
109911
|
/**
|
|
@@ -110271,7 +110601,7 @@ type CurrencyColumnConfig = {
|
|
|
110271
110601
|
*/
|
|
110272
110602
|
alwaysClearCell?: boolean
|
|
110273
110603
|
/**
|
|
110274
|
-
* The `aria-label` to use for this Column
|
|
110604
|
+
* The `aria-label` to use for this Column's header element
|
|
110275
110605
|
*/
|
|
110276
110606
|
ariaLabel?: string
|
|
110277
110607
|
/**
|
|
@@ -110989,7 +111319,7 @@ type DateColumnConfig = {
|
|
|
110989
111319
|
*/
|
|
110990
111320
|
alwaysClearCell?: boolean
|
|
110991
111321
|
/**
|
|
110992
|
-
* The `aria-label` to use for this Column
|
|
111322
|
+
* The `aria-label` to use for this Column's header element
|
|
110993
111323
|
*/
|
|
110994
111324
|
ariaLabel?: string
|
|
110995
111325
|
/**
|
|
@@ -111714,7 +112044,7 @@ type NumberColumnConfig = {
|
|
|
111714
112044
|
*/
|
|
111715
112045
|
alwaysClearCell?: boolean
|
|
111716
112046
|
/**
|
|
111717
|
-
* The `aria-label` to use for this Column
|
|
112047
|
+
* The `aria-label` to use for this Column's header element
|
|
111718
112048
|
*/
|
|
111719
112049
|
ariaLabel?: string
|
|
111720
112050
|
/**
|
|
@@ -112454,7 +112784,7 @@ type PercentColumnConfig = {
|
|
|
112454
112784
|
*/
|
|
112455
112785
|
alwaysClearCell?: boolean
|
|
112456
112786
|
/**
|
|
112457
|
-
* The `aria-label` to use for this Column
|
|
112787
|
+
* The `aria-label` to use for this Column's header element
|
|
112458
112788
|
*/
|
|
112459
112789
|
ariaLabel?: string
|
|
112460
112790
|
/**
|
|
@@ -113180,7 +113510,7 @@ type RatingColumnConfig = {
|
|
|
113180
113510
|
*/
|
|
113181
113511
|
alwaysClearCell?: boolean
|
|
113182
113512
|
/**
|
|
113183
|
-
* The `aria-label` to use for this Column
|
|
113513
|
+
* The `aria-label` to use for this Column's header element
|
|
113184
113514
|
*/
|
|
113185
113515
|
ariaLabel?: string
|
|
113186
113516
|
/**
|
|
@@ -113903,7 +114233,7 @@ type RowNumberColumnConfig = {
|
|
|
113903
114233
|
*/
|
|
113904
114234
|
alwaysClearCell?: boolean
|
|
113905
114235
|
/**
|
|
113906
|
-
* The `aria-label` to use for this Column
|
|
114236
|
+
* The `aria-label` to use for this Column's header element
|
|
113907
114237
|
*/
|
|
113908
114238
|
ariaLabel?: string
|
|
113909
114239
|
/**
|
|
@@ -114464,7 +114794,7 @@ type SparklineColumnConfig = {
|
|
|
114464
114794
|
*/
|
|
114465
114795
|
alwaysClearCell?: boolean
|
|
114466
114796
|
/**
|
|
114467
|
-
* The `aria-label` to use for this Column
|
|
114797
|
+
* The `aria-label` to use for this Column's header element
|
|
114468
114798
|
*/
|
|
114469
114799
|
ariaLabel?: string
|
|
114470
114800
|
/**
|
|
@@ -115163,7 +115493,7 @@ type TemplateColumnConfig = {
|
|
|
115163
115493
|
*/
|
|
115164
115494
|
alwaysClearCell?: boolean
|
|
115165
115495
|
/**
|
|
115166
|
-
* The `aria-label` to use for this Column
|
|
115496
|
+
* The `aria-label` to use for this Column's header element
|
|
115167
115497
|
*/
|
|
115168
115498
|
ariaLabel?: string
|
|
115169
115499
|
/**
|
|
@@ -115849,7 +116179,7 @@ type TimeColumnConfig = {
|
|
|
115849
116179
|
*/
|
|
115850
116180
|
alwaysClearCell?: boolean
|
|
115851
116181
|
/**
|
|
115852
|
-
* The `aria-label` to use for this Column
|
|
116182
|
+
* The `aria-label` to use for this Column's header element
|
|
115853
116183
|
*/
|
|
115854
116184
|
ariaLabel?: string
|
|
115855
116185
|
/**
|
|
@@ -116532,7 +116862,7 @@ type TreeColumnConfig = {
|
|
|
116532
116862
|
*/
|
|
116533
116863
|
alwaysClearCell?: boolean
|
|
116534
116864
|
/**
|
|
116535
|
-
* The `aria-label` to use for this Column
|
|
116865
|
+
* The `aria-label` to use for this Column's header element
|
|
116536
116866
|
*/
|
|
116537
116867
|
ariaLabel?: string
|
|
116538
116868
|
/**
|
|
@@ -117268,7 +117598,7 @@ type WidgetColumnConfig = {
|
|
|
117268
117598
|
*/
|
|
117269
117599
|
alwaysClearCell?: boolean
|
|
117270
117600
|
/**
|
|
117271
|
-
* The `aria-label` to use for this Column
|
|
117601
|
+
* The `aria-label` to use for this Column's header element
|
|
117272
117602
|
*/
|
|
117273
117603
|
ariaLabel?: string
|
|
117274
117604
|
/**
|
|
@@ -120877,9 +121207,10 @@ type CellTooltipConfig = {
|
|
|
120877
121207
|
catchEventHandlerExceptions?: boolean
|
|
120878
121208
|
/**
|
|
120879
121209
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
120880
|
-
*
|
|
121210
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-centered)
|
|
121211
|
+
* @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.
|
|
120881
121212
|
*/
|
|
120882
|
-
centered?: boolean
|
|
121213
|
+
centered?: boolean|object
|
|
120883
121214
|
/**
|
|
120884
121215
|
* The widget which this plugin is to attach to.
|
|
120885
121216
|
*/
|
|
@@ -121184,7 +121515,7 @@ type CellTooltipConfig = {
|
|
|
121184
121515
|
*/
|
|
121185
121516
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
121186
121517
|
/**
|
|
121187
|
-
* Sets `labelWidth
|
|
121518
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
121188
121519
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-labelWidth)
|
|
121189
121520
|
*/
|
|
121190
121521
|
labelWidth?: number|null
|
|
@@ -121401,7 +121732,7 @@ type CellTooltipConfig = {
|
|
|
121401
121732
|
rtl?: boolean
|
|
121402
121733
|
/**
|
|
121403
121734
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
121404
|
-
* Valid values:
|
|
121735
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
121405
121736
|
*/
|
|
121406
121737
|
scrollAction?: 'hide'|'realign'|null
|
|
121407
121738
|
/**
|
|
@@ -130384,6 +130715,11 @@ type ExcelExporterConfig = {
|
|
|
130384
130715
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-convertEmptyValueToEmptyString)
|
|
130385
130716
|
*/
|
|
130386
130717
|
convertEmptyValueToEmptyString?: boolean
|
|
130718
|
+
/**
|
|
130719
|
+
* MIME type used when creating the CSV Blob for download. Some environments (e.g. Salesforce Lightning Web
|
|
130720
|
+
* Security) block `text/csv` for `URL.createObjectURL`. Use `application/octet-stream` there instead.
|
|
130721
|
+
*/
|
|
130722
|
+
csvMimeType?: string
|
|
130387
130723
|
/**
|
|
130388
130724
|
* Defines how dates in a cell will be formatted
|
|
130389
130725
|
*/
|
|
@@ -130439,6 +130775,12 @@ type ExcelExporterConfig = {
|
|
|
130439
130775
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsProvider)
|
|
130440
130776
|
*/
|
|
130441
130777
|
xlsProvider?: typeof XlsProviderBase
|
|
130778
|
+
/**
|
|
130779
|
+
* MIME type used when creating the XLSX download Blob. Some environments (e.g. Salesforce Lightning Web
|
|
130780
|
+
* Security) block the default XLSX MIME type for `URL.createObjectURL`. Use `application/octet-stream` in such case
|
|
130781
|
+
* instead.
|
|
130782
|
+
*/
|
|
130783
|
+
xlsxMimeType?: string
|
|
130442
130784
|
/**
|
|
130443
130785
|
* Fires before an object is destroyed.
|
|
130444
130786
|
* @param {object} event Event object
|
|
@@ -130521,10 +130863,12 @@ export class ExcelExporter extends InstancePlugin {
|
|
|
130521
130863
|
* @param {boolean,object} [config.csv] Set to `true` to output as a CSV file, or as an object where you can specify delimiters.
|
|
130522
130864
|
* @param {string} [config.csv.columnDelimiter] The CSV delimiter to separate values on one line, defaults to `,`.
|
|
130523
130865
|
* @param {string} [config.csv.lineDelimiter] The CSV delimiter to separate lines, defaults to `\n`.
|
|
130866
|
+
* @param {string} [config.csvMimeType] MIME type used when creating the CSV Blob. Overrides [csvMimeType](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-csvMimeType).
|
|
130867
|
+
* @param {string} [config.xlsxMimeType] MIME type used when creating the XLSX download Blob. Overrides [xlsxMimeType](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsxMimeType).
|
|
130524
130868
|
* @param {string[],object[]} [config.columns] An array of column configuration objects
|
|
130525
130869
|
* @param {Core.data.Model[]} [config.rows] An array of records to export
|
|
130526
130870
|
*/
|
|
130527
|
-
export(config: { filename?: string, dateFormat?: string, csv?: boolean|{ columnDelimiter?: string, lineDelimiter?: string }, columns?: string[]|object[], rows?: Model[] }): Promise<any>;
|
|
130871
|
+
export(config: { filename?: string, dateFormat?: string, csv?: boolean|{ columnDelimiter?: string, lineDelimiter?: string }, csvMimeType?: string, xlsxMimeType?: string, columns?: string[]|object[], rows?: Model[] }): Promise<any>;
|
|
130528
130872
|
}
|
|
130529
130873
|
|
|
130530
130874
|
/**
|
|
@@ -130748,9 +131092,10 @@ export class WriteExcelFileProvider {
|
|
|
130748
131092
|
* @param {object} config.sheet *deprecated, to be removed in 7.0* Object with columns and data
|
|
130749
131093
|
* @param {any[][]} config.sheet.data Array of rows, each row is an array of cells
|
|
130750
131094
|
* @param {XLSColumn[]} config.sheet.cols Array of columns
|
|
130751
|
-
* @param {string} config.MIME
|
|
131095
|
+
* @param {string} config.mimeType MIME type used when creating the download Blob, passed from [xlsxMimeType](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsxMimeType).
|
|
131096
|
+
* @param {string} [config.MIME] *deprecated, use `mimeType` instead*
|
|
130752
131097
|
*/
|
|
130753
|
-
static write(config: { filename: string, rows: any[], columns: XLSColumn[], sheet: { data: any[], cols: XLSColumn[] },
|
|
131098
|
+
static write(config: { filename: string, rows: any[], columns: XLSColumn[], sheet: { data: any[], cols: XLSColumn[] }, mimeType: string, MIME?: string }): Promise<any>;
|
|
130754
131099
|
}
|
|
130755
131100
|
|
|
130756
131101
|
/**
|
|
@@ -130759,17 +131104,18 @@ export class WriteExcelFileProvider {
|
|
|
130759
131104
|
*/
|
|
130760
131105
|
export class XlsProviderBase {
|
|
130761
131106
|
/**
|
|
130762
|
-
* Implement this method to write data to an xls file
|
|
131107
|
+
* Implement this method to write data to an xls file. May return a Promise if the
|
|
131108
|
+
* implementation needs to perform asynchronous work (e.g. awaiting a 3rd-party library).
|
|
131109
|
+
* [ExcelExporter](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter) awaits the return value, so both sync
|
|
131110
|
+
* and async implementations are supported.
|
|
130763
131111
|
* @param {object} config
|
|
130764
131112
|
* @param {string} config.filename Name of the exported file
|
|
130765
131113
|
* @param {any[][]} config.rows Array of rows, each row is an array of cells
|
|
130766
131114
|
* @param {XLSColumn[]} config.columns Array of columns
|
|
130767
|
-
* @param {
|
|
130768
|
-
* @param {
|
|
130769
|
-
* @param {XLSColumn[]} config.sheet.cols Array of columns
|
|
130770
|
-
* @param {string} config.MIME File MIME type
|
|
131115
|
+
* @param {string} config.mimeType MIME type to use when creating the download Blob. Configured via [xlsxMimeType](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter#config-xlsxMimeType).
|
|
131116
|
+
* @param {string} [config.MIME] *deprecated, use `mimeType` instead*
|
|
130771
131117
|
*/
|
|
130772
|
-
static write(config: { filename: string, rows: any[], columns: XLSColumn[],
|
|
131118
|
+
static write(config: { filename: string, rows: any[], columns: XLSColumn[], mimeType: string, MIME?: string }): Promise<void|any>;
|
|
130773
131119
|
}
|
|
130774
131120
|
|
|
130775
131121
|
/**
|
|
@@ -130946,8 +131292,8 @@ type PdfExportConfig = {
|
|
|
130946
131292
|
*/
|
|
130947
131293
|
fileName?: string
|
|
130948
131294
|
/**
|
|
130949
|
-
* A template function used to generate a page footer. It is passed an object with
|
|
130950
|
-
* `totalPages
|
|
131295
|
+
* A template function used to generate a page footer. It is passed an object with `currentPage` and
|
|
131296
|
+
* `totalPages` properties.
|
|
130951
131297
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/PdfExport#config-footerTpl)
|
|
130952
131298
|
* @param {object} data Data object
|
|
130953
131299
|
* @param {number} data.currentPage Current page number
|
|
@@ -130956,8 +131302,8 @@ type PdfExportConfig = {
|
|
|
130956
131302
|
*/
|
|
130957
131303
|
footerTpl?: (data: { currentPage: number, totalPages: number }) => string
|
|
130958
131304
|
/**
|
|
130959
|
-
* A template function used to generate a page header. It is passed an object with
|
|
130960
|
-
* `totalPages
|
|
131305
|
+
* A template function used to generate a page header. It is passed an object with `currentPage` and
|
|
131306
|
+
* `totalPages` properties.
|
|
130961
131307
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/PdfExport#config-headerTpl)
|
|
130962
131308
|
* @param {object} data Data object
|
|
130963
131309
|
* @param {number} data.currentPage Current page number
|
|
@@ -131387,8 +131733,8 @@ type PrintConfig = {
|
|
|
131387
131733
|
*/
|
|
131388
131734
|
exporters?: Exporter[]
|
|
131389
131735
|
/**
|
|
131390
|
-
* A template function used to generate a page footer. It is passed an object with
|
|
131391
|
-
* `totalPages
|
|
131736
|
+
* A template function used to generate a page footer. It is passed an object with `currentPage` and
|
|
131737
|
+
* `totalPages` properties.
|
|
131392
131738
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/Print#config-footerTpl)
|
|
131393
131739
|
* @param {object} data Data object
|
|
131394
131740
|
* @param {number} data.currentPage Current page number
|
|
@@ -131397,8 +131743,8 @@ type PrintConfig = {
|
|
|
131397
131743
|
*/
|
|
131398
131744
|
footerTpl?: (data: { currentPage: number, totalPages: number }) => string
|
|
131399
131745
|
/**
|
|
131400
|
-
* A template function used to generate a page header. It is passed an object with
|
|
131401
|
-
* `totalPages
|
|
131746
|
+
* A template function used to generate a page header. It is passed an object with `currentPage` and
|
|
131747
|
+
* `totalPages` properties.
|
|
131402
131748
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/Print#config-headerTpl)
|
|
131403
131749
|
* @param {object} data Data object
|
|
131404
131750
|
* @param {number} data.currentPage Current page number
|
|
@@ -135673,7 +136019,7 @@ type GridConfig = {
|
|
|
135673
136019
|
*/
|
|
135674
136020
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
135675
136021
|
/**
|
|
135676
|
-
* Sets `labelWidth
|
|
136022
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
135677
136023
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-labelWidth)
|
|
135678
136024
|
*/
|
|
135679
136025
|
labelWidth?: number|null
|
|
@@ -139734,7 +140080,7 @@ type GridBaseConfig = {
|
|
|
139734
140080
|
*/
|
|
139735
140081
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
139736
140082
|
/**
|
|
139737
|
-
* Sets `labelWidth
|
|
140083
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
139738
140084
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-labelWidth)
|
|
139739
140085
|
*/
|
|
139740
140086
|
labelWidth?: number|null
|
|
@@ -143177,9 +143523,10 @@ type SubGridConfig = {
|
|
|
143177
143523
|
catchEventHandlerExceptions?: boolean
|
|
143178
143524
|
/**
|
|
143179
143525
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
143180
|
-
*
|
|
143526
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/SubGrid#config-centered)
|
|
143527
|
+
* @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.
|
|
143181
143528
|
*/
|
|
143182
|
-
centered?: boolean
|
|
143529
|
+
centered?: boolean|object
|
|
143183
143530
|
/**
|
|
143184
143531
|
* Custom CSS classes to add to element.
|
|
143185
143532
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -146212,7 +146559,7 @@ type TreeGridConfig = {
|
|
|
146212
146559
|
*/
|
|
146213
146560
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
146214
146561
|
/**
|
|
146215
|
-
* Sets `labelWidth
|
|
146562
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
146216
146563
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-labelWidth)
|
|
146217
146564
|
*/
|
|
146218
146565
|
labelWidth?: number|null
|
|
@@ -148262,9 +148609,10 @@ type ExportDialogConfig = {
|
|
|
148262
148609
|
catchEventHandlerExceptions?: boolean
|
|
148263
148610
|
/**
|
|
148264
148611
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
148265
|
-
*
|
|
148612
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-centered)
|
|
148613
|
+
* @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.
|
|
148266
148614
|
*/
|
|
148267
|
-
centered?: boolean
|
|
148615
|
+
centered?: boolean|object
|
|
148268
148616
|
/**
|
|
148269
148617
|
* Grid instance to build export dialog for
|
|
148270
148618
|
*/
|
|
@@ -148529,7 +148877,7 @@ type ExportDialogConfig = {
|
|
|
148529
148877
|
*/
|
|
148530
148878
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
148531
148879
|
/**
|
|
148532
|
-
* Sets `labelWidth
|
|
148880
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
148533
148881
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-labelWidth)
|
|
148534
148882
|
*/
|
|
148535
148883
|
labelWidth?: number|null
|
|
@@ -148734,7 +149082,7 @@ type ExportDialogConfig = {
|
|
|
148734
149082
|
rtl?: boolean
|
|
148735
149083
|
/**
|
|
148736
149084
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
148737
|
-
* Valid values:
|
|
149085
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
148738
149086
|
*/
|
|
148739
149087
|
scrollAction?: 'hide'|'realign'|null
|
|
148740
149088
|
/**
|
|
@@ -149084,7 +149432,7 @@ export class ExportDialog extends Popup {
|
|
|
149084
149432
|
/**
|
|
149085
149433
|
* Returns map of values of dialog fields.
|
|
149086
149434
|
*/
|
|
149087
|
-
|
|
149435
|
+
values: Record<string, object>
|
|
149088
149436
|
/**
|
|
149089
149437
|
* Fires before an object is destroyed.
|
|
149090
149438
|
* @param {object} event Event object
|
|
@@ -150246,9 +150594,10 @@ type AIFilterFieldConfig = {
|
|
|
150246
150594
|
catchEventHandlerExceptions?: boolean
|
|
150247
150595
|
/**
|
|
150248
150596
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
150249
|
-
*
|
|
150597
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-centered)
|
|
150598
|
+
* @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.
|
|
150250
150599
|
*/
|
|
150251
|
-
centered?: boolean
|
|
150600
|
+
centered?: boolean|object
|
|
150252
150601
|
/**
|
|
150253
150602
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
150254
150603
|
* 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)
|
|
@@ -150262,6 +150611,7 @@ type AIFilterFieldConfig = {
|
|
|
150262
150611
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
150263
150612
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
150264
150613
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
150614
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-clearable)
|
|
150265
150615
|
*/
|
|
150266
150616
|
clearable?: boolean|FieldTriggerConfig
|
|
150267
150617
|
/**
|
|
@@ -150349,7 +150699,7 @@ type AIFilterFieldConfig = {
|
|
|
150349
150699
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
150350
150700
|
/**
|
|
150351
150701
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
150352
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
150702
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
150353
150703
|
* property which controls when a drag should start.
|
|
150354
150704
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-draggable)
|
|
150355
150705
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -150685,7 +151035,7 @@ type AIFilterFieldConfig = {
|
|
|
150685
151035
|
rtl?: boolean
|
|
150686
151036
|
/**
|
|
150687
151037
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
150688
|
-
* Valid values:
|
|
151038
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
150689
151039
|
*/
|
|
150690
151040
|
scrollAction?: 'hide'|'realign'|null
|
|
150691
151041
|
/**
|
|
@@ -151411,9 +151761,10 @@ type ChecklistFilterComboConfig = {
|
|
|
151411
151761
|
catchEventHandlerExceptions?: boolean
|
|
151412
151762
|
/**
|
|
151413
151763
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
151414
|
-
*
|
|
151764
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-centered)
|
|
151765
|
+
* @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.
|
|
151415
151766
|
*/
|
|
151416
|
-
centered?: boolean
|
|
151767
|
+
centered?: boolean|object
|
|
151417
151768
|
/**
|
|
151418
151769
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
151419
151770
|
* 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)
|
|
@@ -151445,6 +151796,7 @@ type ChecklistFilterComboConfig = {
|
|
|
151445
151796
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
151446
151797
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
151447
151798
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
151799
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-clearable)
|
|
151448
151800
|
*/
|
|
151449
151801
|
clearable?: boolean|FieldTriggerConfig
|
|
151450
151802
|
/**
|
|
@@ -151548,7 +151900,7 @@ type ChecklistFilterComboConfig = {
|
|
|
151548
151900
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
151549
151901
|
/**
|
|
151550
151902
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
151551
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
151903
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
151552
151904
|
* property which controls when a drag should start.
|
|
151553
151905
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-draggable)
|
|
151554
151906
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -151995,7 +152347,7 @@ type ChecklistFilterComboConfig = {
|
|
|
151995
152347
|
rtl?: boolean
|
|
151996
152348
|
/**
|
|
151997
152349
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
151998
|
-
* Valid values:
|
|
152350
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
151999
152351
|
*/
|
|
152000
152352
|
scrollAction?: 'hide'|'realign'|null
|
|
152001
152353
|
/**
|
|
@@ -152633,9 +152985,10 @@ type GridChartDesignerConfig = {
|
|
|
152633
152985
|
catchEventHandlerExceptions?: boolean
|
|
152634
152986
|
/**
|
|
152635
152987
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
152636
|
-
*
|
|
152988
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-centered)
|
|
152989
|
+
* @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.
|
|
152637
152990
|
*/
|
|
152638
|
-
centered?: boolean
|
|
152991
|
+
centered?: boolean|object
|
|
152639
152992
|
/**
|
|
152640
152993
|
* Custom CSS classes to add to element.
|
|
152641
152994
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -152708,7 +153061,7 @@ type GridChartDesignerConfig = {
|
|
|
152708
153061
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
152709
153062
|
/**
|
|
152710
153063
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
152711
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
153064
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
152712
153065
|
* property which controls when a drag should start.
|
|
152713
153066
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-draggable)
|
|
152714
153067
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -152924,7 +153277,7 @@ type GridChartDesignerConfig = {
|
|
|
152924
153277
|
rtl?: boolean
|
|
152925
153278
|
/**
|
|
152926
153279
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
152927
|
-
* Valid values:
|
|
153280
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
152928
153281
|
*/
|
|
152929
153282
|
scrollAction?: 'hide'|'realign'|null
|
|
152930
153283
|
/**
|
|
@@ -153508,9 +153861,10 @@ type GridFieldFilterPickerConfig = {
|
|
|
153508
153861
|
catchEventHandlerExceptions?: boolean
|
|
153509
153862
|
/**
|
|
153510
153863
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
153511
|
-
*
|
|
153864
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-centered)
|
|
153865
|
+
* @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.
|
|
153512
153866
|
*/
|
|
153513
|
-
centered?: boolean
|
|
153867
|
+
centered?: boolean|object
|
|
153514
153868
|
/**
|
|
153515
153869
|
* Custom CSS classes to add to element.
|
|
153516
153870
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -153598,7 +153952,7 @@ type GridFieldFilterPickerConfig = {
|
|
|
153598
153952
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
153599
153953
|
/**
|
|
153600
153954
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
153601
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
153955
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
153602
153956
|
* property which controls when a drag should start.
|
|
153603
153957
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-draggable)
|
|
153604
153958
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -153734,7 +154088,7 @@ type GridFieldFilterPickerConfig = {
|
|
|
153734
154088
|
*/
|
|
153735
154089
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
153736
154090
|
/**
|
|
153737
|
-
* Sets `labelWidth
|
|
154091
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
153738
154092
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-labelWidth)
|
|
153739
154093
|
*/
|
|
153740
154094
|
labelWidth?: number|null
|
|
@@ -153920,7 +154274,7 @@ type GridFieldFilterPickerConfig = {
|
|
|
153920
154274
|
rtl?: boolean
|
|
153921
154275
|
/**
|
|
153922
154276
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
153923
|
-
* Valid values:
|
|
154277
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
153924
154278
|
*/
|
|
153925
154279
|
scrollAction?: 'hide'|'realign'|null
|
|
153926
154280
|
/**
|
|
@@ -154589,9 +154943,10 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
154589
154943
|
catchEventHandlerExceptions?: boolean
|
|
154590
154944
|
/**
|
|
154591
154945
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
154592
|
-
*
|
|
154946
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-centered)
|
|
154947
|
+
* @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.
|
|
154593
154948
|
*/
|
|
154594
|
-
centered?: boolean
|
|
154949
|
+
centered?: boolean|object
|
|
154595
154950
|
/**
|
|
154596
154951
|
* Custom CSS classes to add to element.
|
|
154597
154952
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -154679,7 +155034,7 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
154679
155034
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
154680
155035
|
/**
|
|
154681
155036
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
154682
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
155037
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
154683
155038
|
* property which controls when a drag should start.
|
|
154684
155039
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-draggable)
|
|
154685
155040
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -154811,7 +155166,7 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
154811
155166
|
*/
|
|
154812
155167
|
labelPosition?: 'before'|'above'|'align-before'|'auto'|null
|
|
154813
155168
|
/**
|
|
154814
|
-
* Sets `labelWidth
|
|
155169
|
+
* Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
|
|
154815
155170
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-labelWidth)
|
|
154816
155171
|
*/
|
|
154817
155172
|
labelWidth?: number|null
|
|
@@ -154992,7 +155347,7 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
154992
155347
|
rtl?: boolean
|
|
154993
155348
|
/**
|
|
154994
155349
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
154995
|
-
* Valid values:
|
|
155350
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
154996
155351
|
*/
|
|
154997
155352
|
scrollAction?: 'hide'|'realign'|null
|
|
154998
155353
|
/**
|
|
@@ -155667,9 +156022,10 @@ type GroupBarConfig = {
|
|
|
155667
156022
|
catchEventHandlerExceptions?: boolean
|
|
155668
156023
|
/**
|
|
155669
156024
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
155670
|
-
*
|
|
156025
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-centered)
|
|
156026
|
+
* @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.
|
|
155671
156027
|
*/
|
|
155672
|
-
centered?: boolean
|
|
156028
|
+
centered?: boolean|object
|
|
155673
156029
|
/**
|
|
155674
156030
|
* Configure as `true` to clear selection when clicking on empty space inside the List´s element.
|
|
155675
156031
|
*/
|
|
@@ -155768,7 +156124,7 @@ type GroupBarConfig = {
|
|
|
155768
156124
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
155769
156125
|
/**
|
|
155770
156126
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
155771
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
156127
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
155772
156128
|
* property which controls when a drag should start.
|
|
155773
156129
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-draggable)
|
|
155774
156130
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -156034,7 +156390,7 @@ type GroupBarConfig = {
|
|
|
156034
156390
|
rtl?: boolean
|
|
156035
156391
|
/**
|
|
156036
156392
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
156037
|
-
* Valid values:
|
|
156393
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
156038
156394
|
*/
|
|
156039
156395
|
scrollAction?: 'hide'|'realign'|null
|
|
156040
156396
|
/**
|
|
@@ -156760,9 +157116,10 @@ type TreeComboConfig = {
|
|
|
156760
157116
|
catchEventHandlerExceptions?: boolean
|
|
156761
157117
|
/**
|
|
156762
157118
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
156763
|
-
*
|
|
157119
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-centered)
|
|
157120
|
+
* @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.
|
|
156764
157121
|
*/
|
|
156765
|
-
centered?: boolean
|
|
157122
|
+
centered?: boolean|object
|
|
156766
157123
|
/**
|
|
156767
157124
|
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
156768
157125
|
* 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)
|
|
@@ -156794,6 +157151,7 @@ type TreeComboConfig = {
|
|
|
156794
157151
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
156795
157152
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
156796
157153
|
* configures the `clear` [trigger](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers).
|
|
157154
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-clearable)
|
|
156797
157155
|
*/
|
|
156798
157156
|
clearable?: boolean|FieldTriggerConfig
|
|
156799
157157
|
/**
|
|
@@ -156897,7 +157255,7 @@ type TreeComboConfig = {
|
|
|
156897
157255
|
dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
156898
157256
|
/**
|
|
156899
157257
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
156900
|
-
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a
|
|
157258
|
+
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
|
|
156901
157259
|
* property which controls when a drag should start.
|
|
156902
157260
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-draggable)
|
|
156903
157261
|
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
@@ -157343,7 +157701,7 @@ type TreeComboConfig = {
|
|
|
157343
157701
|
rtl?: boolean
|
|
157344
157702
|
/**
|
|
157345
157703
|
* Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
|
|
157346
|
-
* Valid values:
|
|
157704
|
+
* Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
|
|
157347
157705
|
*/
|
|
157348
157706
|
scrollAction?: 'hide'|'realign'|null
|
|
157349
157707
|
/**
|