@bryntum/grid-trial 7.3.0 → 7.3.1
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/README.md +1 -1
- package/fluent2-dark.css +2 -325
- package/fluent2-light.css +2 -325
- package/fonts/Montserrat.woff2 +0 -0
- package/fonts/RobotoFlex.woff2 +0 -0
- package/fonts/poppins-v20-latin-100.woff +0 -0
- package/fonts/poppins-v20-latin-100.woff2 +0 -0
- package/fonts/poppins-v20-latin-200.woff +0 -0
- package/fonts/poppins-v20-latin-200.woff2 +0 -0
- package/fonts/poppins-v20-latin-300.woff +0 -0
- package/fonts/poppins-v20-latin-300.woff2 +0 -0
- package/fonts/poppins-v20-latin-500.woff +0 -0
- package/fonts/poppins-v20-latin-500.woff2 +0 -0
- package/fonts/poppins-v20-latin-600.woff +0 -0
- package/fonts/poppins-v20-latin-600.woff2 +0 -0
- package/fonts/poppins-v20-latin-700.woff +0 -0
- package/fonts/poppins-v20-latin-700.woff2 +0 -0
- package/fonts/poppins-v20-latin-800.woff +0 -0
- package/fonts/poppins-v20-latin-800.woff2 +0 -0
- package/fonts/poppins-v20-latin-900.woff +0 -0
- package/fonts/poppins-v20-latin-900.woff2 +0 -0
- package/fonts/poppins-v20-latin-regular.woff +0 -0
- package/fonts/poppins-v20-latin-regular.woff2 +0 -0
- package/grid.css +2 -325
- package/grid.d.ts +1138 -1211
- package/grid.lwc.module.d.ts +0 -323
- package/grid.module.d.ts +0 -323
- package/grid.module.js +50 -373
- package/grid.thin.d.ts +363 -656
- package/grid.umd.d.ts +0 -323
- package/grid.umd.js +48 -371
- package/grid.wc.module.d.ts +0 -323
- package/high-contrast-dark.css +2 -325
- package/high-contrast-light.css +2 -325
- package/material3-dark.css +2 -325
- package/material3-light.css +2 -325
- package/package.json +1 -1
- package/stockholm-dark.css +2 -325
- package/stockholm-light.css +2 -325
- package/svalbard-dark.css +2 -325
- package/svalbard-light.css +2 -325
- package/visby-dark.css +2 -325
- package/visby-light.css +2 -325
- package/grid.lwc.module.js +0 -324
- package/grid.wc.module.js +0 -420
package/grid.thin.d.ts
CHANGED
|
@@ -1,326 +1,3 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
*
|
|
3
|
-
* Bryntum Grid 7.3.0 (TRIAL VERSION)
|
|
4
|
-
*
|
|
5
|
-
* Copyright(c) 2026 Bryntum AB
|
|
6
|
-
* https://bryntum.com/contact
|
|
7
|
-
* https://bryntum.com/license
|
|
8
|
-
*
|
|
9
|
-
* Bryntum incorporates third-party code licensed under the MIT and Apache-2.0 licenses.
|
|
10
|
-
* See the licenses below or visit https://bryntum.com/products/grid/docs/guide/Grid/licenses
|
|
11
|
-
*
|
|
12
|
-
* # Third Party Notices
|
|
13
|
-
*
|
|
14
|
-
* Bryntum uses the following third party libraries:
|
|
15
|
-
*
|
|
16
|
-
* * [Font Awesome 6 Free](https://fontawesome.com/license/free) (MIT/SIL OFL 1.1)
|
|
17
|
-
* * [Roboto font (for Material theme only)](https://github.com/google/roboto) (Apache-2.0)
|
|
18
|
-
* * [Styling Cross-Browser Compatible Range Inputs with Sass](https://github.com/darlanrod/input-range-sass) (MIT)
|
|
19
|
-
* * [Tree Walker polyfill (only applies to Salesforce)](https://github.com/Krinkle/dom-TreeWalker-polyfill) (MIT)
|
|
20
|
-
* * [chronograph](https://github.com/bryntum/chronograph) (MIT)
|
|
21
|
-
* * [later.js](https://github.com/bunkat/later) (MIT)
|
|
22
|
-
* * [Monaco editor (only used in our demos)](https://microsoft.github.io/monaco-editor) (MIT)
|
|
23
|
-
* * Map/Set polyfill to fix performance issues for Salesforce LWS (MIT)
|
|
24
|
-
* * [Chart.js (when using Chart package)](https://github.com/chartjs/Chart.js) (MIT)
|
|
25
|
-
*
|
|
26
|
-
* Note: the **chronograph** and **later.js** libraries are used in Bryntum Scheduler Pro and Bryntum Gantt, but they are
|
|
27
|
-
* listed for all Bryntum products since the distribution contains trial versions of the thin bundles for all other
|
|
28
|
-
* products. TreeWalker is only used in the LWC bundle for Salesforce. Roboto font is only used in the material theme.
|
|
29
|
-
*
|
|
30
|
-
* ## Font Awesome 6 Free
|
|
31
|
-
*
|
|
32
|
-
* [Font Awesome Free 6 by @fontawesome](https://fontawesome.com/)
|
|
33
|
-
*
|
|
34
|
-
* Font Awesome Free is free, open source, and GPL friendly. You can use it for commercial projects, open source projects,
|
|
35
|
-
* or really almost whatever you want.
|
|
36
|
-
*
|
|
37
|
-
* [Full Font Awesome Free license](https://fontawesome.com/license/free)
|
|
38
|
-
*
|
|
39
|
-
* ## Roboto font
|
|
40
|
-
*
|
|
41
|
-
* [Apache License Version 2.0, January 2004](https://www.apache.org/licenses/LICENSE-2.0)
|
|
42
|
-
*
|
|
43
|
-
* TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
44
|
-
*
|
|
45
|
-
* 1. Definitions.
|
|
46
|
-
*
|
|
47
|
-
* "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9
|
|
48
|
-
* of this document.
|
|
49
|
-
*
|
|
50
|
-
* "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
|
|
51
|
-
*
|
|
52
|
-
* "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are
|
|
53
|
-
* under common control with that entity. For the purposes of this definition,
|
|
54
|
-
* "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by
|
|
55
|
-
* contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial
|
|
56
|
-
* ownership of such entity.
|
|
57
|
-
*
|
|
58
|
-
* "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
|
|
59
|
-
*
|
|
60
|
-
* "Source" form shall mean the preferred form for making modifications, including but not limited to software source code,
|
|
61
|
-
* documentation source, and configuration files.
|
|
62
|
-
*
|
|
63
|
-
* "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including
|
|
64
|
-
* but not limited to compiled object code, generated documentation, and conversions to other media types.
|
|
65
|
-
*
|
|
66
|
-
* "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as
|
|
67
|
-
* indicated by a copyright notice that is included in or attached to the work
|
|
68
|
-
* (an example is provided in the Appendix below).
|
|
69
|
-
*
|
|
70
|
-
* "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work
|
|
71
|
-
* and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an
|
|
72
|
-
* original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain
|
|
73
|
-
* separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
|
|
74
|
-
*
|
|
75
|
-
* "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or
|
|
76
|
-
* additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the
|
|
77
|
-
* Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner.
|
|
78
|
-
* For the purposes of this definition, "submitted"
|
|
79
|
-
* means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including
|
|
80
|
-
* but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems
|
|
81
|
-
* that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding
|
|
82
|
-
* communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a
|
|
83
|
-
* Contribution."
|
|
84
|
-
*
|
|
85
|
-
* "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received
|
|
86
|
-
* by Licensor and subsequently incorporated within the Work.
|
|
87
|
-
*
|
|
88
|
-
* 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to
|
|
89
|
-
* You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce,
|
|
90
|
-
* prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such
|
|
91
|
-
* Derivative Works in Source or Object form.
|
|
92
|
-
*
|
|
93
|
-
* 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a
|
|
94
|
-
* perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
95
|
-
* (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise
|
|
96
|
-
* transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are
|
|
97
|
-
* necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s)
|
|
98
|
-
* with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (
|
|
99
|
-
* including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within
|
|
100
|
-
* the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this
|
|
101
|
-
* License for that Work shall terminate as of the date such litigation is filed.
|
|
102
|
-
*
|
|
103
|
-
* 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with
|
|
104
|
-
* or without modifications, and in Source or Object form, provided that You meet the following conditions:
|
|
105
|
-
*
|
|
106
|
-
* (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
|
|
107
|
-
*
|
|
108
|
-
* (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
|
|
109
|
-
*
|
|
110
|
-
* (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark,
|
|
111
|
-
* and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the
|
|
112
|
-
* Derivative Works; and
|
|
113
|
-
*
|
|
114
|
-
* (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute
|
|
115
|
-
* must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that
|
|
116
|
-
* do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file
|
|
117
|
-
* distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the
|
|
118
|
-
* Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices
|
|
119
|
-
* normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You
|
|
120
|
-
* may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the
|
|
121
|
-
* NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the
|
|
122
|
-
* License.
|
|
123
|
-
*
|
|
124
|
-
* You may add Your own copyright statement to Your modifications and may provide additional or different license terms and
|
|
125
|
-
* conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole,
|
|
126
|
-
* provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this
|
|
127
|
-
* License.
|
|
128
|
-
*
|
|
129
|
-
* 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for
|
|
130
|
-
* inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any
|
|
131
|
-
* additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any
|
|
132
|
-
* separate license agreement you may have executed with Licensor regarding such Contributions.
|
|
133
|
-
*
|
|
134
|
-
* 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product
|
|
135
|
-
* names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and
|
|
136
|
-
* reproducing the content of the NOTICE file.
|
|
137
|
-
*
|
|
138
|
-
* 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and
|
|
139
|
-
* each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
|
140
|
-
* either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT,
|
|
141
|
-
* MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness
|
|
142
|
-
* of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this
|
|
143
|
-
* License.
|
|
144
|
-
*
|
|
145
|
-
* 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or
|
|
146
|
-
* otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing,
|
|
147
|
-
* shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or
|
|
148
|
-
* consequential damages of any character arising as a result of this License or out of the use or inability to use the
|
|
149
|
-
* Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or
|
|
150
|
-
* any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such
|
|
151
|
-
* damages.
|
|
152
|
-
*
|
|
153
|
-
* 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose
|
|
154
|
-
* to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or
|
|
155
|
-
* rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and
|
|
156
|
-
* on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and
|
|
157
|
-
* hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason
|
|
158
|
-
* of your accepting any such warranty or additional liability.
|
|
159
|
-
*
|
|
160
|
-
* END OF TERMS AND CONDITIONS
|
|
161
|
-
*
|
|
162
|
-
* APPENDIX: How to apply the Apache License to your work.
|
|
163
|
-
*
|
|
164
|
-
* To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by
|
|
165
|
-
* brackets "[]"
|
|
166
|
-
* replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the
|
|
167
|
-
* appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose
|
|
168
|
-
* be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
|
|
169
|
-
*
|
|
170
|
-
* Copyright [yyyy] [name of copyright owner]
|
|
171
|
-
*
|
|
172
|
-
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the
|
|
173
|
-
* License. You may obtain a copy of the License at
|
|
174
|
-
*
|
|
175
|
-
* [APACHE LICENSE, VERSION 2.0](http://www.apache.org/licenses/LICENSE-2.0)
|
|
176
|
-
*
|
|
177
|
-
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "
|
|
178
|
-
* AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
|
|
179
|
-
* language governing permissions and limitations under the License.
|
|
180
|
-
*
|
|
181
|
-
* ## Styling Cross-Browser Compatible Range Inputs with Sass
|
|
182
|
-
*
|
|
183
|
-
* Github: [input-range-sass](https://github.com/darlanrod/input-range-sass)
|
|
184
|
-
*
|
|
185
|
-
* Author: [Darlan Rod](https://github.com/darlanrod)
|
|
186
|
-
*
|
|
187
|
-
* Version 1.4.1
|
|
188
|
-
*
|
|
189
|
-
* The MIT License (MIT)
|
|
190
|
-
*
|
|
191
|
-
* Copyright (c) 2016 Darlan Rod
|
|
192
|
-
*
|
|
193
|
-
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
|
|
194
|
-
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
|
|
195
|
-
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
|
|
196
|
-
* persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
197
|
-
*
|
|
198
|
-
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
|
|
199
|
-
* Software.
|
|
200
|
-
*
|
|
201
|
-
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
|
|
202
|
-
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
203
|
-
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
|
204
|
-
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
205
|
-
*
|
|
206
|
-
* ## Tree Walker polyfill
|
|
207
|
-
*
|
|
208
|
-
* The MIT License (MIT)
|
|
209
|
-
*
|
|
210
|
-
* [Copyright 2013–2017 Timo Tijhof](https://github.com/Krinkle/dom-TreeWalker-polyfill)
|
|
211
|
-
*
|
|
212
|
-
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
|
|
213
|
-
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
|
|
214
|
-
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
|
|
215
|
-
* persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
216
|
-
*
|
|
217
|
-
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
|
|
218
|
-
* Software.
|
|
219
|
-
*
|
|
220
|
-
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
|
|
221
|
-
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
222
|
-
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
|
223
|
-
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
224
|
-
*
|
|
225
|
-
* ## chronograph
|
|
226
|
-
*
|
|
227
|
-
* GitHub: [chronograph](https://github.com/bryntum/chronograph)
|
|
228
|
-
*
|
|
229
|
-
* The MIT License (MIT)
|
|
230
|
-
*
|
|
231
|
-
* Copyright (c) 2023 Bryntum
|
|
232
|
-
*
|
|
233
|
-
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
|
|
234
|
-
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
|
|
235
|
-
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
|
|
236
|
-
* persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
237
|
-
*
|
|
238
|
-
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
|
|
239
|
-
* Software.
|
|
240
|
-
*
|
|
241
|
-
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
|
|
242
|
-
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
243
|
-
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
|
244
|
-
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
245
|
-
*
|
|
246
|
-
* ## later.js
|
|
247
|
-
*
|
|
248
|
-
* GitHub: [later.js](https://github.com/bunkat/later)
|
|
249
|
-
*
|
|
250
|
-
* The MIT License (MIT)
|
|
251
|
-
*
|
|
252
|
-
* Copyright © 2013 BunKat
|
|
253
|
-
*
|
|
254
|
-
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
|
|
255
|
-
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
|
|
256
|
-
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
|
|
257
|
-
* persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
258
|
-
*
|
|
259
|
-
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
|
|
260
|
-
* Software.
|
|
261
|
-
*
|
|
262
|
-
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
|
|
263
|
-
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
264
|
-
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
|
265
|
-
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
266
|
-
*
|
|
267
|
-
* ## Monaco editor
|
|
268
|
-
*
|
|
269
|
-
* GitHub: [Monaco editor](https://microsoft.github.io/monaco-editor) (MIT)
|
|
270
|
-
*
|
|
271
|
-
* The MIT License (MIT)
|
|
272
|
-
*
|
|
273
|
-
* Copyright (c) 2016 - present Microsoft Corporation
|
|
274
|
-
*
|
|
275
|
-
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
|
|
276
|
-
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
|
|
277
|
-
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
|
|
278
|
-
* persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
279
|
-
*
|
|
280
|
-
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
|
|
281
|
-
* Software.
|
|
282
|
-
*
|
|
283
|
-
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
|
|
284
|
-
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
285
|
-
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
|
286
|
-
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
287
|
-
*
|
|
288
|
-
* ## Map/Set polyfill to fix performance issues for Salesforce LWS
|
|
289
|
-
*
|
|
290
|
-
* Copyright © 2024 Certinia Inc.
|
|
291
|
-
*
|
|
292
|
-
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
293
|
-
* of this software and associated documentation files (the "Software"), to deal
|
|
294
|
-
* in the Software without restriction, including without limitation the rights
|
|
295
|
-
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
296
|
-
* copies of the Software, and to permit persons to whom the Software is
|
|
297
|
-
* furnished to do so, subject to the following conditions:
|
|
298
|
-
*
|
|
299
|
-
* The above copyright notice and this permission notice shall be included in all
|
|
300
|
-
* copies or substantial portions of the Software.
|
|
301
|
-
*
|
|
302
|
-
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
303
|
-
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
304
|
-
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
305
|
-
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
306
|
-
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
307
|
-
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
308
|
-
* SOFTWARE.
|
|
309
|
-
*
|
|
310
|
-
* ## Chart.js
|
|
311
|
-
*
|
|
312
|
-
* GitHub: [Chart.js](https://github.com/chartjs/Chart.js)
|
|
313
|
-
*
|
|
314
|
-
* The MIT License (MIT)
|
|
315
|
-
*
|
|
316
|
-
* Copyright (c) 2014-2022 Chart.js Contributors
|
|
317
|
-
*
|
|
318
|
-
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
|
|
319
|
-
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
320
|
-
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
|
321
|
-
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
322
|
-
*
|
|
323
|
-
*/
|
|
324
1
|
import { AIBase, AIModelConfiguration, AIModelSelector, AISettingsModel, AISettingsModelConfig, AITool, AIToolConfig,
|
|
325
2
|
AIVoiceActivationConfig, AbstractApiPlugin, AjaxStore, AjaxStoreConfig, AlignSpec, AnimateScrollOptions, Base, BryntumListenerConfig,
|
|
326
3
|
BryntumScrollOptions, ChatButton, ChatButtonConfig, ChipView, ChipViewConfig, Collection, CollectionCompareOperator, CollectionConfig,
|
|
@@ -725,7 +402,8 @@ type GridSelectionMode = {
|
|
|
725
402
|
checkboxIndex?: number|string
|
|
726
403
|
/**
|
|
727
404
|
* Select rows only when clicking in the checkbox column.
|
|
728
|
-
* Requires cell selection config to be `false` and checkbox to be set to `true`. This setting
|
|
405
|
+
* Requires cell selection config to be `false` and checkbox to be set to `true`. This setting allows
|
|
406
|
+
* clicking on other cells without affecting selection. This setting was previously named
|
|
729
407
|
* `rowCheckboxSelection`
|
|
730
408
|
*/
|
|
731
409
|
checkboxOnly?: boolean
|
|
@@ -2993,7 +2671,7 @@ type CheckColumnListenersTypes = {
|
|
|
2993
2671
|
* @param {Core.data.Model} event.record The record for the row containing the cell.
|
|
2994
2672
|
* @param {boolean} event.checked The new checked status of the cell.
|
|
2995
2673
|
*/
|
|
2996
|
-
beforeToggle: (event: { source: Column, record: Model, checked: boolean }) =>
|
|
2674
|
+
beforeToggle: (event: { source: Column, record: Model, checked: boolean }) => boolean|void
|
|
2997
2675
|
/**
|
|
2998
2676
|
* Fires when any other event is fired from the object.
|
|
2999
2677
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/column/CheckColumn#event-catchAll)
|
|
@@ -3046,7 +2724,7 @@ type CheckColumnListeners = {
|
|
|
3046
2724
|
* @param {Core.data.Model} event.record The record for the row containing the cell.
|
|
3047
2725
|
* @param {boolean} event.checked The new checked status of the cell.
|
|
3048
2726
|
*/
|
|
3049
|
-
beforeToggle?: ((event: { source: Column, record: Model, checked: boolean }) =>
|
|
2727
|
+
beforeToggle?: ((event: { source: Column, record: Model, checked: boolean }) => boolean|void)|string
|
|
3050
2728
|
/**
|
|
3051
2729
|
* Fires when any other event is fired from the object.
|
|
3052
2730
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/column/CheckColumn#event-catchAll)
|
|
@@ -3668,7 +3346,7 @@ type CheckColumnConfig = {
|
|
|
3668
3346
|
* @param {Core.data.Model} event.record The record for the row containing the cell.
|
|
3669
3347
|
* @param {boolean} event.checked The new checked status of the cell.
|
|
3670
3348
|
*/
|
|
3671
|
-
onBeforeToggle?: ((event: { source: Column, record: Model, checked: boolean }) =>
|
|
3349
|
+
onBeforeToggle?: ((event: { source: Column, record: Model, checked: boolean }) => boolean|void)|string
|
|
3672
3350
|
/**
|
|
3673
3351
|
* Fires when any other event is fired from the object.
|
|
3674
3352
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/column/CheckColumn#event-catchAll)
|
|
@@ -3742,7 +3420,7 @@ export class CheckColumn extends WidgetColumn {
|
|
|
3742
3420
|
* @param {Core.data.Model} event.record The record for the row containing the cell.
|
|
3743
3421
|
* @param {boolean} event.checked The new checked status of the cell.
|
|
3744
3422
|
*/
|
|
3745
|
-
onBeforeToggle: ((event: { source: Column, record: Model, checked: boolean }) =>
|
|
3423
|
+
onBeforeToggle: ((event: { source: Column, record: Model, checked: boolean }) => boolean|void)|string
|
|
3746
3424
|
/**
|
|
3747
3425
|
* Fires when any other event is fired from the object.
|
|
3748
3426
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/column/CheckColumn#event-catchAll)
|
|
@@ -13580,7 +13258,7 @@ type ColumnStoreListenersTypes = {
|
|
|
13580
13258
|
* @param {Core.data.Model[]} event.records The records which are to be added
|
|
13581
13259
|
* @param {Core.data.Model} event.parent The parent node when using a tree store
|
|
13582
13260
|
*/
|
|
13583
|
-
beforeAdd: (event: { source: Store, records: Model[], parent: Model }) =>
|
|
13261
|
+
beforeAdd: (event: { source: Store, records: Model[], parent: Model }) => boolean|void
|
|
13584
13262
|
/**
|
|
13585
13263
|
* Fired before committing changes. Return false from handler to abort commit
|
|
13586
13264
|
* @param {object} event Event object
|
|
@@ -13607,14 +13285,14 @@ type ColumnStoreListenersTypes = {
|
|
|
13607
13285
|
* @param {Core.data.Store,any} event.source The
|
|
13608
13286
|
* @param {(Core.data.Model|any)[]} event.records The nodes to indent.
|
|
13609
13287
|
*/
|
|
13610
|
-
beforeIndent: (event: { source: Store|any, records: (Model|any)[] }) =>
|
|
13288
|
+
beforeIndent: (event: { source: Store|any, records: (Model|any)[] }) => boolean|void
|
|
13611
13289
|
/**
|
|
13612
13290
|
* Fired before nodes in the tree are outdented. Return `false` from a listener to prevent the outdent.
|
|
13613
13291
|
* @param {object} event Event object
|
|
13614
13292
|
* @param {Core.data.Store,any} event.source This store
|
|
13615
13293
|
* @param {(Core.data.Model|any)[]} event.records Nodes to be outdented
|
|
13616
13294
|
*/
|
|
13617
|
-
beforeOutdent: (event: { source: Store|any, records: (Model|any)[] }) =>
|
|
13295
|
+
beforeOutdent: (event: { source: Store|any, records: (Model|any)[] }) => boolean|void
|
|
13618
13296
|
/**
|
|
13619
13297
|
* Fired before records are removed from this store by the [remove](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreCRUD#function-remove) or [removeAll](#Core/data/mixin/StoreCRUD#function-removeAll).
|
|
13620
13298
|
* Also fired when removing a child record in a tree store using [removeChild](https://bryntum.com/products/grid/docs/api/Core/data/mixin/TreeNode#function-removeChild).
|
|
@@ -13626,7 +13304,7 @@ type ColumnStoreListenersTypes = {
|
|
|
13626
13304
|
* @param {boolean} event.isMove This flag is `true` if the child node is being removed by [appendChild](https://bryntum.com/products/grid/docs/api/Core/data/mixin/TreeNode#function-appendChild) to be moved *within the same tree*.
|
|
13627
13305
|
* @param {boolean} event.removingAll This flag is `true` if the operation is removing the store's entire data set.
|
|
13628
13306
|
*/
|
|
13629
|
-
beforeRemove: (event: { source: Store, records: Model[], parent: Model, isMove: boolean, removingAll: boolean }) =>
|
|
13307
|
+
beforeRemove: (event: { source: Store, records: Model[], parent: Model, isMove: boolean, removingAll: boolean }) => boolean|void
|
|
13630
13308
|
/**
|
|
13631
13309
|
* Fired before sorting
|
|
13632
13310
|
* @param {object} event Event object
|
|
@@ -13838,7 +13516,7 @@ type ColumnStoreListeners = {
|
|
|
13838
13516
|
* @param {Core.data.Model[]} event.records The records which are to be added
|
|
13839
13517
|
* @param {Core.data.Model} event.parent The parent node when using a tree store
|
|
13840
13518
|
*/
|
|
13841
|
-
beforeAdd?: ((event: { source: Store, records: Model[], parent: Model }) =>
|
|
13519
|
+
beforeAdd?: ((event: { source: Store, records: Model[], parent: Model }) => boolean|void)|string
|
|
13842
13520
|
/**
|
|
13843
13521
|
* Fired before committing changes. Return false from handler to abort commit
|
|
13844
13522
|
* @param {object} event Event object
|
|
@@ -13865,14 +13543,14 @@ type ColumnStoreListeners = {
|
|
|
13865
13543
|
* @param {Core.data.Store,any} event.source The
|
|
13866
13544
|
* @param {(Core.data.Model|any)[]} event.records The nodes to indent.
|
|
13867
13545
|
*/
|
|
13868
|
-
beforeIndent?: ((event: { source: Store|any, records: (Model|any)[] }) =>
|
|
13546
|
+
beforeIndent?: ((event: { source: Store|any, records: (Model|any)[] }) => boolean|void)|string
|
|
13869
13547
|
/**
|
|
13870
13548
|
* Fired before nodes in the tree are outdented. Return `false` from a listener to prevent the outdent.
|
|
13871
13549
|
* @param {object} event Event object
|
|
13872
13550
|
* @param {Core.data.Store,any} event.source This store
|
|
13873
13551
|
* @param {(Core.data.Model|any)[]} event.records Nodes to be outdented
|
|
13874
13552
|
*/
|
|
13875
|
-
beforeOutdent?: ((event: { source: Store|any, records: (Model|any)[] }) =>
|
|
13553
|
+
beforeOutdent?: ((event: { source: Store|any, records: (Model|any)[] }) => boolean|void)|string
|
|
13876
13554
|
/**
|
|
13877
13555
|
* Fired before records are removed from this store by the [remove](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreCRUD#function-remove) or [removeAll](#Core/data/mixin/StoreCRUD#function-removeAll).
|
|
13878
13556
|
* Also fired when removing a child record in a tree store using [removeChild](https://bryntum.com/products/grid/docs/api/Core/data/mixin/TreeNode#function-removeChild).
|
|
@@ -13884,7 +13562,7 @@ type ColumnStoreListeners = {
|
|
|
13884
13562
|
* @param {boolean} event.isMove This flag is `true` if the child node is being removed by [appendChild](https://bryntum.com/products/grid/docs/api/Core/data/mixin/TreeNode#function-appendChild) to be moved *within the same tree*.
|
|
13885
13563
|
* @param {boolean} event.removingAll This flag is `true` if the operation is removing the store's entire data set.
|
|
13886
13564
|
*/
|
|
13887
|
-
beforeRemove?: ((event: { source: Store, records: Model[], parent: Model, isMove: boolean, removingAll: boolean }) =>
|
|
13565
|
+
beforeRemove?: ((event: { source: Store, records: Model[], parent: Model, isMove: boolean, removingAll: boolean }) => boolean|void)|string
|
|
13888
13566
|
/**
|
|
13889
13567
|
* Fired before sorting
|
|
13890
13568
|
* @param {object} event Event object
|
|
@@ -14392,7 +14070,7 @@ type ColumnStoreConfig = {
|
|
|
14392
14070
|
* @param {Core.data.Model[]} event.records The records which are to be added
|
|
14393
14071
|
* @param {Core.data.Model} event.parent The parent node when using a tree store
|
|
14394
14072
|
*/
|
|
14395
|
-
onBeforeAdd?: ((event: { source: Store, records: Model[], parent: Model }) =>
|
|
14073
|
+
onBeforeAdd?: ((event: { source: Store, records: Model[], parent: Model }) => boolean|void)|string
|
|
14396
14074
|
/**
|
|
14397
14075
|
* Fired before committing changes. Return false from handler to abort commit
|
|
14398
14076
|
* @param {object} event Event object
|
|
@@ -14419,14 +14097,14 @@ type ColumnStoreConfig = {
|
|
|
14419
14097
|
* @param {Core.data.Store,any} event.source The
|
|
14420
14098
|
* @param {(Core.data.Model|any)[]} event.records The nodes to indent.
|
|
14421
14099
|
*/
|
|
14422
|
-
onBeforeIndent?: ((event: { source: Store|any, records: (Model|any)[] }) =>
|
|
14100
|
+
onBeforeIndent?: ((event: { source: Store|any, records: (Model|any)[] }) => boolean|void)|string
|
|
14423
14101
|
/**
|
|
14424
14102
|
* Fired before nodes in the tree are outdented. Return `false` from a listener to prevent the outdent.
|
|
14425
14103
|
* @param {object} event Event object
|
|
14426
14104
|
* @param {Core.data.Store,any} event.source This store
|
|
14427
14105
|
* @param {(Core.data.Model|any)[]} event.records Nodes to be outdented
|
|
14428
14106
|
*/
|
|
14429
|
-
onBeforeOutdent?: ((event: { source: Store|any, records: (Model|any)[] }) =>
|
|
14107
|
+
onBeforeOutdent?: ((event: { source: Store|any, records: (Model|any)[] }) => boolean|void)|string
|
|
14430
14108
|
/**
|
|
14431
14109
|
* Fired before records are removed from this store by the [remove](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreCRUD#function-remove) or [removeAll](#Core/data/mixin/StoreCRUD#function-removeAll).
|
|
14432
14110
|
* Also fired when removing a child record in a tree store using [removeChild](https://bryntum.com/products/grid/docs/api/Core/data/mixin/TreeNode#function-removeChild).
|
|
@@ -14438,7 +14116,7 @@ type ColumnStoreConfig = {
|
|
|
14438
14116
|
* @param {boolean} event.isMove This flag is `true` if the child node is being removed by [appendChild](https://bryntum.com/products/grid/docs/api/Core/data/mixin/TreeNode#function-appendChild) to be moved *within the same tree*.
|
|
14439
14117
|
* @param {boolean} event.removingAll This flag is `true` if the operation is removing the store's entire data set.
|
|
14440
14118
|
*/
|
|
14441
|
-
onBeforeRemove?: ((event: { source: Store, records: Model[], parent: Model, isMove: boolean, removingAll: boolean }) =>
|
|
14119
|
+
onBeforeRemove?: ((event: { source: Store, records: Model[], parent: Model, isMove: boolean, removingAll: boolean }) => boolean|void)|string
|
|
14442
14120
|
/**
|
|
14443
14121
|
* Fired before sorting
|
|
14444
14122
|
* @param {object} event Event object
|
|
@@ -14662,7 +14340,7 @@ export class ColumnStore extends Store {
|
|
|
14662
14340
|
* @param {Core.data.Model[]} event.records The records which are to be added
|
|
14663
14341
|
* @param {Core.data.Model} event.parent The parent node when using a tree store
|
|
14664
14342
|
*/
|
|
14665
|
-
onBeforeAdd: ((event: { source: Store, records: Model[], parent: Model }) =>
|
|
14343
|
+
onBeforeAdd: ((event: { source: Store, records: Model[], parent: Model }) => boolean|void)|string
|
|
14666
14344
|
/**
|
|
14667
14345
|
* Fired before committing changes. Return false from handler to abort commit
|
|
14668
14346
|
* @param {object} event Event object
|
|
@@ -14689,14 +14367,14 @@ export class ColumnStore extends Store {
|
|
|
14689
14367
|
* @param {Core.data.Store,any} event.source The
|
|
14690
14368
|
* @param {(Core.data.Model|any)[]} event.records The nodes to indent.
|
|
14691
14369
|
*/
|
|
14692
|
-
onBeforeIndent: ((event: { source: Store|any, records: (Model|any)[] }) =>
|
|
14370
|
+
onBeforeIndent: ((event: { source: Store|any, records: (Model|any)[] }) => boolean|void)|string
|
|
14693
14371
|
/**
|
|
14694
14372
|
* Fired before nodes in the tree are outdented. Return `false` from a listener to prevent the outdent.
|
|
14695
14373
|
* @param {object} event Event object
|
|
14696
14374
|
* @param {Core.data.Store,any} event.source This store
|
|
14697
14375
|
* @param {(Core.data.Model|any)[]} event.records Nodes to be outdented
|
|
14698
14376
|
*/
|
|
14699
|
-
onBeforeOutdent: ((event: { source: Store|any, records: (Model|any)[] }) =>
|
|
14377
|
+
onBeforeOutdent: ((event: { source: Store|any, records: (Model|any)[] }) => boolean|void)|string
|
|
14700
14378
|
/**
|
|
14701
14379
|
* Fired before records are removed from this store by the [remove](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreCRUD#function-remove) or [removeAll](#Core/data/mixin/StoreCRUD#function-removeAll).
|
|
14702
14380
|
* Also fired when removing a child record in a tree store using [removeChild](https://bryntum.com/products/grid/docs/api/Core/data/mixin/TreeNode#function-removeChild).
|
|
@@ -14708,7 +14386,7 @@ export class ColumnStore extends Store {
|
|
|
14708
14386
|
* @param {boolean} event.isMove This flag is `true` if the child node is being removed by [appendChild](https://bryntum.com/products/grid/docs/api/Core/data/mixin/TreeNode#function-appendChild) to be moved *within the same tree*.
|
|
14709
14387
|
* @param {boolean} event.removingAll This flag is `true` if the operation is removing the store's entire data set.
|
|
14710
14388
|
*/
|
|
14711
|
-
onBeforeRemove: ((event: { source: Store, records: Model[], parent: Model, isMove: boolean, removingAll: boolean }) =>
|
|
14389
|
+
onBeforeRemove: ((event: { source: Store, records: Model[], parent: Model, isMove: boolean, removingAll: boolean }) => boolean|void)|string
|
|
14712
14390
|
/**
|
|
14713
14391
|
* Fired before sorting
|
|
14714
14392
|
* @param {object} event Event object
|
|
@@ -22668,13 +22346,15 @@ type RowReorderConfig = {
|
|
|
22668
22346
|
* data (e.g. to copy instead of move), you can provide an object with a `transferData` method.
|
|
22669
22347
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowReorder#config-allowCrossGridDrag)
|
|
22670
22348
|
* @property {Function} allowCrossGridDrag.transferData A function which decides what should happen to the dragged records upon drop. It receives a single context object with information about the drag drop state.
|
|
22671
|
-
* @property {
|
|
22672
|
-
* @property {Grid.view.GridBase} allowCrossGridDrag.transferData.
|
|
22673
|
-
* @property {
|
|
22674
|
-
* @property {Core.data.Model} allowCrossGridDrag.transferData.
|
|
22675
|
-
* @property {Core.data.Model} allowCrossGridDrag.transferData.
|
|
22349
|
+
* @property {object} allowCrossGridDrag.transferData.data Context object describing the drag drop state.
|
|
22350
|
+
* @property {Grid.view.GridBase} allowCrossGridDrag.transferData.data.sourceGrid The source grid
|
|
22351
|
+
* @property {Grid.view.GridBase} allowCrossGridDrag.transferData.data.targetGrid the target grid
|
|
22352
|
+
* @property {Core.data.Model[]} allowCrossGridDrag.transferData.data.records The dragged records
|
|
22353
|
+
* @property {Core.data.Model} allowCrossGridDrag.transferData.data.insertBefore The record to insert before
|
|
22354
|
+
* @property {Core.data.Model} allowCrossGridDrag.transferData.data.parent The parent record of the current drop position (only applicable for trees)
|
|
22355
|
+
* @property {Promise<any>,void} allowCrossGridDrag.transferData.returns May return a `Promise` to signal that the transfer is asynchronous. The drop operation will wait for the `Promise` to resolve before finalizing.
|
|
22676
22356
|
*/
|
|
22677
|
-
allowCrossGridDrag?: boolean|{ transferData: (sourceGrid: GridBase, targetGrid: GridBase, records: Model[], insertBefore: Model, parent: Model) => void }
|
|
22357
|
+
allowCrossGridDrag?: boolean|{ transferData: (data: { sourceGrid: GridBase, targetGrid: GridBase, records: Model[], insertBefore: Model, parent: Model }) => Promise<any>|void }
|
|
22678
22358
|
/**
|
|
22679
22359
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
22680
22360
|
* hierarchy when triggered.
|
|
@@ -28734,14 +28414,14 @@ type GridListenersTypes = {
|
|
|
28734
28414
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
28735
28415
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
28736
28416
|
*/
|
|
28737
|
-
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
28417
|
+
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void
|
|
28738
28418
|
/**
|
|
28739
28419
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
28740
28420
|
* @param {object} event Event object
|
|
28741
28421
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
28742
28422
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
28743
28423
|
*/
|
|
28744
|
-
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) =>
|
|
28424
|
+
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) => boolean|void
|
|
28745
28425
|
/**
|
|
28746
28426
|
* Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
|
|
28747
28427
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-beforeCancelRowEdit)
|
|
@@ -28756,7 +28436,7 @@ type GridListenersTypes = {
|
|
|
28756
28436
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
28757
28437
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
28758
28438
|
*/
|
|
28759
|
-
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
28439
|
+
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => boolean|void
|
|
28760
28440
|
/**
|
|
28761
28441
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
28762
28442
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -28764,7 +28444,7 @@ type GridListenersTypes = {
|
|
|
28764
28444
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
28765
28445
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
|
|
28766
28446
|
*/
|
|
28767
|
-
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
28447
|
+
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void
|
|
28768
28448
|
/**
|
|
28769
28449
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
28770
28450
|
* @param {object} event Event object
|
|
@@ -28772,7 +28452,7 @@ type GridListenersTypes = {
|
|
|
28772
28452
|
* @param {string} event.field The field being changed
|
|
28773
28453
|
* @param {any} event.value The value being set
|
|
28774
28454
|
*/
|
|
28775
|
-
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) =>
|
|
28455
|
+
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => boolean|void
|
|
28776
28456
|
/**
|
|
28777
28457
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
28778
28458
|
* @param {object} event Event object
|
|
@@ -28788,7 +28468,7 @@ type GridListenersTypes = {
|
|
|
28788
28468
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
28789
28469
|
* @param {Event} event.event The browser event.
|
|
28790
28470
|
*/
|
|
28791
|
-
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) =>
|
|
28471
|
+
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) => boolean|void
|
|
28792
28472
|
/**
|
|
28793
28473
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
28794
28474
|
* @param {object} event Event object
|
|
@@ -28799,7 +28479,7 @@ type GridListenersTypes = {
|
|
|
28799
28479
|
* @param {Event} event.event The browser event.
|
|
28800
28480
|
* @param {string} event.region The region where the column was dropped.
|
|
28801
28481
|
*/
|
|
28802
|
-
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
28482
|
+
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void
|
|
28803
28483
|
/**
|
|
28804
28484
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
28805
28485
|
* `false`.
|
|
@@ -28808,7 +28488,7 @@ type GridListenersTypes = {
|
|
|
28808
28488
|
* @param {Grid.column.Column} event.column The column
|
|
28809
28489
|
* @param {Event} event.domEvent The browser event
|
|
28810
28490
|
*/
|
|
28811
|
-
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
28491
|
+
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) => boolean|void
|
|
28812
28492
|
/**
|
|
28813
28493
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
28814
28494
|
* @param {object} event Event object
|
|
@@ -28832,14 +28512,14 @@ type GridListenersTypes = {
|
|
|
28832
28512
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
28833
28513
|
* @param {any[][]} event.rows An array of records to export
|
|
28834
28514
|
*/
|
|
28835
|
-
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
28515
|
+
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void
|
|
28836
28516
|
/**
|
|
28837
28517
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
28838
28518
|
* @param {object} event Event object
|
|
28839
28519
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
28840
28520
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
28841
28521
|
*/
|
|
28842
|
-
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
28522
|
+
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
28843
28523
|
/**
|
|
28844
28524
|
* Fires on the owning Grid before the cell editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
28845
28525
|
* @param {object} event Event object
|
|
@@ -28860,7 +28540,7 @@ type GridListenersTypes = {
|
|
|
28860
28540
|
* @param {object} event Event object
|
|
28861
28541
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
28862
28542
|
*/
|
|
28863
|
-
beforeHide: (event: { source: Widget }) =>
|
|
28543
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
28864
28544
|
/**
|
|
28865
28545
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
28866
28546
|
* @param {object} event Event object
|
|
@@ -28876,7 +28556,7 @@ type GridListenersTypes = {
|
|
|
28876
28556
|
* @param {object} event Event object
|
|
28877
28557
|
* @param {PdfExportConfig} event.config Export config
|
|
28878
28558
|
*/
|
|
28879
|
-
beforePdfExport: (event: { config: PdfExportConfig }) =>
|
|
28559
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => boolean|void
|
|
28880
28560
|
/**
|
|
28881
28561
|
* Fires before a row is rendered.
|
|
28882
28562
|
* @param {object} event Event object
|
|
@@ -28919,7 +28599,7 @@ type GridListenersTypes = {
|
|
|
28919
28599
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
28920
28600
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
28921
28601
|
*/
|
|
28922
|
-
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
28602
|
+
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void
|
|
28923
28603
|
/**
|
|
28924
28604
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
28925
28605
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -28940,19 +28620,19 @@ type GridListenersTypes = {
|
|
|
28940
28620
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
28941
28621
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
28942
28622
|
*/
|
|
28943
|
-
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
28623
|
+
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) => boolean|void
|
|
28944
28624
|
/**
|
|
28945
28625
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
28946
28626
|
* @param {object} event Event object
|
|
28947
28627
|
* @param {GridStateInfo} event.state State object config
|
|
28948
28628
|
*/
|
|
28949
|
-
beforeStateApply: (event: { state: GridStateInfo }) =>
|
|
28629
|
+
beforeStateApply: (event: { state: GridStateInfo }) => boolean|void
|
|
28950
28630
|
/**
|
|
28951
28631
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
28952
28632
|
* @param {object} event Event object
|
|
28953
28633
|
* @param {GridStateInfo} event.state State object config
|
|
28954
28634
|
*/
|
|
28955
|
-
beforeStateSave: (event: { state: GridStateInfo }) =>
|
|
28635
|
+
beforeStateSave: (event: { state: GridStateInfo }) => boolean|void
|
|
28956
28636
|
/**
|
|
28957
28637
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
28958
28638
|
* Returning `false` from a listener prevents the operation
|
|
@@ -28962,7 +28642,7 @@ type GridListenersTypes = {
|
|
|
28962
28642
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
28963
28643
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
28964
28644
|
*/
|
|
28965
|
-
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
28645
|
+
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void
|
|
28966
28646
|
/**
|
|
28967
28647
|
* Fired before a parent node record toggles its collapsed state.
|
|
28968
28648
|
* @param {object} event Event object
|
|
@@ -29031,7 +28711,7 @@ type GridListenersTypes = {
|
|
|
29031
28711
|
* @param {Grid.column.Column} event.column Column
|
|
29032
28712
|
* @param {Core.data.Model} event.record Record
|
|
29033
28713
|
*/
|
|
29034
|
-
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
28714
|
+
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void
|
|
29035
28715
|
/**
|
|
29036
28716
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
29037
28717
|
* @param {object} event Event object
|
|
@@ -29158,7 +28838,7 @@ type GridListenersTypes = {
|
|
|
29158
28838
|
* @param {Event} event.event The browser event.
|
|
29159
28839
|
* @param {string} event.region The region where the column was dropped.
|
|
29160
28840
|
*/
|
|
29161
|
-
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
28841
|
+
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void
|
|
29162
28842
|
/**
|
|
29163
28843
|
* This event is fired after a resize gesture is completed.
|
|
29164
28844
|
* @param {object} event Event object
|
|
@@ -29298,7 +28978,7 @@ type GridListenersTypes = {
|
|
|
29298
28978
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
29299
28979
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
29300
28980
|
*/
|
|
29301
|
-
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
28981
|
+
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
29302
28982
|
/**
|
|
29303
28983
|
* Fires on the owning Grid when cell editing is finished
|
|
29304
28984
|
* @param {object} event Event object
|
|
@@ -29346,7 +29026,7 @@ type GridListenersTypes = {
|
|
|
29346
29026
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
29347
29027
|
* @param {MouseEvent,TouchEvent} event.event
|
|
29348
29028
|
*/
|
|
29349
|
-
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
29029
|
+
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void
|
|
29350
29030
|
/**
|
|
29351
29031
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
29352
29032
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -29413,7 +29093,7 @@ type GridListenersTypes = {
|
|
|
29413
29093
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
29414
29094
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
29415
29095
|
*/
|
|
29416
|
-
headerClick: (event: { domEvent: Event, column: Column }) =>
|
|
29096
|
+
headerClick: (event: { domEvent: Event, column: Column }) => boolean|void
|
|
29417
29097
|
/**
|
|
29418
29098
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
29419
29099
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu#config-processItems).
|
|
@@ -29424,7 +29104,7 @@ type GridListenersTypes = {
|
|
|
29424
29104
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
29425
29105
|
* @param {Grid.column.Column} event.column Column
|
|
29426
29106
|
*/
|
|
29427
|
-
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
29107
|
+
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void
|
|
29428
29108
|
/**
|
|
29429
29109
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
29430
29110
|
* @param {object} event Event object
|
|
@@ -29635,7 +29315,7 @@ type GridListenersTypes = {
|
|
|
29635
29315
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
29636
29316
|
* @param {Event} event.domEvent The native DOM event
|
|
29637
29317
|
*/
|
|
29638
|
-
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
29318
|
+
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
29639
29319
|
/**
|
|
29640
29320
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
29641
29321
|
* @param {object} event Event object
|
|
@@ -29660,7 +29340,7 @@ type GridListenersTypes = {
|
|
|
29660
29340
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
29661
29341
|
* @param {Event} event.domEvent The native DOM event
|
|
29662
29342
|
*/
|
|
29663
|
-
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
29343
|
+
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
29664
29344
|
/**
|
|
29665
29345
|
* Fires on the owning Grid when editing starts
|
|
29666
29346
|
* @param {object} event Event object
|
|
@@ -29749,14 +29429,14 @@ type GridListeners = {
|
|
|
29749
29429
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
29750
29430
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
29751
29431
|
*/
|
|
29752
|
-
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
29432
|
+
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
29753
29433
|
/**
|
|
29754
29434
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
29755
29435
|
* @param {object} event Event object
|
|
29756
29436
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
29757
29437
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
29758
29438
|
*/
|
|
29759
|
-
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
29439
|
+
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
29760
29440
|
/**
|
|
29761
29441
|
* Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
|
|
29762
29442
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-beforeCancelRowEdit)
|
|
@@ -29771,7 +29451,7 @@ type GridListeners = {
|
|
|
29771
29451
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
29772
29452
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
29773
29453
|
*/
|
|
29774
|
-
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
29454
|
+
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
29775
29455
|
/**
|
|
29776
29456
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
29777
29457
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -29779,7 +29459,7 @@ type GridListeners = {
|
|
|
29779
29459
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
29780
29460
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
|
|
29781
29461
|
*/
|
|
29782
|
-
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
29462
|
+
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
29783
29463
|
/**
|
|
29784
29464
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
29785
29465
|
* @param {object} event Event object
|
|
@@ -29787,7 +29467,7 @@ type GridListeners = {
|
|
|
29787
29467
|
* @param {string} event.field The field being changed
|
|
29788
29468
|
* @param {any} event.value The value being set
|
|
29789
29469
|
*/
|
|
29790
|
-
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
29470
|
+
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
29791
29471
|
/**
|
|
29792
29472
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
29793
29473
|
* @param {object} event Event object
|
|
@@ -29803,7 +29483,7 @@ type GridListeners = {
|
|
|
29803
29483
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
29804
29484
|
* @param {Event} event.event The browser event.
|
|
29805
29485
|
*/
|
|
29806
|
-
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
29486
|
+
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
29807
29487
|
/**
|
|
29808
29488
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
29809
29489
|
* @param {object} event Event object
|
|
@@ -29814,7 +29494,7 @@ type GridListeners = {
|
|
|
29814
29494
|
* @param {Event} event.event The browser event.
|
|
29815
29495
|
* @param {string} event.region The region where the column was dropped.
|
|
29816
29496
|
*/
|
|
29817
|
-
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
29497
|
+
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
29818
29498
|
/**
|
|
29819
29499
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
29820
29500
|
* `false`.
|
|
@@ -29823,7 +29503,7 @@ type GridListeners = {
|
|
|
29823
29503
|
* @param {Grid.column.Column} event.column The column
|
|
29824
29504
|
* @param {Event} event.domEvent The browser event
|
|
29825
29505
|
*/
|
|
29826
|
-
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
29506
|
+
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
29827
29507
|
/**
|
|
29828
29508
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
29829
29509
|
* @param {object} event Event object
|
|
@@ -29847,14 +29527,14 @@ type GridListeners = {
|
|
|
29847
29527
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
29848
29528
|
* @param {any[][]} event.rows An array of records to export
|
|
29849
29529
|
*/
|
|
29850
|
-
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
29530
|
+
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
29851
29531
|
/**
|
|
29852
29532
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
29853
29533
|
* @param {object} event Event object
|
|
29854
29534
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
29855
29535
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
29856
29536
|
*/
|
|
29857
|
-
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
29537
|
+
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
29858
29538
|
/**
|
|
29859
29539
|
* Fires on the owning Grid before the cell editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
29860
29540
|
* @param {object} event Event object
|
|
@@ -29875,7 +29555,7 @@ type GridListeners = {
|
|
|
29875
29555
|
* @param {object} event Event object
|
|
29876
29556
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
29877
29557
|
*/
|
|
29878
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
29558
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
29879
29559
|
/**
|
|
29880
29560
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
29881
29561
|
* @param {object} event Event object
|
|
@@ -29891,7 +29571,7 @@ type GridListeners = {
|
|
|
29891
29571
|
* @param {object} event Event object
|
|
29892
29572
|
* @param {PdfExportConfig} event.config Export config
|
|
29893
29573
|
*/
|
|
29894
|
-
beforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
29574
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
29895
29575
|
/**
|
|
29896
29576
|
* Fires before a row is rendered.
|
|
29897
29577
|
* @param {object} event Event object
|
|
@@ -29934,7 +29614,7 @@ type GridListeners = {
|
|
|
29934
29614
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
29935
29615
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
29936
29616
|
*/
|
|
29937
|
-
beforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
29617
|
+
beforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
29938
29618
|
/**
|
|
29939
29619
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
29940
29620
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -29955,19 +29635,19 @@ type GridListeners = {
|
|
|
29955
29635
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
29956
29636
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
29957
29637
|
*/
|
|
29958
|
-
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
29638
|
+
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
29959
29639
|
/**
|
|
29960
29640
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
29961
29641
|
* @param {object} event Event object
|
|
29962
29642
|
* @param {GridStateInfo} event.state State object config
|
|
29963
29643
|
*/
|
|
29964
|
-
beforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
29644
|
+
beforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
29965
29645
|
/**
|
|
29966
29646
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
29967
29647
|
* @param {object} event Event object
|
|
29968
29648
|
* @param {GridStateInfo} event.state State object config
|
|
29969
29649
|
*/
|
|
29970
|
-
beforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
29650
|
+
beforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
29971
29651
|
/**
|
|
29972
29652
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
29973
29653
|
* Returning `false` from a listener prevents the operation
|
|
@@ -29977,7 +29657,7 @@ type GridListeners = {
|
|
|
29977
29657
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
29978
29658
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
29979
29659
|
*/
|
|
29980
|
-
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
29660
|
+
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
29981
29661
|
/**
|
|
29982
29662
|
* Fired before a parent node record toggles its collapsed state.
|
|
29983
29663
|
* @param {object} event Event object
|
|
@@ -30046,7 +29726,7 @@ type GridListeners = {
|
|
|
30046
29726
|
* @param {Grid.column.Column} event.column Column
|
|
30047
29727
|
* @param {Core.data.Model} event.record Record
|
|
30048
29728
|
*/
|
|
30049
|
-
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
29729
|
+
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
30050
29730
|
/**
|
|
30051
29731
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
30052
29732
|
* @param {object} event Event object
|
|
@@ -30173,7 +29853,7 @@ type GridListeners = {
|
|
|
30173
29853
|
* @param {Event} event.event The browser event.
|
|
30174
29854
|
* @param {string} event.region The region where the column was dropped.
|
|
30175
29855
|
*/
|
|
30176
|
-
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
29856
|
+
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
30177
29857
|
/**
|
|
30178
29858
|
* This event is fired after a resize gesture is completed.
|
|
30179
29859
|
* @param {object} event Event object
|
|
@@ -30313,7 +29993,7 @@ type GridListeners = {
|
|
|
30313
29993
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
30314
29994
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
30315
29995
|
*/
|
|
30316
|
-
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
29996
|
+
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
30317
29997
|
/**
|
|
30318
29998
|
* Fires on the owning Grid when cell editing is finished
|
|
30319
29999
|
* @param {object} event Event object
|
|
@@ -30361,7 +30041,7 @@ type GridListeners = {
|
|
|
30361
30041
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
30362
30042
|
* @param {MouseEvent,TouchEvent} event.event
|
|
30363
30043
|
*/
|
|
30364
|
-
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
30044
|
+
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
30365
30045
|
/**
|
|
30366
30046
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
30367
30047
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -30428,7 +30108,7 @@ type GridListeners = {
|
|
|
30428
30108
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
30429
30109
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
30430
30110
|
*/
|
|
30431
|
-
headerClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
30111
|
+
headerClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
30432
30112
|
/**
|
|
30433
30113
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
30434
30114
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu#config-processItems).
|
|
@@ -30439,7 +30119,7 @@ type GridListeners = {
|
|
|
30439
30119
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
30440
30120
|
* @param {Grid.column.Column} event.column Column
|
|
30441
30121
|
*/
|
|
30442
|
-
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
30122
|
+
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
30443
30123
|
/**
|
|
30444
30124
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
30445
30125
|
* @param {object} event Event object
|
|
@@ -30650,7 +30330,7 @@ type GridListeners = {
|
|
|
30650
30330
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
30651
30331
|
* @param {Event} event.domEvent The native DOM event
|
|
30652
30332
|
*/
|
|
30653
|
-
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
30333
|
+
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
30654
30334
|
/**
|
|
30655
30335
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
30656
30336
|
* @param {object} event Event object
|
|
@@ -30675,7 +30355,7 @@ type GridListeners = {
|
|
|
30675
30355
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
30676
30356
|
* @param {Event} event.domEvent The native DOM event
|
|
30677
30357
|
*/
|
|
30678
|
-
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
30358
|
+
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
30679
30359
|
/**
|
|
30680
30360
|
* Fires on the owning Grid when editing starts
|
|
30681
30361
|
* @param {object} event Event object
|
|
@@ -31559,14 +31239,14 @@ type GridConfig = {
|
|
|
31559
31239
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
31560
31240
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
31561
31241
|
*/
|
|
31562
|
-
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
31242
|
+
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
31563
31243
|
/**
|
|
31564
31244
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
31565
31245
|
* @param {object} event Event object
|
|
31566
31246
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
31567
31247
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
31568
31248
|
*/
|
|
31569
|
-
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
31249
|
+
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
31570
31250
|
/**
|
|
31571
31251
|
* Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
|
|
31572
31252
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-beforeCancelRowEdit)
|
|
@@ -31581,7 +31261,7 @@ type GridConfig = {
|
|
|
31581
31261
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
31582
31262
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
31583
31263
|
*/
|
|
31584
|
-
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
31264
|
+
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
31585
31265
|
/**
|
|
31586
31266
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
31587
31267
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -31589,7 +31269,7 @@ type GridConfig = {
|
|
|
31589
31269
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
31590
31270
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
|
|
31591
31271
|
*/
|
|
31592
|
-
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
31272
|
+
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
31593
31273
|
/**
|
|
31594
31274
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
31595
31275
|
* @param {object} event Event object
|
|
@@ -31597,7 +31277,7 @@ type GridConfig = {
|
|
|
31597
31277
|
* @param {string} event.field The field being changed
|
|
31598
31278
|
* @param {any} event.value The value being set
|
|
31599
31279
|
*/
|
|
31600
|
-
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
31280
|
+
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
31601
31281
|
/**
|
|
31602
31282
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
31603
31283
|
* @param {object} event Event object
|
|
@@ -31613,7 +31293,7 @@ type GridConfig = {
|
|
|
31613
31293
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
31614
31294
|
* @param {Event} event.event The browser event.
|
|
31615
31295
|
*/
|
|
31616
|
-
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
31296
|
+
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
31617
31297
|
/**
|
|
31618
31298
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
31619
31299
|
* @param {object} event Event object
|
|
@@ -31624,7 +31304,7 @@ type GridConfig = {
|
|
|
31624
31304
|
* @param {Event} event.event The browser event.
|
|
31625
31305
|
* @param {string} event.region The region where the column was dropped.
|
|
31626
31306
|
*/
|
|
31627
|
-
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
31307
|
+
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
31628
31308
|
/**
|
|
31629
31309
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
31630
31310
|
* `false`.
|
|
@@ -31633,7 +31313,7 @@ type GridConfig = {
|
|
|
31633
31313
|
* @param {Grid.column.Column} event.column The column
|
|
31634
31314
|
* @param {Event} event.domEvent The browser event
|
|
31635
31315
|
*/
|
|
31636
|
-
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
31316
|
+
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
31637
31317
|
/**
|
|
31638
31318
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
31639
31319
|
* @param {object} event Event object
|
|
@@ -31657,14 +31337,14 @@ type GridConfig = {
|
|
|
31657
31337
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
31658
31338
|
* @param {any[][]} event.rows An array of records to export
|
|
31659
31339
|
*/
|
|
31660
|
-
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
31340
|
+
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
31661
31341
|
/**
|
|
31662
31342
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
31663
31343
|
* @param {object} event Event object
|
|
31664
31344
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
31665
31345
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
31666
31346
|
*/
|
|
31667
|
-
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
31347
|
+
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
31668
31348
|
/**
|
|
31669
31349
|
* Fires on the owning Grid before the cell editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
31670
31350
|
* @param {object} event Event object
|
|
@@ -31685,7 +31365,7 @@ type GridConfig = {
|
|
|
31685
31365
|
* @param {object} event Event object
|
|
31686
31366
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
31687
31367
|
*/
|
|
31688
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
31368
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
31689
31369
|
/**
|
|
31690
31370
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
31691
31371
|
* @param {object} event Event object
|
|
@@ -31701,7 +31381,7 @@ type GridConfig = {
|
|
|
31701
31381
|
* @param {object} event Event object
|
|
31702
31382
|
* @param {PdfExportConfig} event.config Export config
|
|
31703
31383
|
*/
|
|
31704
|
-
onBeforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
31384
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
31705
31385
|
/**
|
|
31706
31386
|
* Fires before a row is rendered.
|
|
31707
31387
|
* @param {object} event Event object
|
|
@@ -31744,7 +31424,7 @@ type GridConfig = {
|
|
|
31744
31424
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
31745
31425
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
31746
31426
|
*/
|
|
31747
|
-
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
31427
|
+
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
31748
31428
|
/**
|
|
31749
31429
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
31750
31430
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -31765,19 +31445,19 @@ type GridConfig = {
|
|
|
31765
31445
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
31766
31446
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
31767
31447
|
*/
|
|
31768
|
-
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
31448
|
+
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
31769
31449
|
/**
|
|
31770
31450
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
31771
31451
|
* @param {object} event Event object
|
|
31772
31452
|
* @param {GridStateInfo} event.state State object config
|
|
31773
31453
|
*/
|
|
31774
|
-
onBeforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
31454
|
+
onBeforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
31775
31455
|
/**
|
|
31776
31456
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
31777
31457
|
* @param {object} event Event object
|
|
31778
31458
|
* @param {GridStateInfo} event.state State object config
|
|
31779
31459
|
*/
|
|
31780
|
-
onBeforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
31460
|
+
onBeforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
31781
31461
|
/**
|
|
31782
31462
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
31783
31463
|
* Returning `false` from a listener prevents the operation
|
|
@@ -31787,7 +31467,7 @@ type GridConfig = {
|
|
|
31787
31467
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
31788
31468
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
31789
31469
|
*/
|
|
31790
|
-
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
31470
|
+
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
31791
31471
|
/**
|
|
31792
31472
|
* Fired before a parent node record toggles its collapsed state.
|
|
31793
31473
|
* @param {object} event Event object
|
|
@@ -31856,7 +31536,7 @@ type GridConfig = {
|
|
|
31856
31536
|
* @param {Grid.column.Column} event.column Column
|
|
31857
31537
|
* @param {Core.data.Model} event.record Record
|
|
31858
31538
|
*/
|
|
31859
|
-
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
31539
|
+
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
31860
31540
|
/**
|
|
31861
31541
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
31862
31542
|
* @param {object} event Event object
|
|
@@ -31983,7 +31663,7 @@ type GridConfig = {
|
|
|
31983
31663
|
* @param {Event} event.event The browser event.
|
|
31984
31664
|
* @param {string} event.region The region where the column was dropped.
|
|
31985
31665
|
*/
|
|
31986
|
-
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
31666
|
+
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
31987
31667
|
/**
|
|
31988
31668
|
* This event is fired after a resize gesture is completed.
|
|
31989
31669
|
* @param {object} event Event object
|
|
@@ -32123,7 +31803,7 @@ type GridConfig = {
|
|
|
32123
31803
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
32124
31804
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
32125
31805
|
*/
|
|
32126
|
-
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
31806
|
+
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
32127
31807
|
/**
|
|
32128
31808
|
* Fires on the owning Grid when cell editing is finished
|
|
32129
31809
|
* @param {object} event Event object
|
|
@@ -32171,7 +31851,7 @@ type GridConfig = {
|
|
|
32171
31851
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
32172
31852
|
* @param {MouseEvent,TouchEvent} event.event
|
|
32173
31853
|
*/
|
|
32174
|
-
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
31854
|
+
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
32175
31855
|
/**
|
|
32176
31856
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
32177
31857
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -32238,7 +31918,7 @@ type GridConfig = {
|
|
|
32238
31918
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
32239
31919
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
32240
31920
|
*/
|
|
32241
|
-
onHeaderClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
31921
|
+
onHeaderClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
32242
31922
|
/**
|
|
32243
31923
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
32244
31924
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu#config-processItems).
|
|
@@ -32249,7 +31929,7 @@ type GridConfig = {
|
|
|
32249
31929
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
32250
31930
|
* @param {Grid.column.Column} event.column Column
|
|
32251
31931
|
*/
|
|
32252
|
-
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
31932
|
+
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
32253
31933
|
/**
|
|
32254
31934
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
32255
31935
|
* @param {object} event Event object
|
|
@@ -32460,7 +32140,7 @@ type GridConfig = {
|
|
|
32460
32140
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
32461
32141
|
* @param {Event} event.domEvent The native DOM event
|
|
32462
32142
|
*/
|
|
32463
|
-
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
32143
|
+
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
32464
32144
|
/**
|
|
32465
32145
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
32466
32146
|
* @param {object} event Event object
|
|
@@ -32485,7 +32165,7 @@ type GridConfig = {
|
|
|
32485
32165
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
32486
32166
|
* @param {Event} event.domEvent The native DOM event
|
|
32487
32167
|
*/
|
|
32488
|
-
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
32168
|
+
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
32489
32169
|
/**
|
|
32490
32170
|
* Fires on the owning Grid when editing starts
|
|
32491
32171
|
* @param {object} event Event object
|
|
@@ -32594,19 +32274,19 @@ export class Grid extends GridBase {
|
|
|
32594
32274
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
32595
32275
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
32596
32276
|
*/
|
|
32597
|
-
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
32277
|
+
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
32598
32278
|
/**
|
|
32599
32279
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
32600
32280
|
* @param {object} event Event object
|
|
32601
32281
|
* @param {GridStateInfo} event.state State object config
|
|
32602
32282
|
*/
|
|
32603
|
-
onBeforeStateApply: ((event: { state: GridStateInfo }) =>
|
|
32283
|
+
onBeforeStateApply: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
32604
32284
|
/**
|
|
32605
32285
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
32606
32286
|
* @param {object} event Event object
|
|
32607
32287
|
* @param {GridStateInfo} event.state State object config
|
|
32608
32288
|
*/
|
|
32609
|
-
onBeforeStateSave: ((event: { state: GridStateInfo }) =>
|
|
32289
|
+
onBeforeStateSave: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
32610
32290
|
/**
|
|
32611
32291
|
* Fires when any other event is fired from the object.
|
|
32612
32292
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-catchAll)
|
|
@@ -32712,7 +32392,7 @@ export class Grid extends GridBase {
|
|
|
32712
32392
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
32713
32393
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
32714
32394
|
*/
|
|
32715
|
-
onHeaderClick: ((event: { domEvent: Event, column: Column }) =>
|
|
32395
|
+
onHeaderClick: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
32716
32396
|
/**
|
|
32717
32397
|
* Mouse moved out from element in grid
|
|
32718
32398
|
* @param {object} event Event object
|
|
@@ -32790,14 +32470,14 @@ type GridBaseListenersTypes = {
|
|
|
32790
32470
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
32791
32471
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
32792
32472
|
*/
|
|
32793
|
-
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
32473
|
+
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void
|
|
32794
32474
|
/**
|
|
32795
32475
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
32796
32476
|
* @param {object} event Event object
|
|
32797
32477
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
32798
32478
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
32799
32479
|
*/
|
|
32800
|
-
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) =>
|
|
32480
|
+
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) => boolean|void
|
|
32801
32481
|
/**
|
|
32802
32482
|
* Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
|
|
32803
32483
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
|
|
@@ -32812,7 +32492,7 @@ type GridBaseListenersTypes = {
|
|
|
32812
32492
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
32813
32493
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
32814
32494
|
*/
|
|
32815
|
-
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
32495
|
+
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => boolean|void
|
|
32816
32496
|
/**
|
|
32817
32497
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
32818
32498
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -32820,7 +32500,7 @@ type GridBaseListenersTypes = {
|
|
|
32820
32500
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
32821
32501
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
|
|
32822
32502
|
*/
|
|
32823
|
-
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
32503
|
+
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void
|
|
32824
32504
|
/**
|
|
32825
32505
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
32826
32506
|
* @param {object} event Event object
|
|
@@ -32828,7 +32508,7 @@ type GridBaseListenersTypes = {
|
|
|
32828
32508
|
* @param {string} event.field The field being changed
|
|
32829
32509
|
* @param {any} event.value The value being set
|
|
32830
32510
|
*/
|
|
32831
|
-
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) =>
|
|
32511
|
+
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => boolean|void
|
|
32832
32512
|
/**
|
|
32833
32513
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
32834
32514
|
* @param {object} event Event object
|
|
@@ -32844,7 +32524,7 @@ type GridBaseListenersTypes = {
|
|
|
32844
32524
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
32845
32525
|
* @param {Event} event.event The browser event.
|
|
32846
32526
|
*/
|
|
32847
|
-
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) =>
|
|
32527
|
+
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) => boolean|void
|
|
32848
32528
|
/**
|
|
32849
32529
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
32850
32530
|
* @param {object} event Event object
|
|
@@ -32855,7 +32535,7 @@ type GridBaseListenersTypes = {
|
|
|
32855
32535
|
* @param {Event} event.event The browser event.
|
|
32856
32536
|
* @param {string} event.region The region where the column was dropped.
|
|
32857
32537
|
*/
|
|
32858
|
-
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
32538
|
+
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void
|
|
32859
32539
|
/**
|
|
32860
32540
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
32861
32541
|
* `false`.
|
|
@@ -32864,7 +32544,7 @@ type GridBaseListenersTypes = {
|
|
|
32864
32544
|
* @param {Grid.column.Column} event.column The column
|
|
32865
32545
|
* @param {Event} event.domEvent The browser event
|
|
32866
32546
|
*/
|
|
32867
|
-
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
32547
|
+
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) => boolean|void
|
|
32868
32548
|
/**
|
|
32869
32549
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
32870
32550
|
* @param {object} event Event object
|
|
@@ -32888,14 +32568,14 @@ type GridBaseListenersTypes = {
|
|
|
32888
32568
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
32889
32569
|
* @param {any[][]} event.rows An array of records to export
|
|
32890
32570
|
*/
|
|
32891
|
-
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
32571
|
+
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void
|
|
32892
32572
|
/**
|
|
32893
32573
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
32894
32574
|
* @param {object} event Event object
|
|
32895
32575
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
32896
32576
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
32897
32577
|
*/
|
|
32898
|
-
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
32578
|
+
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
32899
32579
|
/**
|
|
32900
32580
|
* Fires on the owning Grid before the cell editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
32901
32581
|
* @param {object} event Event object
|
|
@@ -32916,7 +32596,7 @@ type GridBaseListenersTypes = {
|
|
|
32916
32596
|
* @param {object} event Event object
|
|
32917
32597
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
32918
32598
|
*/
|
|
32919
|
-
beforeHide: (event: { source: Widget }) =>
|
|
32599
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
32920
32600
|
/**
|
|
32921
32601
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
32922
32602
|
* @param {object} event Event object
|
|
@@ -32932,7 +32612,7 @@ type GridBaseListenersTypes = {
|
|
|
32932
32612
|
* @param {object} event Event object
|
|
32933
32613
|
* @param {PdfExportConfig} event.config Export config
|
|
32934
32614
|
*/
|
|
32935
|
-
beforePdfExport: (event: { config: PdfExportConfig }) =>
|
|
32615
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => boolean|void
|
|
32936
32616
|
/**
|
|
32937
32617
|
* Fires before a row is rendered.
|
|
32938
32618
|
* @param {object} event Event object
|
|
@@ -32975,7 +32655,7 @@ type GridBaseListenersTypes = {
|
|
|
32975
32655
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
32976
32656
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
32977
32657
|
*/
|
|
32978
|
-
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
32658
|
+
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void
|
|
32979
32659
|
/**
|
|
32980
32660
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
32981
32661
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -32996,19 +32676,19 @@ type GridBaseListenersTypes = {
|
|
|
32996
32676
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
32997
32677
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
32998
32678
|
*/
|
|
32999
|
-
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
32679
|
+
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) => boolean|void
|
|
33000
32680
|
/**
|
|
33001
32681
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
33002
32682
|
* @param {object} event Event object
|
|
33003
32683
|
* @param {GridStateInfo} event.state State object config
|
|
33004
32684
|
*/
|
|
33005
|
-
beforeStateApply: (event: { state: GridStateInfo }) =>
|
|
32685
|
+
beforeStateApply: (event: { state: GridStateInfo }) => boolean|void
|
|
33006
32686
|
/**
|
|
33007
32687
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
33008
32688
|
* @param {object} event Event object
|
|
33009
32689
|
* @param {GridStateInfo} event.state State object config
|
|
33010
32690
|
*/
|
|
33011
|
-
beforeStateSave: (event: { state: GridStateInfo }) =>
|
|
32691
|
+
beforeStateSave: (event: { state: GridStateInfo }) => boolean|void
|
|
33012
32692
|
/**
|
|
33013
32693
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
33014
32694
|
* Returning `false` from a listener prevents the operation
|
|
@@ -33018,7 +32698,7 @@ type GridBaseListenersTypes = {
|
|
|
33018
32698
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
33019
32699
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
33020
32700
|
*/
|
|
33021
|
-
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
32701
|
+
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void
|
|
33022
32702
|
/**
|
|
33023
32703
|
* Fired before a parent node record toggles its collapsed state.
|
|
33024
32704
|
* @param {object} event Event object
|
|
@@ -33087,7 +32767,7 @@ type GridBaseListenersTypes = {
|
|
|
33087
32767
|
* @param {Grid.column.Column} event.column Column
|
|
33088
32768
|
* @param {Core.data.Model} event.record Record
|
|
33089
32769
|
*/
|
|
33090
|
-
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
32770
|
+
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void
|
|
33091
32771
|
/**
|
|
33092
32772
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
33093
32773
|
* @param {object} event Event object
|
|
@@ -33214,7 +32894,7 @@ type GridBaseListenersTypes = {
|
|
|
33214
32894
|
* @param {Event} event.event The browser event.
|
|
33215
32895
|
* @param {string} event.region The region where the column was dropped.
|
|
33216
32896
|
*/
|
|
33217
|
-
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
32897
|
+
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void
|
|
33218
32898
|
/**
|
|
33219
32899
|
* This event is fired after a resize gesture is completed.
|
|
33220
32900
|
* @param {object} event Event object
|
|
@@ -33354,7 +33034,7 @@ type GridBaseListenersTypes = {
|
|
|
33354
33034
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
33355
33035
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
33356
33036
|
*/
|
|
33357
|
-
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
33037
|
+
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
33358
33038
|
/**
|
|
33359
33039
|
* Fires on the owning Grid when cell editing is finished
|
|
33360
33040
|
* @param {object} event Event object
|
|
@@ -33402,7 +33082,7 @@ type GridBaseListenersTypes = {
|
|
|
33402
33082
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
33403
33083
|
* @param {MouseEvent,TouchEvent} event.event
|
|
33404
33084
|
*/
|
|
33405
|
-
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
33085
|
+
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void
|
|
33406
33086
|
/**
|
|
33407
33087
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
33408
33088
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -33469,7 +33149,7 @@ type GridBaseListenersTypes = {
|
|
|
33469
33149
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
33470
33150
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
33471
33151
|
*/
|
|
33472
|
-
headerClick: (event: { domEvent: Event, column: Column }) =>
|
|
33152
|
+
headerClick: (event: { domEvent: Event, column: Column }) => boolean|void
|
|
33473
33153
|
/**
|
|
33474
33154
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
33475
33155
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu#config-processItems).
|
|
@@ -33480,7 +33160,7 @@ type GridBaseListenersTypes = {
|
|
|
33480
33160
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
33481
33161
|
* @param {Grid.column.Column} event.column Column
|
|
33482
33162
|
*/
|
|
33483
|
-
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
33163
|
+
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void
|
|
33484
33164
|
/**
|
|
33485
33165
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
33486
33166
|
* @param {object} event Event object
|
|
@@ -33691,7 +33371,7 @@ type GridBaseListenersTypes = {
|
|
|
33691
33371
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
33692
33372
|
* @param {Event} event.domEvent The native DOM event
|
|
33693
33373
|
*/
|
|
33694
|
-
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
33374
|
+
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
33695
33375
|
/**
|
|
33696
33376
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
33697
33377
|
* @param {object} event Event object
|
|
@@ -33716,7 +33396,7 @@ type GridBaseListenersTypes = {
|
|
|
33716
33396
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
33717
33397
|
* @param {Event} event.domEvent The native DOM event
|
|
33718
33398
|
*/
|
|
33719
|
-
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
33399
|
+
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
33720
33400
|
/**
|
|
33721
33401
|
* Fires on the owning Grid when editing starts
|
|
33722
33402
|
* @param {object} event Event object
|
|
@@ -33805,14 +33485,14 @@ type GridBaseListeners = {
|
|
|
33805
33485
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
33806
33486
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
33807
33487
|
*/
|
|
33808
|
-
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
33488
|
+
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
33809
33489
|
/**
|
|
33810
33490
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
33811
33491
|
* @param {object} event Event object
|
|
33812
33492
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
33813
33493
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
33814
33494
|
*/
|
|
33815
|
-
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
33495
|
+
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
33816
33496
|
/**
|
|
33817
33497
|
* Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
|
|
33818
33498
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
|
|
@@ -33827,7 +33507,7 @@ type GridBaseListeners = {
|
|
|
33827
33507
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
33828
33508
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
33829
33509
|
*/
|
|
33830
|
-
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
33510
|
+
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
33831
33511
|
/**
|
|
33832
33512
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
33833
33513
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -33835,7 +33515,7 @@ type GridBaseListeners = {
|
|
|
33835
33515
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
33836
33516
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
|
|
33837
33517
|
*/
|
|
33838
|
-
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
33518
|
+
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
33839
33519
|
/**
|
|
33840
33520
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
33841
33521
|
* @param {object} event Event object
|
|
@@ -33843,7 +33523,7 @@ type GridBaseListeners = {
|
|
|
33843
33523
|
* @param {string} event.field The field being changed
|
|
33844
33524
|
* @param {any} event.value The value being set
|
|
33845
33525
|
*/
|
|
33846
|
-
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
33526
|
+
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
33847
33527
|
/**
|
|
33848
33528
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
33849
33529
|
* @param {object} event Event object
|
|
@@ -33859,7 +33539,7 @@ type GridBaseListeners = {
|
|
|
33859
33539
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
33860
33540
|
* @param {Event} event.event The browser event.
|
|
33861
33541
|
*/
|
|
33862
|
-
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
33542
|
+
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
33863
33543
|
/**
|
|
33864
33544
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
33865
33545
|
* @param {object} event Event object
|
|
@@ -33870,7 +33550,7 @@ type GridBaseListeners = {
|
|
|
33870
33550
|
* @param {Event} event.event The browser event.
|
|
33871
33551
|
* @param {string} event.region The region where the column was dropped.
|
|
33872
33552
|
*/
|
|
33873
|
-
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
33553
|
+
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
33874
33554
|
/**
|
|
33875
33555
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
33876
33556
|
* `false`.
|
|
@@ -33879,7 +33559,7 @@ type GridBaseListeners = {
|
|
|
33879
33559
|
* @param {Grid.column.Column} event.column The column
|
|
33880
33560
|
* @param {Event} event.domEvent The browser event
|
|
33881
33561
|
*/
|
|
33882
|
-
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
33562
|
+
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
33883
33563
|
/**
|
|
33884
33564
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
33885
33565
|
* @param {object} event Event object
|
|
@@ -33903,14 +33583,14 @@ type GridBaseListeners = {
|
|
|
33903
33583
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
33904
33584
|
* @param {any[][]} event.rows An array of records to export
|
|
33905
33585
|
*/
|
|
33906
|
-
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
33586
|
+
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
33907
33587
|
/**
|
|
33908
33588
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
33909
33589
|
* @param {object} event Event object
|
|
33910
33590
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
33911
33591
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
33912
33592
|
*/
|
|
33913
|
-
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
33593
|
+
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
33914
33594
|
/**
|
|
33915
33595
|
* Fires on the owning Grid before the cell editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
33916
33596
|
* @param {object} event Event object
|
|
@@ -33931,7 +33611,7 @@ type GridBaseListeners = {
|
|
|
33931
33611
|
* @param {object} event Event object
|
|
33932
33612
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
33933
33613
|
*/
|
|
33934
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
33614
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
33935
33615
|
/**
|
|
33936
33616
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
33937
33617
|
* @param {object} event Event object
|
|
@@ -33947,7 +33627,7 @@ type GridBaseListeners = {
|
|
|
33947
33627
|
* @param {object} event Event object
|
|
33948
33628
|
* @param {PdfExportConfig} event.config Export config
|
|
33949
33629
|
*/
|
|
33950
|
-
beforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
33630
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
33951
33631
|
/**
|
|
33952
33632
|
* Fires before a row is rendered.
|
|
33953
33633
|
* @param {object} event Event object
|
|
@@ -33990,7 +33670,7 @@ type GridBaseListeners = {
|
|
|
33990
33670
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
33991
33671
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
33992
33672
|
*/
|
|
33993
|
-
beforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
33673
|
+
beforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
33994
33674
|
/**
|
|
33995
33675
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
33996
33676
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -34011,19 +33691,19 @@ type GridBaseListeners = {
|
|
|
34011
33691
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
34012
33692
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
34013
33693
|
*/
|
|
34014
|
-
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
33694
|
+
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
34015
33695
|
/**
|
|
34016
33696
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
34017
33697
|
* @param {object} event Event object
|
|
34018
33698
|
* @param {GridStateInfo} event.state State object config
|
|
34019
33699
|
*/
|
|
34020
|
-
beforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
33700
|
+
beforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
34021
33701
|
/**
|
|
34022
33702
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
34023
33703
|
* @param {object} event Event object
|
|
34024
33704
|
* @param {GridStateInfo} event.state State object config
|
|
34025
33705
|
*/
|
|
34026
|
-
beforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
33706
|
+
beforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
34027
33707
|
/**
|
|
34028
33708
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
34029
33709
|
* Returning `false` from a listener prevents the operation
|
|
@@ -34033,7 +33713,7 @@ type GridBaseListeners = {
|
|
|
34033
33713
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
34034
33714
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
34035
33715
|
*/
|
|
34036
|
-
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
33716
|
+
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
34037
33717
|
/**
|
|
34038
33718
|
* Fired before a parent node record toggles its collapsed state.
|
|
34039
33719
|
* @param {object} event Event object
|
|
@@ -34102,7 +33782,7 @@ type GridBaseListeners = {
|
|
|
34102
33782
|
* @param {Grid.column.Column} event.column Column
|
|
34103
33783
|
* @param {Core.data.Model} event.record Record
|
|
34104
33784
|
*/
|
|
34105
|
-
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
33785
|
+
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
34106
33786
|
/**
|
|
34107
33787
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
34108
33788
|
* @param {object} event Event object
|
|
@@ -34229,7 +33909,7 @@ type GridBaseListeners = {
|
|
|
34229
33909
|
* @param {Event} event.event The browser event.
|
|
34230
33910
|
* @param {string} event.region The region where the column was dropped.
|
|
34231
33911
|
*/
|
|
34232
|
-
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
33912
|
+
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
34233
33913
|
/**
|
|
34234
33914
|
* This event is fired after a resize gesture is completed.
|
|
34235
33915
|
* @param {object} event Event object
|
|
@@ -34369,7 +34049,7 @@ type GridBaseListeners = {
|
|
|
34369
34049
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
34370
34050
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
34371
34051
|
*/
|
|
34372
|
-
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
34052
|
+
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
34373
34053
|
/**
|
|
34374
34054
|
* Fires on the owning Grid when cell editing is finished
|
|
34375
34055
|
* @param {object} event Event object
|
|
@@ -34417,7 +34097,7 @@ type GridBaseListeners = {
|
|
|
34417
34097
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
34418
34098
|
* @param {MouseEvent,TouchEvent} event.event
|
|
34419
34099
|
*/
|
|
34420
|
-
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
34100
|
+
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
34421
34101
|
/**
|
|
34422
34102
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
34423
34103
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -34484,7 +34164,7 @@ type GridBaseListeners = {
|
|
|
34484
34164
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
34485
34165
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
34486
34166
|
*/
|
|
34487
|
-
headerClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
34167
|
+
headerClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
34488
34168
|
/**
|
|
34489
34169
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
34490
34170
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu#config-processItems).
|
|
@@ -34495,7 +34175,7 @@ type GridBaseListeners = {
|
|
|
34495
34175
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
34496
34176
|
* @param {Grid.column.Column} event.column Column
|
|
34497
34177
|
*/
|
|
34498
|
-
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
34178
|
+
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
34499
34179
|
/**
|
|
34500
34180
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
34501
34181
|
* @param {object} event Event object
|
|
@@ -34706,7 +34386,7 @@ type GridBaseListeners = {
|
|
|
34706
34386
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
34707
34387
|
* @param {Event} event.domEvent The native DOM event
|
|
34708
34388
|
*/
|
|
34709
|
-
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
34389
|
+
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
34710
34390
|
/**
|
|
34711
34391
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
34712
34392
|
* @param {object} event Event object
|
|
@@ -34731,7 +34411,7 @@ type GridBaseListeners = {
|
|
|
34731
34411
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
34732
34412
|
* @param {Event} event.domEvent The native DOM event
|
|
34733
34413
|
*/
|
|
34734
|
-
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
34414
|
+
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
34735
34415
|
/**
|
|
34736
34416
|
* Fires on the owning Grid when editing starts
|
|
34737
34417
|
* @param {object} event Event object
|
|
@@ -35614,14 +35294,14 @@ type GridBaseConfig = {
|
|
|
35614
35294
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
35615
35295
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
35616
35296
|
*/
|
|
35617
|
-
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
35297
|
+
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
35618
35298
|
/**
|
|
35619
35299
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
35620
35300
|
* @param {object} event Event object
|
|
35621
35301
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
35622
35302
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
35623
35303
|
*/
|
|
35624
|
-
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
35304
|
+
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
35625
35305
|
/**
|
|
35626
35306
|
* Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
|
|
35627
35307
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
|
|
@@ -35636,7 +35316,7 @@ type GridBaseConfig = {
|
|
|
35636
35316
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
35637
35317
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
35638
35318
|
*/
|
|
35639
|
-
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
35319
|
+
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
35640
35320
|
/**
|
|
35641
35321
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
35642
35322
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -35644,7 +35324,7 @@ type GridBaseConfig = {
|
|
|
35644
35324
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
35645
35325
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
|
|
35646
35326
|
*/
|
|
35647
|
-
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
35327
|
+
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
35648
35328
|
/**
|
|
35649
35329
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
35650
35330
|
* @param {object} event Event object
|
|
@@ -35652,7 +35332,7 @@ type GridBaseConfig = {
|
|
|
35652
35332
|
* @param {string} event.field The field being changed
|
|
35653
35333
|
* @param {any} event.value The value being set
|
|
35654
35334
|
*/
|
|
35655
|
-
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
35335
|
+
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
35656
35336
|
/**
|
|
35657
35337
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
35658
35338
|
* @param {object} event Event object
|
|
@@ -35668,7 +35348,7 @@ type GridBaseConfig = {
|
|
|
35668
35348
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
35669
35349
|
* @param {Event} event.event The browser event.
|
|
35670
35350
|
*/
|
|
35671
|
-
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
35351
|
+
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
35672
35352
|
/**
|
|
35673
35353
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
35674
35354
|
* @param {object} event Event object
|
|
@@ -35679,7 +35359,7 @@ type GridBaseConfig = {
|
|
|
35679
35359
|
* @param {Event} event.event The browser event.
|
|
35680
35360
|
* @param {string} event.region The region where the column was dropped.
|
|
35681
35361
|
*/
|
|
35682
|
-
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
35362
|
+
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
35683
35363
|
/**
|
|
35684
35364
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
35685
35365
|
* `false`.
|
|
@@ -35688,7 +35368,7 @@ type GridBaseConfig = {
|
|
|
35688
35368
|
* @param {Grid.column.Column} event.column The column
|
|
35689
35369
|
* @param {Event} event.domEvent The browser event
|
|
35690
35370
|
*/
|
|
35691
|
-
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
35371
|
+
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
35692
35372
|
/**
|
|
35693
35373
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
35694
35374
|
* @param {object} event Event object
|
|
@@ -35712,14 +35392,14 @@ type GridBaseConfig = {
|
|
|
35712
35392
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
35713
35393
|
* @param {any[][]} event.rows An array of records to export
|
|
35714
35394
|
*/
|
|
35715
|
-
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
35395
|
+
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
35716
35396
|
/**
|
|
35717
35397
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
35718
35398
|
* @param {object} event Event object
|
|
35719
35399
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
35720
35400
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
35721
35401
|
*/
|
|
35722
|
-
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
35402
|
+
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
35723
35403
|
/**
|
|
35724
35404
|
* Fires on the owning Grid before the cell editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
35725
35405
|
* @param {object} event Event object
|
|
@@ -35740,7 +35420,7 @@ type GridBaseConfig = {
|
|
|
35740
35420
|
* @param {object} event Event object
|
|
35741
35421
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
35742
35422
|
*/
|
|
35743
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
35423
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
35744
35424
|
/**
|
|
35745
35425
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
35746
35426
|
* @param {object} event Event object
|
|
@@ -35756,7 +35436,7 @@ type GridBaseConfig = {
|
|
|
35756
35436
|
* @param {object} event Event object
|
|
35757
35437
|
* @param {PdfExportConfig} event.config Export config
|
|
35758
35438
|
*/
|
|
35759
|
-
onBeforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
35439
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
35760
35440
|
/**
|
|
35761
35441
|
* Fires before a row is rendered.
|
|
35762
35442
|
* @param {object} event Event object
|
|
@@ -35799,7 +35479,7 @@ type GridBaseConfig = {
|
|
|
35799
35479
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
35800
35480
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
35801
35481
|
*/
|
|
35802
|
-
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
35482
|
+
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
35803
35483
|
/**
|
|
35804
35484
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
35805
35485
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -35820,19 +35500,19 @@ type GridBaseConfig = {
|
|
|
35820
35500
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
35821
35501
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
35822
35502
|
*/
|
|
35823
|
-
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
35503
|
+
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
35824
35504
|
/**
|
|
35825
35505
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
35826
35506
|
* @param {object} event Event object
|
|
35827
35507
|
* @param {GridStateInfo} event.state State object config
|
|
35828
35508
|
*/
|
|
35829
|
-
onBeforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
35509
|
+
onBeforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
35830
35510
|
/**
|
|
35831
35511
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
35832
35512
|
* @param {object} event Event object
|
|
35833
35513
|
* @param {GridStateInfo} event.state State object config
|
|
35834
35514
|
*/
|
|
35835
|
-
onBeforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
35515
|
+
onBeforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
35836
35516
|
/**
|
|
35837
35517
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
35838
35518
|
* Returning `false` from a listener prevents the operation
|
|
@@ -35842,7 +35522,7 @@ type GridBaseConfig = {
|
|
|
35842
35522
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
35843
35523
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
35844
35524
|
*/
|
|
35845
|
-
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
35525
|
+
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
35846
35526
|
/**
|
|
35847
35527
|
* Fired before a parent node record toggles its collapsed state.
|
|
35848
35528
|
* @param {object} event Event object
|
|
@@ -35911,7 +35591,7 @@ type GridBaseConfig = {
|
|
|
35911
35591
|
* @param {Grid.column.Column} event.column Column
|
|
35912
35592
|
* @param {Core.data.Model} event.record Record
|
|
35913
35593
|
*/
|
|
35914
|
-
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
35594
|
+
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
35915
35595
|
/**
|
|
35916
35596
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
35917
35597
|
* @param {object} event Event object
|
|
@@ -36038,7 +35718,7 @@ type GridBaseConfig = {
|
|
|
36038
35718
|
* @param {Event} event.event The browser event.
|
|
36039
35719
|
* @param {string} event.region The region where the column was dropped.
|
|
36040
35720
|
*/
|
|
36041
|
-
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
35721
|
+
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
36042
35722
|
/**
|
|
36043
35723
|
* This event is fired after a resize gesture is completed.
|
|
36044
35724
|
* @param {object} event Event object
|
|
@@ -36178,7 +35858,7 @@ type GridBaseConfig = {
|
|
|
36178
35858
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
36179
35859
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
36180
35860
|
*/
|
|
36181
|
-
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
35861
|
+
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
36182
35862
|
/**
|
|
36183
35863
|
* Fires on the owning Grid when cell editing is finished
|
|
36184
35864
|
* @param {object} event Event object
|
|
@@ -36226,7 +35906,7 @@ type GridBaseConfig = {
|
|
|
36226
35906
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
36227
35907
|
* @param {MouseEvent,TouchEvent} event.event
|
|
36228
35908
|
*/
|
|
36229
|
-
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
35909
|
+
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
36230
35910
|
/**
|
|
36231
35911
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
36232
35912
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -36293,7 +35973,7 @@ type GridBaseConfig = {
|
|
|
36293
35973
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
36294
35974
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
36295
35975
|
*/
|
|
36296
|
-
onHeaderClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
35976
|
+
onHeaderClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
36297
35977
|
/**
|
|
36298
35978
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
36299
35979
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu#config-processItems).
|
|
@@ -36304,7 +35984,7 @@ type GridBaseConfig = {
|
|
|
36304
35984
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
36305
35985
|
* @param {Grid.column.Column} event.column Column
|
|
36306
35986
|
*/
|
|
36307
|
-
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
35987
|
+
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
36308
35988
|
/**
|
|
36309
35989
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
36310
35990
|
* @param {object} event Event object
|
|
@@ -36515,7 +36195,7 @@ type GridBaseConfig = {
|
|
|
36515
36195
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
36516
36196
|
* @param {Event} event.domEvent The native DOM event
|
|
36517
36197
|
*/
|
|
36518
|
-
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
36198
|
+
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
36519
36199
|
/**
|
|
36520
36200
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
36521
36201
|
* @param {object} event Event object
|
|
@@ -36540,7 +36220,7 @@ type GridBaseConfig = {
|
|
|
36540
36220
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
36541
36221
|
* @param {Event} event.domEvent The native DOM event
|
|
36542
36222
|
*/
|
|
36543
|
-
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
36223
|
+
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
36544
36224
|
/**
|
|
36545
36225
|
* Fires on the owning Grid when editing starts
|
|
36546
36226
|
* @param {object} event Event object
|
|
@@ -36958,14 +36638,14 @@ export class GridBase extends Panel {
|
|
|
36958
36638
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
36959
36639
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
36960
36640
|
*/
|
|
36961
|
-
onBeforeCSVExport: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
36641
|
+
onBeforeCSVExport: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
36962
36642
|
/**
|
|
36963
36643
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
36964
36644
|
* @param {object} event Event object
|
|
36965
36645
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
36966
36646
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
36967
36647
|
*/
|
|
36968
|
-
onBeforeCancelCellEdit: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
36648
|
+
onBeforeCancelCellEdit: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
36969
36649
|
/**
|
|
36970
36650
|
* Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
|
|
36971
36651
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
|
|
@@ -36980,7 +36660,7 @@ export class GridBase extends Panel {
|
|
|
36980
36660
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
36981
36661
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
36982
36662
|
*/
|
|
36983
|
-
onBeforeCellEditStart: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
36663
|
+
onBeforeCellEditStart: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
36984
36664
|
/**
|
|
36985
36665
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
36986
36666
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -36988,7 +36668,7 @@ export class GridBase extends Panel {
|
|
|
36988
36668
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
36989
36669
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
|
|
36990
36670
|
*/
|
|
36991
|
-
onBeforeCellRangeDelete: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
36671
|
+
onBeforeCellRangeDelete: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
36992
36672
|
/**
|
|
36993
36673
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
36994
36674
|
* @param {object} event Event object
|
|
@@ -36996,7 +36676,7 @@ export class GridBase extends Panel {
|
|
|
36996
36676
|
* @param {string} event.field The field being changed
|
|
36997
36677
|
* @param {any} event.value The value being set
|
|
36998
36678
|
*/
|
|
36999
|
-
onBeforeCellRangeEdit: ((event: { record: Model, field: string, value: any }) =>
|
|
36679
|
+
onBeforeCellRangeEdit: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
37000
36680
|
/**
|
|
37001
36681
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
37002
36682
|
* @param {object} event Event object
|
|
@@ -37012,7 +36692,7 @@ export class GridBase extends Panel {
|
|
|
37012
36692
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
37013
36693
|
* @param {Event} event.event The browser event.
|
|
37014
36694
|
*/
|
|
37015
|
-
onBeforeColumnDragStart: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
36695
|
+
onBeforeColumnDragStart: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
37016
36696
|
/**
|
|
37017
36697
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
37018
36698
|
* @param {object} event Event object
|
|
@@ -37023,7 +36703,7 @@ export class GridBase extends Panel {
|
|
|
37023
36703
|
* @param {Event} event.event The browser event.
|
|
37024
36704
|
* @param {string} event.region The region where the column was dropped.
|
|
37025
36705
|
*/
|
|
37026
|
-
onBeforeColumnDropFinalize: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
36706
|
+
onBeforeColumnDropFinalize: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
37027
36707
|
/**
|
|
37028
36708
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
37029
36709
|
* `false`.
|
|
@@ -37032,7 +36712,7 @@ export class GridBase extends Panel {
|
|
|
37032
36712
|
* @param {Grid.column.Column} event.column The column
|
|
37033
36713
|
* @param {Event} event.domEvent The browser event
|
|
37034
36714
|
*/
|
|
37035
|
-
onBeforeColumnResize: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
36715
|
+
onBeforeColumnResize: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
37036
36716
|
/**
|
|
37037
36717
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
37038
36718
|
* @param {object} event Event object
|
|
@@ -37056,14 +36736,14 @@ export class GridBase extends Panel {
|
|
|
37056
36736
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
37057
36737
|
* @param {any[][]} event.rows An array of records to export
|
|
37058
36738
|
*/
|
|
37059
|
-
onBeforeExcelExport: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
36739
|
+
onBeforeExcelExport: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
37060
36740
|
/**
|
|
37061
36741
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
37062
36742
|
* @param {object} event Event object
|
|
37063
36743
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
37064
36744
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
37065
36745
|
*/
|
|
37066
|
-
onBeforeFillHandleDragStart: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
36746
|
+
onBeforeFillHandleDragStart: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
37067
36747
|
/**
|
|
37068
36748
|
* Fires on the owning Grid before the cell editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
37069
36749
|
* @param {object} event Event object
|
|
@@ -37094,7 +36774,7 @@ export class GridBase extends Panel {
|
|
|
37094
36774
|
* @param {object} event Event object
|
|
37095
36775
|
* @param {PdfExportConfig} event.config Export config
|
|
37096
36776
|
*/
|
|
37097
|
-
onBeforePdfExport: ((event: { config: PdfExportConfig }) =>
|
|
36777
|
+
onBeforePdfExport: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
37098
36778
|
/**
|
|
37099
36779
|
* Fires before a row is rendered.
|
|
37100
36780
|
* @param {object} event Event object
|
|
@@ -37137,26 +36817,26 @@ export class GridBase extends Panel {
|
|
|
37137
36817
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
37138
36818
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
37139
36819
|
*/
|
|
37140
|
-
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
36820
|
+
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
37141
36821
|
/**
|
|
37142
36822
|
* Fires on the owning Grid before editing starts, return `false` to prevent editing
|
|
37143
36823
|
* @param {object} event Event object
|
|
37144
36824
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
37145
36825
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
37146
36826
|
*/
|
|
37147
|
-
onBeforeStartRowEdit: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
36827
|
+
onBeforeStartRowEdit: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
37148
36828
|
/**
|
|
37149
36829
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
37150
36830
|
* @param {object} event Event object
|
|
37151
36831
|
* @param {GridStateInfo} event.state State object config
|
|
37152
36832
|
*/
|
|
37153
|
-
onBeforeStateApply: ((event: { state: GridStateInfo }) =>
|
|
36833
|
+
onBeforeStateApply: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
37154
36834
|
/**
|
|
37155
36835
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
37156
36836
|
* @param {object} event Event object
|
|
37157
36837
|
* @param {GridStateInfo} event.state State object config
|
|
37158
36838
|
*/
|
|
37159
|
-
onBeforeStateSave: ((event: { state: GridStateInfo }) =>
|
|
36839
|
+
onBeforeStateSave: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
37160
36840
|
/**
|
|
37161
36841
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
37162
36842
|
* Returning `false` from a listener prevents the operation
|
|
@@ -37166,7 +36846,7 @@ export class GridBase extends Panel {
|
|
|
37166
36846
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
37167
36847
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
37168
36848
|
*/
|
|
37169
|
-
onBeforeToggleGroup: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
36849
|
+
onBeforeToggleGroup: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
37170
36850
|
/**
|
|
37171
36851
|
* Fired before a parent node record toggles its collapsed state.
|
|
37172
36852
|
* @param {object} event Event object
|
|
@@ -37235,7 +36915,7 @@ export class GridBase extends Panel {
|
|
|
37235
36915
|
* @param {Grid.column.Column} event.column Column
|
|
37236
36916
|
* @param {Core.data.Model} event.record Record
|
|
37237
36917
|
*/
|
|
37238
|
-
onCellMenuBeforeShow: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
36918
|
+
onCellMenuBeforeShow: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
37239
36919
|
/**
|
|
37240
36920
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
37241
36921
|
* @param {object} event Event object
|
|
@@ -37356,7 +37036,7 @@ export class GridBase extends Panel {
|
|
|
37356
37036
|
* @param {Event} event.event The browser event.
|
|
37357
37037
|
* @param {string} event.region The region where the column was dropped.
|
|
37358
37038
|
*/
|
|
37359
|
-
onColumnDrop: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
37039
|
+
onColumnDrop: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
37360
37040
|
/**
|
|
37361
37041
|
* This event is fired after a resize gesture is completed.
|
|
37362
37042
|
* @param {object} event Event object
|
|
@@ -37460,7 +37140,7 @@ export class GridBase extends Panel {
|
|
|
37460
37140
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
37461
37141
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
37462
37142
|
*/
|
|
37463
|
-
onFillHandleDragStart: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
37143
|
+
onFillHandleDragStart: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
37464
37144
|
/**
|
|
37465
37145
|
* Fires on the owning Grid when cell editing is finished
|
|
37466
37146
|
* @param {object} event Event object
|
|
@@ -37484,7 +37164,7 @@ export class GridBase extends Panel {
|
|
|
37484
37164
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
37485
37165
|
* @param {MouseEvent,TouchEvent} event.event
|
|
37486
37166
|
*/
|
|
37487
|
-
onGridRowBeforeDragStart: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
37167
|
+
onGridRowBeforeDragStart: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
37488
37168
|
/**
|
|
37489
37169
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
37490
37170
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -37551,7 +37231,7 @@ export class GridBase extends Panel {
|
|
|
37551
37231
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
37552
37232
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
37553
37233
|
*/
|
|
37554
|
-
onHeaderClick: ((event: { domEvent: Event, column: Column }) =>
|
|
37234
|
+
onHeaderClick: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
37555
37235
|
/**
|
|
37556
37236
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
37557
37237
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu#config-processItems).
|
|
@@ -37562,7 +37242,7 @@ export class GridBase extends Panel {
|
|
|
37562
37242
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
37563
37243
|
* @param {Grid.column.Column} event.column Column
|
|
37564
37244
|
*/
|
|
37565
|
-
onHeaderMenuBeforeShow: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
37245
|
+
onHeaderMenuBeforeShow: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
37566
37246
|
/**
|
|
37567
37247
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
37568
37248
|
* @param {object} event Event object
|
|
@@ -37731,7 +37411,7 @@ export class GridBase extends Panel {
|
|
|
37731
37411
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
37732
37412
|
* @param {Event} event.domEvent The native DOM event
|
|
37733
37413
|
*/
|
|
37734
|
-
onSplitterCollapseClick: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
37414
|
+
onSplitterCollapseClick: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
37735
37415
|
/**
|
|
37736
37416
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
37737
37417
|
* @param {object} event Event object
|
|
@@ -37756,7 +37436,7 @@ export class GridBase extends Panel {
|
|
|
37756
37436
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
37757
37437
|
* @param {Event} event.domEvent The native DOM event
|
|
37758
37438
|
*/
|
|
37759
|
-
onSplitterExpandClick: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
37439
|
+
onSplitterExpandClick: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
37760
37440
|
/**
|
|
37761
37441
|
* Fires on the owning Grid when editing starts
|
|
37762
37442
|
* @param {object} event Event object
|
|
@@ -38408,7 +38088,7 @@ type SubGridListenersTypes = {
|
|
|
38408
38088
|
* @param {object} event Event object
|
|
38409
38089
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
38410
38090
|
*/
|
|
38411
|
-
beforeHide: (event: { source: Widget }) =>
|
|
38091
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
38412
38092
|
/**
|
|
38413
38093
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
38414
38094
|
* @param {object} event Event object
|
|
@@ -38538,7 +38218,7 @@ type SubGridListeners = {
|
|
|
38538
38218
|
* @param {object} event Event object
|
|
38539
38219
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
38540
38220
|
*/
|
|
38541
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
38221
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
38542
38222
|
/**
|
|
38543
38223
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
38544
38224
|
* @param {object} event Event object
|
|
@@ -39027,7 +38707,7 @@ type SubGridConfig = {
|
|
|
39027
38707
|
* @param {object} event Event object
|
|
39028
38708
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
39029
38709
|
*/
|
|
39030
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
38710
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
39031
38711
|
/**
|
|
39032
38712
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
39033
38713
|
* @param {object} event Event object
|
|
@@ -39261,14 +38941,14 @@ type TreeGridListenersTypes = {
|
|
|
39261
38941
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
39262
38942
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
39263
38943
|
*/
|
|
39264
|
-
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
38944
|
+
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void
|
|
39265
38945
|
/**
|
|
39266
38946
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
39267
38947
|
* @param {object} event Event object
|
|
39268
38948
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
39269
38949
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
39270
38950
|
*/
|
|
39271
|
-
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) =>
|
|
38951
|
+
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) => boolean|void
|
|
39272
38952
|
/**
|
|
39273
38953
|
* Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
|
|
39274
38954
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeCancelRowEdit)
|
|
@@ -39283,7 +38963,7 @@ type TreeGridListenersTypes = {
|
|
|
39283
38963
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
39284
38964
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
39285
38965
|
*/
|
|
39286
|
-
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
38966
|
+
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => boolean|void
|
|
39287
38967
|
/**
|
|
39288
38968
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
39289
38969
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -39291,7 +38971,7 @@ type TreeGridListenersTypes = {
|
|
|
39291
38971
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
39292
38972
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
|
|
39293
38973
|
*/
|
|
39294
|
-
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
38974
|
+
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void
|
|
39295
38975
|
/**
|
|
39296
38976
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
39297
38977
|
* @param {object} event Event object
|
|
@@ -39299,7 +38979,7 @@ type TreeGridListenersTypes = {
|
|
|
39299
38979
|
* @param {string} event.field The field being changed
|
|
39300
38980
|
* @param {any} event.value The value being set
|
|
39301
38981
|
*/
|
|
39302
|
-
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) =>
|
|
38982
|
+
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => boolean|void
|
|
39303
38983
|
/**
|
|
39304
38984
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
39305
38985
|
* @param {object} event Event object
|
|
@@ -39315,7 +38995,7 @@ type TreeGridListenersTypes = {
|
|
|
39315
38995
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
39316
38996
|
* @param {Event} event.event The browser event.
|
|
39317
38997
|
*/
|
|
39318
|
-
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) =>
|
|
38998
|
+
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) => boolean|void
|
|
39319
38999
|
/**
|
|
39320
39000
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
39321
39001
|
* @param {object} event Event object
|
|
@@ -39326,7 +39006,7 @@ type TreeGridListenersTypes = {
|
|
|
39326
39006
|
* @param {Event} event.event The browser event.
|
|
39327
39007
|
* @param {string} event.region The region where the column was dropped.
|
|
39328
39008
|
*/
|
|
39329
|
-
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
39009
|
+
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void
|
|
39330
39010
|
/**
|
|
39331
39011
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
39332
39012
|
* `false`.
|
|
@@ -39335,7 +39015,7 @@ type TreeGridListenersTypes = {
|
|
|
39335
39015
|
* @param {Grid.column.Column} event.column The column
|
|
39336
39016
|
* @param {Event} event.domEvent The browser event
|
|
39337
39017
|
*/
|
|
39338
|
-
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
39018
|
+
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) => boolean|void
|
|
39339
39019
|
/**
|
|
39340
39020
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
39341
39021
|
* @param {object} event Event object
|
|
@@ -39359,14 +39039,14 @@ type TreeGridListenersTypes = {
|
|
|
39359
39039
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
39360
39040
|
* @param {any[][]} event.rows An array of records to export
|
|
39361
39041
|
*/
|
|
39362
|
-
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
39042
|
+
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void
|
|
39363
39043
|
/**
|
|
39364
39044
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
39365
39045
|
* @param {object} event Event object
|
|
39366
39046
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
39367
39047
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
39368
39048
|
*/
|
|
39369
|
-
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
39049
|
+
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
39370
39050
|
/**
|
|
39371
39051
|
* Fires on the owning Grid before the cell editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
39372
39052
|
* @param {object} event Event object
|
|
@@ -39387,7 +39067,7 @@ type TreeGridListenersTypes = {
|
|
|
39387
39067
|
* @param {object} event Event object
|
|
39388
39068
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
39389
39069
|
*/
|
|
39390
|
-
beforeHide: (event: { source: Widget }) =>
|
|
39070
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
39391
39071
|
/**
|
|
39392
39072
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
39393
39073
|
* @param {object} event Event object
|
|
@@ -39403,7 +39083,7 @@ type TreeGridListenersTypes = {
|
|
|
39403
39083
|
* @param {object} event Event object
|
|
39404
39084
|
* @param {PdfExportConfig} event.config Export config
|
|
39405
39085
|
*/
|
|
39406
|
-
beforePdfExport: (event: { config: PdfExportConfig }) =>
|
|
39086
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => boolean|void
|
|
39407
39087
|
/**
|
|
39408
39088
|
* Fires before a row is rendered.
|
|
39409
39089
|
* @param {object} event Event object
|
|
@@ -39446,7 +39126,7 @@ type TreeGridListenersTypes = {
|
|
|
39446
39126
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
39447
39127
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
39448
39128
|
*/
|
|
39449
|
-
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
39129
|
+
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void
|
|
39450
39130
|
/**
|
|
39451
39131
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
39452
39132
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -39467,19 +39147,19 @@ type TreeGridListenersTypes = {
|
|
|
39467
39147
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
39468
39148
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
39469
39149
|
*/
|
|
39470
|
-
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
39150
|
+
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) => boolean|void
|
|
39471
39151
|
/**
|
|
39472
39152
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
39473
39153
|
* @param {object} event Event object
|
|
39474
39154
|
* @param {GridStateInfo} event.state State object config
|
|
39475
39155
|
*/
|
|
39476
|
-
beforeStateApply: (event: { state: GridStateInfo }) =>
|
|
39156
|
+
beforeStateApply: (event: { state: GridStateInfo }) => boolean|void
|
|
39477
39157
|
/**
|
|
39478
39158
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
39479
39159
|
* @param {object} event Event object
|
|
39480
39160
|
* @param {GridStateInfo} event.state State object config
|
|
39481
39161
|
*/
|
|
39482
|
-
beforeStateSave: (event: { state: GridStateInfo }) =>
|
|
39162
|
+
beforeStateSave: (event: { state: GridStateInfo }) => boolean|void
|
|
39483
39163
|
/**
|
|
39484
39164
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
39485
39165
|
* Returning `false` from a listener prevents the operation
|
|
@@ -39489,7 +39169,7 @@ type TreeGridListenersTypes = {
|
|
|
39489
39169
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
39490
39170
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
39491
39171
|
*/
|
|
39492
|
-
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
39172
|
+
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void
|
|
39493
39173
|
/**
|
|
39494
39174
|
* Fired before a parent node record toggles its collapsed state.
|
|
39495
39175
|
* @param {object} event Event object
|
|
@@ -39558,7 +39238,7 @@ type TreeGridListenersTypes = {
|
|
|
39558
39238
|
* @param {Grid.column.Column} event.column Column
|
|
39559
39239
|
* @param {Core.data.Model} event.record Record
|
|
39560
39240
|
*/
|
|
39561
|
-
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
39241
|
+
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void
|
|
39562
39242
|
/**
|
|
39563
39243
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
39564
39244
|
* @param {object} event Event object
|
|
@@ -39685,7 +39365,7 @@ type TreeGridListenersTypes = {
|
|
|
39685
39365
|
* @param {Event} event.event The browser event.
|
|
39686
39366
|
* @param {string} event.region The region where the column was dropped.
|
|
39687
39367
|
*/
|
|
39688
|
-
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
39368
|
+
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void
|
|
39689
39369
|
/**
|
|
39690
39370
|
* This event is fired after a resize gesture is completed.
|
|
39691
39371
|
* @param {object} event Event object
|
|
@@ -39825,7 +39505,7 @@ type TreeGridListenersTypes = {
|
|
|
39825
39505
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
39826
39506
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
39827
39507
|
*/
|
|
39828
|
-
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
39508
|
+
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
39829
39509
|
/**
|
|
39830
39510
|
* Fires on the owning Grid when cell editing is finished
|
|
39831
39511
|
* @param {object} event Event object
|
|
@@ -39873,7 +39553,7 @@ type TreeGridListenersTypes = {
|
|
|
39873
39553
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
39874
39554
|
* @param {MouseEvent,TouchEvent} event.event
|
|
39875
39555
|
*/
|
|
39876
|
-
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
39556
|
+
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void
|
|
39877
39557
|
/**
|
|
39878
39558
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
39879
39559
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -39940,7 +39620,7 @@ type TreeGridListenersTypes = {
|
|
|
39940
39620
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
39941
39621
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
39942
39622
|
*/
|
|
39943
|
-
headerClick: (event: { domEvent: Event, column: Column }) =>
|
|
39623
|
+
headerClick: (event: { domEvent: Event, column: Column }) => boolean|void
|
|
39944
39624
|
/**
|
|
39945
39625
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
39946
39626
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu#config-processItems).
|
|
@@ -39951,7 +39631,7 @@ type TreeGridListenersTypes = {
|
|
|
39951
39631
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
39952
39632
|
* @param {Grid.column.Column} event.column Column
|
|
39953
39633
|
*/
|
|
39954
|
-
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
39634
|
+
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void
|
|
39955
39635
|
/**
|
|
39956
39636
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
39957
39637
|
* @param {object} event Event object
|
|
@@ -40162,7 +39842,7 @@ type TreeGridListenersTypes = {
|
|
|
40162
39842
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
40163
39843
|
* @param {Event} event.domEvent The native DOM event
|
|
40164
39844
|
*/
|
|
40165
|
-
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
39845
|
+
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
40166
39846
|
/**
|
|
40167
39847
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
40168
39848
|
* @param {object} event Event object
|
|
@@ -40187,7 +39867,7 @@ type TreeGridListenersTypes = {
|
|
|
40187
39867
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
40188
39868
|
* @param {Event} event.domEvent The native DOM event
|
|
40189
39869
|
*/
|
|
40190
|
-
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
39870
|
+
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
40191
39871
|
/**
|
|
40192
39872
|
* Fires on the owning Grid when editing starts
|
|
40193
39873
|
* @param {object} event Event object
|
|
@@ -40276,14 +39956,14 @@ type TreeGridListeners = {
|
|
|
40276
39956
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
40277
39957
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
40278
39958
|
*/
|
|
40279
|
-
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
39959
|
+
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
40280
39960
|
/**
|
|
40281
39961
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
40282
39962
|
* @param {object} event Event object
|
|
40283
39963
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
40284
39964
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
40285
39965
|
*/
|
|
40286
|
-
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
39966
|
+
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
40287
39967
|
/**
|
|
40288
39968
|
* Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
|
|
40289
39969
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeCancelRowEdit)
|
|
@@ -40298,7 +39978,7 @@ type TreeGridListeners = {
|
|
|
40298
39978
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
40299
39979
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
40300
39980
|
*/
|
|
40301
|
-
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
39981
|
+
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
40302
39982
|
/**
|
|
40303
39983
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
40304
39984
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -40306,7 +39986,7 @@ type TreeGridListeners = {
|
|
|
40306
39986
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
40307
39987
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
|
|
40308
39988
|
*/
|
|
40309
|
-
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
39989
|
+
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
40310
39990
|
/**
|
|
40311
39991
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
40312
39992
|
* @param {object} event Event object
|
|
@@ -40314,7 +39994,7 @@ type TreeGridListeners = {
|
|
|
40314
39994
|
* @param {string} event.field The field being changed
|
|
40315
39995
|
* @param {any} event.value The value being set
|
|
40316
39996
|
*/
|
|
40317
|
-
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
39997
|
+
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
40318
39998
|
/**
|
|
40319
39999
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
40320
40000
|
* @param {object} event Event object
|
|
@@ -40330,7 +40010,7 @@ type TreeGridListeners = {
|
|
|
40330
40010
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
40331
40011
|
* @param {Event} event.event The browser event.
|
|
40332
40012
|
*/
|
|
40333
|
-
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
40013
|
+
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
40334
40014
|
/**
|
|
40335
40015
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
40336
40016
|
* @param {object} event Event object
|
|
@@ -40341,7 +40021,7 @@ type TreeGridListeners = {
|
|
|
40341
40021
|
* @param {Event} event.event The browser event.
|
|
40342
40022
|
* @param {string} event.region The region where the column was dropped.
|
|
40343
40023
|
*/
|
|
40344
|
-
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
40024
|
+
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
40345
40025
|
/**
|
|
40346
40026
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
40347
40027
|
* `false`.
|
|
@@ -40350,7 +40030,7 @@ type TreeGridListeners = {
|
|
|
40350
40030
|
* @param {Grid.column.Column} event.column The column
|
|
40351
40031
|
* @param {Event} event.domEvent The browser event
|
|
40352
40032
|
*/
|
|
40353
|
-
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
40033
|
+
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
40354
40034
|
/**
|
|
40355
40035
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
40356
40036
|
* @param {object} event Event object
|
|
@@ -40374,14 +40054,14 @@ type TreeGridListeners = {
|
|
|
40374
40054
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
40375
40055
|
* @param {any[][]} event.rows An array of records to export
|
|
40376
40056
|
*/
|
|
40377
|
-
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
40057
|
+
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
40378
40058
|
/**
|
|
40379
40059
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
40380
40060
|
* @param {object} event Event object
|
|
40381
40061
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
40382
40062
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
40383
40063
|
*/
|
|
40384
|
-
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
40064
|
+
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
40385
40065
|
/**
|
|
40386
40066
|
* Fires on the owning Grid before the cell editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
40387
40067
|
* @param {object} event Event object
|
|
@@ -40402,7 +40082,7 @@ type TreeGridListeners = {
|
|
|
40402
40082
|
* @param {object} event Event object
|
|
40403
40083
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
40404
40084
|
*/
|
|
40405
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
40085
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
40406
40086
|
/**
|
|
40407
40087
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
40408
40088
|
* @param {object} event Event object
|
|
@@ -40418,7 +40098,7 @@ type TreeGridListeners = {
|
|
|
40418
40098
|
* @param {object} event Event object
|
|
40419
40099
|
* @param {PdfExportConfig} event.config Export config
|
|
40420
40100
|
*/
|
|
40421
|
-
beforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
40101
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
40422
40102
|
/**
|
|
40423
40103
|
* Fires before a row is rendered.
|
|
40424
40104
|
* @param {object} event Event object
|
|
@@ -40461,7 +40141,7 @@ type TreeGridListeners = {
|
|
|
40461
40141
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
40462
40142
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
40463
40143
|
*/
|
|
40464
|
-
beforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
40144
|
+
beforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
40465
40145
|
/**
|
|
40466
40146
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
40467
40147
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -40482,19 +40162,19 @@ type TreeGridListeners = {
|
|
|
40482
40162
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
40483
40163
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
40484
40164
|
*/
|
|
40485
|
-
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
40165
|
+
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
40486
40166
|
/**
|
|
40487
40167
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
40488
40168
|
* @param {object} event Event object
|
|
40489
40169
|
* @param {GridStateInfo} event.state State object config
|
|
40490
40170
|
*/
|
|
40491
|
-
beforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
40171
|
+
beforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
40492
40172
|
/**
|
|
40493
40173
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
40494
40174
|
* @param {object} event Event object
|
|
40495
40175
|
* @param {GridStateInfo} event.state State object config
|
|
40496
40176
|
*/
|
|
40497
|
-
beforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
40177
|
+
beforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
40498
40178
|
/**
|
|
40499
40179
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
40500
40180
|
* Returning `false` from a listener prevents the operation
|
|
@@ -40504,7 +40184,7 @@ type TreeGridListeners = {
|
|
|
40504
40184
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
40505
40185
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
40506
40186
|
*/
|
|
40507
|
-
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
40187
|
+
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
40508
40188
|
/**
|
|
40509
40189
|
* Fired before a parent node record toggles its collapsed state.
|
|
40510
40190
|
* @param {object} event Event object
|
|
@@ -40573,7 +40253,7 @@ type TreeGridListeners = {
|
|
|
40573
40253
|
* @param {Grid.column.Column} event.column Column
|
|
40574
40254
|
* @param {Core.data.Model} event.record Record
|
|
40575
40255
|
*/
|
|
40576
|
-
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
40256
|
+
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
40577
40257
|
/**
|
|
40578
40258
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
40579
40259
|
* @param {object} event Event object
|
|
@@ -40700,7 +40380,7 @@ type TreeGridListeners = {
|
|
|
40700
40380
|
* @param {Event} event.event The browser event.
|
|
40701
40381
|
* @param {string} event.region The region where the column was dropped.
|
|
40702
40382
|
*/
|
|
40703
|
-
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
40383
|
+
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
40704
40384
|
/**
|
|
40705
40385
|
* This event is fired after a resize gesture is completed.
|
|
40706
40386
|
* @param {object} event Event object
|
|
@@ -40840,7 +40520,7 @@ type TreeGridListeners = {
|
|
|
40840
40520
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
40841
40521
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
40842
40522
|
*/
|
|
40843
|
-
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
40523
|
+
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
40844
40524
|
/**
|
|
40845
40525
|
* Fires on the owning Grid when cell editing is finished
|
|
40846
40526
|
* @param {object} event Event object
|
|
@@ -40888,7 +40568,7 @@ type TreeGridListeners = {
|
|
|
40888
40568
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
40889
40569
|
* @param {MouseEvent,TouchEvent} event.event
|
|
40890
40570
|
*/
|
|
40891
|
-
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
40571
|
+
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
40892
40572
|
/**
|
|
40893
40573
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
40894
40574
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -40955,7 +40635,7 @@ type TreeGridListeners = {
|
|
|
40955
40635
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
40956
40636
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
40957
40637
|
*/
|
|
40958
|
-
headerClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
40638
|
+
headerClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
40959
40639
|
/**
|
|
40960
40640
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
40961
40641
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu#config-processItems).
|
|
@@ -40966,7 +40646,7 @@ type TreeGridListeners = {
|
|
|
40966
40646
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
40967
40647
|
* @param {Grid.column.Column} event.column Column
|
|
40968
40648
|
*/
|
|
40969
|
-
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
40649
|
+
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
40970
40650
|
/**
|
|
40971
40651
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
40972
40652
|
* @param {object} event Event object
|
|
@@ -41177,7 +40857,7 @@ type TreeGridListeners = {
|
|
|
41177
40857
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
41178
40858
|
* @param {Event} event.domEvent The native DOM event
|
|
41179
40859
|
*/
|
|
41180
|
-
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
40860
|
+
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
41181
40861
|
/**
|
|
41182
40862
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
41183
40863
|
* @param {object} event Event object
|
|
@@ -41202,7 +40882,7 @@ type TreeGridListeners = {
|
|
|
41202
40882
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
41203
40883
|
* @param {Event} event.domEvent The native DOM event
|
|
41204
40884
|
*/
|
|
41205
|
-
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
40885
|
+
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
41206
40886
|
/**
|
|
41207
40887
|
* Fires on the owning Grid when editing starts
|
|
41208
40888
|
* @param {object} event Event object
|
|
@@ -42086,14 +41766,14 @@ type TreeGridConfig = {
|
|
|
42086
41766
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
42087
41767
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
42088
41768
|
*/
|
|
42089
|
-
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
41769
|
+
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
42090
41770
|
/**
|
|
42091
41771
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
42092
41772
|
* @param {object} event Event object
|
|
42093
41773
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
42094
41774
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
42095
41775
|
*/
|
|
42096
|
-
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
41776
|
+
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
42097
41777
|
/**
|
|
42098
41778
|
* Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
|
|
42099
41779
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeCancelRowEdit)
|
|
@@ -42108,7 +41788,7 @@ type TreeGridConfig = {
|
|
|
42108
41788
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
42109
41789
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
42110
41790
|
*/
|
|
42111
|
-
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
41791
|
+
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
42112
41792
|
/**
|
|
42113
41793
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
42114
41794
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -42116,7 +41796,7 @@ type TreeGridConfig = {
|
|
|
42116
41796
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
42117
41797
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
|
|
42118
41798
|
*/
|
|
42119
|
-
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
41799
|
+
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
42120
41800
|
/**
|
|
42121
41801
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
42122
41802
|
* @param {object} event Event object
|
|
@@ -42124,7 +41804,7 @@ type TreeGridConfig = {
|
|
|
42124
41804
|
* @param {string} event.field The field being changed
|
|
42125
41805
|
* @param {any} event.value The value being set
|
|
42126
41806
|
*/
|
|
42127
|
-
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
41807
|
+
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
42128
41808
|
/**
|
|
42129
41809
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
42130
41810
|
* @param {object} event Event object
|
|
@@ -42140,7 +41820,7 @@ type TreeGridConfig = {
|
|
|
42140
41820
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
42141
41821
|
* @param {Event} event.event The browser event.
|
|
42142
41822
|
*/
|
|
42143
|
-
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
41823
|
+
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
42144
41824
|
/**
|
|
42145
41825
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
42146
41826
|
* @param {object} event Event object
|
|
@@ -42151,7 +41831,7 @@ type TreeGridConfig = {
|
|
|
42151
41831
|
* @param {Event} event.event The browser event.
|
|
42152
41832
|
* @param {string} event.region The region where the column was dropped.
|
|
42153
41833
|
*/
|
|
42154
|
-
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
41834
|
+
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
42155
41835
|
/**
|
|
42156
41836
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
42157
41837
|
* `false`.
|
|
@@ -42160,7 +41840,7 @@ type TreeGridConfig = {
|
|
|
42160
41840
|
* @param {Grid.column.Column} event.column The column
|
|
42161
41841
|
* @param {Event} event.domEvent The browser event
|
|
42162
41842
|
*/
|
|
42163
|
-
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
41843
|
+
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
42164
41844
|
/**
|
|
42165
41845
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
42166
41846
|
* @param {object} event Event object
|
|
@@ -42184,14 +41864,14 @@ type TreeGridConfig = {
|
|
|
42184
41864
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
42185
41865
|
* @param {any[][]} event.rows An array of records to export
|
|
42186
41866
|
*/
|
|
42187
|
-
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
41867
|
+
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
42188
41868
|
/**
|
|
42189
41869
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
42190
41870
|
* @param {object} event Event object
|
|
42191
41871
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
42192
41872
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
42193
41873
|
*/
|
|
42194
|
-
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
41874
|
+
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
42195
41875
|
/**
|
|
42196
41876
|
* Fires on the owning Grid before the cell editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
42197
41877
|
* @param {object} event Event object
|
|
@@ -42212,7 +41892,7 @@ type TreeGridConfig = {
|
|
|
42212
41892
|
* @param {object} event Event object
|
|
42213
41893
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
42214
41894
|
*/
|
|
42215
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
41895
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
42216
41896
|
/**
|
|
42217
41897
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
42218
41898
|
* @param {object} event Event object
|
|
@@ -42228,7 +41908,7 @@ type TreeGridConfig = {
|
|
|
42228
41908
|
* @param {object} event Event object
|
|
42229
41909
|
* @param {PdfExportConfig} event.config Export config
|
|
42230
41910
|
*/
|
|
42231
|
-
onBeforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
41911
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
42232
41912
|
/**
|
|
42233
41913
|
* Fires before a row is rendered.
|
|
42234
41914
|
* @param {object} event Event object
|
|
@@ -42271,7 +41951,7 @@ type TreeGridConfig = {
|
|
|
42271
41951
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
42272
41952
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
42273
41953
|
*/
|
|
42274
|
-
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
41954
|
+
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
42275
41955
|
/**
|
|
42276
41956
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
42277
41957
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -42292,19 +41972,19 @@ type TreeGridConfig = {
|
|
|
42292
41972
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
42293
41973
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
42294
41974
|
*/
|
|
42295
|
-
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
41975
|
+
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
42296
41976
|
/**
|
|
42297
41977
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
42298
41978
|
* @param {object} event Event object
|
|
42299
41979
|
* @param {GridStateInfo} event.state State object config
|
|
42300
41980
|
*/
|
|
42301
|
-
onBeforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
41981
|
+
onBeforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
42302
41982
|
/**
|
|
42303
41983
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
42304
41984
|
* @param {object} event Event object
|
|
42305
41985
|
* @param {GridStateInfo} event.state State object config
|
|
42306
41986
|
*/
|
|
42307
|
-
onBeforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
41987
|
+
onBeforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
42308
41988
|
/**
|
|
42309
41989
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
42310
41990
|
* Returning `false` from a listener prevents the operation
|
|
@@ -42314,7 +41994,7 @@ type TreeGridConfig = {
|
|
|
42314
41994
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
42315
41995
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
42316
41996
|
*/
|
|
42317
|
-
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
41997
|
+
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
42318
41998
|
/**
|
|
42319
41999
|
* Fired before a parent node record toggles its collapsed state.
|
|
42320
42000
|
* @param {object} event Event object
|
|
@@ -42383,7 +42063,7 @@ type TreeGridConfig = {
|
|
|
42383
42063
|
* @param {Grid.column.Column} event.column Column
|
|
42384
42064
|
* @param {Core.data.Model} event.record Record
|
|
42385
42065
|
*/
|
|
42386
|
-
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
42066
|
+
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
42387
42067
|
/**
|
|
42388
42068
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
42389
42069
|
* @param {object} event Event object
|
|
@@ -42510,7 +42190,7 @@ type TreeGridConfig = {
|
|
|
42510
42190
|
* @param {Event} event.event The browser event.
|
|
42511
42191
|
* @param {string} event.region The region where the column was dropped.
|
|
42512
42192
|
*/
|
|
42513
|
-
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
42193
|
+
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
42514
42194
|
/**
|
|
42515
42195
|
* This event is fired after a resize gesture is completed.
|
|
42516
42196
|
* @param {object} event Event object
|
|
@@ -42650,7 +42330,7 @@ type TreeGridConfig = {
|
|
|
42650
42330
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
42651
42331
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
42652
42332
|
*/
|
|
42653
|
-
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
42333
|
+
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
42654
42334
|
/**
|
|
42655
42335
|
* Fires on the owning Grid when cell editing is finished
|
|
42656
42336
|
* @param {object} event Event object
|
|
@@ -42698,7 +42378,7 @@ type TreeGridConfig = {
|
|
|
42698
42378
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
42699
42379
|
* @param {MouseEvent,TouchEvent} event.event
|
|
42700
42380
|
*/
|
|
42701
|
-
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
42381
|
+
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
42702
42382
|
/**
|
|
42703
42383
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
42704
42384
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -42765,7 +42445,7 @@ type TreeGridConfig = {
|
|
|
42765
42445
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
42766
42446
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
42767
42447
|
*/
|
|
42768
|
-
onHeaderClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
42448
|
+
onHeaderClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
42769
42449
|
/**
|
|
42770
42450
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
42771
42451
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu#config-processItems).
|
|
@@ -42776,7 +42456,7 @@ type TreeGridConfig = {
|
|
|
42776
42456
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
42777
42457
|
* @param {Grid.column.Column} event.column Column
|
|
42778
42458
|
*/
|
|
42779
|
-
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
42459
|
+
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
42780
42460
|
/**
|
|
42781
42461
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
42782
42462
|
* @param {object} event Event object
|
|
@@ -42987,7 +42667,7 @@ type TreeGridConfig = {
|
|
|
42987
42667
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
42988
42668
|
* @param {Event} event.domEvent The native DOM event
|
|
42989
42669
|
*/
|
|
42990
|
-
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
42670
|
+
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
42991
42671
|
/**
|
|
42992
42672
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
42993
42673
|
* @param {object} event Event object
|
|
@@ -43012,7 +42692,7 @@ type TreeGridConfig = {
|
|
|
43012
42692
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
43013
42693
|
* @param {Event} event.domEvent The native DOM event
|
|
43014
42694
|
*/
|
|
43015
|
-
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
42695
|
+
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
43016
42696
|
/**
|
|
43017
42697
|
* Fires on the owning Grid when editing starts
|
|
43018
42698
|
* @param {object} event Event object
|
|
@@ -43122,19 +42802,19 @@ export class TreeGrid extends Grid {
|
|
|
43122
42802
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
43123
42803
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
43124
42804
|
*/
|
|
43125
|
-
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
42805
|
+
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
43126
42806
|
/**
|
|
43127
42807
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
43128
42808
|
* @param {object} event Event object
|
|
43129
42809
|
* @param {GridStateInfo} event.state State object config
|
|
43130
42810
|
*/
|
|
43131
|
-
onBeforeStateApply: ((event: { state: GridStateInfo }) =>
|
|
42811
|
+
onBeforeStateApply: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
43132
42812
|
/**
|
|
43133
42813
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
43134
42814
|
* @param {object} event Event object
|
|
43135
42815
|
* @param {GridStateInfo} event.state State object config
|
|
43136
42816
|
*/
|
|
43137
|
-
onBeforeStateSave: ((event: { state: GridStateInfo }) =>
|
|
42817
|
+
onBeforeStateSave: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
43138
42818
|
/**
|
|
43139
42819
|
* Fires when any other event is fired from the object.
|
|
43140
42820
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-catchAll)
|
|
@@ -43240,7 +42920,7 @@ export class TreeGrid extends Grid {
|
|
|
43240
42920
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
43241
42921
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
43242
42922
|
*/
|
|
43243
|
-
onHeaderClick: ((event: { domEvent: Event, column: Column }) =>
|
|
42923
|
+
onHeaderClick: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
43244
42924
|
/**
|
|
43245
42925
|
* Mouse moved out from element in grid
|
|
43246
42926
|
* @param {object} event Event object
|
|
@@ -43354,7 +43034,7 @@ type ExportDialogListenersTypes = {
|
|
|
43354
43034
|
* @param {object} event Event object
|
|
43355
43035
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
43356
43036
|
*/
|
|
43357
|
-
beforeHide: (event: { source: Widget }) =>
|
|
43037
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
43358
43038
|
/**
|
|
43359
43039
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
43360
43040
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -43374,13 +43054,13 @@ type ExportDialogListenersTypes = {
|
|
|
43374
43054
|
* @param {object} event Event object
|
|
43375
43055
|
* @param {any} event.state State object config
|
|
43376
43056
|
*/
|
|
43377
|
-
beforeStateApply: (event: { state: any }) =>
|
|
43057
|
+
beforeStateApply: (event: { state: any }) => boolean|void
|
|
43378
43058
|
/**
|
|
43379
43059
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
43380
43060
|
* @param {object} event Event object
|
|
43381
43061
|
* @param {any} event.state State object config
|
|
43382
43062
|
*/
|
|
43383
|
-
beforeStateSave: (event: { state: any }) =>
|
|
43063
|
+
beforeStateSave: (event: { state: any }) => boolean|void
|
|
43384
43064
|
/**
|
|
43385
43065
|
* Fires when cancel button is clicked. Popup will hide itself.
|
|
43386
43066
|
*/
|
|
@@ -43531,7 +43211,7 @@ type ExportDialogListeners = {
|
|
|
43531
43211
|
* @param {object} event Event object
|
|
43532
43212
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
43533
43213
|
*/
|
|
43534
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
43214
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
43535
43215
|
/**
|
|
43536
43216
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
43537
43217
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -43551,13 +43231,13 @@ type ExportDialogListeners = {
|
|
|
43551
43231
|
* @param {object} event Event object
|
|
43552
43232
|
* @param {any} event.state State object config
|
|
43553
43233
|
*/
|
|
43554
|
-
beforeStateApply?: ((event: { state: any }) =>
|
|
43234
|
+
beforeStateApply?: ((event: { state: any }) => boolean|void)|string
|
|
43555
43235
|
/**
|
|
43556
43236
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
43557
43237
|
* @param {object} event Event object
|
|
43558
43238
|
* @param {any} event.state State object config
|
|
43559
43239
|
*/
|
|
43560
|
-
beforeStateSave?: ((event: { state: any }) =>
|
|
43240
|
+
beforeStateSave?: ((event: { state: any }) => boolean|void)|string
|
|
43561
43241
|
/**
|
|
43562
43242
|
* Fires when cancel button is clicked. Popup will hide itself.
|
|
43563
43243
|
*/
|
|
@@ -44423,7 +44103,7 @@ type ExportDialogConfig = {
|
|
|
44423
44103
|
* @param {object} event Event object
|
|
44424
44104
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
44425
44105
|
*/
|
|
44426
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
44106
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
44427
44107
|
/**
|
|
44428
44108
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
44429
44109
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -44443,13 +44123,13 @@ type ExportDialogConfig = {
|
|
|
44443
44123
|
* @param {object} event Event object
|
|
44444
44124
|
* @param {any} event.state State object config
|
|
44445
44125
|
*/
|
|
44446
|
-
onBeforeStateApply?: ((event: { state: any }) =>
|
|
44126
|
+
onBeforeStateApply?: ((event: { state: any }) => boolean|void)|string
|
|
44447
44127
|
/**
|
|
44448
44128
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
44449
44129
|
* @param {object} event Event object
|
|
44450
44130
|
* @param {any} event.state State object config
|
|
44451
44131
|
*/
|
|
44452
|
-
onBeforeStateSave?: ((event: { state: any }) =>
|
|
44132
|
+
onBeforeStateSave?: ((event: { state: any }) => boolean|void)|string
|
|
44453
44133
|
/**
|
|
44454
44134
|
* Fires when cancel button is clicked. Popup will hide itself.
|
|
44455
44135
|
*/
|
|
@@ -44608,13 +44288,13 @@ export class ExportDialog extends Popup {
|
|
|
44608
44288
|
* @param {object} event Event object
|
|
44609
44289
|
* @param {any} event.state State object config
|
|
44610
44290
|
*/
|
|
44611
|
-
onBeforeStateApply: ((event: { state: any }) =>
|
|
44291
|
+
onBeforeStateApply: ((event: { state: any }) => boolean|void)|string
|
|
44612
44292
|
/**
|
|
44613
44293
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
44614
44294
|
* @param {object} event Event object
|
|
44615
44295
|
* @param {any} event.state State object config
|
|
44616
44296
|
*/
|
|
44617
|
-
onBeforeStateSave: ((event: { state: any }) =>
|
|
44297
|
+
onBeforeStateSave: ((event: { state: any }) => boolean|void)|string
|
|
44618
44298
|
/**
|
|
44619
44299
|
* Fires when cancel button is clicked. Popup will hide itself.
|
|
44620
44300
|
*/
|
|
@@ -44745,7 +44425,7 @@ type GridElementEventsClassConfig = {
|
|
|
44745
44425
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
44746
44426
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
44747
44427
|
*/
|
|
44748
|
-
onHeaderClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
44428
|
+
onHeaderClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
44749
44429
|
/**
|
|
44750
44430
|
* Mouse moved out from element in grid
|
|
44751
44431
|
* @param {object} event Event object
|
|
@@ -44883,7 +44563,7 @@ export class GridElementEventsClass {
|
|
|
44883
44563
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
44884
44564
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
44885
44565
|
*/
|
|
44886
|
-
onHeaderClick: ((event: { domEvent: Event, column: Column }) =>
|
|
44566
|
+
onHeaderClick: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
44887
44567
|
/**
|
|
44888
44568
|
* Mouse moved out from element in grid
|
|
44889
44569
|
* @param {object} event Event object
|
|
@@ -45039,7 +44719,7 @@ type GridSelectionClassConfig = {
|
|
|
45039
44719
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
45040
44720
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
45041
44721
|
*/
|
|
45042
|
-
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
44722
|
+
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
45043
44723
|
/**
|
|
45044
44724
|
* Fires while drag selecting. UI will update with current range, but the cells will not be selected until
|
|
45045
44725
|
* mouse up. This event can be listened for to perform actions while drag selecting.
|
|
@@ -45125,7 +44805,7 @@ export class GridSelectionClass {
|
|
|
45125
44805
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
45126
44806
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
45127
44807
|
*/
|
|
45128
|
-
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
44808
|
+
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
45129
44809
|
/**
|
|
45130
44810
|
* Fires while drag selecting. UI will update with current range, but the cells will not be selected until
|
|
45131
44811
|
* mouse up. This event can be listened for to perform actions while drag selecting.
|
|
@@ -45283,13 +44963,13 @@ type GridStateClassConfig = {
|
|
|
45283
44963
|
* @param {object} event Event object
|
|
45284
44964
|
* @param {GridStateInfo} event.state State object config
|
|
45285
44965
|
*/
|
|
45286
|
-
onBeforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
44966
|
+
onBeforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
45287
44967
|
/**
|
|
45288
44968
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
45289
44969
|
* @param {object} event Event object
|
|
45290
44970
|
* @param {GridStateInfo} event.state State object config
|
|
45291
44971
|
*/
|
|
45292
|
-
onBeforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
44972
|
+
onBeforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
45293
44973
|
}
|
|
45294
44974
|
|
|
45295
44975
|
export class GridStateClass {
|
|
@@ -45316,13 +44996,13 @@ export class GridStateClass {
|
|
|
45316
44996
|
* @param {object} event Event object
|
|
45317
44997
|
* @param {GridStateInfo} event.state State object config
|
|
45318
44998
|
*/
|
|
45319
|
-
onBeforeStateApply: ((event: { state: GridStateInfo }) =>
|
|
44999
|
+
onBeforeStateApply: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
45320
45000
|
/**
|
|
45321
45001
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
45322
45002
|
* @param {object} event Event object
|
|
45323
45003
|
* @param {GridStateInfo} event.state State object config
|
|
45324
45004
|
*/
|
|
45325
|
-
onBeforeStateSave: ((event: { state: GridStateInfo }) =>
|
|
45005
|
+
onBeforeStateSave: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
45326
45006
|
/**
|
|
45327
45007
|
* Creates an instance of the class using the supplied configuration
|
|
45328
45008
|
* @param {GridStateClassConfig} [config]
|
|
@@ -45389,7 +45069,7 @@ type AIFilterFieldListenersTypes = {
|
|
|
45389
45069
|
* @param {object} event Event object
|
|
45390
45070
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
45391
45071
|
*/
|
|
45392
|
-
beforeHide: (event: { source: Widget }) =>
|
|
45072
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
45393
45073
|
/**
|
|
45394
45074
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
45395
45075
|
* @param {object} event Event object
|
|
@@ -45551,7 +45231,7 @@ type AIFilterFieldListeners = {
|
|
|
45551
45231
|
* @param {object} event Event object
|
|
45552
45232
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
45553
45233
|
*/
|
|
45554
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
45234
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
45555
45235
|
/**
|
|
45556
45236
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
45557
45237
|
* @param {object} event Event object
|
|
@@ -45759,6 +45439,15 @@ type AIFilterFieldConfig = {
|
|
|
45759
45439
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
45760
45440
|
*/
|
|
45761
45441
|
centered?: boolean
|
|
45442
|
+
/**
|
|
45443
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
45444
|
+
* 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)
|
|
45445
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
45446
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-checkValidity)
|
|
45447
|
+
* @param {Core.widget.Field} field The field being validated
|
|
45448
|
+
* @returns {void}
|
|
45449
|
+
*/
|
|
45450
|
+
checkValidity?: ((field: Field) => void)|string
|
|
45762
45451
|
/**
|
|
45763
45452
|
* 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
|
|
45764
45453
|
* 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
|
|
@@ -46313,7 +46002,7 @@ type AIFilterFieldConfig = {
|
|
|
46313
46002
|
* @param {object} event Event object
|
|
46314
46003
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
46315
46004
|
*/
|
|
46316
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
46005
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
46317
46006
|
/**
|
|
46318
46007
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
46319
46008
|
* @param {object} event Event object
|
|
@@ -46510,7 +46199,7 @@ type ChecklistFilterComboListenersTypes = {
|
|
|
46510
46199
|
* @param {object} event Event object
|
|
46511
46200
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
46512
46201
|
*/
|
|
46513
|
-
beforeHide: (event: { source: Widget }) =>
|
|
46202
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
46514
46203
|
/**
|
|
46515
46204
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
46516
46205
|
* @param {object} event Event object
|
|
@@ -46678,7 +46367,7 @@ type ChecklistFilterComboListeners = {
|
|
|
46678
46367
|
* @param {object} event Event object
|
|
46679
46368
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
46680
46369
|
*/
|
|
46681
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
46370
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
46682
46371
|
/**
|
|
46683
46372
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
46684
46373
|
* @param {object} event Event object
|
|
@@ -46909,6 +46598,15 @@ type ChecklistFilterComboConfig = {
|
|
|
46909
46598
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
46910
46599
|
*/
|
|
46911
46600
|
centered?: boolean
|
|
46601
|
+
/**
|
|
46602
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
46603
|
+
* 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)
|
|
46604
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
46605
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-checkValidity)
|
|
46606
|
+
* @param {Core.widget.Field} field The field being validated
|
|
46607
|
+
* @returns {void}
|
|
46608
|
+
*/
|
|
46609
|
+
checkValidity?: ((field: Field) => void)|string
|
|
46912
46610
|
/**
|
|
46913
46611
|
* A config object to configure the [ChipView](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView) to display the
|
|
46914
46612
|
* selected value set when [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
|
|
@@ -47632,7 +47330,7 @@ type ChecklistFilterComboConfig = {
|
|
|
47632
47330
|
* @param {object} event Event object
|
|
47633
47331
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
47634
47332
|
*/
|
|
47635
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
47333
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
47636
47334
|
/**
|
|
47637
47335
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
47638
47336
|
* @param {object} event Event object
|
|
@@ -47841,7 +47539,7 @@ type GridChartDesignerListenersTypes = {
|
|
|
47841
47539
|
* @param {object} event Event object
|
|
47842
47540
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
47843
47541
|
*/
|
|
47844
|
-
beforeHide: (event: { source: Widget }) =>
|
|
47542
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
47845
47543
|
/**
|
|
47846
47544
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
47847
47545
|
* @param {object} event Event object
|
|
@@ -47955,7 +47653,7 @@ type GridChartDesignerListeners = {
|
|
|
47955
47653
|
* @param {object} event Event object
|
|
47956
47654
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
47957
47655
|
*/
|
|
47958
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
47656
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
47959
47657
|
/**
|
|
47960
47658
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
47961
47659
|
* @param {object} event Event object
|
|
@@ -48497,7 +48195,7 @@ type GridChartDesignerConfig = {
|
|
|
48497
48195
|
* @param {object} event Event object
|
|
48498
48196
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
48499
48197
|
*/
|
|
48500
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
48198
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
48501
48199
|
/**
|
|
48502
48200
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
48503
48201
|
* @param {object} event Event object
|
|
@@ -48649,7 +48347,7 @@ type GridFieldFilterPickerListenersTypes = {
|
|
|
48649
48347
|
* @param {object} event Event object
|
|
48650
48348
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
48651
48349
|
*/
|
|
48652
|
-
beforeHide: (event: { source: Widget }) =>
|
|
48350
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
48653
48351
|
/**
|
|
48654
48352
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
48655
48353
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -48786,7 +48484,7 @@ type GridFieldFilterPickerListeners = {
|
|
|
48786
48484
|
* @param {object} event Event object
|
|
48787
48485
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
48788
48486
|
*/
|
|
48789
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
48487
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
48790
48488
|
/**
|
|
48791
48489
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
48792
48490
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -49513,7 +49211,7 @@ type GridFieldFilterPickerConfig = {
|
|
|
49513
49211
|
* @param {object} event Event object
|
|
49514
49212
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
49515
49213
|
*/
|
|
49516
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
49214
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
49517
49215
|
/**
|
|
49518
49216
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
49519
49217
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -49685,7 +49383,7 @@ type GridFieldFilterPickerGroupListenersTypes = {
|
|
|
49685
49383
|
* @param {Core.widget.FieldFilterPicker} event.source The FieldFilterPicker instance that fired the event.
|
|
49686
49384
|
* @param {CollectionFilterConfig} event.filter The [CollectionFilter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) configuration object for the filter represented by this [FieldFilterPicker](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPicker).
|
|
49687
49385
|
*/
|
|
49688
|
-
beforeAddFilter: (event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) =>
|
|
49386
|
+
beforeAddFilter: (event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) => boolean|void
|
|
49689
49387
|
/**
|
|
49690
49388
|
* Fires before an object is destroyed.
|
|
49691
49389
|
* @param {object} event Event object
|
|
@@ -49697,7 +49395,7 @@ type GridFieldFilterPickerGroupListenersTypes = {
|
|
|
49697
49395
|
* @param {object} event Event object
|
|
49698
49396
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
49699
49397
|
*/
|
|
49700
|
-
beforeHide: (event: { source: Widget }) =>
|
|
49398
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
49701
49399
|
/**
|
|
49702
49400
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
49703
49401
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -49830,7 +49528,7 @@ type GridFieldFilterPickerGroupListeners = {
|
|
|
49830
49528
|
* @param {Core.widget.FieldFilterPicker} event.source The FieldFilterPicker instance that fired the event.
|
|
49831
49529
|
* @param {CollectionFilterConfig} event.filter The [CollectionFilter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) configuration object for the filter represented by this [FieldFilterPicker](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPicker).
|
|
49832
49530
|
*/
|
|
49833
|
-
beforeAddFilter?: ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) =>
|
|
49531
|
+
beforeAddFilter?: ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) => boolean|void)|string
|
|
49834
49532
|
/**
|
|
49835
49533
|
* Fires before an object is destroyed.
|
|
49836
49534
|
* @param {object} event Event object
|
|
@@ -49842,7 +49540,7 @@ type GridFieldFilterPickerGroupListeners = {
|
|
|
49842
49540
|
* @param {object} event Event object
|
|
49843
49541
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
49844
49542
|
*/
|
|
49845
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
49543
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
49846
49544
|
/**
|
|
49847
49545
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
49848
49546
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -50571,7 +50269,7 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
50571
50269
|
* @param {Core.widget.FieldFilterPicker} event.source The FieldFilterPicker instance that fired the event.
|
|
50572
50270
|
* @param {CollectionFilterConfig} event.filter The [CollectionFilter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) configuration object for the filter represented by this [FieldFilterPicker](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPicker).
|
|
50573
50271
|
*/
|
|
50574
|
-
onBeforeAddFilter?: ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) =>
|
|
50272
|
+
onBeforeAddFilter?: ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) => boolean|void)|string
|
|
50575
50273
|
/**
|
|
50576
50274
|
* Fires before an object is destroyed.
|
|
50577
50275
|
* @param {object} event Event object
|
|
@@ -50583,7 +50281,7 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
50583
50281
|
* @param {object} event Event object
|
|
50584
50282
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
50585
50283
|
*/
|
|
50586
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
50284
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
50587
50285
|
/**
|
|
50588
50286
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
50589
50287
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -50759,7 +50457,7 @@ type GroupBarListenersTypes = {
|
|
|
50759
50457
|
* @param {object} event Event object
|
|
50760
50458
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
50761
50459
|
*/
|
|
50762
|
-
beforeHide: (event: { source: Widget }) =>
|
|
50460
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
50763
50461
|
/**
|
|
50764
50462
|
* User going to activate an item in the list either by pointer or keyboard.
|
|
50765
50463
|
* The active record, list item index, and the triggering event are passed.
|
|
@@ -50771,7 +50469,7 @@ type GroupBarListenersTypes = {
|
|
|
50771
50469
|
* @param {number} event.index List item index
|
|
50772
50470
|
* @param {Event} event.event Triggering event
|
|
50773
50471
|
*/
|
|
50774
|
-
beforeItem: (event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) =>
|
|
50472
|
+
beforeItem: (event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void
|
|
50775
50473
|
/**
|
|
50776
50474
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
50777
50475
|
* @param {object} event Event object
|
|
@@ -50917,7 +50615,7 @@ type GroupBarListeners = {
|
|
|
50917
50615
|
* @param {object} event Event object
|
|
50918
50616
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
50919
50617
|
*/
|
|
50920
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
50618
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
50921
50619
|
/**
|
|
50922
50620
|
* User going to activate an item in the list either by pointer or keyboard.
|
|
50923
50621
|
* The active record, list item index, and the triggering event are passed.
|
|
@@ -50929,7 +50627,7 @@ type GroupBarListeners = {
|
|
|
50929
50627
|
* @param {number} event.index List item index
|
|
50930
50628
|
* @param {Event} event.event Triggering event
|
|
50931
50629
|
*/
|
|
50932
|
-
beforeItem?: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) =>
|
|
50630
|
+
beforeItem?: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void)|string
|
|
50933
50631
|
/**
|
|
50934
50632
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
50935
50633
|
* @param {object} event Event object
|
|
@@ -51616,7 +51314,7 @@ type GroupBarConfig = {
|
|
|
51616
51314
|
* @param {object} event Event object
|
|
51617
51315
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
51618
51316
|
*/
|
|
51619
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
51317
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
51620
51318
|
/**
|
|
51621
51319
|
* User going to activate an item in the list either by pointer or keyboard.
|
|
51622
51320
|
* The active record, list item index, and the triggering event are passed.
|
|
@@ -51628,7 +51326,7 @@ type GroupBarConfig = {
|
|
|
51628
51326
|
* @param {number} event.index List item index
|
|
51629
51327
|
* @param {Event} event.event Triggering event
|
|
51630
51328
|
*/
|
|
51631
|
-
onBeforeItem?: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) =>
|
|
51329
|
+
onBeforeItem?: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void)|string
|
|
51632
51330
|
/**
|
|
51633
51331
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
51634
51332
|
* @param {object} event Event object
|
|
@@ -51818,7 +51516,7 @@ type TreeComboListenersTypes = {
|
|
|
51818
51516
|
* @param {object} event Event object
|
|
51819
51517
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
51820
51518
|
*/
|
|
51821
|
-
beforeHide: (event: { source: Widget }) =>
|
|
51519
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
51822
51520
|
/**
|
|
51823
51521
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
51824
51522
|
* @param {object} event Event object
|
|
@@ -51986,7 +51684,7 @@ type TreeComboListeners = {
|
|
|
51986
51684
|
* @param {object} event Event object
|
|
51987
51685
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
51988
51686
|
*/
|
|
51989
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
51687
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
51990
51688
|
/**
|
|
51991
51689
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
51992
51690
|
* @param {object} event Event object
|
|
@@ -52217,6 +51915,15 @@ type TreeComboConfig = {
|
|
|
52217
51915
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
52218
51916
|
*/
|
|
52219
51917
|
centered?: boolean
|
|
51918
|
+
/**
|
|
51919
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
51920
|
+
* 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)
|
|
51921
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
51922
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-checkValidity)
|
|
51923
|
+
* @param {Core.widget.Field} field The field being validated
|
|
51924
|
+
* @returns {void}
|
|
51925
|
+
*/
|
|
51926
|
+
checkValidity?: ((field: Field) => void)|string
|
|
52220
51927
|
/**
|
|
52221
51928
|
* A config object to configure the [ChipView](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView) to display the
|
|
52222
51929
|
* selected value set when [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
|
|
@@ -52931,7 +52638,7 @@ type TreeComboConfig = {
|
|
|
52931
52638
|
* @param {object} event Event object
|
|
52932
52639
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
52933
52640
|
*/
|
|
52934
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
52641
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
52935
52642
|
/**
|
|
52936
52643
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
52937
52644
|
* @param {object} event Event object
|