@bryntum/grid-trial 7.3.0 → 7.3.2
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 +1660 -1216
- 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 +440 -658
- package/grid.umd.d.ts +0 -323
- package/grid.umd.js +47 -370
- package/grid.wc.module.d.ts +0 -323
- package/high-contrast-dark.css +2 -325
- package/high-contrast-light.css +2 -325
- package/locales/grid.locale.Ar.js +1 -1
- package/locales/grid.locale.Bg.js +1 -1
- package/locales/grid.locale.Ca.js +1 -1
- package/locales/grid.locale.Cs.js +1 -1
- package/locales/grid.locale.Da.js +1 -1
- package/locales/grid.locale.De.js +1 -1
- package/locales/grid.locale.El.js +1 -1
- package/locales/grid.locale.En.js +1 -1
- package/locales/grid.locale.EnGb.js +1 -1
- package/locales/grid.locale.Es.js +1 -1
- package/locales/grid.locale.Et.js +1 -1
- package/locales/grid.locale.Eu.js +1 -1
- package/locales/grid.locale.Fi.js +1 -1
- package/locales/grid.locale.FrFr.js +1 -1
- package/locales/grid.locale.Gl.js +1 -1
- package/locales/grid.locale.He.js +1 -1
- package/locales/grid.locale.Hi.js +1 -1
- package/locales/grid.locale.Hr.js +1 -1
- package/locales/grid.locale.Hu.js +1 -1
- package/locales/grid.locale.Id.js +1 -1
- package/locales/grid.locale.It.js +1 -1
- package/locales/grid.locale.Ja.js +1 -1
- package/locales/grid.locale.Kk.js +1 -1
- package/locales/grid.locale.Ko.js +1 -1
- package/locales/grid.locale.Lt.js +1 -1
- package/locales/grid.locale.Lv.js +1 -1
- package/locales/grid.locale.Ms.js +1 -1
- package/locales/grid.locale.Nl.js +1 -1
- package/locales/grid.locale.No.js +1 -1
- package/locales/grid.locale.Pl.js +1 -1
- package/locales/grid.locale.Pt.js +1 -1
- package/locales/grid.locale.PtBr.js +1 -1
- package/locales/grid.locale.Ro.js +1 -1
- package/locales/grid.locale.Ru.js +1 -1
- package/locales/grid.locale.Sk.js +1 -1
- package/locales/grid.locale.Sl.js +1 -1
- package/locales/grid.locale.Sr.js +1 -1
- package/locales/grid.locale.SrRs.js +1 -1
- package/locales/grid.locale.SvSE.js +1 -1
- package/locales/grid.locale.Th.js +1 -1
- package/locales/grid.locale.Tr.js +1 -1
- package/locales/grid.locale.Uk.js +1 -1
- package/locales/grid.locale.Vi.js +1 -1
- package/locales/grid.locale.ZhCn.js +1 -1
- package/locales/grid.locale.ZhTw.js +1 -1
- package/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
|
|
@@ -16353,6 +16031,8 @@ type CellTooltipConfig = {
|
|
|
16353
16031
|
/**
|
|
16354
16032
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
16355
16033
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
16034
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
16035
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-appendTo)
|
|
16356
16036
|
*/
|
|
16357
16037
|
appendTo?: HTMLElement|string
|
|
16358
16038
|
/**
|
|
@@ -16614,10 +16294,11 @@ type CellTooltipConfig = {
|
|
|
16614
16294
|
* @param {Core.widget.Tooltip} context.tip The tooltip instance
|
|
16615
16295
|
* @param {HTMLElement} context.element The Element for which the Tooltip is monitoring mouse movement
|
|
16616
16296
|
* @param {HTMLElement} context.activeTarget The target element that triggered the show
|
|
16297
|
+
* @param {HTMLElement} [context.forElement] Alias for `activeTarget`, provided for backward compatibility
|
|
16617
16298
|
* @param {Event} context.event The raw DOM event
|
|
16618
16299
|
* @returns {string,Promise<any>}
|
|
16619
16300
|
*/
|
|
16620
|
-
getHtml?: ((context: { tip: Tooltip, element: HTMLElement, activeTarget: HTMLElement, event: Event }) => Promise<string|Promise<any>>)|string
|
|
16301
|
+
getHtml?: ((context: { tip: Tooltip, element: HTMLElement, activeTarget: HTMLElement, forElement?: HTMLElement, event: Event }) => Promise<string|Promise<any>>)|string
|
|
16621
16302
|
/**
|
|
16622
16303
|
* A config [object](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
|
|
16623
16304
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-header)
|
|
@@ -16693,10 +16374,14 @@ type CellTooltipConfig = {
|
|
|
16693
16374
|
inputFieldAlign?: 'start'|'end'
|
|
16694
16375
|
/**
|
|
16695
16376
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
16377
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
16378
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-insertBefore)
|
|
16696
16379
|
*/
|
|
16697
16380
|
insertBefore?: HTMLElement|string
|
|
16698
16381
|
/**
|
|
16699
16382
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
16383
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
16384
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip#config-insertFirst)
|
|
16700
16385
|
*/
|
|
16701
16386
|
insertFirst?: HTMLElement|string
|
|
16702
16387
|
/**
|
|
@@ -22668,13 +22353,15 @@ type RowReorderConfig = {
|
|
|
22668
22353
|
* data (e.g. to copy instead of move), you can provide an object with a `transferData` method.
|
|
22669
22354
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowReorder#config-allowCrossGridDrag)
|
|
22670
22355
|
* @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.
|
|
22356
|
+
* @property {object} allowCrossGridDrag.transferData.data Context object describing the drag drop state.
|
|
22357
|
+
* @property {Grid.view.GridBase} allowCrossGridDrag.transferData.data.sourceGrid The source grid
|
|
22358
|
+
* @property {Grid.view.GridBase} allowCrossGridDrag.transferData.data.targetGrid the target grid
|
|
22359
|
+
* @property {Core.data.Model[]} allowCrossGridDrag.transferData.data.records The dragged records
|
|
22360
|
+
* @property {Core.data.Model} allowCrossGridDrag.transferData.data.insertBefore The record to insert before
|
|
22361
|
+
* @property {Core.data.Model} allowCrossGridDrag.transferData.data.parent The parent record of the current drop position (only applicable for trees)
|
|
22362
|
+
* @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
22363
|
*/
|
|
22677
|
-
allowCrossGridDrag?: boolean|{ transferData: (sourceGrid: GridBase, targetGrid: GridBase, records: Model[], insertBefore: Model, parent: Model) => void }
|
|
22364
|
+
allowCrossGridDrag?: boolean|{ transferData: (data: { sourceGrid: GridBase, targetGrid: GridBase, records: Model[], insertBefore: Model, parent: Model }) => Promise<any>|void }
|
|
22678
22365
|
/**
|
|
22679
22366
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
22680
22367
|
* hierarchy when triggered.
|
|
@@ -28734,14 +28421,14 @@ type GridListenersTypes = {
|
|
|
28734
28421
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
28735
28422
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
28736
28423
|
*/
|
|
28737
|
-
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
28424
|
+
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void
|
|
28738
28425
|
/**
|
|
28739
28426
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
28740
28427
|
* @param {object} event Event object
|
|
28741
28428
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
28742
28429
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
28743
28430
|
*/
|
|
28744
|
-
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) =>
|
|
28431
|
+
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) => boolean|void
|
|
28745
28432
|
/**
|
|
28746
28433
|
* 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
28434
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-beforeCancelRowEdit)
|
|
@@ -28756,7 +28443,7 @@ type GridListenersTypes = {
|
|
|
28756
28443
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
28757
28444
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
28758
28445
|
*/
|
|
28759
|
-
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
28446
|
+
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => boolean|void
|
|
28760
28447
|
/**
|
|
28761
28448
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
28762
28449
|
* 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 +28451,7 @@ type GridListenersTypes = {
|
|
|
28764
28451
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
28765
28452
|
* @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
28453
|
*/
|
|
28767
|
-
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
28454
|
+
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void
|
|
28768
28455
|
/**
|
|
28769
28456
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
28770
28457
|
* @param {object} event Event object
|
|
@@ -28772,7 +28459,7 @@ type GridListenersTypes = {
|
|
|
28772
28459
|
* @param {string} event.field The field being changed
|
|
28773
28460
|
* @param {any} event.value The value being set
|
|
28774
28461
|
*/
|
|
28775
|
-
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) =>
|
|
28462
|
+
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => boolean|void
|
|
28776
28463
|
/**
|
|
28777
28464
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
28778
28465
|
* @param {object} event Event object
|
|
@@ -28788,7 +28475,7 @@ type GridListenersTypes = {
|
|
|
28788
28475
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
28789
28476
|
* @param {Event} event.event The browser event.
|
|
28790
28477
|
*/
|
|
28791
|
-
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) =>
|
|
28478
|
+
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) => boolean|void
|
|
28792
28479
|
/**
|
|
28793
28480
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
28794
28481
|
* @param {object} event Event object
|
|
@@ -28799,7 +28486,7 @@ type GridListenersTypes = {
|
|
|
28799
28486
|
* @param {Event} event.event The browser event.
|
|
28800
28487
|
* @param {string} event.region The region where the column was dropped.
|
|
28801
28488
|
*/
|
|
28802
|
-
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
28489
|
+
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void
|
|
28803
28490
|
/**
|
|
28804
28491
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
28805
28492
|
* `false`.
|
|
@@ -28808,7 +28495,7 @@ type GridListenersTypes = {
|
|
|
28808
28495
|
* @param {Grid.column.Column} event.column The column
|
|
28809
28496
|
* @param {Event} event.domEvent The browser event
|
|
28810
28497
|
*/
|
|
28811
|
-
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
28498
|
+
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) => boolean|void
|
|
28812
28499
|
/**
|
|
28813
28500
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
28814
28501
|
* @param {object} event Event object
|
|
@@ -28832,14 +28519,14 @@ type GridListenersTypes = {
|
|
|
28832
28519
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
28833
28520
|
* @param {any[][]} event.rows An array of records to export
|
|
28834
28521
|
*/
|
|
28835
|
-
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
28522
|
+
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void
|
|
28836
28523
|
/**
|
|
28837
28524
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
28838
28525
|
* @param {object} event Event object
|
|
28839
28526
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
28840
28527
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
28841
28528
|
*/
|
|
28842
|
-
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
28529
|
+
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
28843
28530
|
/**
|
|
28844
28531
|
* 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
28532
|
* @param {object} event Event object
|
|
@@ -28860,7 +28547,7 @@ type GridListenersTypes = {
|
|
|
28860
28547
|
* @param {object} event Event object
|
|
28861
28548
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
28862
28549
|
*/
|
|
28863
|
-
beforeHide: (event: { source: Widget }) =>
|
|
28550
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
28864
28551
|
/**
|
|
28865
28552
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
28866
28553
|
* @param {object} event Event object
|
|
@@ -28876,7 +28563,7 @@ type GridListenersTypes = {
|
|
|
28876
28563
|
* @param {object} event Event object
|
|
28877
28564
|
* @param {PdfExportConfig} event.config Export config
|
|
28878
28565
|
*/
|
|
28879
|
-
beforePdfExport: (event: { config: PdfExportConfig }) =>
|
|
28566
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => boolean|void
|
|
28880
28567
|
/**
|
|
28881
28568
|
* Fires before a row is rendered.
|
|
28882
28569
|
* @param {object} event Event object
|
|
@@ -28919,7 +28606,7 @@ type GridListenersTypes = {
|
|
|
28919
28606
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
28920
28607
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
28921
28608
|
*/
|
|
28922
|
-
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
28609
|
+
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void
|
|
28923
28610
|
/**
|
|
28924
28611
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
28925
28612
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -28940,19 +28627,19 @@ type GridListenersTypes = {
|
|
|
28940
28627
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
28941
28628
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
28942
28629
|
*/
|
|
28943
|
-
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
28630
|
+
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) => boolean|void
|
|
28944
28631
|
/**
|
|
28945
28632
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
28946
28633
|
* @param {object} event Event object
|
|
28947
28634
|
* @param {GridStateInfo} event.state State object config
|
|
28948
28635
|
*/
|
|
28949
|
-
beforeStateApply: (event: { state: GridStateInfo }) =>
|
|
28636
|
+
beforeStateApply: (event: { state: GridStateInfo }) => boolean|void
|
|
28950
28637
|
/**
|
|
28951
28638
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
28952
28639
|
* @param {object} event Event object
|
|
28953
28640
|
* @param {GridStateInfo} event.state State object config
|
|
28954
28641
|
*/
|
|
28955
|
-
beforeStateSave: (event: { state: GridStateInfo }) =>
|
|
28642
|
+
beforeStateSave: (event: { state: GridStateInfo }) => boolean|void
|
|
28956
28643
|
/**
|
|
28957
28644
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
28958
28645
|
* Returning `false` from a listener prevents the operation
|
|
@@ -28962,7 +28649,7 @@ type GridListenersTypes = {
|
|
|
28962
28649
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
28963
28650
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
28964
28651
|
*/
|
|
28965
|
-
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
28652
|
+
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void
|
|
28966
28653
|
/**
|
|
28967
28654
|
* Fired before a parent node record toggles its collapsed state.
|
|
28968
28655
|
* @param {object} event Event object
|
|
@@ -29031,7 +28718,7 @@ type GridListenersTypes = {
|
|
|
29031
28718
|
* @param {Grid.column.Column} event.column Column
|
|
29032
28719
|
* @param {Core.data.Model} event.record Record
|
|
29033
28720
|
*/
|
|
29034
|
-
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
28721
|
+
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void
|
|
29035
28722
|
/**
|
|
29036
28723
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
29037
28724
|
* @param {object} event Event object
|
|
@@ -29158,7 +28845,7 @@ type GridListenersTypes = {
|
|
|
29158
28845
|
* @param {Event} event.event The browser event.
|
|
29159
28846
|
* @param {string} event.region The region where the column was dropped.
|
|
29160
28847
|
*/
|
|
29161
|
-
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
28848
|
+
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void
|
|
29162
28849
|
/**
|
|
29163
28850
|
* This event is fired after a resize gesture is completed.
|
|
29164
28851
|
* @param {object} event Event object
|
|
@@ -29298,7 +28985,7 @@ type GridListenersTypes = {
|
|
|
29298
28985
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
29299
28986
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
29300
28987
|
*/
|
|
29301
|
-
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
28988
|
+
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
29302
28989
|
/**
|
|
29303
28990
|
* Fires on the owning Grid when cell editing is finished
|
|
29304
28991
|
* @param {object} event Event object
|
|
@@ -29346,7 +29033,7 @@ type GridListenersTypes = {
|
|
|
29346
29033
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
29347
29034
|
* @param {MouseEvent,TouchEvent} event.event
|
|
29348
29035
|
*/
|
|
29349
|
-
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
29036
|
+
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void
|
|
29350
29037
|
/**
|
|
29351
29038
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
29352
29039
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -29413,7 +29100,7 @@ type GridListenersTypes = {
|
|
|
29413
29100
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
29414
29101
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
29415
29102
|
*/
|
|
29416
|
-
headerClick: (event: { domEvent: Event, column: Column }) =>
|
|
29103
|
+
headerClick: (event: { domEvent: Event, column: Column }) => boolean|void
|
|
29417
29104
|
/**
|
|
29418
29105
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
29419
29106
|
* 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 +29111,7 @@ type GridListenersTypes = {
|
|
|
29424
29111
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
29425
29112
|
* @param {Grid.column.Column} event.column Column
|
|
29426
29113
|
*/
|
|
29427
|
-
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
29114
|
+
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void
|
|
29428
29115
|
/**
|
|
29429
29116
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
29430
29117
|
* @param {object} event Event object
|
|
@@ -29635,7 +29322,7 @@ type GridListenersTypes = {
|
|
|
29635
29322
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
29636
29323
|
* @param {Event} event.domEvent The native DOM event
|
|
29637
29324
|
*/
|
|
29638
|
-
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
29325
|
+
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
29639
29326
|
/**
|
|
29640
29327
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
29641
29328
|
* @param {object} event Event object
|
|
@@ -29660,7 +29347,7 @@ type GridListenersTypes = {
|
|
|
29660
29347
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
29661
29348
|
* @param {Event} event.domEvent The native DOM event
|
|
29662
29349
|
*/
|
|
29663
|
-
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
29350
|
+
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
29664
29351
|
/**
|
|
29665
29352
|
* Fires on the owning Grid when editing starts
|
|
29666
29353
|
* @param {object} event Event object
|
|
@@ -29749,14 +29436,14 @@ type GridListeners = {
|
|
|
29749
29436
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
29750
29437
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
29751
29438
|
*/
|
|
29752
|
-
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
29439
|
+
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
29753
29440
|
/**
|
|
29754
29441
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
29755
29442
|
* @param {object} event Event object
|
|
29756
29443
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
29757
29444
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
29758
29445
|
*/
|
|
29759
|
-
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
29446
|
+
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
29760
29447
|
/**
|
|
29761
29448
|
* 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
29449
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-beforeCancelRowEdit)
|
|
@@ -29771,7 +29458,7 @@ type GridListeners = {
|
|
|
29771
29458
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
29772
29459
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
29773
29460
|
*/
|
|
29774
|
-
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
29461
|
+
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
29775
29462
|
/**
|
|
29776
29463
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
29777
29464
|
* 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 +29466,7 @@ type GridListeners = {
|
|
|
29779
29466
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
29780
29467
|
* @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
29468
|
*/
|
|
29782
|
-
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
29469
|
+
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
29783
29470
|
/**
|
|
29784
29471
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
29785
29472
|
* @param {object} event Event object
|
|
@@ -29787,7 +29474,7 @@ type GridListeners = {
|
|
|
29787
29474
|
* @param {string} event.field The field being changed
|
|
29788
29475
|
* @param {any} event.value The value being set
|
|
29789
29476
|
*/
|
|
29790
|
-
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
29477
|
+
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
29791
29478
|
/**
|
|
29792
29479
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
29793
29480
|
* @param {object} event Event object
|
|
@@ -29803,7 +29490,7 @@ type GridListeners = {
|
|
|
29803
29490
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
29804
29491
|
* @param {Event} event.event The browser event.
|
|
29805
29492
|
*/
|
|
29806
|
-
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
29493
|
+
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
29807
29494
|
/**
|
|
29808
29495
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
29809
29496
|
* @param {object} event Event object
|
|
@@ -29814,7 +29501,7 @@ type GridListeners = {
|
|
|
29814
29501
|
* @param {Event} event.event The browser event.
|
|
29815
29502
|
* @param {string} event.region The region where the column was dropped.
|
|
29816
29503
|
*/
|
|
29817
|
-
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
29504
|
+
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
29818
29505
|
/**
|
|
29819
29506
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
29820
29507
|
* `false`.
|
|
@@ -29823,7 +29510,7 @@ type GridListeners = {
|
|
|
29823
29510
|
* @param {Grid.column.Column} event.column The column
|
|
29824
29511
|
* @param {Event} event.domEvent The browser event
|
|
29825
29512
|
*/
|
|
29826
|
-
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
29513
|
+
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
29827
29514
|
/**
|
|
29828
29515
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
29829
29516
|
* @param {object} event Event object
|
|
@@ -29847,14 +29534,14 @@ type GridListeners = {
|
|
|
29847
29534
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
29848
29535
|
* @param {any[][]} event.rows An array of records to export
|
|
29849
29536
|
*/
|
|
29850
|
-
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
29537
|
+
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
29851
29538
|
/**
|
|
29852
29539
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
29853
29540
|
* @param {object} event Event object
|
|
29854
29541
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
29855
29542
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
29856
29543
|
*/
|
|
29857
|
-
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
29544
|
+
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
29858
29545
|
/**
|
|
29859
29546
|
* 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
29547
|
* @param {object} event Event object
|
|
@@ -29875,7 +29562,7 @@ type GridListeners = {
|
|
|
29875
29562
|
* @param {object} event Event object
|
|
29876
29563
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
29877
29564
|
*/
|
|
29878
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
29565
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
29879
29566
|
/**
|
|
29880
29567
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
29881
29568
|
* @param {object} event Event object
|
|
@@ -29891,7 +29578,7 @@ type GridListeners = {
|
|
|
29891
29578
|
* @param {object} event Event object
|
|
29892
29579
|
* @param {PdfExportConfig} event.config Export config
|
|
29893
29580
|
*/
|
|
29894
|
-
beforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
29581
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
29895
29582
|
/**
|
|
29896
29583
|
* Fires before a row is rendered.
|
|
29897
29584
|
* @param {object} event Event object
|
|
@@ -29934,7 +29621,7 @@ type GridListeners = {
|
|
|
29934
29621
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
29935
29622
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
29936
29623
|
*/
|
|
29937
|
-
beforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
29624
|
+
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
29625
|
/**
|
|
29939
29626
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
29940
29627
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -29955,19 +29642,19 @@ type GridListeners = {
|
|
|
29955
29642
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
29956
29643
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
29957
29644
|
*/
|
|
29958
|
-
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
29645
|
+
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
29959
29646
|
/**
|
|
29960
29647
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
29961
29648
|
* @param {object} event Event object
|
|
29962
29649
|
* @param {GridStateInfo} event.state State object config
|
|
29963
29650
|
*/
|
|
29964
|
-
beforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
29651
|
+
beforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
29965
29652
|
/**
|
|
29966
29653
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
29967
29654
|
* @param {object} event Event object
|
|
29968
29655
|
* @param {GridStateInfo} event.state State object config
|
|
29969
29656
|
*/
|
|
29970
|
-
beforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
29657
|
+
beforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
29971
29658
|
/**
|
|
29972
29659
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
29973
29660
|
* Returning `false` from a listener prevents the operation
|
|
@@ -29977,7 +29664,7 @@ type GridListeners = {
|
|
|
29977
29664
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
29978
29665
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
29979
29666
|
*/
|
|
29980
|
-
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
29667
|
+
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
29981
29668
|
/**
|
|
29982
29669
|
* Fired before a parent node record toggles its collapsed state.
|
|
29983
29670
|
* @param {object} event Event object
|
|
@@ -30046,7 +29733,7 @@ type GridListeners = {
|
|
|
30046
29733
|
* @param {Grid.column.Column} event.column Column
|
|
30047
29734
|
* @param {Core.data.Model} event.record Record
|
|
30048
29735
|
*/
|
|
30049
|
-
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
29736
|
+
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
30050
29737
|
/**
|
|
30051
29738
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
30052
29739
|
* @param {object} event Event object
|
|
@@ -30173,7 +29860,7 @@ type GridListeners = {
|
|
|
30173
29860
|
* @param {Event} event.event The browser event.
|
|
30174
29861
|
* @param {string} event.region The region where the column was dropped.
|
|
30175
29862
|
*/
|
|
30176
|
-
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
29863
|
+
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
30177
29864
|
/**
|
|
30178
29865
|
* This event is fired after a resize gesture is completed.
|
|
30179
29866
|
* @param {object} event Event object
|
|
@@ -30313,7 +30000,7 @@ type GridListeners = {
|
|
|
30313
30000
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
30314
30001
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
30315
30002
|
*/
|
|
30316
|
-
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
30003
|
+
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
30317
30004
|
/**
|
|
30318
30005
|
* Fires on the owning Grid when cell editing is finished
|
|
30319
30006
|
* @param {object} event Event object
|
|
@@ -30361,7 +30048,7 @@ type GridListeners = {
|
|
|
30361
30048
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
30362
30049
|
* @param {MouseEvent,TouchEvent} event.event
|
|
30363
30050
|
*/
|
|
30364
|
-
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
30051
|
+
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
30365
30052
|
/**
|
|
30366
30053
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
30367
30054
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -30428,7 +30115,7 @@ type GridListeners = {
|
|
|
30428
30115
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
30429
30116
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
30430
30117
|
*/
|
|
30431
|
-
headerClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
30118
|
+
headerClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
30432
30119
|
/**
|
|
30433
30120
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
30434
30121
|
* 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 +30126,7 @@ type GridListeners = {
|
|
|
30439
30126
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
30440
30127
|
* @param {Grid.column.Column} event.column Column
|
|
30441
30128
|
*/
|
|
30442
|
-
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
30129
|
+
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
30443
30130
|
/**
|
|
30444
30131
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
30445
30132
|
* @param {object} event Event object
|
|
@@ -30650,7 +30337,7 @@ type GridListeners = {
|
|
|
30650
30337
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
30651
30338
|
* @param {Event} event.domEvent The native DOM event
|
|
30652
30339
|
*/
|
|
30653
|
-
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
30340
|
+
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
30654
30341
|
/**
|
|
30655
30342
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
30656
30343
|
* @param {object} event Event object
|
|
@@ -30675,7 +30362,7 @@ type GridListeners = {
|
|
|
30675
30362
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
30676
30363
|
* @param {Event} event.domEvent The native DOM event
|
|
30677
30364
|
*/
|
|
30678
|
-
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
30365
|
+
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
30679
30366
|
/**
|
|
30680
30367
|
* Fires on the owning Grid when editing starts
|
|
30681
30368
|
* @param {object} event Event object
|
|
@@ -30873,6 +30560,8 @@ type GridConfig = {
|
|
|
30873
30560
|
/**
|
|
30874
30561
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
30875
30562
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
30563
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
30564
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-appendTo)
|
|
30876
30565
|
*/
|
|
30877
30566
|
appendTo?: HTMLElement|string
|
|
30878
30567
|
/**
|
|
@@ -31187,10 +30876,14 @@ type GridConfig = {
|
|
|
31187
30876
|
inputFieldAlign?: 'start'|'end'
|
|
31188
30877
|
/**
|
|
31189
30878
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
30879
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
30880
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-insertBefore)
|
|
31190
30881
|
*/
|
|
31191
30882
|
insertBefore?: HTMLElement|string
|
|
31192
30883
|
/**
|
|
31193
30884
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
30885
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
30886
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-insertFirst)
|
|
31194
30887
|
*/
|
|
31195
30888
|
insertFirst?: HTMLElement|string
|
|
31196
30889
|
/**
|
|
@@ -31559,14 +31252,14 @@ type GridConfig = {
|
|
|
31559
31252
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
31560
31253
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
31561
31254
|
*/
|
|
31562
|
-
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
31255
|
+
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
31563
31256
|
/**
|
|
31564
31257
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
31565
31258
|
* @param {object} event Event object
|
|
31566
31259
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
31567
31260
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
31568
31261
|
*/
|
|
31569
|
-
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
31262
|
+
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
31570
31263
|
/**
|
|
31571
31264
|
* 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
31265
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-beforeCancelRowEdit)
|
|
@@ -31581,7 +31274,7 @@ type GridConfig = {
|
|
|
31581
31274
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
31582
31275
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
31583
31276
|
*/
|
|
31584
|
-
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
31277
|
+
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
31585
31278
|
/**
|
|
31586
31279
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
31587
31280
|
* 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 +31282,7 @@ type GridConfig = {
|
|
|
31589
31282
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
31590
31283
|
* @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
31284
|
*/
|
|
31592
|
-
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
31285
|
+
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
31593
31286
|
/**
|
|
31594
31287
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
31595
31288
|
* @param {object} event Event object
|
|
@@ -31597,7 +31290,7 @@ type GridConfig = {
|
|
|
31597
31290
|
* @param {string} event.field The field being changed
|
|
31598
31291
|
* @param {any} event.value The value being set
|
|
31599
31292
|
*/
|
|
31600
|
-
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
31293
|
+
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
31601
31294
|
/**
|
|
31602
31295
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
31603
31296
|
* @param {object} event Event object
|
|
@@ -31613,7 +31306,7 @@ type GridConfig = {
|
|
|
31613
31306
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
31614
31307
|
* @param {Event} event.event The browser event.
|
|
31615
31308
|
*/
|
|
31616
|
-
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
31309
|
+
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
31617
31310
|
/**
|
|
31618
31311
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
31619
31312
|
* @param {object} event Event object
|
|
@@ -31624,7 +31317,7 @@ type GridConfig = {
|
|
|
31624
31317
|
* @param {Event} event.event The browser event.
|
|
31625
31318
|
* @param {string} event.region The region where the column was dropped.
|
|
31626
31319
|
*/
|
|
31627
|
-
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
31320
|
+
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
31628
31321
|
/**
|
|
31629
31322
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
31630
31323
|
* `false`.
|
|
@@ -31633,7 +31326,7 @@ type GridConfig = {
|
|
|
31633
31326
|
* @param {Grid.column.Column} event.column The column
|
|
31634
31327
|
* @param {Event} event.domEvent The browser event
|
|
31635
31328
|
*/
|
|
31636
|
-
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
31329
|
+
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
31637
31330
|
/**
|
|
31638
31331
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
31639
31332
|
* @param {object} event Event object
|
|
@@ -31657,14 +31350,14 @@ type GridConfig = {
|
|
|
31657
31350
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
31658
31351
|
* @param {any[][]} event.rows An array of records to export
|
|
31659
31352
|
*/
|
|
31660
|
-
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
31353
|
+
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
31661
31354
|
/**
|
|
31662
31355
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
31663
31356
|
* @param {object} event Event object
|
|
31664
31357
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
31665
31358
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
31666
31359
|
*/
|
|
31667
|
-
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
31360
|
+
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
31668
31361
|
/**
|
|
31669
31362
|
* 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
31363
|
* @param {object} event Event object
|
|
@@ -31685,7 +31378,7 @@ type GridConfig = {
|
|
|
31685
31378
|
* @param {object} event Event object
|
|
31686
31379
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
31687
31380
|
*/
|
|
31688
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
31381
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
31689
31382
|
/**
|
|
31690
31383
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
31691
31384
|
* @param {object} event Event object
|
|
@@ -31701,7 +31394,7 @@ type GridConfig = {
|
|
|
31701
31394
|
* @param {object} event Event object
|
|
31702
31395
|
* @param {PdfExportConfig} event.config Export config
|
|
31703
31396
|
*/
|
|
31704
|
-
onBeforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
31397
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
31705
31398
|
/**
|
|
31706
31399
|
* Fires before a row is rendered.
|
|
31707
31400
|
* @param {object} event Event object
|
|
@@ -31744,7 +31437,7 @@ type GridConfig = {
|
|
|
31744
31437
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
31745
31438
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
31746
31439
|
*/
|
|
31747
|
-
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
31440
|
+
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
31441
|
/**
|
|
31749
31442
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
31750
31443
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -31765,19 +31458,19 @@ type GridConfig = {
|
|
|
31765
31458
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
31766
31459
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
31767
31460
|
*/
|
|
31768
|
-
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
31461
|
+
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
31769
31462
|
/**
|
|
31770
31463
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
31771
31464
|
* @param {object} event Event object
|
|
31772
31465
|
* @param {GridStateInfo} event.state State object config
|
|
31773
31466
|
*/
|
|
31774
|
-
onBeforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
31467
|
+
onBeforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
31775
31468
|
/**
|
|
31776
31469
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
31777
31470
|
* @param {object} event Event object
|
|
31778
31471
|
* @param {GridStateInfo} event.state State object config
|
|
31779
31472
|
*/
|
|
31780
|
-
onBeforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
31473
|
+
onBeforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
31781
31474
|
/**
|
|
31782
31475
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
31783
31476
|
* Returning `false` from a listener prevents the operation
|
|
@@ -31787,7 +31480,7 @@ type GridConfig = {
|
|
|
31787
31480
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
31788
31481
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
31789
31482
|
*/
|
|
31790
|
-
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
31483
|
+
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
31791
31484
|
/**
|
|
31792
31485
|
* Fired before a parent node record toggles its collapsed state.
|
|
31793
31486
|
* @param {object} event Event object
|
|
@@ -31856,7 +31549,7 @@ type GridConfig = {
|
|
|
31856
31549
|
* @param {Grid.column.Column} event.column Column
|
|
31857
31550
|
* @param {Core.data.Model} event.record Record
|
|
31858
31551
|
*/
|
|
31859
|
-
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
31552
|
+
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
31860
31553
|
/**
|
|
31861
31554
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
31862
31555
|
* @param {object} event Event object
|
|
@@ -31983,7 +31676,7 @@ type GridConfig = {
|
|
|
31983
31676
|
* @param {Event} event.event The browser event.
|
|
31984
31677
|
* @param {string} event.region The region where the column was dropped.
|
|
31985
31678
|
*/
|
|
31986
|
-
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
31679
|
+
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
31987
31680
|
/**
|
|
31988
31681
|
* This event is fired after a resize gesture is completed.
|
|
31989
31682
|
* @param {object} event Event object
|
|
@@ -32123,7 +31816,7 @@ type GridConfig = {
|
|
|
32123
31816
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
32124
31817
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
32125
31818
|
*/
|
|
32126
|
-
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
31819
|
+
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
32127
31820
|
/**
|
|
32128
31821
|
* Fires on the owning Grid when cell editing is finished
|
|
32129
31822
|
* @param {object} event Event object
|
|
@@ -32171,7 +31864,7 @@ type GridConfig = {
|
|
|
32171
31864
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
32172
31865
|
* @param {MouseEvent,TouchEvent} event.event
|
|
32173
31866
|
*/
|
|
32174
|
-
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
31867
|
+
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
32175
31868
|
/**
|
|
32176
31869
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
32177
31870
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -32238,7 +31931,7 @@ type GridConfig = {
|
|
|
32238
31931
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
32239
31932
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
32240
31933
|
*/
|
|
32241
|
-
onHeaderClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
31934
|
+
onHeaderClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
32242
31935
|
/**
|
|
32243
31936
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
32244
31937
|
* 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 +31942,7 @@ type GridConfig = {
|
|
|
32249
31942
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
32250
31943
|
* @param {Grid.column.Column} event.column Column
|
|
32251
31944
|
*/
|
|
32252
|
-
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
31945
|
+
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
32253
31946
|
/**
|
|
32254
31947
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
32255
31948
|
* @param {object} event Event object
|
|
@@ -32460,7 +32153,7 @@ type GridConfig = {
|
|
|
32460
32153
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
32461
32154
|
* @param {Event} event.domEvent The native DOM event
|
|
32462
32155
|
*/
|
|
32463
|
-
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
32156
|
+
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
32464
32157
|
/**
|
|
32465
32158
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
32466
32159
|
* @param {object} event Event object
|
|
@@ -32485,7 +32178,7 @@ type GridConfig = {
|
|
|
32485
32178
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
32486
32179
|
* @param {Event} event.domEvent The native DOM event
|
|
32487
32180
|
*/
|
|
32488
|
-
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
32181
|
+
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
32489
32182
|
/**
|
|
32490
32183
|
* Fires on the owning Grid when editing starts
|
|
32491
32184
|
* @param {object} event Event object
|
|
@@ -32594,19 +32287,19 @@ export class Grid extends GridBase {
|
|
|
32594
32287
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
32595
32288
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
32596
32289
|
*/
|
|
32597
|
-
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
32290
|
+
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
32291
|
/**
|
|
32599
32292
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
32600
32293
|
* @param {object} event Event object
|
|
32601
32294
|
* @param {GridStateInfo} event.state State object config
|
|
32602
32295
|
*/
|
|
32603
|
-
onBeforeStateApply: ((event: { state: GridStateInfo }) =>
|
|
32296
|
+
onBeforeStateApply: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
32604
32297
|
/**
|
|
32605
32298
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
32606
32299
|
* @param {object} event Event object
|
|
32607
32300
|
* @param {GridStateInfo} event.state State object config
|
|
32608
32301
|
*/
|
|
32609
|
-
onBeforeStateSave: ((event: { state: GridStateInfo }) =>
|
|
32302
|
+
onBeforeStateSave: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
32610
32303
|
/**
|
|
32611
32304
|
* Fires when any other event is fired from the object.
|
|
32612
32305
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-catchAll)
|
|
@@ -32712,7 +32405,7 @@ export class Grid extends GridBase {
|
|
|
32712
32405
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
32713
32406
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
32714
32407
|
*/
|
|
32715
|
-
onHeaderClick: ((event: { domEvent: Event, column: Column }) =>
|
|
32408
|
+
onHeaderClick: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
32716
32409
|
/**
|
|
32717
32410
|
* Mouse moved out from element in grid
|
|
32718
32411
|
* @param {object} event Event object
|
|
@@ -32790,14 +32483,14 @@ type GridBaseListenersTypes = {
|
|
|
32790
32483
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
32791
32484
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
32792
32485
|
*/
|
|
32793
|
-
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
32486
|
+
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void
|
|
32794
32487
|
/**
|
|
32795
32488
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
32796
32489
|
* @param {object} event Event object
|
|
32797
32490
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
32798
32491
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
32799
32492
|
*/
|
|
32800
|
-
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) =>
|
|
32493
|
+
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) => boolean|void
|
|
32801
32494
|
/**
|
|
32802
32495
|
* 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
32496
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
|
|
@@ -32812,7 +32505,7 @@ type GridBaseListenersTypes = {
|
|
|
32812
32505
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
32813
32506
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
32814
32507
|
*/
|
|
32815
|
-
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
32508
|
+
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => boolean|void
|
|
32816
32509
|
/**
|
|
32817
32510
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
32818
32511
|
* 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 +32513,7 @@ type GridBaseListenersTypes = {
|
|
|
32820
32513
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
32821
32514
|
* @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
32515
|
*/
|
|
32823
|
-
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
32516
|
+
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void
|
|
32824
32517
|
/**
|
|
32825
32518
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
32826
32519
|
* @param {object} event Event object
|
|
@@ -32828,7 +32521,7 @@ type GridBaseListenersTypes = {
|
|
|
32828
32521
|
* @param {string} event.field The field being changed
|
|
32829
32522
|
* @param {any} event.value The value being set
|
|
32830
32523
|
*/
|
|
32831
|
-
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) =>
|
|
32524
|
+
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => boolean|void
|
|
32832
32525
|
/**
|
|
32833
32526
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
32834
32527
|
* @param {object} event Event object
|
|
@@ -32844,7 +32537,7 @@ type GridBaseListenersTypes = {
|
|
|
32844
32537
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
32845
32538
|
* @param {Event} event.event The browser event.
|
|
32846
32539
|
*/
|
|
32847
|
-
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) =>
|
|
32540
|
+
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) => boolean|void
|
|
32848
32541
|
/**
|
|
32849
32542
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
32850
32543
|
* @param {object} event Event object
|
|
@@ -32855,7 +32548,7 @@ type GridBaseListenersTypes = {
|
|
|
32855
32548
|
* @param {Event} event.event The browser event.
|
|
32856
32549
|
* @param {string} event.region The region where the column was dropped.
|
|
32857
32550
|
*/
|
|
32858
|
-
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
32551
|
+
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void
|
|
32859
32552
|
/**
|
|
32860
32553
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
32861
32554
|
* `false`.
|
|
@@ -32864,7 +32557,7 @@ type GridBaseListenersTypes = {
|
|
|
32864
32557
|
* @param {Grid.column.Column} event.column The column
|
|
32865
32558
|
* @param {Event} event.domEvent The browser event
|
|
32866
32559
|
*/
|
|
32867
|
-
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
32560
|
+
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) => boolean|void
|
|
32868
32561
|
/**
|
|
32869
32562
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
32870
32563
|
* @param {object} event Event object
|
|
@@ -32888,14 +32581,14 @@ type GridBaseListenersTypes = {
|
|
|
32888
32581
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
32889
32582
|
* @param {any[][]} event.rows An array of records to export
|
|
32890
32583
|
*/
|
|
32891
|
-
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
32584
|
+
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void
|
|
32892
32585
|
/**
|
|
32893
32586
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
32894
32587
|
* @param {object} event Event object
|
|
32895
32588
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
32896
32589
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
32897
32590
|
*/
|
|
32898
|
-
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
32591
|
+
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
32899
32592
|
/**
|
|
32900
32593
|
* 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
32594
|
* @param {object} event Event object
|
|
@@ -32916,7 +32609,7 @@ type GridBaseListenersTypes = {
|
|
|
32916
32609
|
* @param {object} event Event object
|
|
32917
32610
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
32918
32611
|
*/
|
|
32919
|
-
beforeHide: (event: { source: Widget }) =>
|
|
32612
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
32920
32613
|
/**
|
|
32921
32614
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
32922
32615
|
* @param {object} event Event object
|
|
@@ -32932,7 +32625,7 @@ type GridBaseListenersTypes = {
|
|
|
32932
32625
|
* @param {object} event Event object
|
|
32933
32626
|
* @param {PdfExportConfig} event.config Export config
|
|
32934
32627
|
*/
|
|
32935
|
-
beforePdfExport: (event: { config: PdfExportConfig }) =>
|
|
32628
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => boolean|void
|
|
32936
32629
|
/**
|
|
32937
32630
|
* Fires before a row is rendered.
|
|
32938
32631
|
* @param {object} event Event object
|
|
@@ -32975,7 +32668,7 @@ type GridBaseListenersTypes = {
|
|
|
32975
32668
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
32976
32669
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
32977
32670
|
*/
|
|
32978
|
-
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
32671
|
+
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void
|
|
32979
32672
|
/**
|
|
32980
32673
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
32981
32674
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -32996,19 +32689,19 @@ type GridBaseListenersTypes = {
|
|
|
32996
32689
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
32997
32690
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
32998
32691
|
*/
|
|
32999
|
-
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
32692
|
+
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) => boolean|void
|
|
33000
32693
|
/**
|
|
33001
32694
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
33002
32695
|
* @param {object} event Event object
|
|
33003
32696
|
* @param {GridStateInfo} event.state State object config
|
|
33004
32697
|
*/
|
|
33005
|
-
beforeStateApply: (event: { state: GridStateInfo }) =>
|
|
32698
|
+
beforeStateApply: (event: { state: GridStateInfo }) => boolean|void
|
|
33006
32699
|
/**
|
|
33007
32700
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
33008
32701
|
* @param {object} event Event object
|
|
33009
32702
|
* @param {GridStateInfo} event.state State object config
|
|
33010
32703
|
*/
|
|
33011
|
-
beforeStateSave: (event: { state: GridStateInfo }) =>
|
|
32704
|
+
beforeStateSave: (event: { state: GridStateInfo }) => boolean|void
|
|
33012
32705
|
/**
|
|
33013
32706
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
33014
32707
|
* Returning `false` from a listener prevents the operation
|
|
@@ -33018,7 +32711,7 @@ type GridBaseListenersTypes = {
|
|
|
33018
32711
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
33019
32712
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
33020
32713
|
*/
|
|
33021
|
-
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
32714
|
+
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void
|
|
33022
32715
|
/**
|
|
33023
32716
|
* Fired before a parent node record toggles its collapsed state.
|
|
33024
32717
|
* @param {object} event Event object
|
|
@@ -33087,7 +32780,7 @@ type GridBaseListenersTypes = {
|
|
|
33087
32780
|
* @param {Grid.column.Column} event.column Column
|
|
33088
32781
|
* @param {Core.data.Model} event.record Record
|
|
33089
32782
|
*/
|
|
33090
|
-
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
32783
|
+
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void
|
|
33091
32784
|
/**
|
|
33092
32785
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
33093
32786
|
* @param {object} event Event object
|
|
@@ -33214,7 +32907,7 @@ type GridBaseListenersTypes = {
|
|
|
33214
32907
|
* @param {Event} event.event The browser event.
|
|
33215
32908
|
* @param {string} event.region The region where the column was dropped.
|
|
33216
32909
|
*/
|
|
33217
|
-
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
32910
|
+
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void
|
|
33218
32911
|
/**
|
|
33219
32912
|
* This event is fired after a resize gesture is completed.
|
|
33220
32913
|
* @param {object} event Event object
|
|
@@ -33354,7 +33047,7 @@ type GridBaseListenersTypes = {
|
|
|
33354
33047
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
33355
33048
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
33356
33049
|
*/
|
|
33357
|
-
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
33050
|
+
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
33358
33051
|
/**
|
|
33359
33052
|
* Fires on the owning Grid when cell editing is finished
|
|
33360
33053
|
* @param {object} event Event object
|
|
@@ -33402,7 +33095,7 @@ type GridBaseListenersTypes = {
|
|
|
33402
33095
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
33403
33096
|
* @param {MouseEvent,TouchEvent} event.event
|
|
33404
33097
|
*/
|
|
33405
|
-
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
33098
|
+
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void
|
|
33406
33099
|
/**
|
|
33407
33100
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
33408
33101
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -33469,7 +33162,7 @@ type GridBaseListenersTypes = {
|
|
|
33469
33162
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
33470
33163
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
33471
33164
|
*/
|
|
33472
|
-
headerClick: (event: { domEvent: Event, column: Column }) =>
|
|
33165
|
+
headerClick: (event: { domEvent: Event, column: Column }) => boolean|void
|
|
33473
33166
|
/**
|
|
33474
33167
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
33475
33168
|
* 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 +33173,7 @@ type GridBaseListenersTypes = {
|
|
|
33480
33173
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
33481
33174
|
* @param {Grid.column.Column} event.column Column
|
|
33482
33175
|
*/
|
|
33483
|
-
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
33176
|
+
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void
|
|
33484
33177
|
/**
|
|
33485
33178
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
33486
33179
|
* @param {object} event Event object
|
|
@@ -33691,7 +33384,7 @@ type GridBaseListenersTypes = {
|
|
|
33691
33384
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
33692
33385
|
* @param {Event} event.domEvent The native DOM event
|
|
33693
33386
|
*/
|
|
33694
|
-
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
33387
|
+
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
33695
33388
|
/**
|
|
33696
33389
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
33697
33390
|
* @param {object} event Event object
|
|
@@ -33716,7 +33409,7 @@ type GridBaseListenersTypes = {
|
|
|
33716
33409
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
33717
33410
|
* @param {Event} event.domEvent The native DOM event
|
|
33718
33411
|
*/
|
|
33719
|
-
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
33412
|
+
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
33720
33413
|
/**
|
|
33721
33414
|
* Fires on the owning Grid when editing starts
|
|
33722
33415
|
* @param {object} event Event object
|
|
@@ -33805,14 +33498,14 @@ type GridBaseListeners = {
|
|
|
33805
33498
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
33806
33499
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
33807
33500
|
*/
|
|
33808
|
-
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
33501
|
+
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
33809
33502
|
/**
|
|
33810
33503
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
33811
33504
|
* @param {object} event Event object
|
|
33812
33505
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
33813
33506
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
33814
33507
|
*/
|
|
33815
|
-
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
33508
|
+
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
33816
33509
|
/**
|
|
33817
33510
|
* 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
33511
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
|
|
@@ -33827,7 +33520,7 @@ type GridBaseListeners = {
|
|
|
33827
33520
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
33828
33521
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
33829
33522
|
*/
|
|
33830
|
-
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
33523
|
+
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
33831
33524
|
/**
|
|
33832
33525
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
33833
33526
|
* 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 +33528,7 @@ type GridBaseListeners = {
|
|
|
33835
33528
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
33836
33529
|
* @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
33530
|
*/
|
|
33838
|
-
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
33531
|
+
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
33839
33532
|
/**
|
|
33840
33533
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
33841
33534
|
* @param {object} event Event object
|
|
@@ -33843,7 +33536,7 @@ type GridBaseListeners = {
|
|
|
33843
33536
|
* @param {string} event.field The field being changed
|
|
33844
33537
|
* @param {any} event.value The value being set
|
|
33845
33538
|
*/
|
|
33846
|
-
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
33539
|
+
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
33847
33540
|
/**
|
|
33848
33541
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
33849
33542
|
* @param {object} event Event object
|
|
@@ -33859,7 +33552,7 @@ type GridBaseListeners = {
|
|
|
33859
33552
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
33860
33553
|
* @param {Event} event.event The browser event.
|
|
33861
33554
|
*/
|
|
33862
|
-
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
33555
|
+
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
33863
33556
|
/**
|
|
33864
33557
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
33865
33558
|
* @param {object} event Event object
|
|
@@ -33870,7 +33563,7 @@ type GridBaseListeners = {
|
|
|
33870
33563
|
* @param {Event} event.event The browser event.
|
|
33871
33564
|
* @param {string} event.region The region where the column was dropped.
|
|
33872
33565
|
*/
|
|
33873
|
-
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
33566
|
+
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
33874
33567
|
/**
|
|
33875
33568
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
33876
33569
|
* `false`.
|
|
@@ -33879,7 +33572,7 @@ type GridBaseListeners = {
|
|
|
33879
33572
|
* @param {Grid.column.Column} event.column The column
|
|
33880
33573
|
* @param {Event} event.domEvent The browser event
|
|
33881
33574
|
*/
|
|
33882
|
-
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
33575
|
+
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
33883
33576
|
/**
|
|
33884
33577
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
33885
33578
|
* @param {object} event Event object
|
|
@@ -33903,14 +33596,14 @@ type GridBaseListeners = {
|
|
|
33903
33596
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
33904
33597
|
* @param {any[][]} event.rows An array of records to export
|
|
33905
33598
|
*/
|
|
33906
|
-
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
33599
|
+
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
33907
33600
|
/**
|
|
33908
33601
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
33909
33602
|
* @param {object} event Event object
|
|
33910
33603
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
33911
33604
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
33912
33605
|
*/
|
|
33913
|
-
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
33606
|
+
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
33914
33607
|
/**
|
|
33915
33608
|
* 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
33609
|
* @param {object} event Event object
|
|
@@ -33931,7 +33624,7 @@ type GridBaseListeners = {
|
|
|
33931
33624
|
* @param {object} event Event object
|
|
33932
33625
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
33933
33626
|
*/
|
|
33934
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
33627
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
33935
33628
|
/**
|
|
33936
33629
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
33937
33630
|
* @param {object} event Event object
|
|
@@ -33947,7 +33640,7 @@ type GridBaseListeners = {
|
|
|
33947
33640
|
* @param {object} event Event object
|
|
33948
33641
|
* @param {PdfExportConfig} event.config Export config
|
|
33949
33642
|
*/
|
|
33950
|
-
beforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
33643
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
33951
33644
|
/**
|
|
33952
33645
|
* Fires before a row is rendered.
|
|
33953
33646
|
* @param {object} event Event object
|
|
@@ -33990,7 +33683,7 @@ type GridBaseListeners = {
|
|
|
33990
33683
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
33991
33684
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
33992
33685
|
*/
|
|
33993
|
-
beforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
33686
|
+
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
33687
|
/**
|
|
33995
33688
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
33996
33689
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -34011,19 +33704,19 @@ type GridBaseListeners = {
|
|
|
34011
33704
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
34012
33705
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
34013
33706
|
*/
|
|
34014
|
-
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
33707
|
+
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
34015
33708
|
/**
|
|
34016
33709
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
34017
33710
|
* @param {object} event Event object
|
|
34018
33711
|
* @param {GridStateInfo} event.state State object config
|
|
34019
33712
|
*/
|
|
34020
|
-
beforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
33713
|
+
beforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
34021
33714
|
/**
|
|
34022
33715
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
34023
33716
|
* @param {object} event Event object
|
|
34024
33717
|
* @param {GridStateInfo} event.state State object config
|
|
34025
33718
|
*/
|
|
34026
|
-
beforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
33719
|
+
beforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
34027
33720
|
/**
|
|
34028
33721
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
34029
33722
|
* Returning `false` from a listener prevents the operation
|
|
@@ -34033,7 +33726,7 @@ type GridBaseListeners = {
|
|
|
34033
33726
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
34034
33727
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
34035
33728
|
*/
|
|
34036
|
-
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
33729
|
+
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
34037
33730
|
/**
|
|
34038
33731
|
* Fired before a parent node record toggles its collapsed state.
|
|
34039
33732
|
* @param {object} event Event object
|
|
@@ -34102,7 +33795,7 @@ type GridBaseListeners = {
|
|
|
34102
33795
|
* @param {Grid.column.Column} event.column Column
|
|
34103
33796
|
* @param {Core.data.Model} event.record Record
|
|
34104
33797
|
*/
|
|
34105
|
-
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
33798
|
+
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
34106
33799
|
/**
|
|
34107
33800
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
34108
33801
|
* @param {object} event Event object
|
|
@@ -34229,7 +33922,7 @@ type GridBaseListeners = {
|
|
|
34229
33922
|
* @param {Event} event.event The browser event.
|
|
34230
33923
|
* @param {string} event.region The region where the column was dropped.
|
|
34231
33924
|
*/
|
|
34232
|
-
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
33925
|
+
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
34233
33926
|
/**
|
|
34234
33927
|
* This event is fired after a resize gesture is completed.
|
|
34235
33928
|
* @param {object} event Event object
|
|
@@ -34369,7 +34062,7 @@ type GridBaseListeners = {
|
|
|
34369
34062
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
34370
34063
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
34371
34064
|
*/
|
|
34372
|
-
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
34065
|
+
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
34373
34066
|
/**
|
|
34374
34067
|
* Fires on the owning Grid when cell editing is finished
|
|
34375
34068
|
* @param {object} event Event object
|
|
@@ -34417,7 +34110,7 @@ type GridBaseListeners = {
|
|
|
34417
34110
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
34418
34111
|
* @param {MouseEvent,TouchEvent} event.event
|
|
34419
34112
|
*/
|
|
34420
|
-
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
34113
|
+
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
34421
34114
|
/**
|
|
34422
34115
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
34423
34116
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -34484,7 +34177,7 @@ type GridBaseListeners = {
|
|
|
34484
34177
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
34485
34178
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
34486
34179
|
*/
|
|
34487
|
-
headerClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
34180
|
+
headerClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
34488
34181
|
/**
|
|
34489
34182
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
34490
34183
|
* 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 +34188,7 @@ type GridBaseListeners = {
|
|
|
34495
34188
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
34496
34189
|
* @param {Grid.column.Column} event.column Column
|
|
34497
34190
|
*/
|
|
34498
|
-
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
34191
|
+
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
34499
34192
|
/**
|
|
34500
34193
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
34501
34194
|
* @param {object} event Event object
|
|
@@ -34706,7 +34399,7 @@ type GridBaseListeners = {
|
|
|
34706
34399
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
34707
34400
|
* @param {Event} event.domEvent The native DOM event
|
|
34708
34401
|
*/
|
|
34709
|
-
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
34402
|
+
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
34710
34403
|
/**
|
|
34711
34404
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
34712
34405
|
* @param {object} event Event object
|
|
@@ -34731,7 +34424,7 @@ type GridBaseListeners = {
|
|
|
34731
34424
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
34732
34425
|
* @param {Event} event.domEvent The native DOM event
|
|
34733
34426
|
*/
|
|
34734
|
-
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
34427
|
+
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
34735
34428
|
/**
|
|
34736
34429
|
* Fires on the owning Grid when editing starts
|
|
34737
34430
|
* @param {object} event Event object
|
|
@@ -34928,6 +34621,8 @@ type GridBaseConfig = {
|
|
|
34928
34621
|
/**
|
|
34929
34622
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
34930
34623
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
34624
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
34625
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-appendTo)
|
|
34931
34626
|
*/
|
|
34932
34627
|
appendTo?: HTMLElement|string
|
|
34933
34628
|
/**
|
|
@@ -35242,10 +34937,14 @@ type GridBaseConfig = {
|
|
|
35242
34937
|
inputFieldAlign?: 'start'|'end'
|
|
35243
34938
|
/**
|
|
35244
34939
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
34940
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
34941
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-insertBefore)
|
|
35245
34942
|
*/
|
|
35246
34943
|
insertBefore?: HTMLElement|string
|
|
35247
34944
|
/**
|
|
35248
34945
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
34946
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
34947
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-insertFirst)
|
|
35249
34948
|
*/
|
|
35250
34949
|
insertFirst?: HTMLElement|string
|
|
35251
34950
|
/**
|
|
@@ -35614,14 +35313,14 @@ type GridBaseConfig = {
|
|
|
35614
35313
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
35615
35314
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
35616
35315
|
*/
|
|
35617
|
-
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
35316
|
+
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
35618
35317
|
/**
|
|
35619
35318
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
35620
35319
|
* @param {object} event Event object
|
|
35621
35320
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
35622
35321
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
35623
35322
|
*/
|
|
35624
|
-
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
35323
|
+
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
35625
35324
|
/**
|
|
35626
35325
|
* 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
35326
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
|
|
@@ -35636,7 +35335,7 @@ type GridBaseConfig = {
|
|
|
35636
35335
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
35637
35336
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
35638
35337
|
*/
|
|
35639
|
-
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
35338
|
+
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
35640
35339
|
/**
|
|
35641
35340
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
35642
35341
|
* 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 +35343,7 @@ type GridBaseConfig = {
|
|
|
35644
35343
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
35645
35344
|
* @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
35345
|
*/
|
|
35647
|
-
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
35346
|
+
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
35648
35347
|
/**
|
|
35649
35348
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
35650
35349
|
* @param {object} event Event object
|
|
@@ -35652,7 +35351,7 @@ type GridBaseConfig = {
|
|
|
35652
35351
|
* @param {string} event.field The field being changed
|
|
35653
35352
|
* @param {any} event.value The value being set
|
|
35654
35353
|
*/
|
|
35655
|
-
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
35354
|
+
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
35656
35355
|
/**
|
|
35657
35356
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
35658
35357
|
* @param {object} event Event object
|
|
@@ -35668,7 +35367,7 @@ type GridBaseConfig = {
|
|
|
35668
35367
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
35669
35368
|
* @param {Event} event.event The browser event.
|
|
35670
35369
|
*/
|
|
35671
|
-
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
35370
|
+
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
35672
35371
|
/**
|
|
35673
35372
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
35674
35373
|
* @param {object} event Event object
|
|
@@ -35679,7 +35378,7 @@ type GridBaseConfig = {
|
|
|
35679
35378
|
* @param {Event} event.event The browser event.
|
|
35680
35379
|
* @param {string} event.region The region where the column was dropped.
|
|
35681
35380
|
*/
|
|
35682
|
-
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
35381
|
+
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
35683
35382
|
/**
|
|
35684
35383
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
35685
35384
|
* `false`.
|
|
@@ -35688,7 +35387,7 @@ type GridBaseConfig = {
|
|
|
35688
35387
|
* @param {Grid.column.Column} event.column The column
|
|
35689
35388
|
* @param {Event} event.domEvent The browser event
|
|
35690
35389
|
*/
|
|
35691
|
-
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
35390
|
+
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
35692
35391
|
/**
|
|
35693
35392
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
35694
35393
|
* @param {object} event Event object
|
|
@@ -35712,14 +35411,14 @@ type GridBaseConfig = {
|
|
|
35712
35411
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
35713
35412
|
* @param {any[][]} event.rows An array of records to export
|
|
35714
35413
|
*/
|
|
35715
|
-
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
35414
|
+
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
35716
35415
|
/**
|
|
35717
35416
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
35718
35417
|
* @param {object} event Event object
|
|
35719
35418
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
35720
35419
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
35721
35420
|
*/
|
|
35722
|
-
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
35421
|
+
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
35723
35422
|
/**
|
|
35724
35423
|
* 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
35424
|
* @param {object} event Event object
|
|
@@ -35740,7 +35439,7 @@ type GridBaseConfig = {
|
|
|
35740
35439
|
* @param {object} event Event object
|
|
35741
35440
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
35742
35441
|
*/
|
|
35743
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
35442
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
35744
35443
|
/**
|
|
35745
35444
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
35746
35445
|
* @param {object} event Event object
|
|
@@ -35756,7 +35455,7 @@ type GridBaseConfig = {
|
|
|
35756
35455
|
* @param {object} event Event object
|
|
35757
35456
|
* @param {PdfExportConfig} event.config Export config
|
|
35758
35457
|
*/
|
|
35759
|
-
onBeforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
35458
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
35760
35459
|
/**
|
|
35761
35460
|
* Fires before a row is rendered.
|
|
35762
35461
|
* @param {object} event Event object
|
|
@@ -35799,7 +35498,7 @@ type GridBaseConfig = {
|
|
|
35799
35498
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
35800
35499
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
35801
35500
|
*/
|
|
35802
|
-
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
35501
|
+
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
35502
|
/**
|
|
35804
35503
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
35805
35504
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -35820,19 +35519,19 @@ type GridBaseConfig = {
|
|
|
35820
35519
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
35821
35520
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
35822
35521
|
*/
|
|
35823
|
-
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
35522
|
+
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
35824
35523
|
/**
|
|
35825
35524
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
35826
35525
|
* @param {object} event Event object
|
|
35827
35526
|
* @param {GridStateInfo} event.state State object config
|
|
35828
35527
|
*/
|
|
35829
|
-
onBeforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
35528
|
+
onBeforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
35830
35529
|
/**
|
|
35831
35530
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
35832
35531
|
* @param {object} event Event object
|
|
35833
35532
|
* @param {GridStateInfo} event.state State object config
|
|
35834
35533
|
*/
|
|
35835
|
-
onBeforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
35534
|
+
onBeforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
35836
35535
|
/**
|
|
35837
35536
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
35838
35537
|
* Returning `false` from a listener prevents the operation
|
|
@@ -35842,7 +35541,7 @@ type GridBaseConfig = {
|
|
|
35842
35541
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
35843
35542
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
35844
35543
|
*/
|
|
35845
|
-
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
35544
|
+
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
35846
35545
|
/**
|
|
35847
35546
|
* Fired before a parent node record toggles its collapsed state.
|
|
35848
35547
|
* @param {object} event Event object
|
|
@@ -35911,7 +35610,7 @@ type GridBaseConfig = {
|
|
|
35911
35610
|
* @param {Grid.column.Column} event.column Column
|
|
35912
35611
|
* @param {Core.data.Model} event.record Record
|
|
35913
35612
|
*/
|
|
35914
|
-
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
35613
|
+
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
35915
35614
|
/**
|
|
35916
35615
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
35917
35616
|
* @param {object} event Event object
|
|
@@ -36038,7 +35737,7 @@ type GridBaseConfig = {
|
|
|
36038
35737
|
* @param {Event} event.event The browser event.
|
|
36039
35738
|
* @param {string} event.region The region where the column was dropped.
|
|
36040
35739
|
*/
|
|
36041
|
-
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
35740
|
+
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
36042
35741
|
/**
|
|
36043
35742
|
* This event is fired after a resize gesture is completed.
|
|
36044
35743
|
* @param {object} event Event object
|
|
@@ -36178,7 +35877,7 @@ type GridBaseConfig = {
|
|
|
36178
35877
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
36179
35878
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
36180
35879
|
*/
|
|
36181
|
-
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
35880
|
+
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
36182
35881
|
/**
|
|
36183
35882
|
* Fires on the owning Grid when cell editing is finished
|
|
36184
35883
|
* @param {object} event Event object
|
|
@@ -36226,7 +35925,7 @@ type GridBaseConfig = {
|
|
|
36226
35925
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
36227
35926
|
* @param {MouseEvent,TouchEvent} event.event
|
|
36228
35927
|
*/
|
|
36229
|
-
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
35928
|
+
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
36230
35929
|
/**
|
|
36231
35930
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
36232
35931
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -36293,7 +35992,7 @@ type GridBaseConfig = {
|
|
|
36293
35992
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
36294
35993
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
36295
35994
|
*/
|
|
36296
|
-
onHeaderClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
35995
|
+
onHeaderClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
36297
35996
|
/**
|
|
36298
35997
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
36299
35998
|
* 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 +36003,7 @@ type GridBaseConfig = {
|
|
|
36304
36003
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
36305
36004
|
* @param {Grid.column.Column} event.column Column
|
|
36306
36005
|
*/
|
|
36307
|
-
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
36006
|
+
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
36308
36007
|
/**
|
|
36309
36008
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
36310
36009
|
* @param {object} event Event object
|
|
@@ -36515,7 +36214,7 @@ type GridBaseConfig = {
|
|
|
36515
36214
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
36516
36215
|
* @param {Event} event.domEvent The native DOM event
|
|
36517
36216
|
*/
|
|
36518
|
-
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
36217
|
+
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
36519
36218
|
/**
|
|
36520
36219
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
36521
36220
|
* @param {object} event Event object
|
|
@@ -36540,7 +36239,7 @@ type GridBaseConfig = {
|
|
|
36540
36239
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
36541
36240
|
* @param {Event} event.domEvent The native DOM event
|
|
36542
36241
|
*/
|
|
36543
|
-
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
36242
|
+
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
36544
36243
|
/**
|
|
36545
36244
|
* Fires on the owning Grid when editing starts
|
|
36546
36245
|
* @param {object} event Event object
|
|
@@ -36958,14 +36657,14 @@ export class GridBase extends Panel {
|
|
|
36958
36657
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
36959
36658
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
36960
36659
|
*/
|
|
36961
|
-
onBeforeCSVExport: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
36660
|
+
onBeforeCSVExport: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
36962
36661
|
/**
|
|
36963
36662
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
36964
36663
|
* @param {object} event Event object
|
|
36965
36664
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
36966
36665
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
36967
36666
|
*/
|
|
36968
|
-
onBeforeCancelCellEdit: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
36667
|
+
onBeforeCancelCellEdit: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
36969
36668
|
/**
|
|
36970
36669
|
* 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
36670
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
|
|
@@ -36980,7 +36679,7 @@ export class GridBase extends Panel {
|
|
|
36980
36679
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
36981
36680
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
36982
36681
|
*/
|
|
36983
|
-
onBeforeCellEditStart: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
36682
|
+
onBeforeCellEditStart: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
36984
36683
|
/**
|
|
36985
36684
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
36986
36685
|
* 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 +36687,7 @@ export class GridBase extends Panel {
|
|
|
36988
36687
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
36989
36688
|
* @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
36689
|
*/
|
|
36991
|
-
onBeforeCellRangeDelete: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
36690
|
+
onBeforeCellRangeDelete: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
36992
36691
|
/**
|
|
36993
36692
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
36994
36693
|
* @param {object} event Event object
|
|
@@ -36996,7 +36695,7 @@ export class GridBase extends Panel {
|
|
|
36996
36695
|
* @param {string} event.field The field being changed
|
|
36997
36696
|
* @param {any} event.value The value being set
|
|
36998
36697
|
*/
|
|
36999
|
-
onBeforeCellRangeEdit: ((event: { record: Model, field: string, value: any }) =>
|
|
36698
|
+
onBeforeCellRangeEdit: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
37000
36699
|
/**
|
|
37001
36700
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
37002
36701
|
* @param {object} event Event object
|
|
@@ -37012,7 +36711,7 @@ export class GridBase extends Panel {
|
|
|
37012
36711
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
37013
36712
|
* @param {Event} event.event The browser event.
|
|
37014
36713
|
*/
|
|
37015
|
-
onBeforeColumnDragStart: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
36714
|
+
onBeforeColumnDragStart: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
37016
36715
|
/**
|
|
37017
36716
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
37018
36717
|
* @param {object} event Event object
|
|
@@ -37023,7 +36722,7 @@ export class GridBase extends Panel {
|
|
|
37023
36722
|
* @param {Event} event.event The browser event.
|
|
37024
36723
|
* @param {string} event.region The region where the column was dropped.
|
|
37025
36724
|
*/
|
|
37026
|
-
onBeforeColumnDropFinalize: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
36725
|
+
onBeforeColumnDropFinalize: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
37027
36726
|
/**
|
|
37028
36727
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
37029
36728
|
* `false`.
|
|
@@ -37032,7 +36731,7 @@ export class GridBase extends Panel {
|
|
|
37032
36731
|
* @param {Grid.column.Column} event.column The column
|
|
37033
36732
|
* @param {Event} event.domEvent The browser event
|
|
37034
36733
|
*/
|
|
37035
|
-
onBeforeColumnResize: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
36734
|
+
onBeforeColumnResize: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
37036
36735
|
/**
|
|
37037
36736
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
37038
36737
|
* @param {object} event Event object
|
|
@@ -37056,14 +36755,14 @@ export class GridBase extends Panel {
|
|
|
37056
36755
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
37057
36756
|
* @param {any[][]} event.rows An array of records to export
|
|
37058
36757
|
*/
|
|
37059
|
-
onBeforeExcelExport: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
36758
|
+
onBeforeExcelExport: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
37060
36759
|
/**
|
|
37061
36760
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
37062
36761
|
* @param {object} event Event object
|
|
37063
36762
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
37064
36763
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
37065
36764
|
*/
|
|
37066
|
-
onBeforeFillHandleDragStart: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
36765
|
+
onBeforeFillHandleDragStart: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
37067
36766
|
/**
|
|
37068
36767
|
* 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
36768
|
* @param {object} event Event object
|
|
@@ -37094,7 +36793,7 @@ export class GridBase extends Panel {
|
|
|
37094
36793
|
* @param {object} event Event object
|
|
37095
36794
|
* @param {PdfExportConfig} event.config Export config
|
|
37096
36795
|
*/
|
|
37097
|
-
onBeforePdfExport: ((event: { config: PdfExportConfig }) =>
|
|
36796
|
+
onBeforePdfExport: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
37098
36797
|
/**
|
|
37099
36798
|
* Fires before a row is rendered.
|
|
37100
36799
|
* @param {object} event Event object
|
|
@@ -37137,26 +36836,26 @@ export class GridBase extends Panel {
|
|
|
37137
36836
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
37138
36837
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
37139
36838
|
*/
|
|
37140
|
-
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
36839
|
+
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
36840
|
/**
|
|
37142
36841
|
* Fires on the owning Grid before editing starts, return `false` to prevent editing
|
|
37143
36842
|
* @param {object} event Event object
|
|
37144
36843
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
37145
36844
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
37146
36845
|
*/
|
|
37147
|
-
onBeforeStartRowEdit: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
36846
|
+
onBeforeStartRowEdit: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
37148
36847
|
/**
|
|
37149
36848
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
37150
36849
|
* @param {object} event Event object
|
|
37151
36850
|
* @param {GridStateInfo} event.state State object config
|
|
37152
36851
|
*/
|
|
37153
|
-
onBeforeStateApply: ((event: { state: GridStateInfo }) =>
|
|
36852
|
+
onBeforeStateApply: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
37154
36853
|
/**
|
|
37155
36854
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
37156
36855
|
* @param {object} event Event object
|
|
37157
36856
|
* @param {GridStateInfo} event.state State object config
|
|
37158
36857
|
*/
|
|
37159
|
-
onBeforeStateSave: ((event: { state: GridStateInfo }) =>
|
|
36858
|
+
onBeforeStateSave: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
37160
36859
|
/**
|
|
37161
36860
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
37162
36861
|
* Returning `false` from a listener prevents the operation
|
|
@@ -37166,7 +36865,7 @@ export class GridBase extends Panel {
|
|
|
37166
36865
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
37167
36866
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
37168
36867
|
*/
|
|
37169
|
-
onBeforeToggleGroup: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
36868
|
+
onBeforeToggleGroup: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
37170
36869
|
/**
|
|
37171
36870
|
* Fired before a parent node record toggles its collapsed state.
|
|
37172
36871
|
* @param {object} event Event object
|
|
@@ -37235,7 +36934,7 @@ export class GridBase extends Panel {
|
|
|
37235
36934
|
* @param {Grid.column.Column} event.column Column
|
|
37236
36935
|
* @param {Core.data.Model} event.record Record
|
|
37237
36936
|
*/
|
|
37238
|
-
onCellMenuBeforeShow: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
36937
|
+
onCellMenuBeforeShow: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
37239
36938
|
/**
|
|
37240
36939
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
37241
36940
|
* @param {object} event Event object
|
|
@@ -37356,7 +37055,7 @@ export class GridBase extends Panel {
|
|
|
37356
37055
|
* @param {Event} event.event The browser event.
|
|
37357
37056
|
* @param {string} event.region The region where the column was dropped.
|
|
37358
37057
|
*/
|
|
37359
|
-
onColumnDrop: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
37058
|
+
onColumnDrop: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
37360
37059
|
/**
|
|
37361
37060
|
* This event is fired after a resize gesture is completed.
|
|
37362
37061
|
* @param {object} event Event object
|
|
@@ -37460,7 +37159,7 @@ export class GridBase extends Panel {
|
|
|
37460
37159
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
37461
37160
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
37462
37161
|
*/
|
|
37463
|
-
onFillHandleDragStart: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
37162
|
+
onFillHandleDragStart: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
37464
37163
|
/**
|
|
37465
37164
|
* Fires on the owning Grid when cell editing is finished
|
|
37466
37165
|
* @param {object} event Event object
|
|
@@ -37484,7 +37183,7 @@ export class GridBase extends Panel {
|
|
|
37484
37183
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
37485
37184
|
* @param {MouseEvent,TouchEvent} event.event
|
|
37486
37185
|
*/
|
|
37487
|
-
onGridRowBeforeDragStart: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
37186
|
+
onGridRowBeforeDragStart: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
37488
37187
|
/**
|
|
37489
37188
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
37490
37189
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -37551,7 +37250,7 @@ export class GridBase extends Panel {
|
|
|
37551
37250
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
37552
37251
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
37553
37252
|
*/
|
|
37554
|
-
onHeaderClick: ((event: { domEvent: Event, column: Column }) =>
|
|
37253
|
+
onHeaderClick: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
37555
37254
|
/**
|
|
37556
37255
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
37557
37256
|
* 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 +37261,7 @@ export class GridBase extends Panel {
|
|
|
37562
37261
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
37563
37262
|
* @param {Grid.column.Column} event.column Column
|
|
37564
37263
|
*/
|
|
37565
|
-
onHeaderMenuBeforeShow: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
37264
|
+
onHeaderMenuBeforeShow: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
37566
37265
|
/**
|
|
37567
37266
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
37568
37267
|
* @param {object} event Event object
|
|
@@ -37731,7 +37430,7 @@ export class GridBase extends Panel {
|
|
|
37731
37430
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
37732
37431
|
* @param {Event} event.domEvent The native DOM event
|
|
37733
37432
|
*/
|
|
37734
|
-
onSplitterCollapseClick: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
37433
|
+
onSplitterCollapseClick: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
37735
37434
|
/**
|
|
37736
37435
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
37737
37436
|
* @param {object} event Event object
|
|
@@ -37756,7 +37455,7 @@ export class GridBase extends Panel {
|
|
|
37756
37455
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
37757
37456
|
* @param {Event} event.domEvent The native DOM event
|
|
37758
37457
|
*/
|
|
37759
|
-
onSplitterExpandClick: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
37458
|
+
onSplitterExpandClick: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
37760
37459
|
/**
|
|
37761
37460
|
* Fires on the owning Grid when editing starts
|
|
37762
37461
|
* @param {object} event Event object
|
|
@@ -38408,7 +38107,7 @@ type SubGridListenersTypes = {
|
|
|
38408
38107
|
* @param {object} event Event object
|
|
38409
38108
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
38410
38109
|
*/
|
|
38411
|
-
beforeHide: (event: { source: Widget }) =>
|
|
38110
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
38412
38111
|
/**
|
|
38413
38112
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
38414
38113
|
* @param {object} event Event object
|
|
@@ -38538,7 +38237,7 @@ type SubGridListeners = {
|
|
|
38538
38237
|
* @param {object} event Event object
|
|
38539
38238
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
38540
38239
|
*/
|
|
38541
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
38240
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
38542
38241
|
/**
|
|
38543
38242
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
38544
38243
|
* @param {object} event Event object
|
|
@@ -39027,7 +38726,7 @@ type SubGridConfig = {
|
|
|
39027
38726
|
* @param {object} event Event object
|
|
39028
38727
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
39029
38728
|
*/
|
|
39030
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
38729
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
39031
38730
|
/**
|
|
39032
38731
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
39033
38732
|
* @param {object} event Event object
|
|
@@ -39261,14 +38960,14 @@ type TreeGridListenersTypes = {
|
|
|
39261
38960
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
39262
38961
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
39263
38962
|
*/
|
|
39264
|
-
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
38963
|
+
beforeCSVExport: (event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void
|
|
39265
38964
|
/**
|
|
39266
38965
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
39267
38966
|
* @param {object} event Event object
|
|
39268
38967
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
39269
38968
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
39270
38969
|
*/
|
|
39271
|
-
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) =>
|
|
38970
|
+
beforeCancelCellEdit: (event: { source: Grid, editorContext: GridLocation }) => boolean|void
|
|
39272
38971
|
/**
|
|
39273
38972
|
* 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
38973
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeCancelRowEdit)
|
|
@@ -39283,7 +38982,7 @@ type TreeGridListenersTypes = {
|
|
|
39283
38982
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
39284
38983
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
39285
38984
|
*/
|
|
39286
|
-
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
38985
|
+
beforeCellEditStart: (event: { source: Grid, editorContext: CellEditorContext }) => boolean|void
|
|
39287
38986
|
/**
|
|
39288
38987
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
39289
38988
|
* 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 +38990,7 @@ type TreeGridListenersTypes = {
|
|
|
39291
38990
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
39292
38991
|
* @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
38992
|
*/
|
|
39294
|
-
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
38993
|
+
beforeCellRangeDelete: (event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void
|
|
39295
38994
|
/**
|
|
39296
38995
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
39297
38996
|
* @param {object} event Event object
|
|
@@ -39299,7 +38998,7 @@ type TreeGridListenersTypes = {
|
|
|
39299
38998
|
* @param {string} event.field The field being changed
|
|
39300
38999
|
* @param {any} event.value The value being set
|
|
39301
39000
|
*/
|
|
39302
|
-
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) =>
|
|
39001
|
+
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => boolean|void
|
|
39303
39002
|
/**
|
|
39304
39003
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
39305
39004
|
* @param {object} event Event object
|
|
@@ -39315,7 +39014,7 @@ type TreeGridListenersTypes = {
|
|
|
39315
39014
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
39316
39015
|
* @param {Event} event.event The browser event.
|
|
39317
39016
|
*/
|
|
39318
|
-
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) =>
|
|
39017
|
+
beforeColumnDragStart: (event: { source: Grid, column: Column, event: Event }) => boolean|void
|
|
39319
39018
|
/**
|
|
39320
39019
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
39321
39020
|
* @param {object} event Event object
|
|
@@ -39326,7 +39025,7 @@ type TreeGridListenersTypes = {
|
|
|
39326
39025
|
* @param {Event} event.event The browser event.
|
|
39327
39026
|
* @param {string} event.region The region where the column was dropped.
|
|
39328
39027
|
*/
|
|
39329
|
-
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
39028
|
+
beforeColumnDropFinalize: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void
|
|
39330
39029
|
/**
|
|
39331
39030
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
39332
39031
|
* `false`.
|
|
@@ -39335,7 +39034,7 @@ type TreeGridListenersTypes = {
|
|
|
39335
39034
|
* @param {Grid.column.Column} event.column The column
|
|
39336
39035
|
* @param {Event} event.domEvent The browser event
|
|
39337
39036
|
*/
|
|
39338
|
-
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
39037
|
+
beforeColumnResize: (event: { source: Grid, column: Column, domEvent: Event }) => boolean|void
|
|
39339
39038
|
/**
|
|
39340
39039
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
39341
39040
|
* @param {object} event Event object
|
|
@@ -39359,14 +39058,14 @@ type TreeGridListenersTypes = {
|
|
|
39359
39058
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
39360
39059
|
* @param {any[][]} event.rows An array of records to export
|
|
39361
39060
|
*/
|
|
39362
|
-
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
39061
|
+
beforeExcelExport: (event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void
|
|
39363
39062
|
/**
|
|
39364
39063
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
39365
39064
|
* @param {object} event Event object
|
|
39366
39065
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
39367
39066
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
39368
39067
|
*/
|
|
39369
|
-
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
39068
|
+
beforeFillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
39370
39069
|
/**
|
|
39371
39070
|
* 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
39071
|
* @param {object} event Event object
|
|
@@ -39387,7 +39086,7 @@ type TreeGridListenersTypes = {
|
|
|
39387
39086
|
* @param {object} event Event object
|
|
39388
39087
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
39389
39088
|
*/
|
|
39390
|
-
beforeHide: (event: { source: Widget }) =>
|
|
39089
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
39391
39090
|
/**
|
|
39392
39091
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
39393
39092
|
* @param {object} event Event object
|
|
@@ -39403,7 +39102,7 @@ type TreeGridListenersTypes = {
|
|
|
39403
39102
|
* @param {object} event Event object
|
|
39404
39103
|
* @param {PdfExportConfig} event.config Export config
|
|
39405
39104
|
*/
|
|
39406
|
-
beforePdfExport: (event: { config: PdfExportConfig }) =>
|
|
39105
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => boolean|void
|
|
39407
39106
|
/**
|
|
39408
39107
|
* Fires before a row is rendered.
|
|
39409
39108
|
* @param {object} event Event object
|
|
@@ -39446,7 +39145,7 @@ type TreeGridListenersTypes = {
|
|
|
39446
39145
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
39447
39146
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
39448
39147
|
*/
|
|
39449
|
-
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
39148
|
+
beforeSelectionChange: (event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void
|
|
39450
39149
|
/**
|
|
39451
39150
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
39452
39151
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -39467,19 +39166,19 @@ type TreeGridListenersTypes = {
|
|
|
39467
39166
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
39468
39167
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
39469
39168
|
*/
|
|
39470
|
-
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
39169
|
+
beforeStartRowEdit: (event: { source: Grid, editorContext: RowEditorContext }) => boolean|void
|
|
39471
39170
|
/**
|
|
39472
39171
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
39473
39172
|
* @param {object} event Event object
|
|
39474
39173
|
* @param {GridStateInfo} event.state State object config
|
|
39475
39174
|
*/
|
|
39476
|
-
beforeStateApply: (event: { state: GridStateInfo }) =>
|
|
39175
|
+
beforeStateApply: (event: { state: GridStateInfo }) => boolean|void
|
|
39477
39176
|
/**
|
|
39478
39177
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
39479
39178
|
* @param {object} event Event object
|
|
39480
39179
|
* @param {GridStateInfo} event.state State object config
|
|
39481
39180
|
*/
|
|
39482
|
-
beforeStateSave: (event: { state: GridStateInfo }) =>
|
|
39181
|
+
beforeStateSave: (event: { state: GridStateInfo }) => boolean|void
|
|
39483
39182
|
/**
|
|
39484
39183
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
39485
39184
|
* Returning `false` from a listener prevents the operation
|
|
@@ -39489,7 +39188,7 @@ type TreeGridListenersTypes = {
|
|
|
39489
39188
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
39490
39189
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
39491
39190
|
*/
|
|
39492
|
-
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
39191
|
+
beforeToggleGroup: (event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void
|
|
39493
39192
|
/**
|
|
39494
39193
|
* Fired before a parent node record toggles its collapsed state.
|
|
39495
39194
|
* @param {object} event Event object
|
|
@@ -39558,7 +39257,7 @@ type TreeGridListenersTypes = {
|
|
|
39558
39257
|
* @param {Grid.column.Column} event.column Column
|
|
39559
39258
|
* @param {Core.data.Model} event.record Record
|
|
39560
39259
|
*/
|
|
39561
|
-
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
39260
|
+
cellMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void
|
|
39562
39261
|
/**
|
|
39563
39262
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
39564
39263
|
* @param {object} event Event object
|
|
@@ -39685,7 +39384,7 @@ type TreeGridListenersTypes = {
|
|
|
39685
39384
|
* @param {Event} event.event The browser event.
|
|
39686
39385
|
* @param {string} event.region The region where the column was dropped.
|
|
39687
39386
|
*/
|
|
39688
|
-
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
39387
|
+
columnDrop: (event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void
|
|
39689
39388
|
/**
|
|
39690
39389
|
* This event is fired after a resize gesture is completed.
|
|
39691
39390
|
* @param {object} event Event object
|
|
@@ -39825,7 +39524,7 @@ type TreeGridListenersTypes = {
|
|
|
39825
39524
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
39826
39525
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
39827
39526
|
*/
|
|
39828
|
-
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
39527
|
+
fillHandleDragStart: (event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void
|
|
39829
39528
|
/**
|
|
39830
39529
|
* Fires on the owning Grid when cell editing is finished
|
|
39831
39530
|
* @param {object} event Event object
|
|
@@ -39873,7 +39572,7 @@ type TreeGridListenersTypes = {
|
|
|
39873
39572
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
39874
39573
|
* @param {MouseEvent,TouchEvent} event.event
|
|
39875
39574
|
*/
|
|
39876
|
-
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
39575
|
+
gridRowBeforeDragStart: (event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void
|
|
39877
39576
|
/**
|
|
39878
39577
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
39879
39578
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -39940,7 +39639,7 @@ type TreeGridListenersTypes = {
|
|
|
39940
39639
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
39941
39640
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
39942
39641
|
*/
|
|
39943
|
-
headerClick: (event: { domEvent: Event, column: Column }) =>
|
|
39642
|
+
headerClick: (event: { domEvent: Event, column: Column }) => boolean|void
|
|
39944
39643
|
/**
|
|
39945
39644
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
39946
39645
|
* 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 +39650,7 @@ type TreeGridListenersTypes = {
|
|
|
39951
39650
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
39952
39651
|
* @param {Grid.column.Column} event.column Column
|
|
39953
39652
|
*/
|
|
39954
|
-
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
39653
|
+
headerMenuBeforeShow: (event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void
|
|
39955
39654
|
/**
|
|
39956
39655
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
39957
39656
|
* @param {object} event Event object
|
|
@@ -40162,7 +39861,7 @@ type TreeGridListenersTypes = {
|
|
|
40162
39861
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
40163
39862
|
* @param {Event} event.domEvent The native DOM event
|
|
40164
39863
|
*/
|
|
40165
|
-
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
39864
|
+
splitterCollapseClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
40166
39865
|
/**
|
|
40167
39866
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
40168
39867
|
* @param {object} event Event object
|
|
@@ -40187,7 +39886,7 @@ type TreeGridListenersTypes = {
|
|
|
40187
39886
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
40188
39887
|
* @param {Event} event.domEvent The native DOM event
|
|
40189
39888
|
*/
|
|
40190
|
-
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
39889
|
+
splitterExpandClick: (event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void
|
|
40191
39890
|
/**
|
|
40192
39891
|
* Fires on the owning Grid when editing starts
|
|
40193
39892
|
* @param {object} event Event object
|
|
@@ -40276,14 +39975,14 @@ type TreeGridListeners = {
|
|
|
40276
39975
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
40277
39976
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
40278
39977
|
*/
|
|
40279
|
-
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
39978
|
+
beforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
40280
39979
|
/**
|
|
40281
39980
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
40282
39981
|
* @param {object} event Event object
|
|
40283
39982
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
40284
39983
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
40285
39984
|
*/
|
|
40286
|
-
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
39985
|
+
beforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
40287
39986
|
/**
|
|
40288
39987
|
* 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
39988
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeCancelRowEdit)
|
|
@@ -40298,7 +39997,7 @@ type TreeGridListeners = {
|
|
|
40298
39997
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
40299
39998
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
40300
39999
|
*/
|
|
40301
|
-
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
40000
|
+
beforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
40302
40001
|
/**
|
|
40303
40002
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
40304
40003
|
* 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 +40005,7 @@ type TreeGridListeners = {
|
|
|
40306
40005
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
40307
40006
|
* @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
40007
|
*/
|
|
40309
|
-
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
40008
|
+
beforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
40310
40009
|
/**
|
|
40311
40010
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
40312
40011
|
* @param {object} event Event object
|
|
@@ -40314,7 +40013,7 @@ type TreeGridListeners = {
|
|
|
40314
40013
|
* @param {string} event.field The field being changed
|
|
40315
40014
|
* @param {any} event.value The value being set
|
|
40316
40015
|
*/
|
|
40317
|
-
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
40016
|
+
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
40318
40017
|
/**
|
|
40319
40018
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
40320
40019
|
* @param {object} event Event object
|
|
@@ -40330,7 +40029,7 @@ type TreeGridListeners = {
|
|
|
40330
40029
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
40331
40030
|
* @param {Event} event.event The browser event.
|
|
40332
40031
|
*/
|
|
40333
|
-
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
40032
|
+
beforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
40334
40033
|
/**
|
|
40335
40034
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
40336
40035
|
* @param {object} event Event object
|
|
@@ -40341,7 +40040,7 @@ type TreeGridListeners = {
|
|
|
40341
40040
|
* @param {Event} event.event The browser event.
|
|
40342
40041
|
* @param {string} event.region The region where the column was dropped.
|
|
40343
40042
|
*/
|
|
40344
|
-
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
40043
|
+
beforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
40345
40044
|
/**
|
|
40346
40045
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
40347
40046
|
* `false`.
|
|
@@ -40350,7 +40049,7 @@ type TreeGridListeners = {
|
|
|
40350
40049
|
* @param {Grid.column.Column} event.column The column
|
|
40351
40050
|
* @param {Event} event.domEvent The browser event
|
|
40352
40051
|
*/
|
|
40353
|
-
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
40052
|
+
beforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
40354
40053
|
/**
|
|
40355
40054
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
40356
40055
|
* @param {object} event Event object
|
|
@@ -40374,14 +40073,14 @@ type TreeGridListeners = {
|
|
|
40374
40073
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
40375
40074
|
* @param {any[][]} event.rows An array of records to export
|
|
40376
40075
|
*/
|
|
40377
|
-
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
40076
|
+
beforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
40378
40077
|
/**
|
|
40379
40078
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
40380
40079
|
* @param {object} event Event object
|
|
40381
40080
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
40382
40081
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
40383
40082
|
*/
|
|
40384
|
-
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
40083
|
+
beforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
40385
40084
|
/**
|
|
40386
40085
|
* 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
40086
|
* @param {object} event Event object
|
|
@@ -40402,7 +40101,7 @@ type TreeGridListeners = {
|
|
|
40402
40101
|
* @param {object} event Event object
|
|
40403
40102
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
40404
40103
|
*/
|
|
40405
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
40104
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
40406
40105
|
/**
|
|
40407
40106
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
40408
40107
|
* @param {object} event Event object
|
|
@@ -40418,7 +40117,7 @@ type TreeGridListeners = {
|
|
|
40418
40117
|
* @param {object} event Event object
|
|
40419
40118
|
* @param {PdfExportConfig} event.config Export config
|
|
40420
40119
|
*/
|
|
40421
|
-
beforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
40120
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
40422
40121
|
/**
|
|
40423
40122
|
* Fires before a row is rendered.
|
|
40424
40123
|
* @param {object} event Event object
|
|
@@ -40461,7 +40160,7 @@ type TreeGridListeners = {
|
|
|
40461
40160
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
40462
40161
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
40463
40162
|
*/
|
|
40464
|
-
beforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
40163
|
+
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
40164
|
/**
|
|
40466
40165
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
40467
40166
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -40482,19 +40181,19 @@ type TreeGridListeners = {
|
|
|
40482
40181
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
40483
40182
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
40484
40183
|
*/
|
|
40485
|
-
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
40184
|
+
beforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
40486
40185
|
/**
|
|
40487
40186
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
40488
40187
|
* @param {object} event Event object
|
|
40489
40188
|
* @param {GridStateInfo} event.state State object config
|
|
40490
40189
|
*/
|
|
40491
|
-
beforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
40190
|
+
beforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
40492
40191
|
/**
|
|
40493
40192
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
40494
40193
|
* @param {object} event Event object
|
|
40495
40194
|
* @param {GridStateInfo} event.state State object config
|
|
40496
40195
|
*/
|
|
40497
|
-
beforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
40196
|
+
beforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
40498
40197
|
/**
|
|
40499
40198
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
40500
40199
|
* Returning `false` from a listener prevents the operation
|
|
@@ -40504,7 +40203,7 @@ type TreeGridListeners = {
|
|
|
40504
40203
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
40505
40204
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
40506
40205
|
*/
|
|
40507
|
-
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
40206
|
+
beforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
40508
40207
|
/**
|
|
40509
40208
|
* Fired before a parent node record toggles its collapsed state.
|
|
40510
40209
|
* @param {object} event Event object
|
|
@@ -40573,7 +40272,7 @@ type TreeGridListeners = {
|
|
|
40573
40272
|
* @param {Grid.column.Column} event.column Column
|
|
40574
40273
|
* @param {Core.data.Model} event.record Record
|
|
40575
40274
|
*/
|
|
40576
|
-
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
40275
|
+
cellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
40577
40276
|
/**
|
|
40578
40277
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
40579
40278
|
* @param {object} event Event object
|
|
@@ -40700,7 +40399,7 @@ type TreeGridListeners = {
|
|
|
40700
40399
|
* @param {Event} event.event The browser event.
|
|
40701
40400
|
* @param {string} event.region The region where the column was dropped.
|
|
40702
40401
|
*/
|
|
40703
|
-
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
40402
|
+
columnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
40704
40403
|
/**
|
|
40705
40404
|
* This event is fired after a resize gesture is completed.
|
|
40706
40405
|
* @param {object} event Event object
|
|
@@ -40840,7 +40539,7 @@ type TreeGridListeners = {
|
|
|
40840
40539
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
40841
40540
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
40842
40541
|
*/
|
|
40843
|
-
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
40542
|
+
fillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
40844
40543
|
/**
|
|
40845
40544
|
* Fires on the owning Grid when cell editing is finished
|
|
40846
40545
|
* @param {object} event Event object
|
|
@@ -40888,7 +40587,7 @@ type TreeGridListeners = {
|
|
|
40888
40587
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
40889
40588
|
* @param {MouseEvent,TouchEvent} event.event
|
|
40890
40589
|
*/
|
|
40891
|
-
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
40590
|
+
gridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
40892
40591
|
/**
|
|
40893
40592
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
40894
40593
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -40955,7 +40654,7 @@ type TreeGridListeners = {
|
|
|
40955
40654
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
40956
40655
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
40957
40656
|
*/
|
|
40958
|
-
headerClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
40657
|
+
headerClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
40959
40658
|
/**
|
|
40960
40659
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
40961
40660
|
* 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 +40665,7 @@ type TreeGridListeners = {
|
|
|
40966
40665
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
40967
40666
|
* @param {Grid.column.Column} event.column Column
|
|
40968
40667
|
*/
|
|
40969
|
-
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
40668
|
+
headerMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
40970
40669
|
/**
|
|
40971
40670
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
40972
40671
|
* @param {object} event Event object
|
|
@@ -41177,7 +40876,7 @@ type TreeGridListeners = {
|
|
|
41177
40876
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
41178
40877
|
* @param {Event} event.domEvent The native DOM event
|
|
41179
40878
|
*/
|
|
41180
|
-
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
40879
|
+
splitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
41181
40880
|
/**
|
|
41182
40881
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
41183
40882
|
* @param {object} event Event object
|
|
@@ -41202,7 +40901,7 @@ type TreeGridListeners = {
|
|
|
41202
40901
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
41203
40902
|
* @param {Event} event.domEvent The native DOM event
|
|
41204
40903
|
*/
|
|
41205
|
-
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
40904
|
+
splitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
41206
40905
|
/**
|
|
41207
40906
|
* Fires on the owning Grid when editing starts
|
|
41208
40907
|
* @param {object} event Event object
|
|
@@ -41400,6 +41099,8 @@ type TreeGridConfig = {
|
|
|
41400
41099
|
/**
|
|
41401
41100
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
41402
41101
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
41102
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
41103
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-appendTo)
|
|
41403
41104
|
*/
|
|
41404
41105
|
appendTo?: HTMLElement|string
|
|
41405
41106
|
/**
|
|
@@ -41714,10 +41415,14 @@ type TreeGridConfig = {
|
|
|
41714
41415
|
inputFieldAlign?: 'start'|'end'
|
|
41715
41416
|
/**
|
|
41716
41417
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
41418
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
41419
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-insertBefore)
|
|
41717
41420
|
*/
|
|
41718
41421
|
insertBefore?: HTMLElement|string
|
|
41719
41422
|
/**
|
|
41720
41423
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
41424
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
41425
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-insertFirst)
|
|
41721
41426
|
*/
|
|
41722
41427
|
insertFirst?: HTMLElement|string
|
|
41723
41428
|
/**
|
|
@@ -42086,14 +41791,14 @@ type TreeGridConfig = {
|
|
|
42086
41791
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
42087
41792
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
42088
41793
|
*/
|
|
42089
|
-
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
41794
|
+
onBeforeCSVExport?: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
42090
41795
|
/**
|
|
42091
41796
|
* Fires on the owning Grid before the cell editing is canceled, return `false` to prevent cancellation.
|
|
42092
41797
|
* @param {object} event Event object
|
|
42093
41798
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
42094
41799
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
42095
41800
|
*/
|
|
42096
|
-
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
41801
|
+
onBeforeCancelCellEdit?: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
42097
41802
|
/**
|
|
42098
41803
|
* 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
41804
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeCancelRowEdit)
|
|
@@ -42108,7 +41813,7 @@ type TreeGridConfig = {
|
|
|
42108
41813
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
42109
41814
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
42110
41815
|
*/
|
|
42111
|
-
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
41816
|
+
onBeforeCellEditStart?: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
42112
41817
|
/**
|
|
42113
41818
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
42114
41819
|
* 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 +41821,7 @@ type TreeGridConfig = {
|
|
|
42116
41821
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
42117
41822
|
* @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
41823
|
*/
|
|
42119
|
-
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
41824
|
+
onBeforeCellRangeDelete?: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
42120
41825
|
/**
|
|
42121
41826
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
42122
41827
|
* @param {object} event Event object
|
|
@@ -42124,7 +41829,7 @@ type TreeGridConfig = {
|
|
|
42124
41829
|
* @param {string} event.field The field being changed
|
|
42125
41830
|
* @param {any} event.value The value being set
|
|
42126
41831
|
*/
|
|
42127
|
-
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) =>
|
|
41832
|
+
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
42128
41833
|
/**
|
|
42129
41834
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
42130
41835
|
* @param {object} event Event object
|
|
@@ -42140,7 +41845,7 @@ type TreeGridConfig = {
|
|
|
42140
41845
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
42141
41846
|
* @param {Event} event.event The browser event.
|
|
42142
41847
|
*/
|
|
42143
|
-
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) =>
|
|
41848
|
+
onBeforeColumnDragStart?: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
42144
41849
|
/**
|
|
42145
41850
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
42146
41851
|
* @param {object} event Event object
|
|
@@ -42151,7 +41856,7 @@ type TreeGridConfig = {
|
|
|
42151
41856
|
* @param {Event} event.event The browser event.
|
|
42152
41857
|
* @param {string} event.region The region where the column was dropped.
|
|
42153
41858
|
*/
|
|
42154
|
-
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
41859
|
+
onBeforeColumnDropFinalize?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
42155
41860
|
/**
|
|
42156
41861
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
42157
41862
|
* `false`.
|
|
@@ -42160,7 +41865,7 @@ type TreeGridConfig = {
|
|
|
42160
41865
|
* @param {Grid.column.Column} event.column The column
|
|
42161
41866
|
* @param {Event} event.domEvent The browser event
|
|
42162
41867
|
*/
|
|
42163
|
-
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
41868
|
+
onBeforeColumnResize?: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
42164
41869
|
/**
|
|
42165
41870
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
42166
41871
|
* @param {object} event Event object
|
|
@@ -42184,14 +41889,14 @@ type TreeGridConfig = {
|
|
|
42184
41889
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
42185
41890
|
* @param {any[][]} event.rows An array of records to export
|
|
42186
41891
|
*/
|
|
42187
|
-
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
41892
|
+
onBeforeExcelExport?: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
42188
41893
|
/**
|
|
42189
41894
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
42190
41895
|
* @param {object} event Event object
|
|
42191
41896
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
42192
41897
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
42193
41898
|
*/
|
|
42194
|
-
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
41899
|
+
onBeforeFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
42195
41900
|
/**
|
|
42196
41901
|
* 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
41902
|
* @param {object} event Event object
|
|
@@ -42212,7 +41917,7 @@ type TreeGridConfig = {
|
|
|
42212
41917
|
* @param {object} event Event object
|
|
42213
41918
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
42214
41919
|
*/
|
|
42215
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
41920
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
42216
41921
|
/**
|
|
42217
41922
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
42218
41923
|
* @param {object} event Event object
|
|
@@ -42228,7 +41933,7 @@ type TreeGridConfig = {
|
|
|
42228
41933
|
* @param {object} event Event object
|
|
42229
41934
|
* @param {PdfExportConfig} event.config Export config
|
|
42230
41935
|
*/
|
|
42231
|
-
onBeforePdfExport?: ((event: { config: PdfExportConfig }) =>
|
|
41936
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
42232
41937
|
/**
|
|
42233
41938
|
* Fires before a row is rendered.
|
|
42234
41939
|
* @param {object} event Event object
|
|
@@ -42271,7 +41976,7 @@ type TreeGridConfig = {
|
|
|
42271
41976
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
42272
41977
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
42273
41978
|
*/
|
|
42274
|
-
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
41979
|
+
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
41980
|
/**
|
|
42276
41981
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
42277
41982
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -42292,19 +41997,19 @@ type TreeGridConfig = {
|
|
|
42292
41997
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
42293
41998
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
42294
41999
|
*/
|
|
42295
|
-
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
42000
|
+
onBeforeStartRowEdit?: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
42296
42001
|
/**
|
|
42297
42002
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
42298
42003
|
* @param {object} event Event object
|
|
42299
42004
|
* @param {GridStateInfo} event.state State object config
|
|
42300
42005
|
*/
|
|
42301
|
-
onBeforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
42006
|
+
onBeforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
42302
42007
|
/**
|
|
42303
42008
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
42304
42009
|
* @param {object} event Event object
|
|
42305
42010
|
* @param {GridStateInfo} event.state State object config
|
|
42306
42011
|
*/
|
|
42307
|
-
onBeforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
42012
|
+
onBeforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
42308
42013
|
/**
|
|
42309
42014
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
42310
42015
|
* Returning `false` from a listener prevents the operation
|
|
@@ -42314,7 +42019,7 @@ type TreeGridConfig = {
|
|
|
42314
42019
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
42315
42020
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
42316
42021
|
*/
|
|
42317
|
-
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
42022
|
+
onBeforeToggleGroup?: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
42318
42023
|
/**
|
|
42319
42024
|
* Fired before a parent node record toggles its collapsed state.
|
|
42320
42025
|
* @param {object} event Event object
|
|
@@ -42383,7 +42088,7 @@ type TreeGridConfig = {
|
|
|
42383
42088
|
* @param {Grid.column.Column} event.column Column
|
|
42384
42089
|
* @param {Core.data.Model} event.record Record
|
|
42385
42090
|
*/
|
|
42386
|
-
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
42091
|
+
onCellMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
42387
42092
|
/**
|
|
42388
42093
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
42389
42094
|
* @param {object} event Event object
|
|
@@ -42510,7 +42215,7 @@ type TreeGridConfig = {
|
|
|
42510
42215
|
* @param {Event} event.event The browser event.
|
|
42511
42216
|
* @param {string} event.region The region where the column was dropped.
|
|
42512
42217
|
*/
|
|
42513
|
-
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
42218
|
+
onColumnDrop?: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
42514
42219
|
/**
|
|
42515
42220
|
* This event is fired after a resize gesture is completed.
|
|
42516
42221
|
* @param {object} event Event object
|
|
@@ -42650,7 +42355,7 @@ type TreeGridConfig = {
|
|
|
42650
42355
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
42651
42356
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
42652
42357
|
*/
|
|
42653
|
-
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
42358
|
+
onFillHandleDragStart?: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
42654
42359
|
/**
|
|
42655
42360
|
* Fires on the owning Grid when cell editing is finished
|
|
42656
42361
|
* @param {object} event Event object
|
|
@@ -42698,7 +42403,7 @@ type TreeGridConfig = {
|
|
|
42698
42403
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
42699
42404
|
* @param {MouseEvent,TouchEvent} event.event
|
|
42700
42405
|
*/
|
|
42701
|
-
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
42406
|
+
onGridRowBeforeDragStart?: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
42702
42407
|
/**
|
|
42703
42408
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
42704
42409
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -42765,7 +42470,7 @@ type TreeGridConfig = {
|
|
|
42765
42470
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
42766
42471
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
42767
42472
|
*/
|
|
42768
|
-
onHeaderClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
42473
|
+
onHeaderClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
42769
42474
|
/**
|
|
42770
42475
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
42771
42476
|
* 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 +42481,7 @@ type TreeGridConfig = {
|
|
|
42776
42481
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
42777
42482
|
* @param {Grid.column.Column} event.column Column
|
|
42778
42483
|
*/
|
|
42779
|
-
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
42484
|
+
onHeaderMenuBeforeShow?: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
42780
42485
|
/**
|
|
42781
42486
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
42782
42487
|
* @param {object} event Event object
|
|
@@ -42987,7 +42692,7 @@ type TreeGridConfig = {
|
|
|
42987
42692
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
42988
42693
|
* @param {Event} event.domEvent The native DOM event
|
|
42989
42694
|
*/
|
|
42990
|
-
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
42695
|
+
onSplitterCollapseClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
42991
42696
|
/**
|
|
42992
42697
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
42993
42698
|
* @param {object} event Event object
|
|
@@ -43012,7 +42717,7 @@ type TreeGridConfig = {
|
|
|
43012
42717
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
43013
42718
|
* @param {Event} event.domEvent The native DOM event
|
|
43014
42719
|
*/
|
|
43015
|
-
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
42720
|
+
onSplitterExpandClick?: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
43016
42721
|
/**
|
|
43017
42722
|
* Fires on the owning Grid when editing starts
|
|
43018
42723
|
* @param {object} event Event object
|
|
@@ -43122,19 +42827,19 @@ export class TreeGrid extends Grid {
|
|
|
43122
42827
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
43123
42828
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
43124
42829
|
*/
|
|
43125
|
-
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
42830
|
+
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
42831
|
/**
|
|
43127
42832
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
43128
42833
|
* @param {object} event Event object
|
|
43129
42834
|
* @param {GridStateInfo} event.state State object config
|
|
43130
42835
|
*/
|
|
43131
|
-
onBeforeStateApply: ((event: { state: GridStateInfo }) =>
|
|
42836
|
+
onBeforeStateApply: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
43132
42837
|
/**
|
|
43133
42838
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
43134
42839
|
* @param {object} event Event object
|
|
43135
42840
|
* @param {GridStateInfo} event.state State object config
|
|
43136
42841
|
*/
|
|
43137
|
-
onBeforeStateSave: ((event: { state: GridStateInfo }) =>
|
|
42842
|
+
onBeforeStateSave: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
43138
42843
|
/**
|
|
43139
42844
|
* Fires when any other event is fired from the object.
|
|
43140
42845
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-catchAll)
|
|
@@ -43240,7 +42945,7 @@ export class TreeGrid extends Grid {
|
|
|
43240
42945
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
43241
42946
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
43242
42947
|
*/
|
|
43243
|
-
onHeaderClick: ((event: { domEvent: Event, column: Column }) =>
|
|
42948
|
+
onHeaderClick: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
43244
42949
|
/**
|
|
43245
42950
|
* Mouse moved out from element in grid
|
|
43246
42951
|
* @param {object} event Event object
|
|
@@ -43354,7 +43059,7 @@ type ExportDialogListenersTypes = {
|
|
|
43354
43059
|
* @param {object} event Event object
|
|
43355
43060
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
43356
43061
|
*/
|
|
43357
|
-
beforeHide: (event: { source: Widget }) =>
|
|
43062
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
43358
43063
|
/**
|
|
43359
43064
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
43360
43065
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -43374,13 +43079,13 @@ type ExportDialogListenersTypes = {
|
|
|
43374
43079
|
* @param {object} event Event object
|
|
43375
43080
|
* @param {any} event.state State object config
|
|
43376
43081
|
*/
|
|
43377
|
-
beforeStateApply: (event: { state: any }) =>
|
|
43082
|
+
beforeStateApply: (event: { state: any }) => boolean|void
|
|
43378
43083
|
/**
|
|
43379
43084
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
43380
43085
|
* @param {object} event Event object
|
|
43381
43086
|
* @param {any} event.state State object config
|
|
43382
43087
|
*/
|
|
43383
|
-
beforeStateSave: (event: { state: any }) =>
|
|
43088
|
+
beforeStateSave: (event: { state: any }) => boolean|void
|
|
43384
43089
|
/**
|
|
43385
43090
|
* Fires when cancel button is clicked. Popup will hide itself.
|
|
43386
43091
|
*/
|
|
@@ -43531,7 +43236,7 @@ type ExportDialogListeners = {
|
|
|
43531
43236
|
* @param {object} event Event object
|
|
43532
43237
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
43533
43238
|
*/
|
|
43534
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
43239
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
43535
43240
|
/**
|
|
43536
43241
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
43537
43242
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -43551,13 +43256,13 @@ type ExportDialogListeners = {
|
|
|
43551
43256
|
* @param {object} event Event object
|
|
43552
43257
|
* @param {any} event.state State object config
|
|
43553
43258
|
*/
|
|
43554
|
-
beforeStateApply?: ((event: { state: any }) =>
|
|
43259
|
+
beforeStateApply?: ((event: { state: any }) => boolean|void)|string
|
|
43555
43260
|
/**
|
|
43556
43261
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
43557
43262
|
* @param {object} event Event object
|
|
43558
43263
|
* @param {any} event.state State object config
|
|
43559
43264
|
*/
|
|
43560
|
-
beforeStateSave?: ((event: { state: any }) =>
|
|
43265
|
+
beforeStateSave?: ((event: { state: any }) => boolean|void)|string
|
|
43561
43266
|
/**
|
|
43562
43267
|
* Fires when cancel button is clicked. Popup will hide itself.
|
|
43563
43268
|
*/
|
|
@@ -43711,6 +43416,8 @@ type ExportDialogConfig = {
|
|
|
43711
43416
|
/**
|
|
43712
43417
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
43713
43418
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
43419
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
43420
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-appendTo)
|
|
43714
43421
|
*/
|
|
43715
43422
|
appendTo?: HTMLElement|string
|
|
43716
43423
|
/**
|
|
@@ -44012,10 +43719,14 @@ type ExportDialogConfig = {
|
|
|
44012
43719
|
inputFieldAlign?: 'start'|'end'
|
|
44013
43720
|
/**
|
|
44014
43721
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
43722
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
43723
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-insertBefore)
|
|
44015
43724
|
*/
|
|
44016
43725
|
insertBefore?: HTMLElement|string
|
|
44017
43726
|
/**
|
|
44018
43727
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
43728
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
43729
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog#config-insertFirst)
|
|
44019
43730
|
*/
|
|
44020
43731
|
insertFirst?: HTMLElement|string
|
|
44021
43732
|
/**
|
|
@@ -44423,7 +44134,7 @@ type ExportDialogConfig = {
|
|
|
44423
44134
|
* @param {object} event Event object
|
|
44424
44135
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
44425
44136
|
*/
|
|
44426
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
44137
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
44427
44138
|
/**
|
|
44428
44139
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
44429
44140
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -44443,13 +44154,13 @@ type ExportDialogConfig = {
|
|
|
44443
44154
|
* @param {object} event Event object
|
|
44444
44155
|
* @param {any} event.state State object config
|
|
44445
44156
|
*/
|
|
44446
|
-
onBeforeStateApply?: ((event: { state: any }) =>
|
|
44157
|
+
onBeforeStateApply?: ((event: { state: any }) => boolean|void)|string
|
|
44447
44158
|
/**
|
|
44448
44159
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
44449
44160
|
* @param {object} event Event object
|
|
44450
44161
|
* @param {any} event.state State object config
|
|
44451
44162
|
*/
|
|
44452
|
-
onBeforeStateSave?: ((event: { state: any }) =>
|
|
44163
|
+
onBeforeStateSave?: ((event: { state: any }) => boolean|void)|string
|
|
44453
44164
|
/**
|
|
44454
44165
|
* Fires when cancel button is clicked. Popup will hide itself.
|
|
44455
44166
|
*/
|
|
@@ -44608,13 +44319,13 @@ export class ExportDialog extends Popup {
|
|
|
44608
44319
|
* @param {object} event Event object
|
|
44609
44320
|
* @param {any} event.state State object config
|
|
44610
44321
|
*/
|
|
44611
|
-
onBeforeStateApply: ((event: { state: any }) =>
|
|
44322
|
+
onBeforeStateApply: ((event: { state: any }) => boolean|void)|string
|
|
44612
44323
|
/**
|
|
44613
44324
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
44614
44325
|
* @param {object} event Event object
|
|
44615
44326
|
* @param {any} event.state State object config
|
|
44616
44327
|
*/
|
|
44617
|
-
onBeforeStateSave: ((event: { state: any }) =>
|
|
44328
|
+
onBeforeStateSave: ((event: { state: any }) => boolean|void)|string
|
|
44618
44329
|
/**
|
|
44619
44330
|
* Fires when cancel button is clicked. Popup will hide itself.
|
|
44620
44331
|
*/
|
|
@@ -44745,7 +44456,7 @@ type GridElementEventsClassConfig = {
|
|
|
44745
44456
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
44746
44457
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
44747
44458
|
*/
|
|
44748
|
-
onHeaderClick?: ((event: { domEvent: Event, column: Column }) =>
|
|
44459
|
+
onHeaderClick?: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
44749
44460
|
/**
|
|
44750
44461
|
* Mouse moved out from element in grid
|
|
44751
44462
|
* @param {object} event Event object
|
|
@@ -44883,7 +44594,7 @@ export class GridElementEventsClass {
|
|
|
44883
44594
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
44884
44595
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
44885
44596
|
*/
|
|
44886
|
-
onHeaderClick: ((event: { domEvent: Event, column: Column }) =>
|
|
44597
|
+
onHeaderClick: ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
44887
44598
|
/**
|
|
44888
44599
|
* Mouse moved out from element in grid
|
|
44889
44600
|
* @param {object} event Event object
|
|
@@ -45039,7 +44750,7 @@ type GridSelectionClassConfig = {
|
|
|
45039
44750
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
45040
44751
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
45041
44752
|
*/
|
|
45042
|
-
onBeforeSelectionChange?: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
44753
|
+
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
44754
|
/**
|
|
45044
44755
|
* Fires while drag selecting. UI will update with current range, but the cells will not be selected until
|
|
45045
44756
|
* mouse up. This event can be listened for to perform actions while drag selecting.
|
|
@@ -45125,7 +44836,7 @@ export class GridSelectionClass {
|
|
|
45125
44836
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
45126
44837
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
45127
44838
|
*/
|
|
45128
|
-
onBeforeSelectionChange: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
44839
|
+
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
44840
|
/**
|
|
45130
44841
|
* Fires while drag selecting. UI will update with current range, but the cells will not be selected until
|
|
45131
44842
|
* mouse up. This event can be listened for to perform actions while drag selecting.
|
|
@@ -45283,13 +44994,13 @@ type GridStateClassConfig = {
|
|
|
45283
44994
|
* @param {object} event Event object
|
|
45284
44995
|
* @param {GridStateInfo} event.state State object config
|
|
45285
44996
|
*/
|
|
45286
|
-
onBeforeStateApply?: ((event: { state: GridStateInfo }) =>
|
|
44997
|
+
onBeforeStateApply?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
45287
44998
|
/**
|
|
45288
44999
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
45289
45000
|
* @param {object} event Event object
|
|
45290
45001
|
* @param {GridStateInfo} event.state State object config
|
|
45291
45002
|
*/
|
|
45292
|
-
onBeforeStateSave?: ((event: { state: GridStateInfo }) =>
|
|
45003
|
+
onBeforeStateSave?: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
45293
45004
|
}
|
|
45294
45005
|
|
|
45295
45006
|
export class GridStateClass {
|
|
@@ -45316,13 +45027,13 @@ export class GridStateClass {
|
|
|
45316
45027
|
* @param {object} event Event object
|
|
45317
45028
|
* @param {GridStateInfo} event.state State object config
|
|
45318
45029
|
*/
|
|
45319
|
-
onBeforeStateApply: ((event: { state: GridStateInfo }) =>
|
|
45030
|
+
onBeforeStateApply: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
45320
45031
|
/**
|
|
45321
45032
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
45322
45033
|
* @param {object} event Event object
|
|
45323
45034
|
* @param {GridStateInfo} event.state State object config
|
|
45324
45035
|
*/
|
|
45325
|
-
onBeforeStateSave: ((event: { state: GridStateInfo }) =>
|
|
45036
|
+
onBeforeStateSave: ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
45326
45037
|
/**
|
|
45327
45038
|
* Creates an instance of the class using the supplied configuration
|
|
45328
45039
|
* @param {GridStateClassConfig} [config]
|
|
@@ -45389,7 +45100,7 @@ type AIFilterFieldListenersTypes = {
|
|
|
45389
45100
|
* @param {object} event Event object
|
|
45390
45101
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
45391
45102
|
*/
|
|
45392
|
-
beforeHide: (event: { source: Widget }) =>
|
|
45103
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
45393
45104
|
/**
|
|
45394
45105
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
45395
45106
|
* @param {object} event Event object
|
|
@@ -45551,7 +45262,7 @@ type AIFilterFieldListeners = {
|
|
|
45551
45262
|
* @param {object} event Event object
|
|
45552
45263
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
45553
45264
|
*/
|
|
45554
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
45265
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
45555
45266
|
/**
|
|
45556
45267
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
45557
45268
|
* @param {object} event Event object
|
|
@@ -45710,6 +45421,8 @@ type AIFilterFieldConfig = {
|
|
|
45710
45421
|
/**
|
|
45711
45422
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
45712
45423
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
45424
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
45425
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-appendTo)
|
|
45713
45426
|
*/
|
|
45714
45427
|
appendTo?: HTMLElement|string
|
|
45715
45428
|
/**
|
|
@@ -45759,6 +45472,15 @@ type AIFilterFieldConfig = {
|
|
|
45759
45472
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
45760
45473
|
*/
|
|
45761
45474
|
centered?: boolean
|
|
45475
|
+
/**
|
|
45476
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
45477
|
+
* 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)
|
|
45478
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
45479
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-checkValidity)
|
|
45480
|
+
* @param {Core.widget.Field} field The field being validated
|
|
45481
|
+
* @returns {void}
|
|
45482
|
+
*/
|
|
45483
|
+
checkValidity?: ((field: Field) => void)|string
|
|
45762
45484
|
/**
|
|
45763
45485
|
* 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
45486
|
* 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
|
|
@@ -45965,10 +45687,14 @@ type AIFilterFieldConfig = {
|
|
|
45965
45687
|
inputWidth?: string|number
|
|
45966
45688
|
/**
|
|
45967
45689
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
45690
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
45691
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-insertBefore)
|
|
45968
45692
|
*/
|
|
45969
45693
|
insertBefore?: HTMLElement|string
|
|
45970
45694
|
/**
|
|
45971
45695
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
45696
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
45697
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-insertFirst)
|
|
45972
45698
|
*/
|
|
45973
45699
|
insertFirst?: HTMLElement|string
|
|
45974
45700
|
/**
|
|
@@ -46313,7 +46039,7 @@ type AIFilterFieldConfig = {
|
|
|
46313
46039
|
* @param {object} event Event object
|
|
46314
46040
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
46315
46041
|
*/
|
|
46316
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
46042
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
46317
46043
|
/**
|
|
46318
46044
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
46319
46045
|
* @param {object} event Event object
|
|
@@ -46510,7 +46236,7 @@ type ChecklistFilterComboListenersTypes = {
|
|
|
46510
46236
|
* @param {object} event Event object
|
|
46511
46237
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
46512
46238
|
*/
|
|
46513
|
-
beforeHide: (event: { source: Widget }) =>
|
|
46239
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
46514
46240
|
/**
|
|
46515
46241
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
46516
46242
|
* @param {object} event Event object
|
|
@@ -46678,7 +46404,7 @@ type ChecklistFilterComboListeners = {
|
|
|
46678
46404
|
* @param {object} event Event object
|
|
46679
46405
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
46680
46406
|
*/
|
|
46681
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
46407
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
46682
46408
|
/**
|
|
46683
46409
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
46684
46410
|
* @param {object} event Event object
|
|
@@ -46847,6 +46573,8 @@ type ChecklistFilterComboConfig = {
|
|
|
46847
46573
|
/**
|
|
46848
46574
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
46849
46575
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
46576
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
46577
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-appendTo)
|
|
46850
46578
|
*/
|
|
46851
46579
|
appendTo?: HTMLElement|string
|
|
46852
46580
|
/**
|
|
@@ -46909,6 +46637,15 @@ type ChecklistFilterComboConfig = {
|
|
|
46909
46637
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
46910
46638
|
*/
|
|
46911
46639
|
centered?: boolean
|
|
46640
|
+
/**
|
|
46641
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
46642
|
+
* 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)
|
|
46643
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
46644
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-checkValidity)
|
|
46645
|
+
* @param {Core.widget.Field} field The field being validated
|
|
46646
|
+
* @returns {void}
|
|
46647
|
+
*/
|
|
46648
|
+
checkValidity?: ((field: Field) => void)|string
|
|
46912
46649
|
/**
|
|
46913
46650
|
* A config object to configure the [ChipView](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView) to display the
|
|
46914
46651
|
* selected value set when [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
|
|
@@ -47200,10 +46937,14 @@ type ChecklistFilterComboConfig = {
|
|
|
47200
46937
|
inputWidth?: string|number
|
|
47201
46938
|
/**
|
|
47202
46939
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
46940
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
46941
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-insertBefore)
|
|
47203
46942
|
*/
|
|
47204
46943
|
insertBefore?: HTMLElement|string
|
|
47205
46944
|
/**
|
|
47206
46945
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
46946
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
46947
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-insertFirst)
|
|
47207
46948
|
*/
|
|
47208
46949
|
insertFirst?: HTMLElement|string
|
|
47209
46950
|
/**
|
|
@@ -47632,7 +47373,7 @@ type ChecklistFilterComboConfig = {
|
|
|
47632
47373
|
* @param {object} event Event object
|
|
47633
47374
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
47634
47375
|
*/
|
|
47635
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
47376
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
47636
47377
|
/**
|
|
47637
47378
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
47638
47379
|
* @param {object} event Event object
|
|
@@ -47841,7 +47582,7 @@ type GridChartDesignerListenersTypes = {
|
|
|
47841
47582
|
* @param {object} event Event object
|
|
47842
47583
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
47843
47584
|
*/
|
|
47844
|
-
beforeHide: (event: { source: Widget }) =>
|
|
47585
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
47845
47586
|
/**
|
|
47846
47587
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
47847
47588
|
* @param {object} event Event object
|
|
@@ -47955,7 +47696,7 @@ type GridChartDesignerListeners = {
|
|
|
47955
47696
|
* @param {object} event Event object
|
|
47956
47697
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
47957
47698
|
*/
|
|
47958
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
47699
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
47959
47700
|
/**
|
|
47960
47701
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
47961
47702
|
* @param {object} event Event object
|
|
@@ -48080,6 +47821,8 @@ type GridChartDesignerConfig = {
|
|
|
48080
47821
|
/**
|
|
48081
47822
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
48082
47823
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
47824
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
47825
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-appendTo)
|
|
48083
47826
|
*/
|
|
48084
47827
|
appendTo?: HTMLElement|string
|
|
48085
47828
|
/**
|
|
@@ -48255,10 +47998,14 @@ type GridChartDesignerConfig = {
|
|
|
48255
47998
|
ignoreParentReadOnly?: boolean
|
|
48256
47999
|
/**
|
|
48257
48000
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
48001
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
48002
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-insertBefore)
|
|
48258
48003
|
*/
|
|
48259
48004
|
insertBefore?: HTMLElement|string
|
|
48260
48005
|
/**
|
|
48261
48006
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
48007
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
48008
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-insertFirst)
|
|
48262
48009
|
*/
|
|
48263
48010
|
insertFirst?: HTMLElement|string
|
|
48264
48011
|
/**
|
|
@@ -48497,7 +48244,7 @@ type GridChartDesignerConfig = {
|
|
|
48497
48244
|
* @param {object} event Event object
|
|
48498
48245
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
48499
48246
|
*/
|
|
48500
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
48247
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
48501
48248
|
/**
|
|
48502
48249
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
48503
48250
|
* @param {object} event Event object
|
|
@@ -48649,7 +48396,7 @@ type GridFieldFilterPickerListenersTypes = {
|
|
|
48649
48396
|
* @param {object} event Event object
|
|
48650
48397
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
48651
48398
|
*/
|
|
48652
|
-
beforeHide: (event: { source: Widget }) =>
|
|
48399
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
48653
48400
|
/**
|
|
48654
48401
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
48655
48402
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -48786,7 +48533,7 @@ type GridFieldFilterPickerListeners = {
|
|
|
48786
48533
|
* @param {object} event Event object
|
|
48787
48534
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
48788
48535
|
*/
|
|
48789
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
48536
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
48790
48537
|
/**
|
|
48791
48538
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
48792
48539
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -48941,6 +48688,8 @@ type GridFieldFilterPickerConfig = {
|
|
|
48941
48688
|
/**
|
|
48942
48689
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
48943
48690
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
48691
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
48692
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-appendTo)
|
|
48944
48693
|
*/
|
|
48945
48694
|
appendTo?: HTMLElement|string
|
|
48946
48695
|
/**
|
|
@@ -49175,10 +48924,14 @@ type GridFieldFilterPickerConfig = {
|
|
|
49175
48924
|
inputFieldAlign?: 'start'|'end'
|
|
49176
48925
|
/**
|
|
49177
48926
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
48927
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
48928
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-insertBefore)
|
|
49178
48929
|
*/
|
|
49179
48930
|
insertBefore?: HTMLElement|string
|
|
49180
48931
|
/**
|
|
49181
48932
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
48933
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
48934
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-insertFirst)
|
|
49182
48935
|
*/
|
|
49183
48936
|
insertFirst?: HTMLElement|string
|
|
49184
48937
|
/**
|
|
@@ -49513,7 +49266,7 @@ type GridFieldFilterPickerConfig = {
|
|
|
49513
49266
|
* @param {object} event Event object
|
|
49514
49267
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
49515
49268
|
*/
|
|
49516
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
49269
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
49517
49270
|
/**
|
|
49518
49271
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
49519
49272
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -49685,7 +49438,7 @@ type GridFieldFilterPickerGroupListenersTypes = {
|
|
|
49685
49438
|
* @param {Core.widget.FieldFilterPicker} event.source The FieldFilterPicker instance that fired the event.
|
|
49686
49439
|
* @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
49440
|
*/
|
|
49688
|
-
beforeAddFilter: (event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) =>
|
|
49441
|
+
beforeAddFilter: (event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) => boolean|void
|
|
49689
49442
|
/**
|
|
49690
49443
|
* Fires before an object is destroyed.
|
|
49691
49444
|
* @param {object} event Event object
|
|
@@ -49697,7 +49450,7 @@ type GridFieldFilterPickerGroupListenersTypes = {
|
|
|
49697
49450
|
* @param {object} event Event object
|
|
49698
49451
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
49699
49452
|
*/
|
|
49700
|
-
beforeHide: (event: { source: Widget }) =>
|
|
49453
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
49701
49454
|
/**
|
|
49702
49455
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
49703
49456
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -49830,7 +49583,7 @@ type GridFieldFilterPickerGroupListeners = {
|
|
|
49830
49583
|
* @param {Core.widget.FieldFilterPicker} event.source The FieldFilterPicker instance that fired the event.
|
|
49831
49584
|
* @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
49585
|
*/
|
|
49833
|
-
beforeAddFilter?: ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) =>
|
|
49586
|
+
beforeAddFilter?: ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) => boolean|void)|string
|
|
49834
49587
|
/**
|
|
49835
49588
|
* Fires before an object is destroyed.
|
|
49836
49589
|
* @param {object} event Event object
|
|
@@ -49842,7 +49595,7 @@ type GridFieldFilterPickerGroupListeners = {
|
|
|
49842
49595
|
* @param {object} event Event object
|
|
49843
49596
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
49844
49597
|
*/
|
|
49845
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
49598
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
49846
49599
|
/**
|
|
49847
49600
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
49848
49601
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -50000,6 +49753,8 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
50000
49753
|
/**
|
|
50001
49754
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
50002
49755
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
49756
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
49757
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-appendTo)
|
|
50003
49758
|
*/
|
|
50004
49759
|
appendTo?: HTMLElement|string
|
|
50005
49760
|
/**
|
|
@@ -50246,10 +50001,14 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
50246
50001
|
inputFieldAlign?: 'start'|'end'
|
|
50247
50002
|
/**
|
|
50248
50003
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
50004
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
50005
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-insertBefore)
|
|
50249
50006
|
*/
|
|
50250
50007
|
insertBefore?: HTMLElement|string
|
|
50251
50008
|
/**
|
|
50252
50009
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
50010
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
50011
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-insertFirst)
|
|
50253
50012
|
*/
|
|
50254
50013
|
insertFirst?: HTMLElement|string
|
|
50255
50014
|
/**
|
|
@@ -50571,7 +50330,7 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
50571
50330
|
* @param {Core.widget.FieldFilterPicker} event.source The FieldFilterPicker instance that fired the event.
|
|
50572
50331
|
* @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
50332
|
*/
|
|
50574
|
-
onBeforeAddFilter?: ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) =>
|
|
50333
|
+
onBeforeAddFilter?: ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) => boolean|void)|string
|
|
50575
50334
|
/**
|
|
50576
50335
|
* Fires before an object is destroyed.
|
|
50577
50336
|
* @param {object} event Event object
|
|
@@ -50583,7 +50342,7 @@ type GridFieldFilterPickerGroupConfig = {
|
|
|
50583
50342
|
* @param {object} event Event object
|
|
50584
50343
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
50585
50344
|
*/
|
|
50586
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
50345
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
50587
50346
|
/**
|
|
50588
50347
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
50589
50348
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -50759,7 +50518,7 @@ type GroupBarListenersTypes = {
|
|
|
50759
50518
|
* @param {object} event Event object
|
|
50760
50519
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
50761
50520
|
*/
|
|
50762
|
-
beforeHide: (event: { source: Widget }) =>
|
|
50521
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
50763
50522
|
/**
|
|
50764
50523
|
* User going to activate an item in the list either by pointer or keyboard.
|
|
50765
50524
|
* The active record, list item index, and the triggering event are passed.
|
|
@@ -50771,7 +50530,7 @@ type GroupBarListenersTypes = {
|
|
|
50771
50530
|
* @param {number} event.index List item index
|
|
50772
50531
|
* @param {Event} event.event Triggering event
|
|
50773
50532
|
*/
|
|
50774
|
-
beforeItem: (event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) =>
|
|
50533
|
+
beforeItem: (event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void
|
|
50775
50534
|
/**
|
|
50776
50535
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
50777
50536
|
* @param {object} event Event object
|
|
@@ -50917,7 +50676,7 @@ type GroupBarListeners = {
|
|
|
50917
50676
|
* @param {object} event Event object
|
|
50918
50677
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
50919
50678
|
*/
|
|
50920
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
50679
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
50921
50680
|
/**
|
|
50922
50681
|
* User going to activate an item in the list either by pointer or keyboard.
|
|
50923
50682
|
* The active record, list item index, and the triggering event are passed.
|
|
@@ -50929,7 +50688,7 @@ type GroupBarListeners = {
|
|
|
50929
50688
|
* @param {number} event.index List item index
|
|
50930
50689
|
* @param {Event} event.event Triggering event
|
|
50931
50690
|
*/
|
|
50932
|
-
beforeItem?: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) =>
|
|
50691
|
+
beforeItem?: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void)|string
|
|
50933
50692
|
/**
|
|
50934
50693
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
50935
50694
|
* @param {object} event Event object
|
|
@@ -51096,6 +50855,8 @@ type GroupBarConfig = {
|
|
|
51096
50855
|
/**
|
|
51097
50856
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
51098
50857
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
50858
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
50859
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-appendTo)
|
|
51099
50860
|
*/
|
|
51100
50861
|
appendTo?: HTMLElement|string
|
|
51101
50862
|
/**
|
|
@@ -51145,9 +50906,11 @@ type GroupBarConfig = {
|
|
|
51145
50906
|
/**
|
|
51146
50907
|
* If [closable](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-closable) is `true`, this is the name of a callback function to handle what the "close"
|
|
51147
50908
|
* action means. If not provided, the record representing the chip is removed from the store.
|
|
50909
|
+
* @param {Core.data.Model[]} records Records to be closed
|
|
50910
|
+
* @param {object} options Close options
|
|
51148
50911
|
* @returns {void}
|
|
51149
50912
|
*/
|
|
51150
|
-
closeHandler?: string|(() => void)
|
|
50913
|
+
closeHandler?: string|((records: Model[], options: object) => void)
|
|
51151
50914
|
/**
|
|
51152
50915
|
* Custom CSS classes to add to element.
|
|
51153
50916
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -51322,10 +51085,14 @@ type GroupBarConfig = {
|
|
|
51322
51085
|
ignoreParentReadOnly?: boolean
|
|
51323
51086
|
/**
|
|
51324
51087
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
51088
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
51089
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-insertBefore)
|
|
51325
51090
|
*/
|
|
51326
51091
|
insertBefore?: HTMLElement|string
|
|
51327
51092
|
/**
|
|
51328
51093
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
51094
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
51095
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-insertFirst)
|
|
51329
51096
|
*/
|
|
51330
51097
|
insertFirst?: HTMLElement|string
|
|
51331
51098
|
/**
|
|
@@ -51616,7 +51383,7 @@ type GroupBarConfig = {
|
|
|
51616
51383
|
* @param {object} event Event object
|
|
51617
51384
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
51618
51385
|
*/
|
|
51619
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
51386
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
51620
51387
|
/**
|
|
51621
51388
|
* User going to activate an item in the list either by pointer or keyboard.
|
|
51622
51389
|
* The active record, list item index, and the triggering event are passed.
|
|
@@ -51628,7 +51395,7 @@ type GroupBarConfig = {
|
|
|
51628
51395
|
* @param {number} event.index List item index
|
|
51629
51396
|
* @param {Event} event.event Triggering event
|
|
51630
51397
|
*/
|
|
51631
|
-
onBeforeItem?: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) =>
|
|
51398
|
+
onBeforeItem?: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void)|string
|
|
51632
51399
|
/**
|
|
51633
51400
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
51634
51401
|
* @param {object} event Event object
|
|
@@ -51818,7 +51585,7 @@ type TreeComboListenersTypes = {
|
|
|
51818
51585
|
* @param {object} event Event object
|
|
51819
51586
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
51820
51587
|
*/
|
|
51821
|
-
beforeHide: (event: { source: Widget }) =>
|
|
51588
|
+
beforeHide: (event: { source: Widget }) => boolean|void
|
|
51822
51589
|
/**
|
|
51823
51590
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
51824
51591
|
* @param {object} event Event object
|
|
@@ -51986,7 +51753,7 @@ type TreeComboListeners = {
|
|
|
51986
51753
|
* @param {object} event Event object
|
|
51987
51754
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
51988
51755
|
*/
|
|
51989
|
-
beforeHide?: ((event: { source: Widget }) =>
|
|
51756
|
+
beforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
51990
51757
|
/**
|
|
51991
51758
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
51992
51759
|
* @param {object} event Event object
|
|
@@ -52155,6 +51922,8 @@ type TreeComboConfig = {
|
|
|
52155
51922
|
/**
|
|
52156
51923
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
52157
51924
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
51925
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
51926
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-appendTo)
|
|
52158
51927
|
*/
|
|
52159
51928
|
appendTo?: HTMLElement|string
|
|
52160
51929
|
/**
|
|
@@ -52217,6 +51986,15 @@ type TreeComboConfig = {
|
|
|
52217
51986
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
52218
51987
|
*/
|
|
52219
51988
|
centered?: boolean
|
|
51989
|
+
/**
|
|
51990
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
51991
|
+
* 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)
|
|
51992
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
51993
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-checkValidity)
|
|
51994
|
+
* @param {Core.widget.Field} field The field being validated
|
|
51995
|
+
* @returns {void}
|
|
51996
|
+
*/
|
|
51997
|
+
checkValidity?: ((field: Field) => void)|string
|
|
52220
51998
|
/**
|
|
52221
51999
|
* A config object to configure the [ChipView](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView) to display the
|
|
52222
52000
|
* selected value set when [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
|
|
@@ -52508,10 +52286,14 @@ type TreeComboConfig = {
|
|
|
52508
52286
|
inputWidth?: string|number
|
|
52509
52287
|
/**
|
|
52510
52288
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
52289
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
52290
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-insertBefore)
|
|
52511
52291
|
*/
|
|
52512
52292
|
insertBefore?: HTMLElement|string
|
|
52513
52293
|
/**
|
|
52514
52294
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
52295
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
52296
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-insertFirst)
|
|
52515
52297
|
*/
|
|
52516
52298
|
insertFirst?: HTMLElement|string
|
|
52517
52299
|
/**
|
|
@@ -52931,7 +52713,7 @@ type TreeComboConfig = {
|
|
|
52931
52713
|
* @param {object} event Event object
|
|
52932
52714
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
52933
52715
|
*/
|
|
52934
|
-
onBeforeHide?: ((event: { source: Widget }) =>
|
|
52716
|
+
onBeforeHide?: ((event: { source: Widget }) => boolean|void)|string
|
|
52935
52717
|
/**
|
|
52936
52718
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
52937
52719
|
* @param {object} event Event object
|