handsontable 0.0.0-next-d093c11-20240307 → 0.0.0-next-221e46b-20240307
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.
Potentially problematic release.
This version of handsontable might be problematic. Click here for more details.
- package/3rdparty/walkontable/src/cell/range.js +1 -1
- package/3rdparty/walkontable/src/cell/range.mjs +1 -1
- package/base.js +2 -2
- package/base.mjs +2 -2
- package/core.js +21 -21
- package/core.mjs +21 -21
- package/dataMap/metaManager/metaSchema.js +270 -270
- package/dataMap/metaManager/metaSchema.mjs +270 -270
- package/dist/handsontable.css +2 -2
- package/dist/handsontable.full.css +2 -2
- package/dist/handsontable.full.js +397 -397
- package/dist/handsontable.full.min.css +2 -2
- package/dist/handsontable.full.min.js +3 -3
- package/dist/handsontable.js +397 -397
- package/dist/handsontable.min.css +2 -2
- package/dist/handsontable.min.js +3 -3
- package/helpers/mixed.js +1 -1
- package/helpers/mixed.mjs +1 -1
- package/package.json +1 -1
- package/pluginHooks.js +43 -43
- package/pluginHooks.mjs +43 -43
- package/plugins/columnSummary/columnSummary.js +14 -14
- package/plugins/columnSummary/columnSummary.mjs +14 -14
- package/plugins/contextMenu/contextMenu.js +3 -3
- package/plugins/contextMenu/contextMenu.mjs +3 -3
- package/plugins/copyPaste/copyPaste.js +3 -3
- package/plugins/copyPaste/copyPaste.mjs +3 -3
- package/plugins/customBorders/customBorders.js +1 -1
- package/plugins/customBorders/customBorders.mjs +1 -1
- package/plugins/dropdownMenu/dropdownMenu.js +2 -2
- package/plugins/dropdownMenu/dropdownMenu.mjs +2 -2
- package/plugins/exportFile/exportFile.js +1 -1
- package/plugins/exportFile/exportFile.mjs +1 -1
- package/plugins/filters/filters.js +1 -1
- package/plugins/filters/filters.mjs +1 -1
- package/plugins/formulas/formulas.js +1 -1
- package/plugins/formulas/formulas.mjs +1 -1
- package/plugins/hiddenColumns/hiddenColumns.js +4 -4
- package/plugins/hiddenColumns/hiddenColumns.mjs +4 -4
- package/plugins/hiddenRows/hiddenRows.js +4 -4
- package/plugins/hiddenRows/hiddenRows.mjs +4 -4
- package/plugins/manualColumnMove/manualColumnMove.js +7 -7
- package/plugins/manualColumnMove/manualColumnMove.mjs +7 -7
- package/plugins/manualRowMove/manualRowMove.js +7 -7
- package/plugins/manualRowMove/manualRowMove.mjs +7 -7
- package/plugins/nestedRows/nestedRows.js +2 -2
- package/plugins/nestedRows/nestedRows.mjs +2 -2
- package/plugins/nestedRows/utils/rowMoveController.js +4 -4
- package/plugins/nestedRows/utils/rowMoveController.mjs +4 -4
- package/shortcuts/context.js +1 -1
- package/shortcuts/context.mjs +1 -1
- package/shortcuts/manager.js +2 -2
- package/shortcuts/manager.mjs +2 -2
package/dist/handsontable.js
CHANGED
@@ -25,8 +25,8 @@
|
|
25
25
|
* INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER ARISING FROM
|
26
26
|
* USE OR INABILITY TO USE THIS SOFTWARE.
|
27
27
|
*
|
28
|
-
* Version: 0.0.0-next-
|
29
|
-
* Release date: 06/03/2024 (built at 07/03/2024
|
28
|
+
* Version: 0.0.0-next-221e46b-20240307
|
29
|
+
* Release date: 06/03/2024 (built at 07/03/2024 14:16:19)
|
30
30
|
*/
|
31
31
|
(function webpackUniversalModuleDefinition(root, factory) {
|
32
32
|
if(typeof exports === 'object' && typeof module === 'object')
|
@@ -107,8 +107,8 @@ Handsontable.hooks = _pluginHooks.default.getSingleton();
|
|
107
107
|
Handsontable.CellCoords = _src.CellCoords;
|
108
108
|
Handsontable.CellRange = _src.CellRange;
|
109
109
|
Handsontable.packageName = 'handsontable';
|
110
|
-
Handsontable.buildDate = "07/03/2024
|
111
|
-
Handsontable.version = "0.0.0-next-
|
110
|
+
Handsontable.buildDate = "07/03/2024 14:16:19";
|
111
|
+
Handsontable.version = "0.0.0-next-221e46b-20240307";
|
112
112
|
Handsontable.languages = {
|
113
113
|
dictionaryKeys: _registry.dictionaryKeys,
|
114
114
|
getLanguageDictionary: _registry.getLanguageDictionary,
|
@@ -229,8 +229,8 @@ const deprecationWarns = new Set();
|
|
229
229
|
*
|
230
230
|
* ::: only-for react
|
231
231
|
* To use these methods, associate a Handsontable instance with your instance
|
232
|
-
* of the [`HotTable` component](@/guides/getting-started/installation.md#_4-use-the-hottable-component),
|
233
|
-
* by using React's `ref` feature (read more on the [Instance methods](@/guides/getting-started/react-methods.md) page).
|
232
|
+
* of the [`HotTable` component](@/guides/getting-started/installation/installation.md#_4-use-the-hottable-component),
|
233
|
+
* by using React's `ref` feature (read more on the [Instance methods](@/guides/getting-started/react-methods/react-methods.md) page).
|
234
234
|
* :::
|
235
235
|
*
|
236
236
|
* ## How to call a method
|
@@ -2206,20 +2206,20 @@ function Core(rootElement, userSettings) {
|
|
2206
2206
|
* The `updateData()` method replaces Handsontable's [`data`](@/api/options.md#data) with a new dataset.
|
2207
2207
|
*
|
2208
2208
|
* The `updateData()` method:
|
2209
|
-
* - Keeps cells' states (e.g. cells' [formatting](@/guides/cell-features/formatting-cells.md) and cells' [`readOnly`](@/api/options.md#readonly) states)
|
2209
|
+
* - Keeps cells' states (e.g. cells' [formatting](@/guides/cell-features/formatting-cells/formatting-cells.md) and cells' [`readOnly`](@/api/options.md#readonly) states)
|
2210
2210
|
* - Keeps rows' states (e.g. row order)
|
2211
2211
|
* - Keeps columns' states (e.g. column order)
|
2212
2212
|
*
|
2213
2213
|
* To replace Handsontable's [`data`](@/api/options.md#data) and reset states, use the [`loadData()`](#loaddata) method.
|
2214
2214
|
*
|
2215
2215
|
* Read more:
|
2216
|
-
* - [Binding to data](@/guides/getting-started/binding-to-data.md)
|
2217
|
-
* - [Saving data](@/guides/getting-started/saving-data.md)
|
2216
|
+
* - [Binding to data](@/guides/getting-started/binding-to-data/binding-to-data.md)
|
2217
|
+
* - [Saving data](@/guides/getting-started/saving-data/saving-data.md)
|
2218
2218
|
*
|
2219
2219
|
* @memberof Core#
|
2220
2220
|
* @function updateData
|
2221
2221
|
* @since 11.1.0
|
2222
|
-
* @param {Array} data An [array of arrays](@/guides/getting-started/binding-to-data.md#array-of-arrays), or an [array of objects](@/guides/getting-started/binding-to-data.md#array-of-objects), that contains Handsontable's data
|
2222
|
+
* @param {Array} data An [array of arrays](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-arrays), or an [array of objects](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-objects), that contains Handsontable's data
|
2223
2223
|
* @param {string} [source] The source of the `updateData()` call
|
2224
2224
|
* @fires Hooks#beforeUpdateData
|
2225
2225
|
* @fires Hooks#afterUpdateData
|
@@ -2248,19 +2248,19 @@ function Core(rootElement, userSettings) {
|
|
2248
2248
|
* The `loadData()` method replaces Handsontable's [`data`](@/api/options.md#data) with a new dataset.
|
2249
2249
|
*
|
2250
2250
|
* Additionally, the `loadData()` method:
|
2251
|
-
* - Resets cells' states (e.g. cells' [formatting](@/guides/cell-features/formatting-cells.md) and cells' [`readOnly`](@/api/options.md#readonly) states)
|
2251
|
+
* - Resets cells' states (e.g. cells' [formatting](@/guides/cell-features/formatting-cells/formatting-cells.md) and cells' [`readOnly`](@/api/options.md#readonly) states)
|
2252
2252
|
* - Resets rows' states (e.g. row order)
|
2253
2253
|
* - Resets columns' states (e.g. column order)
|
2254
2254
|
*
|
2255
2255
|
* To replace Handsontable's [`data`](@/api/options.md#data) without resetting states, use the [`updateData()`](#updatedata) method.
|
2256
2256
|
*
|
2257
2257
|
* Read more:
|
2258
|
-
* - [Binding to data](@/guides/getting-started/binding-to-data.md)
|
2259
|
-
* - [Saving data](@/guides/getting-started/saving-data.md)
|
2258
|
+
* - [Binding to data](@/guides/getting-started/binding-to-data/binding-to-data.md)
|
2259
|
+
* - [Saving data](@/guides/getting-started/saving-data/saving-data.md)
|
2260
2260
|
*
|
2261
2261
|
* @memberof Core#
|
2262
2262
|
* @function loadData
|
2263
|
-
* @param {Array} data An [array of arrays](@/guides/getting-started/binding-to-data.md#array-of-arrays), or an [array of objects](@/guides/getting-started/binding-to-data.md#array-of-objects), that contains Handsontable's data
|
2263
|
+
* @param {Array} data An [array of arrays](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-arrays), or an [array of objects](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-objects), that contains Handsontable's data
|
2264
2264
|
* @param {string} [source] The source of the `loadData()` call
|
2265
2265
|
* @fires Hooks#beforeLoadData
|
2266
2266
|
* @fires Hooks#afterLoadData
|
@@ -2620,7 +2620,7 @@ function Core(rootElement, userSettings) {
|
|
2620
2620
|
*
|
2621
2621
|
* ::: tip
|
2622
2622
|
* The `alter()` method works only when your [`data`](@/api/options.md#data)
|
2623
|
-
* is an [array of arrays](@/guides/getting-started/binding-to-data.md#array-of-arrays).
|
2623
|
+
* is an [array of arrays](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-arrays).
|
2624
2624
|
* :::
|
2625
2625
|
*
|
2626
2626
|
* ```js
|
@@ -2914,7 +2914,7 @@ function Core(rootElement, userSettings) {
|
|
2914
2914
|
* sorted or trimmed only physical indexes are correct.
|
2915
2915
|
*
|
2916
2916
|
* __Note__: This method may return incorrect values for cells that contain
|
2917
|
-
* [formulas](@/guides/formulas/formula-calculation.md). This is because `getSourceData()`
|
2917
|
+
* [formulas](@/guides/formulas/formula-calculation/formula-calculation.md). This is because `getSourceData()`
|
2918
2918
|
* operates on source data ([physical indexes](@/api/indexMapper.md)),
|
2919
2919
|
* whereas formulas operate on visual data (visual indexes).
|
2920
2920
|
*
|
@@ -3252,8 +3252,8 @@ function Core(rootElement, userSettings) {
|
|
3252
3252
|
};
|
3253
3253
|
|
3254
3254
|
/**
|
3255
|
-
* Checks if your [data format](@/guides/getting-started/binding-to-data.md#compatible-data-types)
|
3256
|
-
* and [configuration options](@/guides/getting-started/configuration-options.md)
|
3255
|
+
* Checks if your [data format](@/guides/getting-started/binding-to-data/binding-to-data.md#compatible-data-types)
|
3256
|
+
* and [configuration options](@/guides/getting-started/configuration-options/configuration-options.md)
|
3257
3257
|
* allow for changing the number of columns.
|
3258
3258
|
*
|
3259
3259
|
* Returns `false` when your data is an array of objects,
|
@@ -3342,10 +3342,10 @@ function Core(rootElement, userSettings) {
|
|
3342
3342
|
|
3343
3343
|
/**
|
3344
3344
|
* Validates every cell in the data set,
|
3345
|
-
* using a [validator function](@/guides/cell-functions/cell-validator.md) configured for each cell.
|
3345
|
+
* using a [validator function](@/guides/cell-functions/cell-validator/cell-validator.md) configured for each cell.
|
3346
3346
|
*
|
3347
|
-
* Doesn't validate cells that are currently [trimmed](@/guides/rows/row-trimming.md),
|
3348
|
-
* [hidden](@/guides/rows/row-hiding.md), or [filtered](@/guides/columns/column-filter.md),
|
3347
|
+
* Doesn't validate cells that are currently [trimmed](@/guides/rows/row-trimming/row-trimming.md),
|
3348
|
+
* [hidden](@/guides/rows/row-hiding/row-hiding.md), or [filtered](@/guides/columns/column-filter/column-filter.md),
|
3349
3349
|
* as such cells are not included in the data set until you bring them back again.
|
3350
3350
|
*
|
3351
3351
|
* After the validation, the `callback` function is fired, with the `valid` argument set to:
|
@@ -3533,18 +3533,18 @@ function Core(rootElement, userSettings) {
|
|
3533
3533
|
* Gets the values of column headers (if column headers are [enabled](@/api/options.md#colheaders)).
|
3534
3534
|
*
|
3535
3535
|
* To get an array with the values of all
|
3536
|
-
* [bottom-most](@/guides/cell-features/clipboard.md#copy-with-headers) column headers,
|
3536
|
+
* [bottom-most](@/guides/cell-features/clipboard/clipboard.md#copy-with-headers) column headers,
|
3537
3537
|
* call `getColHeader()` with no arguments.
|
3538
3538
|
*
|
3539
3539
|
* To get the value of the bottom-most header of a specific column, use the `column` parameter.
|
3540
3540
|
*
|
3541
|
-
* To get the value of a [specific-level](@/guides/columns/column-groups.md) header
|
3541
|
+
* To get the value of a [specific-level](@/guides/columns/column-groups/column-groups.md) header
|
3542
3542
|
* of a specific column, use the `column` and `headerLevel` parameters.
|
3543
3543
|
*
|
3544
3544
|
* Read more:
|
3545
|
-
* - [Guides: Column groups](@/guides/columns/column-groups.md)
|
3545
|
+
* - [Guides: Column groups](@/guides/columns/column-groups/column-groups.md)
|
3546
3546
|
* - [Options: `colHeaders`](@/api/options.md#colheaders)
|
3547
|
-
* - [Guides: Copy with headers](@/guides/cell-features/clipboard.md#copy-with-headers)
|
3547
|
+
* - [Guides: Copy with headers](@/guides/cell-features/clipboard/clipboard.md#copy-with-headers)
|
3548
3548
|
*
|
3549
3549
|
* ```js
|
3550
3550
|
* // get the contents of all bottom-most column headers
|
@@ -8470,7 +8470,7 @@ const domMessages = {
|
|
8470
8470
|
function _injectProductInfo(key, element) {
|
8471
8471
|
const hasValidType = !isEmpty(key);
|
8472
8472
|
const isNonCommercial = typeof key === 'string' && key.toLowerCase() === 'non-commercial-and-evaluation';
|
8473
|
-
const hotVersion = "0.0.0-next-
|
8473
|
+
const hotVersion = "0.0.0-next-221e46b-20240307";
|
8474
8474
|
let keyValidityDate;
|
8475
8475
|
let consoleMessageState = 'invalid';
|
8476
8476
|
let domMessageState = 'invalid';
|
@@ -10919,7 +10919,7 @@ var _function = __webpack_require__(115);
|
|
10919
10919
|
* ::: only-for react
|
10920
10920
|
* This page lists all the **Handsontable hooks** – callbacks that let you react before or after an action occurs.
|
10921
10921
|
*
|
10922
|
-
* Read more on the [Events and hooks](@/guides/getting-started/events-and-hooks.md) page.
|
10922
|
+
* Read more on the [Events and hooks](@/guides/getting-started/events-and-hooks/events-and-hooks.md) page.
|
10923
10923
|
* :::
|
10924
10924
|
*
|
10925
10925
|
* @example
|
@@ -11036,7 +11036,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
11036
11036
|
*
|
11037
11037
|
* @event Hooks#afterChange
|
11038
11038
|
* @param {Array[]} changes 2D array containing information about each of the edited cells `[[row, prop, oldVal, newVal], ...]`. `row` is a visual row index.
|
11039
|
-
* @param {string} [source] String that identifies source of hook call ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)).
|
11039
|
+
* @param {string} [source] String that identifies source of hook call ([list of all available sources](@/guides/getting-started/events-and-hooks/events-and-hooks.md#definition-for-source-argument)).
|
11040
11040
|
* @example
|
11041
11041
|
* ::: only-for javascript
|
11042
11042
|
* ```js
|
@@ -11140,7 +11140,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
11140
11140
|
* @param {number} index Represents the visual index of first newly created column in the data source array.
|
11141
11141
|
* @param {number} amount Number of newly created columns in the data source array.
|
11142
11142
|
* @param {string} [source] String that identifies source of hook call
|
11143
|
-
* ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)).
|
11143
|
+
* ([list of all available sources](@/guides/getting-started/events-and-hooks/events-and-hooks.md#definition-for-source-argument)).
|
11144
11144
|
* @returns {*} If `false` then creating columns is cancelled.
|
11145
11145
|
* @example
|
11146
11146
|
* ::: only-for javascript
|
@@ -11181,7 +11181,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
11181
11181
|
* @param {number} index Represents the visual index of first newly created column in the data source.
|
11182
11182
|
* @param {number} amount Number of newly created columns in the data source.
|
11183
11183
|
* @param {string} [source] String that identifies source of hook call
|
11184
|
-
* ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)).
|
11184
|
+
* ([list of all available sources](@/guides/getting-started/events-and-hooks/events-and-hooks.md#definition-for-source-argument)).
|
11185
11185
|
*/
|
11186
11186
|
'afterCreateCol',
|
11187
11187
|
/**
|
@@ -11191,7 +11191,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
11191
11191
|
* @param {number} index Represents the visual index of first newly created row in the data source array.
|
11192
11192
|
* @param {number} amount Number of newly created rows in the data source array.
|
11193
11193
|
* @param {string} [source] String that identifies source of hook call
|
11194
|
-
* ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)).
|
11194
|
+
* ([list of all available sources](@/guides/getting-started/events-and-hooks/events-and-hooks.md#definition-for-source-argument)).
|
11195
11195
|
* @returns {*|boolean} If false is returned the action is canceled.
|
11196
11196
|
*/
|
11197
11197
|
'beforeCreateRow',
|
@@ -11202,7 +11202,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
11202
11202
|
* @param {number} index Represents the visual index of first newly created row in the data source array.
|
11203
11203
|
* @param {number} amount Number of newly created rows in the data source array.
|
11204
11204
|
* @param {string} [source] String that identifies source of hook call
|
11205
|
-
* ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)).
|
11205
|
+
* ([list of all available sources](@/guides/getting-started/events-and-hooks/events-and-hooks.md#definition-for-source-argument)).
|
11206
11206
|
*/
|
11207
11207
|
'afterCreateRow',
|
11208
11208
|
/**
|
@@ -11285,11 +11285,11 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
11285
11285
|
* or the [`updateSettings()`](@/api/core.md#updatesettings) method.
|
11286
11286
|
*
|
11287
11287
|
* Read more:
|
11288
|
-
* - [Binding to data](@/guides/getting-started/binding-to-data.md)
|
11289
|
-
* - [Saving data](@/guides/getting-started/saving-data.md)
|
11288
|
+
* - [Binding to data](@/guides/getting-started/binding-to-data/binding-to-data.md)
|
11289
|
+
* - [Saving data](@/guides/getting-started/saving-data/saving-data.md)
|
11290
11290
|
*
|
11291
11291
|
* @event Hooks#afterLoadData
|
11292
|
-
* @param {Array} sourceData An [array of arrays](@/guides/getting-started/binding-to-data.md#array-of-arrays), or an [array of objects](@/guides/getting-started/binding-to-data.md#array-of-objects), that contains Handsontable's data
|
11292
|
+
* @param {Array} sourceData An [array of arrays](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-arrays), or an [array of objects](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-objects), that contains Handsontable's data
|
11293
11293
|
* @param {boolean} initialLoad A flag that indicates whether the data was loaded at Handsontable's initialization (`true`) or later (`false`)
|
11294
11294
|
* @param {string} source The source of the call
|
11295
11295
|
*/
|
@@ -11299,12 +11299,12 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
11299
11299
|
* modifies Handsontable's [`data`](@/api/options.md#data).
|
11300
11300
|
*
|
11301
11301
|
* Read more:
|
11302
|
-
* - [Binding to data](@/guides/getting-started/binding-to-data.md)
|
11303
|
-
* - [Saving data](@/guides/getting-started/saving-data.md)
|
11302
|
+
* - [Binding to data](@/guides/getting-started/binding-to-data/binding-to-data.md)
|
11303
|
+
* - [Saving data](@/guides/getting-started/saving-data/saving-data.md)
|
11304
11304
|
*
|
11305
11305
|
* @event Hooks#afterUpdateData
|
11306
11306
|
* @since 11.1.0
|
11307
|
-
* @param {Array} sourceData An [array of arrays](@/guides/getting-started/binding-to-data.md#array-of-arrays), or an [array of objects](@/guides/getting-started/binding-to-data.md#array-of-objects), that contains Handsontable's data
|
11307
|
+
* @param {Array} sourceData An [array of arrays](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-arrays), or an [array of objects](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-objects), that contains Handsontable's data
|
11308
11308
|
* @param {boolean} initialLoad A flag that indicates whether the data was loaded at Handsontable's initialization (`true`) or later (`false`)
|
11309
11309
|
* @param {string} source The source of the call
|
11310
11310
|
*/
|
@@ -11398,7 +11398,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
11398
11398
|
* @param {number} amount An amount of removed columns.
|
11399
11399
|
* @param {number[]} physicalColumns An array of physical columns removed from the data source.
|
11400
11400
|
* @param {string} [source] String that identifies source of hook call
|
11401
|
-
* ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)).
|
11401
|
+
* ([list of all available sources](@/guides/getting-started/events-and-hooks/events-and-hooks.md#definition-for-source-argument)).
|
11402
11402
|
*/
|
11403
11403
|
'afterRemoveCol',
|
11404
11404
|
/**
|
@@ -11409,7 +11409,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
11409
11409
|
* @param {number} amount An amount of removed rows.
|
11410
11410
|
* @param {number[]} physicalRows An array of physical rows removed from the data source.
|
11411
11411
|
* @param {string} [source] String that identifies source of hook call
|
11412
|
-
* ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)).
|
11412
|
+
* ([list of all available sources](@/guides/getting-started/events-and-hooks/events-and-hooks.md#definition-for-source-argument)).
|
11413
11413
|
*/
|
11414
11414
|
'afterRemoveRow',
|
11415
11415
|
/**
|
@@ -11710,7 +11710,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
11710
11710
|
* @event Hooks#afterSetDataAtCell
|
11711
11711
|
* @param {Array} changes An array of changes in format `[[row, column, oldValue, value], ...]`.
|
11712
11712
|
* @param {string} [source] String that identifies source of hook call
|
11713
|
-
* ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)).
|
11713
|
+
* ([list of all available sources](@/guides/getting-started/events-and-hooks/events-and-hooks.md#definition-for-source-argument)).
|
11714
11714
|
*/
|
11715
11715
|
'afterSetDataAtCell',
|
11716
11716
|
/**
|
@@ -11720,7 +11720,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
11720
11720
|
* @event Hooks#afterSetDataAtRowProp
|
11721
11721
|
* @param {Array} changes An array of changes in format `[[row, prop, oldValue, value], ...]`.
|
11722
11722
|
* @param {string} [source] String that identifies source of hook call
|
11723
|
-
* ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)).
|
11723
|
+
* ([list of all available sources](@/guides/getting-started/events-and-hooks/events-and-hooks.md#definition-for-source-argument)).
|
11724
11724
|
*/
|
11725
11725
|
'afterSetDataAtRowProp',
|
11726
11726
|
/**
|
@@ -11752,7 +11752,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
11752
11752
|
* @param {number} row Visual row index.
|
11753
11753
|
* @param {string|number} prop Property name / visual column index.
|
11754
11754
|
* @param {string} [source] String that identifies source of hook call
|
11755
|
-
* ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)).
|
11755
|
+
* ([list of all available sources](@/guides/getting-started/events-and-hooks/events-and-hooks.md#definition-for-source-argument)).
|
11756
11756
|
* @returns {undefined | boolean} If `false` the cell will be marked as invalid, `true` otherwise.
|
11757
11757
|
*/
|
11758
11758
|
'afterValidate',
|
@@ -11828,7 +11828,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
11828
11828
|
* @event Hooks#beforeChange
|
11829
11829
|
* @param {Array[]} changes 2D array containing information about each of the edited cells `[[row, prop, oldVal, newVal], ...]`. `row` is a visual row index.
|
11830
11830
|
* @param {string} [source] String that identifies source of hook call
|
11831
|
-
* ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)).
|
11831
|
+
* ([list of all available sources](@/guides/getting-started/events-and-hooks/events-and-hooks.md#definition-for-source-argument)).
|
11832
11832
|
* @returns {undefined | boolean} If `false` all changes were cancelled, `true` otherwise.
|
11833
11833
|
* @example
|
11834
11834
|
* ::: only-for javascript
|
@@ -11898,7 +11898,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
11898
11898
|
* @event Hooks#beforeChangeRender
|
11899
11899
|
* @param {Array[]} changes Array in form of `[row, prop, oldValue, newValue]`.
|
11900
11900
|
* @param {string} [source] String that identifies source of hook call
|
11901
|
-
* ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)).
|
11901
|
+
* ([list of all available sources](@/guides/getting-started/events-and-hooks/events-and-hooks.md#definition-for-source-argument)).
|
11902
11902
|
*/
|
11903
11903
|
'beforeChangeRender',
|
11904
11904
|
/**
|
@@ -11948,12 +11948,12 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
11948
11948
|
* or the [`updateSettings()`](@/api/core.md#updatesettings) method.
|
11949
11949
|
*
|
11950
11950
|
* Read more:
|
11951
|
-
* - [Binding to data](@/guides/getting-started/binding-to-data.md)
|
11952
|
-
* - [Saving data](@/guides/getting-started/saving-data.md)
|
11951
|
+
* - [Binding to data](@/guides/getting-started/binding-to-data/binding-to-data.md)
|
11952
|
+
* - [Saving data](@/guides/getting-started/saving-data/saving-data.md)
|
11953
11953
|
*
|
11954
11954
|
* @event Hooks#beforeLoadData
|
11955
11955
|
* @since 8.0.0
|
11956
|
-
* @param {Array} sourceData An [array of arrays](@/guides/getting-started/binding-to-data.md#array-of-arrays), or an [array of objects](@/guides/getting-started/binding-to-data.md#array-of-objects), that contains Handsontable's data
|
11956
|
+
* @param {Array} sourceData An [array of arrays](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-arrays), or an [array of objects](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-objects), that contains Handsontable's data
|
11957
11957
|
* @param {boolean} initialLoad A flag that indicates whether the data was loaded at Handsontable's initialization (`true`) or later (`false`)
|
11958
11958
|
* @param {string} source The source of the call
|
11959
11959
|
* @returns {Array} The returned array will be used as Handsontable's new dataset.
|
@@ -11964,12 +11964,12 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
11964
11964
|
* modifies Handsontable's [`data`](@/api/options.md#data).
|
11965
11965
|
*
|
11966
11966
|
* Read more:
|
11967
|
-
* - [Binding to data](@/guides/getting-started/binding-to-data.md)
|
11968
|
-
* - [Saving data](@/guides/getting-started/saving-data.md)
|
11967
|
+
* - [Binding to data](@/guides/getting-started/binding-to-data/binding-to-data.md)
|
11968
|
+
* - [Saving data](@/guides/getting-started/saving-data/saving-data.md)
|
11969
11969
|
*
|
11970
11970
|
* @event Hooks#beforeUpdateData
|
11971
11971
|
* @since 11.1.0
|
11972
|
-
* @param {Array} sourceData An [array of arrays](@/guides/getting-started/binding-to-data.md#array-of-arrays), or an [array of objects](@/guides/getting-started/binding-to-data.md#array-of-objects), that contains Handsontable's data
|
11972
|
+
* @param {Array} sourceData An [array of arrays](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-arrays), or an [array of objects](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-objects), that contains Handsontable's data
|
11973
11973
|
* @param {boolean} initialLoad A flag that indicates whether the data was loaded at Handsontable's initialization (`true`) or later (`false`)
|
11974
11974
|
* @param {string} source The source of the call
|
11975
11975
|
* @returns {Array} The returned array will be used as Handsontable's new dataset.
|
@@ -12042,7 +12042,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
12042
12042
|
* @param {number} amount Amount of columns to be removed.
|
12043
12043
|
* @param {number[]} physicalColumns An array of physical columns removed from the data source.
|
12044
12044
|
* @param {string} [source] String that identifies source of hook call
|
12045
|
-
* ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)).
|
12045
|
+
* ([list of all available sources](@/guides/getting-started/events-and-hooks/events-and-hooks.md#definition-for-source-argument)).
|
12046
12046
|
* @returns {*|boolean} If false is returned the action is canceled.
|
12047
12047
|
*/
|
12048
12048
|
'beforeRemoveCol',
|
@@ -12054,7 +12054,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
12054
12054
|
* @param {number} amount Amount of rows to be removed.
|
12055
12055
|
* @param {number[]} physicalRows An array of physical rows removed from the data source.
|
12056
12056
|
* @param {string} [source] String that identifies source of hook call
|
12057
|
-
* ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)).
|
12057
|
+
* ([list of all available sources](@/guides/getting-started/events-and-hooks/events-and-hooks.md#definition-for-source-argument)).
|
12058
12058
|
* @returns {*|boolean} If false is returned the action is canceled.
|
12059
12059
|
*/
|
12060
12060
|
'beforeRemoveRow',
|
@@ -12197,7 +12197,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
12197
12197
|
* @param {number} row Visual row index.
|
12198
12198
|
* @param {string|number} prop Property name / column index.
|
12199
12199
|
* @param {string} [source] String that identifies source of hook call
|
12200
|
-
* ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)).
|
12200
|
+
* ([list of all available sources](@/guides/getting-started/events-and-hooks/events-and-hooks.md#definition-for-source-argument)).
|
12201
12201
|
*/
|
12202
12202
|
'beforeValidate',
|
12203
12203
|
/**
|
@@ -12640,11 +12640,11 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
12640
12640
|
* @param {number} finalIndex Visual column index, being a start index for the moved columns.
|
12641
12641
|
* Points to where the elements will be placed after the moving action.
|
12642
12642
|
* To check visualization of final index please take a look at
|
12643
|
-
* [documentation](@/guides/columns/column-moving.md).
|
12643
|
+
* [documentation](@/guides/columns/column-moving/column-moving.md).
|
12644
12644
|
* @param {number|undefined} dropIndex Visual column index, being a drop index for the moved columns.
|
12645
12645
|
* Points to where we are going to drop the moved elements. To check
|
12646
12646
|
* visualization of drop index please take a look at
|
12647
|
-
* [documentation](@/guides/columns/column-moving.md).
|
12647
|
+
* [documentation](@/guides/columns/column-moving/column-moving.md).
|
12648
12648
|
* It's `undefined` when `dragColumns` function wasn't called.
|
12649
12649
|
* @param {boolean} movePossible Indicates if it's possible to move rows to the desired position.
|
12650
12650
|
* @returns {undefined | boolean} If `false` the column will not be moved, `true` otherwise.
|
@@ -12659,11 +12659,11 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
12659
12659
|
* @param {number} finalIndex Visual column index, being a start index for the moved columns.
|
12660
12660
|
* Points to where the elements will be placed after the moving action.
|
12661
12661
|
* To check visualization of final index please take a look at
|
12662
|
-
* [documentation](@/guides/columns/column-moving.md).
|
12662
|
+
* [documentation](@/guides/columns/column-moving/column-moving.md).
|
12663
12663
|
* @param {number|undefined} dropIndex Visual column index, being a drop index for the moved columns.
|
12664
12664
|
* Points to where we are going to drop the moved elements.
|
12665
12665
|
* To check visualization of drop index please take a look at
|
12666
|
-
* [documentation](@/guides/columns/column-moving.md).
|
12666
|
+
* [documentation](@/guides/columns/column-moving/column-moving.md).
|
12667
12667
|
* It's `undefined` when `dragColumns` function wasn't called.
|
12668
12668
|
* @param {boolean} movePossible Indicates if it was possible to move columns to the desired position.
|
12669
12669
|
* @param {boolean} orderChanged Indicates if order of columns was changed by move.
|
@@ -12697,11 +12697,11 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
12697
12697
|
* @param {number} finalIndex Visual row index, being a start index for the moved rows.
|
12698
12698
|
* Points to where the elements will be placed after the moving action.
|
12699
12699
|
* To check visualization of final index please take a look at
|
12700
|
-
* [documentation](@/guides/rows/row-moving.md).
|
12700
|
+
* [documentation](@/guides/rows/row-moving/row-moving.md).
|
12701
12701
|
* @param {number|undefined} dropIndex Visual row index, being a drop index for the moved rows.
|
12702
12702
|
* Points to where we are going to drop the moved elements.
|
12703
12703
|
* To check visualization of drop index please take a look at
|
12704
|
-
* [documentation](@/guides/rows/row-moving.md).
|
12704
|
+
* [documentation](@/guides/rows/row-moving/row-moving.md).
|
12705
12705
|
* It's `undefined` when `dragRows` function wasn't called.
|
12706
12706
|
* @param {boolean} movePossible Indicates if it's possible to move rows to the desired position.
|
12707
12707
|
* @returns {*|boolean} If false is returned the action is canceled.
|
@@ -12716,11 +12716,11 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
12716
12716
|
* @param {number} finalIndex Visual row index, being a start index for the moved rows.
|
12717
12717
|
* Points to where the elements will be placed after the moving action.
|
12718
12718
|
* To check visualization of final index please take a look at
|
12719
|
-
* [documentation](@/guides/rows/row-moving.md).
|
12719
|
+
* [documentation](@/guides/rows/row-moving/row-moving.md).
|
12720
12720
|
* @param {number|undefined} dropIndex Visual row index, being a drop index for the moved rows.
|
12721
12721
|
* Points to where we are going to drop the moved elements.
|
12722
12722
|
* To check visualization of drop index please take a look at
|
12723
|
-
* [documentation](@/guides/rows/row-moving.md).
|
12723
|
+
* [documentation](@/guides/rows/row-moving/row-moving.md).
|
12724
12724
|
* It's `undefined` when `dragRows` function wasn't called.
|
12725
12725
|
* @param {boolean} movePossible Indicates if it was possible to move rows to the desired position.
|
12726
12726
|
* @param {boolean} orderChanged Indicates if order of rows was changed by move.
|
@@ -12793,7 +12793,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
12793
12793
|
'beforeStretchingColumnWidth',
|
12794
12794
|
/**
|
12795
12795
|
* Fired by the [`Filters`](@/api/filters.md) plugin,
|
12796
|
-
* before a [column filter](@/guides/columns/column-filter.md) gets applied.
|
12796
|
+
* before a [column filter](@/guides/columns/column-filter/column-filter.md) gets applied.
|
12797
12797
|
*
|
12798
12798
|
* [`beforeFilter`](#beforefilter) takes one argument (`conditionsStack`), which is an array of objects.
|
12799
12799
|
* Each object represents one of your [column filters](@/api/filters.md#addcondition),
|
@@ -12838,7 +12838,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
12838
12838
|
*```
|
12839
12839
|
*
|
12840
12840
|
* Read more:
|
12841
|
-
* - [Guides: Column filter](@/guides/columns/column-filter.md)
|
12841
|
+
* - [Guides: Column filter](@/guides/columns/column-filter/column-filter.md)
|
12842
12842
|
* - [Hooks: `afterFilter`](#afterfilter)
|
12843
12843
|
* - [Options: `filters`](@/api/options.md#filters)
|
12844
12844
|
* - [Plugins: `Filters`](@/api/filters.md)
|
@@ -12851,7 +12851,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
12851
12851
|
'beforeFilter',
|
12852
12852
|
/**
|
12853
12853
|
* Fired by the [`Filters`](@/api/filters.md) plugin,
|
12854
|
-
* after a [column filter](@/guides/columns/column-filter.md) gets applied.
|
12854
|
+
* after a [column filter](@/guides/columns/column-filter/column-filter.md) gets applied.
|
12855
12855
|
*
|
12856
12856
|
* [`afterFilter`](#afterfilter) takes one argument (`conditionsStack`), which is an array of objects.
|
12857
12857
|
* Each object represents one of your [column filters](@/api/filters.md#addcondition),
|
@@ -12885,7 +12885,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
12885
12885
|
* ```
|
12886
12886
|
*
|
12887
12887
|
* Read more:
|
12888
|
-
* - [Guides: Column filter](@/guides/columns/column-filter.md)
|
12888
|
+
* - [Guides: Column filter](@/guides/columns/column-filter/column-filter.md)
|
12889
12889
|
* - [Hooks: `beforeFilter`](#beforefilter)
|
12890
12890
|
* - [Options: `filters`](@/api/options.md#filters)
|
12891
12891
|
* - [Plugins: `Filters`](@/api/filters.md)
|
@@ -12905,7 +12905,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
12905
12905
|
* This hook gets also fired on Handsontable's initialization, returning the addresses and values of all cells.
|
12906
12906
|
*
|
12907
12907
|
* Read more:
|
12908
|
-
* - [Guides: Formula calculation](@/guides/formulas/formula-calculation.md)
|
12908
|
+
* - [Guides: Formula calculation](@/guides/formulas/formula-calculation/formula-calculation.md)
|
12909
12909
|
* - [HyperFormula documentation: `valuesUpdated`](https://hyperformula.handsontable.com/api/interfaces/listeners.html#valuesupdated)
|
12910
12910
|
*
|
12911
12911
|
* @since 9.0.0
|
@@ -12994,7 +12994,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
|
|
12994
12994
|
* @since 8.4.0
|
12995
12995
|
* @param {Array} doneActions Stack of actions which may be undone.
|
12996
12996
|
* @param {string} [source] String that identifies source of action
|
12997
|
-
* ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)).
|
12997
|
+
* ([list of all available sources](@/guides/getting-started/events-and-hooks/events-and-hooks.md#definition-for-source-argument)).
|
12998
12998
|
* @returns {*|boolean} If false is returned the action of changing undo stack is canceled.
|
12999
12999
|
*/
|
13000
13000
|
'beforeUndoStackChange',
|
@@ -13785,7 +13785,7 @@ class Hooks {
|
|
13785
13785
|
/**
|
13786
13786
|
* Registers a hook name (adds it to the list of the known hook names). Used by plugins.
|
13787
13787
|
* It is not necessary to call register, but if you use it, your plugin hook will be used returned by
|
13788
|
-
* the `getRegistered` method. (which itself is used in the [demo](@/guides/getting-started/events-and-hooks.md)).
|
13788
|
+
* the `getRegistered` method. (which itself is used in the [demo](@/guides/getting-started/events-and-hooks/events-and-hooks.md)).
|
13789
13789
|
*
|
13790
13790
|
* @param {string} key The hook name.
|
13791
13791
|
*
|
@@ -18236,7 +18236,7 @@ function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollect
|
|
18236
18236
|
* @description
|
18237
18237
|
*
|
18238
18238
|
* The `CellRange` class holds a set of cell coordinates ([`CellCoords`](@/api/cellCoords.md) instances)
|
18239
|
-
* that form a [selection range](@/guides/cell-features/selection.md#select-ranges).
|
18239
|
+
* that form a [selection range](@/guides/cell-features/selection/selection.md#select-ranges).
|
18240
18240
|
*
|
18241
18241
|
* A single `CellRange` instance represents a single unit of selection
|
18242
18242
|
* that contains either a single cell or multiple adjacent cells.
|
@@ -36786,7 +36786,7 @@ var _object = __webpack_require__(117);
|
|
36786
36786
|
* @class Options
|
36787
36787
|
* @description
|
36788
36788
|
*
|
36789
|
-
* [Configuration options](@/guides/getting-started/configuration-options.md) let you heavily customize your Handsontable instance. For example, you can:
|
36789
|
+
* [Configuration options](@/guides/getting-started/configuration-options/configuration-options.md) let you heavily customize your Handsontable instance. For example, you can:
|
36790
36790
|
*
|
36791
36791
|
* - Enable and disable built-in features
|
36792
36792
|
* - Enable and configure additional [plugins](@/api/plugins.md)
|
@@ -36796,11 +36796,11 @@ var _object = __webpack_require__(117);
|
|
36796
36796
|
*
|
36797
36797
|
* ::: only-for javascript
|
36798
36798
|
*
|
36799
|
-
* To apply [configuration options](@/guides/getting-started/configuration-options.md), pass them as
|
36800
|
-
* a second argument of the [Handsontable constructor](@/guides/getting-started/installation.md#initialize-handsontable),
|
36799
|
+
* To apply [configuration options](@/guides/getting-started/configuration-options/configuration-options.md), pass them as
|
36800
|
+
* a second argument of the [Handsontable constructor](@/guides/getting-started/installation/installation.md#initialize-handsontable),
|
36801
36801
|
* using the [object literal notation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Object_initializer):
|
36802
36802
|
*
|
36803
|
-
* Read more on the [Configuration options](@/guides/getting-started/configuration-options.md) page.
|
36803
|
+
* Read more on the [Configuration options](@/guides/getting-started/configuration-options/configuration-options.md) page.
|
36804
36804
|
*
|
36805
36805
|
* ```js
|
36806
36806
|
* const container = document.getElementById('example');
|
@@ -36831,10 +36831,10 @@ var _object = __webpack_require__(117);
|
|
36831
36831
|
* ::: only-for react
|
36832
36832
|
*
|
36833
36833
|
* To apply configuration options, pass them as individual props
|
36834
|
-
* of the [`HotTable`](@/guides/getting-started/installation.md#_4-use-the-hottable-component)
|
36835
|
-
* or [`HotColumn`](@/guides/columns/react-hot-column.md) components.
|
36834
|
+
* of the [`HotTable`](@/guides/getting-started/installation/installation.md#_4-use-the-hottable-component)
|
36835
|
+
* or [`HotColumn`](@/guides/columns/react-hot-column/react-hot-column.md) components.
|
36836
36836
|
*
|
36837
|
-
* Read more on the [Configuration options](@/guides/getting-started/configuration-options.md) page.
|
36837
|
+
* Read more on the [Configuration options](@/guides/getting-started/configuration-options/configuration-options.md) page.
|
36838
36838
|
*
|
36839
36839
|
* ```jsx
|
36840
36840
|
* <HotTable
|
@@ -36861,14 +36861,14 @@ var _object = __webpack_require__(117);
|
|
36861
36861
|
* :::
|
36862
36862
|
*
|
36863
36863
|
* Depending on your needs, you can apply [configuration options](@/api/options.md) to different elements of your grid:
|
36864
|
-
* - [The entire grid](@/guides/getting-started/configuration-options.md#set-grid-options)
|
36865
|
-
* - [Individual columns](@/guides/getting-started/configuration-options.md#set-column-options)
|
36866
|
-
* - [Individual rows](@/guides/getting-started/configuration-options.md#set-row-options)
|
36867
|
-
* - [Individual cells](@/guides/getting-started/configuration-options.md#set-cell-options)
|
36868
|
-
* - [Individual grid elements, based on any logic you implement](@/guides/getting-started/configuration-options.md#implementing-custom-logic)
|
36864
|
+
* - [The entire grid](@/guides/getting-started/configuration-options/configuration-options.md#set-grid-options)
|
36865
|
+
* - [Individual columns](@/guides/getting-started/configuration-options/configuration-options.md#set-column-options)
|
36866
|
+
* - [Individual rows](@/guides/getting-started/configuration-options/configuration-options.md#set-row-options)
|
36867
|
+
* - [Individual cells](@/guides/getting-started/configuration-options/configuration-options.md#set-cell-options)
|
36868
|
+
* - [Individual grid elements, based on any logic you implement](@/guides/getting-started/configuration-options/configuration-options.md#implementing-custom-logic)
|
36869
36869
|
*
|
36870
36870
|
* Read more:
|
36871
|
-
* - [Configuration options](@/guides/getting-started/configuration-options.md)
|
36871
|
+
* - [Configuration options](@/guides/getting-started/configuration-options/configuration-options.md)
|
36872
36872
|
*/
|
36873
36873
|
var _default = () => {
|
36874
36874
|
return {
|
@@ -36953,8 +36953,8 @@ var _default = () => {
|
|
36953
36953
|
*/
|
36954
36954
|
allowEmpty: true,
|
36955
36955
|
/**
|
36956
|
-
* The `allowHtml` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md)
|
36957
|
-
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type.md) cells' [`source`](#source) data
|
36956
|
+
* The `allowHtml` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
36957
|
+
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md) cells' [`source`](#source) data
|
36958
36958
|
* is treated as HTML.
|
36959
36959
|
*
|
36960
36960
|
* You can set the `allowHtml` option to one of the following:
|
@@ -36967,8 +36967,8 @@ var _default = () => {
|
|
36967
36967
|
* __Warning:__ Setting the `allowHtml` option to `true` can cause serious XSS vulnerabilities.
|
36968
36968
|
*
|
36969
36969
|
* Read more:
|
36970
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
36971
|
-
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type.md)
|
36970
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
36971
|
+
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md)
|
36972
36972
|
* - [`source`](#source)
|
36973
36973
|
*
|
36974
36974
|
* @memberof Options#
|
@@ -36992,7 +36992,7 @@ var _default = () => {
|
|
36992
36992
|
*/
|
36993
36993
|
allowHtml: false,
|
36994
36994
|
/**
|
36995
|
-
* If set to `true`, the `allowInsertColumn` option adds the following menu items to the [context menu](@/guides/accessories-and-menus/context-menu.md):
|
36995
|
+
* If set to `true`, the `allowInsertColumn` option adds the following menu items to the [context menu](@/guides/accessories-and-menus/context-menu/context-menu.md):
|
36996
36996
|
* - **Insert column left**
|
36997
36997
|
* - **Insert column right**
|
36998
36998
|
*
|
@@ -37009,7 +37009,7 @@ var _default = () => {
|
|
37009
37009
|
*/
|
37010
37010
|
allowInsertColumn: true,
|
37011
37011
|
/**
|
37012
|
-
* If set to `true`, the `allowInsertRow` option adds the following menu items to the [context menu](@/guides/accessories-and-menus/context-menu.md):
|
37012
|
+
* If set to `true`, the `allowInsertRow` option adds the following menu items to the [context menu](@/guides/accessories-and-menus/context-menu/context-menu.md):
|
37013
37013
|
* - **Insert row above**
|
37014
37014
|
* - **Insert row below**
|
37015
37015
|
*
|
@@ -37027,21 +37027,21 @@ var _default = () => {
|
|
37027
37027
|
allowInsertRow: true,
|
37028
37028
|
/**
|
37029
37029
|
* The `allowInvalid` option determines whether Handsontable accepts values
|
37030
|
-
* that were marked as `invalid` by the [cell validator](@/guides/cell-functions/cell-validator.md).
|
37030
|
+
* that were marked as `invalid` by the [cell validator](@/guides/cell-functions/cell-validator/cell-validator.md).
|
37031
37031
|
*
|
37032
37032
|
* You can set the `allowInvalid` option to one of the following:
|
37033
37033
|
*
|
37034
37034
|
* | Setting | Description |
|
37035
37035
|
* | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
37036
|
-
* | `true` (default) | - Accept `invalid` values<br>- Allow the user to close the [cell editor](@/guides/cell-functions/cell-editor.md) with `invalid` values<br>- Save `invalid` values into the data source |
|
37037
|
-
* | `false` | - Don't accept `invalid` values<br>- Don't allow the user to close the [cell editor](@/guides/cell-functions/cell-editor.md) with `invalid` values<br>- Don't save `invalid` values into the data source |
|
37036
|
+
* | `true` (default) | - Accept `invalid` values<br>- Allow the user to close the [cell editor](@/guides/cell-functions/cell-editor/cell-editor.md) with `invalid` values<br>- Save `invalid` values into the data source |
|
37037
|
+
* | `false` | - Don't accept `invalid` values<br>- Don't allow the user to close the [cell editor](@/guides/cell-functions/cell-editor/cell-editor.md) with `invalid` values<br>- Don't save `invalid` values into the data source |
|
37038
37038
|
*
|
37039
|
-
* Setting the `allowInvalid` option to `false` can be useful when used with the [Autocomplete strict mode](@/guides/cell-types/autocomplete-cell-type.md#autocomplete-strict-mode).
|
37039
|
+
* Setting the `allowInvalid` option to `false` can be useful when used with the [Autocomplete strict mode](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md#autocomplete-strict-mode).
|
37040
37040
|
*
|
37041
37041
|
* Read more:
|
37042
|
-
* - [Cell validator](@/guides/cell-functions/cell-validator.md)
|
37043
|
-
* - [Cell editor](@/guides/cell-functions/cell-editor.md)
|
37044
|
-
* - [Autocomplete strict mode](@/guides/cell-types/autocomplete-cell-type.md#autocomplete-strict-mode)
|
37042
|
+
* - [Cell validator](@/guides/cell-functions/cell-validator/cell-validator.md)
|
37043
|
+
* - [Cell editor](@/guides/cell-functions/cell-editor/cell-editor.md)
|
37044
|
+
* - [Autocomplete strict mode](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md#autocomplete-strict-mode)
|
37045
37045
|
*
|
37046
37046
|
* @memberof Options#
|
37047
37047
|
* @type {boolean}
|
@@ -37058,11 +37058,11 @@ var _default = () => {
|
|
37058
37058
|
*/
|
37059
37059
|
allowInvalid: true,
|
37060
37060
|
/**
|
37061
|
-
* If set to `true`, the `allowRemoveColumn` option adds the following menu items to the [context menu](@/guides/accessories-and-menus/context-menu.md):
|
37061
|
+
* If set to `true`, the `allowRemoveColumn` option adds the following menu items to the [context menu](@/guides/accessories-and-menus/context-menu/context-menu.md):
|
37062
37062
|
* - **Remove column**
|
37063
37063
|
*
|
37064
37064
|
* Read more:
|
37065
|
-
* - [Context menu](@/guides/accessories-and-menus/context-menu.md)
|
37065
|
+
* - [Context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)
|
37066
37066
|
*
|
37067
37067
|
* @memberof Options#
|
37068
37068
|
* @type {boolean}
|
@@ -37077,11 +37077,11 @@ var _default = () => {
|
|
37077
37077
|
*/
|
37078
37078
|
allowRemoveColumn: true,
|
37079
37079
|
/**
|
37080
|
-
* If set to `true`, the `allowRemoveRow` option adds the following menu items to the [context menu](@/guides/accessories-and-menus/context-menu.md):
|
37080
|
+
* If set to `true`, the `allowRemoveRow` option adds the following menu items to the [context menu](@/guides/accessories-and-menus/context-menu/context-menu.md):
|
37081
37081
|
* - **Remove row**
|
37082
37082
|
*
|
37083
37083
|
* Read more:
|
37084
|
-
* - [Context menu](@/guides/accessories-and-menus/context-menu.md)
|
37084
|
+
* - [Context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)
|
37085
37085
|
*
|
37086
37086
|
* @memberof Options#
|
37087
37087
|
* @type {boolean}
|
@@ -37272,13 +37272,13 @@ var _default = () => {
|
|
37272
37272
|
*/
|
37273
37273
|
bindRowsWithHeaders: undefined,
|
37274
37274
|
/**
|
37275
|
-
* The `cell` option lets you apply [configuration options](@/guides/getting-started/configuration-options.md) to individual cells.
|
37275
|
+
* The `cell` option lets you apply [configuration options](@/guides/getting-started/configuration-options/configuration-options.md) to individual cells.
|
37276
37276
|
*
|
37277
|
-
* The `cell` option overwrites the [top-level grid options](@/guides/getting-started/configuration-options.md#set-grid-options),
|
37277
|
+
* The `cell` option overwrites the [top-level grid options](@/guides/getting-started/configuration-options/configuration-options.md#set-grid-options),
|
37278
37278
|
* and the [`columns`](#columns) options.
|
37279
37279
|
*
|
37280
37280
|
* Read more:
|
37281
|
-
* - [Configuration options: Setting cell options](@/guides/getting-started/configuration-options.md#set-cell-options)
|
37281
|
+
* - [Configuration options: Setting cell options](@/guides/getting-started/configuration-options/configuration-options.md#set-cell-options)
|
37282
37282
|
* - [`columns`](#columns)
|
37283
37283
|
*
|
37284
37284
|
* @memberof Options#
|
@@ -37302,7 +37302,7 @@ var _default = () => {
|
|
37302
37302
|
cell: [],
|
37303
37303
|
/**
|
37304
37304
|
* @description
|
37305
|
-
* The `cells` option lets you apply any other [configuration options](@/guides/getting-started/configuration-options.md) to
|
37305
|
+
* The `cells` option lets you apply any other [configuration options](@/guides/getting-started/configuration-options/configuration-options.md) to
|
37306
37306
|
* individual grid elements (columns, rows, cells), based on any logic you implement.
|
37307
37307
|
*
|
37308
37308
|
* The `cells` option overwrites all other options (including options set by [`columns`](#columns) and [`cell`](#cell)).
|
@@ -37312,11 +37312,11 @@ var _default = () => {
|
|
37312
37312
|
* | --------- | -------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
37313
37313
|
* | `row` | Yes | Number | A physical row index |
|
37314
37314
|
* | `column` | Yes | Number | A physical column index |
|
37315
|
-
* | `prop` | No | String \| Number | If [`data`](#data) is set to an [array of arrays](@/guides/getting-started/binding-to-data.md#array-of-arrays), `prop` is the same number as `column`.<br><br>If [`data`](#data) is set to an [array of objects](@/guides/getting-started/binding-to-data.md#array-of-objects), `prop` is a property name for the column's data object. |
|
37315
|
+
* | `prop` | No | String \| Number | If [`data`](#data) is set to an [array of arrays](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-arrays), `prop` is the same number as `column`.<br><br>If [`data`](#data) is set to an [array of objects](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-objects), `prop` is a property name for the column's data object. |
|
37316
37316
|
*
|
37317
37317
|
* Read more:
|
37318
|
-
* - [Configuration options: Implementing custom logic](@/guides/getting-started/configuration-options.md#implement-custom-logic)
|
37319
|
-
* - [Configuration options: Setting row options](@/guides/getting-started/configuration-options.md#set-row-options)
|
37318
|
+
* - [Configuration options: Implementing custom logic](@/guides/getting-started/configuration-options/configuration-options.md#implement-custom-logic)
|
37319
|
+
* - [Configuration options: Setting row options](@/guides/getting-started/configuration-options/configuration-options.md#set-row-options)
|
37320
37320
|
* - [`columns`](#columns)
|
37321
37321
|
* - [`cell`](#cell)
|
37322
37322
|
*
|
@@ -37344,17 +37344,17 @@ var _default = () => {
|
|
37344
37344
|
cells: undefined,
|
37345
37345
|
/**
|
37346
37346
|
* The `checkedTemplate` option lets you configure what value
|
37347
|
-
* a checked [`checkbox`](@/guides/cell-types/checkbox-cell-type.md) cell has.
|
37347
|
+
* a checked [`checkbox`](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md) cell has.
|
37348
37348
|
*
|
37349
37349
|
* You can set the `checkedTemplate` option to one of the following:
|
37350
37350
|
*
|
37351
37351
|
* | Setting | Description |
|
37352
37352
|
* | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
37353
|
-
* | `true` (default) | If a [`checkbox`](@/guides/cell-types/checkbox-cell-type.md) cell is checked,<br>the [`getDataAtCell`](@/api/core.md#getDataAtCell) method for this cell returns `true` |
|
37354
|
-
* | A string | If a [`checkbox`](@/guides/cell-types/checkbox-cell-type.md) cell is checked,<br>the [`getDataAtCell`](@/api/core.md#getDataAtCell) method for this cell returns a string of your choice |
|
37353
|
+
* | `true` (default) | If a [`checkbox`](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md) cell is checked,<br>the [`getDataAtCell`](@/api/core.md#getDataAtCell) method for this cell returns `true` |
|
37354
|
+
* | A string | If a [`checkbox`](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md) cell is checked,<br>the [`getDataAtCell`](@/api/core.md#getDataAtCell) method for this cell returns a string of your choice |
|
37355
37355
|
*
|
37356
37356
|
* Read more:
|
37357
|
-
* - [Checkbox cell type: Checkbox template](@/guides/cell-types/checkbox-cell-type.md#checkbox-template)
|
37357
|
+
* - [Checkbox cell type: Checkbox template](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md#checkbox-template)
|
37358
37358
|
* - [`getDataAtCell()`](@/api/core.md#getDataAtCell)
|
37359
37359
|
* - [`uncheckedTemplate`](#uncheckedTemplate)
|
37360
37360
|
*
|
@@ -37395,14 +37395,14 @@ var _default = () => {
|
|
37395
37395
|
* | An array of strings | Add multiple CSS class names to every currently-selected element |
|
37396
37396
|
*
|
37397
37397
|
* ::: tip
|
37398
|
-
* Don't change the `className` metadata of the [column summary](@/guides/columns/column-summary.md) row.
|
37398
|
+
* Don't change the `className` metadata of the [column summary](@/guides/columns/column-summary/column-summary.md) row.
|
37399
37399
|
* To style the summary row, use the class name assigned automatically by the [`ColumnSummary`](@/api/columnSummary.md) plugin: `columnSummaryResult`.
|
37400
37400
|
* :::
|
37401
37401
|
*
|
37402
|
-
* To apply different CSS class names on different levels, use Handsontable's [cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration).
|
37402
|
+
* To apply different CSS class names on different levels, use Handsontable's [cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration).
|
37403
37403
|
*
|
37404
37404
|
* Read more:
|
37405
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
37405
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
37406
37406
|
* - [`currentRowClassName`](#currentRowClassName)
|
37407
37407
|
* - [`currentColClassName`](#currentColClassName)
|
37408
37408
|
* - [`currentHeaderClassName`](#currentHeaderClassName)
|
@@ -37444,7 +37444,7 @@ var _default = () => {
|
|
37444
37444
|
* | A function | Define your own column headers, using a function |
|
37445
37445
|
*
|
37446
37446
|
* Read more:
|
37447
|
-
* - [Column header](@/guides/columns/column-header.md)
|
37447
|
+
* - [Column header](@/guides/columns/column-header/column-header.md)
|
37448
37448
|
*
|
37449
37449
|
* @memberof Options#
|
37450
37450
|
* @type {boolean|string[]|Function}
|
@@ -37527,18 +37527,18 @@ var _default = () => {
|
|
37527
37527
|
columnHeaderHeight: undefined,
|
37528
37528
|
/**
|
37529
37529
|
* @description
|
37530
|
-
* The `columns` option lets you apply any other [configuration options](@/guides/getting-started/configuration-options.md) to individual columns (or ranges of columns).
|
37530
|
+
* The `columns` option lets you apply any other [configuration options](@/guides/getting-started/configuration-options/configuration-options.md) to individual columns (or ranges of columns).
|
37531
37531
|
*
|
37532
37532
|
* You can set the `columns` option to one of the following:
|
37533
37533
|
* - An array of objects (each object represents one column)
|
37534
37534
|
* - A function that returns an array of objects
|
37535
37535
|
*
|
37536
|
-
* The `columns` option overwrites the [top-level grid options](@/guides/getting-started/configuration-options.md#set-grid-options).
|
37536
|
+
* The `columns` option overwrites the [top-level grid options](@/guides/getting-started/configuration-options/configuration-options.md#set-grid-options).
|
37537
37537
|
*
|
37538
37538
|
* When you use `columns`, the [`startCols`](#startCols), [`minCols`](#minCols), and [`maxCols`](#maxCols) options are ignored.
|
37539
37539
|
*
|
37540
37540
|
* Read more:
|
37541
|
-
* - [Configuration options: Setting column options](@/guides/getting-started/configuration-options.md#set-column-options)
|
37541
|
+
* - [Configuration options: Setting column options](@/guides/getting-started/configuration-options/configuration-options.md#set-column-options)
|
37542
37542
|
* - [`startCols`](#startCols)
|
37543
37543
|
* - [`minCols`](#minCols)
|
37544
37544
|
* - [`maxCols`](#maxCols)
|
@@ -37598,7 +37598,7 @@ var _default = () => {
|
|
37598
37598
|
* | `indicator` | `true`: Display the arrow icon in the column header, to indicate a sortable column<br>`false`: Don't display the arrow icon in the column header |
|
37599
37599
|
* | `headerAction` | `true`: Enable clicking on the column header to sort the column<br>`false`: Disable clicking on the column header to sort the column |
|
37600
37600
|
* | `sortEmptyCells` | `true`: Sort empty cells as well<br>`false`: Place empty cells at the end |
|
37601
|
-
* | `compareFunctionFactory` | A [custom compare function](@/guides/rows/rows-sorting.md#add-a-custom-comparator) |
|
37601
|
+
* | `compareFunctionFactory` | A [custom compare function](@/guides/rows/rows-sorting/rows-sorting.md#add-a-custom-comparator) |
|
37602
37602
|
*
|
37603
37603
|
* If you set the `columnSorting` option to an object,
|
37604
37604
|
* you can also sort individual columns at Handsontable's initialization.
|
@@ -37611,8 +37611,8 @@ var _default = () => {
|
|
37611
37611
|
* | `sortOrder` | `'asc'` \| `'desc'` | The sorting order:<br>`'asc'`: ascending<br>`'desc'`: descending |
|
37612
37612
|
*
|
37613
37613
|
* Read more:
|
37614
|
-
* - [Rows sorting](@/guides/rows/rows-sorting.md)
|
37615
|
-
* - [Rows sorting: Custom compare functions](@/guides/rows/rows-sorting.md#add-a-custom-comparator)
|
37614
|
+
* - [Rows sorting](@/guides/rows/rows-sorting/rows-sorting.md)
|
37615
|
+
* - [Rows sorting: Custom compare functions](@/guides/rows/rows-sorting/rows-sorting.md#add-a-custom-comparator)
|
37616
37616
|
* - [`multiColumnSorting`](#multiColumnSorting)
|
37617
37617
|
*
|
37618
37618
|
* @memberof Options#
|
@@ -37666,20 +37666,20 @@ var _default = () => {
|
|
37666
37666
|
*
|
37667
37667
|
* | Property | Possible values | Description |
|
37668
37668
|
* | ------------------------ | ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
37669
|
-
* | `sourceColumn` | A number | [Column to summarize](@/guides/columns/column-summary.md#step-2-select-cells-that-you-want-to-summarize) |
|
37670
|
-
* | `ranges` | An array | [Ranges of rows to summarize](@/guides/columns/column-summary.md#step-2-select-cells-that-you-want-to-summarize) |
|
37671
|
-
* | `type` | `'sum'` \| `'min'` \| `'max'` \| `'count'` \| `'average'` \| `'custom'` | [Summary function](@/guides/columns/column-summary.md#step-3-calculate-your-summary) |
|
37672
|
-
* | `destinationRow` | A number | [Destination cell's row coordinate](@/guides/columns/column-summary.md#step-4-provide-the-destination-cell-s-coordinates) |
|
37673
|
-
* | `destinationColumn` | A number | [Destination cell's column coordinate](@/guides/columns/column-summary.md#step-4-provide-the-destination-cell-s-coordinates) |
|
37674
|
-
* | `forceNumeric` | `true` \| `false` | [Treat non-numerics as numerics](@/guides/columns/column-summary.md#force-numeric-values) |
|
37675
|
-
* | `reversedRowCoords` | `true` \| `false` | [Reverse row coordinates](@/guides/columns/column-summary.md#step-5-make-room-for-the-destination-cell) |
|
37676
|
-
* | `suppressDataTypeErrors` | `true` \| `false` | [Suppress data type errors](@/guides/columns/column-summary.md#throw-data-type-errors) |
|
37669
|
+
* | `sourceColumn` | A number | [Column to summarize](@/guides/columns/column-summary/column-summary.md#step-2-select-cells-that-you-want-to-summarize) |
|
37670
|
+
* | `ranges` | An array | [Ranges of rows to summarize](@/guides/columns/column-summary/column-summary.md#step-2-select-cells-that-you-want-to-summarize) |
|
37671
|
+
* | `type` | `'sum'` \| `'min'` \| `'max'` \| `'count'` \| `'average'` \| `'custom'` | [Summary function](@/guides/columns/column-summary/column-summary.md#step-3-calculate-your-summary) |
|
37672
|
+
* | `destinationRow` | A number | [Destination cell's row coordinate](@/guides/columns/column-summary/column-summary.md#step-4-provide-the-destination-cell-s-coordinates) |
|
37673
|
+
* | `destinationColumn` | A number | [Destination cell's column coordinate](@/guides/columns/column-summary/column-summary.md#step-4-provide-the-destination-cell-s-coordinates) |
|
37674
|
+
* | `forceNumeric` | `true` \| `false` | [Treat non-numerics as numerics](@/guides/columns/column-summary/column-summary.md#force-numeric-values) |
|
37675
|
+
* | `reversedRowCoords` | `true` \| `false` | [Reverse row coordinates](@/guides/columns/column-summary/column-summary.md#step-5-make-room-for-the-destination-cell) |
|
37676
|
+
* | `suppressDataTypeErrors` | `true` \| `false` | [Suppress data type errors](@/guides/columns/column-summary/column-summary.md#throw-data-type-errors) |
|
37677
37677
|
* | `readOnly` | `true` \| `false` | Make summary cell read-only |
|
37678
|
-
* | `roundFloat` | `true` \| `false` \| A number | [Round summary result](@/guides/columns/column-summary.md#round-a-column-summary-result) |
|
37679
|
-
* | `customFunction` | A function | [Custom summary function](@/guides/columns/column-summary.md#implement-a-custom-summary-function) |
|
37678
|
+
* | `roundFloat` | `true` \| `false` \| A number | [Round summary result](@/guides/columns/column-summary/column-summary.md#round-a-column-summary-result) |
|
37679
|
+
* | `customFunction` | A function | [Custom summary function](@/guides/columns/column-summary/column-summary.md#implement-a-custom-summary-function) |
|
37680
37680
|
*
|
37681
37681
|
* Read more:
|
37682
|
-
* - [Column summary](@/guides/columns/column-summary.md)
|
37682
|
+
* - [Column summary](@/guides/columns/column-summary/column-summary.md)
|
37683
37683
|
* - [Plugins: `ColumnSummary`](@/api/columnSummary.md)
|
37684
37684
|
*
|
37685
37685
|
* @memberof Options#
|
@@ -37730,7 +37730,7 @@ var _default = () => {
|
|
37730
37730
|
* which may cut longer columns names.
|
37731
37731
|
*
|
37732
37732
|
* Read more:
|
37733
|
-
* - [Column width](@/guides/columns/column-width.md)
|
37733
|
+
* - [Column width](@/guides/columns/column-width/column-width.md)
|
37734
37734
|
* - [Hooks: `modifyColWidth`](@/api/hooks.md#modifyColWidth)
|
37735
37735
|
* - [`autoColumnSize`](#autoColumnSize)
|
37736
37736
|
*
|
@@ -37765,7 +37765,7 @@ var _default = () => {
|
|
37765
37765
|
* that have comments.
|
37766
37766
|
*
|
37767
37767
|
* Read more:
|
37768
|
-
* - [Comments](@/guides/cell-features/comments.md)
|
37768
|
+
* - [Comments](@/guides/cell-features/comments/comments.md)
|
37769
37769
|
* - [`comments`](#comments)
|
37770
37770
|
* - [`readOnlyCellClassName`](#readOnlyCellClassName)
|
37771
37771
|
* - [`currentRowClassName`](#currentRowClassName)
|
@@ -37799,9 +37799,9 @@ var _default = () => {
|
|
37799
37799
|
*
|
37800
37800
|
* | Setting | Description |
|
37801
37801
|
* | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
37802
|
-
* | `true` | - Enable the [`Comments`](@/api/comments.md) plugin<br>- Add comment menu items to the [context menu](@/guides/accessories-and-menus/context-menu.md) |
|
37802
|
+
* | `true` | - Enable the [`Comments`](@/api/comments.md) plugin<br>- Add comment menu items to the [context menu](@/guides/accessories-and-menus/context-menu/context-menu.md) |
|
37803
37803
|
* | `false` | Disable the [`Comments`](@/api/comments.md) plugin |
|
37804
|
-
* | An object | - Enable the [`Comments`](@/api/comments.md) plugin<br>- Add comment menu items to the [context menu](@/guides/accessories-and-menus/context-menu.md)<br>- Configure comment settings |
|
37804
|
+
* | An object | - Enable the [`Comments`](@/api/comments.md) plugin<br>- Add comment menu items to the [context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)<br>- Configure comment settings |
|
37805
37805
|
*
|
37806
37806
|
* If you set the `comments` option to an object, you can configure the following comment options:
|
37807
37807
|
*
|
@@ -37812,8 +37812,8 @@ var _default = () => {
|
|
37812
37812
|
* | `style` | An object | Set comment boxes' `width` and `height` (in pixels) |
|
37813
37813
|
*
|
37814
37814
|
* Read more:
|
37815
|
-
* - [Comments](@/guides/cell-features/comments.md)
|
37816
|
-
* - [Context menu](@/guides/accessories-and-menus/context-menu.md)
|
37815
|
+
* - [Comments](@/guides/cell-features/comments/comments.md)
|
37816
|
+
* - [Context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)
|
37817
37817
|
* - [`width`](#width)
|
37818
37818
|
* - [`height`](#height)
|
37819
37819
|
* - [`readOnly`](#readOnly)
|
@@ -37854,15 +37854,15 @@ var _default = () => {
|
|
37854
37854
|
* | Setting | Description |
|
37855
37855
|
* | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
37856
37856
|
* | `false` | Disable the [`ContextMenu`](@/api/contextMenu.md) plugin |
|
37857
|
-
* | `true` | - Enable the [`ContextMenu`](@/api/contextMenu.md) plugin<br>- Use the [default context menu options](@/guides/accessories-and-menus/context-menu.md#context-menu-with-default-options) |
|
37858
|
-
* | An array | - Enable the [`ContextMenu`](@/api/contextMenu.md) plugin<br>- Modify [individual context menu options](@/guides/accessories-and-menus/context-menu.md#context-menu-with-specific-options) |
|
37859
|
-
* | An object | - Enable the [`ContextMenu`](@/api/contextMenu.md) plugin<br>- Apply a [custom context menu configuration](@/guides/accessories-and-menus/context-menu.md#context-menu-with-a-fully-custom-configuration) |
|
37857
|
+
* | `true` | - Enable the [`ContextMenu`](@/api/contextMenu.md) plugin<br>- Use the [default context menu options](@/guides/accessories-and-menus/context-menu/context-menu.md#context-menu-with-default-options) |
|
37858
|
+
* | An array | - Enable the [`ContextMenu`](@/api/contextMenu.md) plugin<br>- Modify [individual context menu options](@/guides/accessories-and-menus/context-menu/context-menu.md#context-menu-with-specific-options) |
|
37859
|
+
* | An object | - Enable the [`ContextMenu`](@/api/contextMenu.md) plugin<br>- Apply a [custom context menu configuration](@/guides/accessories-and-menus/context-menu/context-menu.md#context-menu-with-a-fully-custom-configuration) |
|
37860
37860
|
*
|
37861
37861
|
* Read more:
|
37862
|
-
* - [Context menu](@/guides/accessories-and-menus/context-menu.md)
|
37863
|
-
* - [Context menu: Context menu with default options](@/guides/accessories-and-menus/context-menu.md#context-menu-with-default-options)
|
37864
|
-
* - [Context menu: Context menu with specific options](@/guides/accessories-and-menus/context-menu.md#context-menu-with-specific-options)
|
37865
|
-
* - [Context menu: Context menu with fully custom configuration options](@/guides/accessories-and-menus/context-menu.md#context-menu-with-a-fully-custom-configuration)
|
37862
|
+
* - [Context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)
|
37863
|
+
* - [Context menu: Context menu with default options](@/guides/accessories-and-menus/context-menu/context-menu.md#context-menu-with-default-options)
|
37864
|
+
* - [Context menu: Context menu with specific options](@/guides/accessories-and-menus/context-menu/context-menu.md#context-menu-with-specific-options)
|
37865
|
+
* - [Context menu: Context menu with fully custom configuration options](@/guides/accessories-and-menus/context-menu/context-menu.md#context-menu-with-a-fully-custom-configuration)
|
37866
37866
|
* - [Plugins: `ContextMenu`](@/api/contextMenu.md)
|
37867
37867
|
*
|
37868
37868
|
* @memberof Options#
|
@@ -37916,12 +37916,12 @@ var _default = () => {
|
|
37916
37916
|
* | Setting | Description |
|
37917
37917
|
* | -------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
37918
37918
|
* | `true` (default) | - On pressing <kbd>**Ctrl**</kbd>/<kbd>**Cmd**</kbd>+<kbd>**C**</kbd>, add the cell's value to the clipboard |
|
37919
|
-
* | `false`<br>(default for the [`password`](@/guides/cell-types/password-cell-type.md) [cell type](#type)) | - On pressing <kbd>**Ctrl**</kbd>/<kbd>**Cmd**</kbd>+<kbd>**C**</kbd>, add an empty string (`""`) to the clipboard |
|
37919
|
+
* | `false`<br>(default for the [`password`](@/guides/cell-types/password-cell-type/password-cell-type.md) [cell type](#type)) | - On pressing <kbd>**Ctrl**</kbd>/<kbd>**Cmd**</kbd>+<kbd>**C**</kbd>, add an empty string (`""`) to the clipboard |
|
37920
37920
|
*
|
37921
37921
|
* Read more:
|
37922
|
-
* - [Clipboard](@/guides/cell-features/clipboard.md)
|
37923
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
37924
|
-
* - [Password cell type](@/guides/cell-types/password-cell-type.md)
|
37922
|
+
* - [Clipboard](@/guides/cell-features/clipboard/clipboard.md)
|
37923
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
37924
|
+
* - [Password cell type](@/guides/cell-types/password-cell-type/password-cell-type.md)
|
37925
37925
|
*
|
37926
37926
|
* @memberof Options#
|
37927
37927
|
* @type {boolean}
|
@@ -37984,7 +37984,7 @@ var _default = () => {
|
|
37984
37984
|
*
|
37985
37985
|
* Read more:
|
37986
37986
|
* - [Plugins: `CopyPaste`](@/api/copyPaste.md)
|
37987
|
-
* - [Guides: Clipboard](@/guides/cell-features/clipboard.md)
|
37987
|
+
* - [Guides: Clipboard](@/guides/cell-features/clipboard/clipboard.md)
|
37988
37988
|
*
|
37989
37989
|
* @memberof Options#
|
37990
37990
|
* @type {object|boolean}
|
@@ -38029,18 +38029,18 @@ var _default = () => {
|
|
38029
38029
|
* The `correctFormat` option configures whether incorrectly-formatted times and dates are amended or not.
|
38030
38030
|
*
|
38031
38031
|
* When the user enters dates and times, Handsontable can automatically adjust their format
|
38032
|
-
* to match the [`dateFormat`](#dateFormat) and [`timeFormat`](@/guides/cell-types/time-cell-type.md) settings.
|
38032
|
+
* to match the [`dateFormat`](#dateFormat) and [`timeFormat`](@/guides/cell-types/time-cell-type/time-cell-type.md) settings.
|
38033
38033
|
*
|
38034
38034
|
* You can set the `correctFormat` option to one of the following:
|
38035
38035
|
*
|
38036
38036
|
* | Setting | Description |
|
38037
38037
|
* | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
38038
38038
|
* | `false` (default) | Don't correct the format of the entered date or time (treat the entered date or time as invalid) |
|
38039
|
-
* | `true` | Correct the format of the entered date or time to match the [`dateFormat`](#dateFormat) or [`timeFormat`](@/guides/cell-types/time-cell-type.md) settings |
|
38039
|
+
* | `true` | Correct the format of the entered date or time to match the [`dateFormat`](#dateFormat) or [`timeFormat`](@/guides/cell-types/time-cell-type/time-cell-type.md) settings |
|
38040
38040
|
*
|
38041
38041
|
* Read more:
|
38042
|
-
* - [Date cell type](@/guides/cell-types/date-cell-type.md)
|
38043
|
-
* - [Time cell type](@/guides/cell-types/time-cell-type.md)
|
38042
|
+
* - [Date cell type](@/guides/cell-types/date-cell-type/date-cell-type.md)
|
38043
|
+
* - [Time cell type](@/guides/cell-types/time-cell-type/time-cell-type.md)
|
38044
38044
|
* - [`dateFormat`](#dateFormat)
|
38045
38045
|
*
|
38046
38046
|
* @memberof Options#
|
@@ -38163,7 +38163,7 @@ var _default = () => {
|
|
38163
38163
|
* The `customBorders` option configures the [`CustomBorders`](@/api/customBorders.md) plugin.
|
38164
38164
|
*
|
38165
38165
|
* To enable the [`CustomBorders`](@/api/customBorders.md) plugin
|
38166
|
-
* (and add its menu items to the [context menu](@/guides/accessories-and-menus/context-menu.md)),
|
38166
|
+
* (and add its menu items to the [context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)),
|
38167
38167
|
* set the `customBorders` option to `true`.
|
38168
38168
|
*
|
38169
38169
|
* To enable the [`CustomBorders`](@/api/customBorders.md) plugin
|
@@ -38175,8 +38175,8 @@ var _default = () => {
|
|
38175
38175
|
* | -------- | ------------------ | ---------------------------------- | ----------------------------------------------------------------- |
|
38176
38176
|
* | `row` | - | `row`: Number | The cell's row coordinate. |
|
38177
38177
|
* | `col` | - | `col`: Number | The cell's column coordinate. |
|
38178
|
-
* | `start` | `width`<br>`color` | `width`: Number<br>`color`: String | If the [layout direction](@/guides/internationalization/layout-direction.md) is LTR (default): `start` sets the width (`width`) and color (`color`) of the left-hand border.<br><br>If the [layout direction](@/guides/internationalization/layout-direction.md) is RTL: `start` sets the width (`width`) and color (`color`) of the right-hand border. |
|
38179
|
-
* | `end` | `width`<br>`color` | `width`: Number<br>`color`: String | If the [layout direction](@/guides/internationalization/layout-direction.md) is LTR (default): `end` sets the width (`width`) and color (`color`) of the right-hand border.<br><br>If the [layout direction](@/guides/internationalization/layout-direction.md) is RTL: `end` sets the width (`width`) and color (`color`) of the left-hand border. |
|
38178
|
+
* | `start` | `width`<br>`color` | `width`: Number<br>`color`: String | If the [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) is LTR (default): `start` sets the width (`width`) and color (`color`) of the left-hand border.<br><br>If the [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) is RTL: `start` sets the width (`width`) and color (`color`) of the right-hand border. |
|
38179
|
+
* | `end` | `width`<br>`color` | `width`: Number<br>`color`: String | If the [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) is LTR (default): `end` sets the width (`width`) and color (`color`) of the right-hand border.<br><br>If the [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) is RTL: `end` sets the width (`width`) and color (`color`) of the left-hand border. |
|
38180
38180
|
* | `top` | `width`<br>`color` | `width`: Number<br>`color`: String | Sets the width (`width`) and color (`color`) of the top border. |
|
38181
38181
|
* | `bottom` | `width`<br>`color` | `width`: Number<br>`color`: String | Sets the width (`width`) and color (`color`) of the bottom border. |
|
38182
38182
|
*
|
@@ -38187,17 +38187,17 @@ var _default = () => {
|
|
38187
38187
|
*
|
38188
38188
|
* | Property | Sub-properties | Types | Description |
|
38189
38189
|
* | -------- | -------------------------------------------- | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
38190
|
-
* | `range` | `from` {`row`, `col`}<br>`to` {`row`, `col`} | `from`: Object<br>`to`: Object<br>`row`: Number<br>`col`: Number | If the [layout direction](@/guides/internationalization/layout-direction.md) is LTR (default):<br>- `from` selects the range's top-left corner.<br>- `to` selects the range's bottom-right corner.<br><br>If the [layout direction](@/guides/internationalization/layout-direction.md) is RTL: <br>- `from` selects the range's top-right corner.<br>- `to` selects the range's bottom-left corner. |
|
38191
|
-
* | `start` | `width`<br>`color` | `width`: Number<br>`color`: String | If the [layout direction](@/guides/internationalization/layout-direction.md) is LTR (default): `start` sets the width (`width`) and color (`color`) of the left-hand border.<br><br>If the [layout direction](@/guides/internationalization/layout-direction.md) is RTL: `start` sets the width (`width`) and color (`color`) of the right-hand border. |
|
38192
|
-
* | `end` | `width`<br>`color` | `width`: Number<br>`color`: String | If the [layout direction](@/guides/internationalization/layout-direction.md) is LTR (default): `end` sets the width (`width`) and color (`color`) of the right-hand border.<br><br>If the [layout direction](@/guides/internationalization/layout-direction.md) is RTL: `end` sets the width (`width`) and color (`color`) of the left-hand border. |
|
38190
|
+
* | `range` | `from` {`row`, `col`}<br>`to` {`row`, `col`} | `from`: Object<br>`to`: Object<br>`row`: Number<br>`col`: Number | If the [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) is LTR (default):<br>- `from` selects the range's top-left corner.<br>- `to` selects the range's bottom-right corner.<br><br>If the [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) is RTL: <br>- `from` selects the range's top-right corner.<br>- `to` selects the range's bottom-left corner. |
|
38191
|
+
* | `start` | `width`<br>`color` | `width`: Number<br>`color`: String | If the [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) is LTR (default): `start` sets the width (`width`) and color (`color`) of the left-hand border.<br><br>If the [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) is RTL: `start` sets the width (`width`) and color (`color`) of the right-hand border. |
|
38192
|
+
* | `end` | `width`<br>`color` | `width`: Number<br>`color`: String | If the [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) is LTR (default): `end` sets the width (`width`) and color (`color`) of the right-hand border.<br><br>If the [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) is RTL: `end` sets the width (`width`) and color (`color`) of the left-hand border. |
|
38193
38193
|
* | `top` | `width`<br>`color` | `width`: Number<br>`color`: String | Sets the width (`width`) and color (`color`) of the top border. |
|
38194
38194
|
* | `bottom` | `width`<br>`color` | `width`: Number<br>`color`: String | Sets the width (`width`) and color (`color`) of the bottom border. |
|
38195
38195
|
*
|
38196
38196
|
* Read more:
|
38197
|
-
* - [Formatting cells: Custom cell borders](@/guides/cell-features/formatting-cells.md#custom-cell-borders)
|
38198
|
-
* - [Context menu](@/guides/accessories-and-menus/context-menu.md)
|
38197
|
+
* - [Formatting cells: Custom cell borders](@/guides/cell-features/formatting-cells/formatting-cells.md#custom-cell-borders)
|
38198
|
+
* - [Context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)
|
38199
38199
|
* - [Plugins: `CustomBorders`](@/api/customBorders.md)
|
38200
|
-
* - [Layout direction](@/guides/internationalization/layout-direction.md)
|
38200
|
+
* - [Layout direction](@/guides/internationalization/layout-direction/layout-direction.md)
|
38201
38201
|
* - [`layoutDirection`](#layoutDirection)
|
38202
38202
|
*
|
38203
38203
|
* @memberof Options#
|
@@ -38272,18 +38272,18 @@ var _default = () => {
|
|
38272
38272
|
customBorders: false,
|
38273
38273
|
/**
|
38274
38274
|
* @description
|
38275
|
-
* The `data` option sets the initial [data](@/guides/getting-started/binding-to-data.md) of your Handsontable instance.
|
38275
|
+
* The `data` option sets the initial [data](@/guides/getting-started/binding-to-data/binding-to-data.md) of your Handsontable instance.
|
38276
38276
|
*
|
38277
38277
|
* Handsontable's data is bound to your source data by reference (i.e. when you edit Handsontable's data, your source data alters as well).
|
38278
38278
|
*
|
38279
38279
|
* You can set the `data` option:
|
38280
|
-
* - Either to an [array of arrays](@/guides/getting-started/binding-to-data.md#array-of-arrays).
|
38281
|
-
* - Or to an [array of objects](@/guides/getting-started/binding-to-data.md#array-of-objects).
|
38280
|
+
* - Either to an [array of arrays](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-arrays).
|
38281
|
+
* - Or to an [array of objects](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-objects).
|
38282
38282
|
*
|
38283
38283
|
* If you don't set the `data` option (or set it to `null`), Handsontable renders as an empty 5x5 grid by default.
|
38284
38284
|
*
|
38285
38285
|
* Read more:
|
38286
|
-
* - [Binding to data](@/guides/getting-started/binding-to-data.md)
|
38286
|
+
* - [Binding to data](@/guides/getting-started/binding-to-data/binding-to-data.md)
|
38287
38287
|
* - [`dataSchema`](#dataSchema)
|
38288
38288
|
* - [`startRows`](#startRows)
|
38289
38289
|
* - [`startCols`](#startCols)
|
@@ -38315,7 +38315,7 @@ var _default = () => {
|
|
38315
38315
|
data: undefined,
|
38316
38316
|
/**
|
38317
38317
|
* @description
|
38318
|
-
* When the [`data`](#data) option is set to an [array of objects](@/guides/getting-started/binding-to-data.md#array-of-objects)
|
38318
|
+
* When the [`data`](#data) option is set to an [array of objects](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-objects)
|
38319
38319
|
* (or is empty), the `dataSchema` option defines the structure of new rows.
|
38320
38320
|
*
|
38321
38321
|
* Using the `dataSchema` option, you can start out with an empty grid.
|
@@ -38325,8 +38325,8 @@ var _default = () => {
|
|
38325
38325
|
* - A function
|
38326
38326
|
*
|
38327
38327
|
* Read more:
|
38328
|
-
* - [Binding to data: Array of objects with custom data schema](@/guides/getting-started/binding-to-data.md#array-of-objects-with-custom-data-schema)
|
38329
|
-
* - [Binding to data: Function data source and schema](@/guides/getting-started/binding-to-data.md#function-data-source-and-schema)
|
38328
|
+
* - [Binding to data: Array of objects with custom data schema](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-objects-with-custom-data-schema)
|
38329
|
+
* - [Binding to data: Function data source and schema](@/guides/getting-started/binding-to-data/binding-to-data.md#function-data-source-and-schema)
|
38330
38330
|
* - [`data`](#data)
|
38331
38331
|
*
|
38332
38332
|
* @memberof Options#
|
@@ -38352,14 +38352,14 @@ var _default = () => {
|
|
38352
38352
|
*/
|
38353
38353
|
dataSchema: undefined,
|
38354
38354
|
/**
|
38355
|
-
* The `dateFormat` option configures the date format accepted by [`date`](@/guides/cell-types/date-cell-type.md) cells.
|
38355
|
+
* The `dateFormat` option configures the date format accepted by [`date`](@/guides/cell-types/date-cell-type/date-cell-type.md) cells.
|
38356
38356
|
*
|
38357
38357
|
* You can set the `dateFormat` option to a string with a proper date format. The default value is: `'DD/MM/YYYY'`.
|
38358
38358
|
*
|
38359
38359
|
* To automatically correct dates whose format doesn't match the `dateFormat` setting, use the [`correctFormat`](#correctFormat) option.
|
38360
38360
|
*
|
38361
38361
|
* Read more:
|
38362
|
-
* - [Date cell type](@/guides/cell-types/date-cell-type.md)
|
38362
|
+
* - [Date cell type](@/guides/cell-types/date-cell-type/date-cell-type.md)
|
38363
38363
|
* - [`correctFormat`](#correctFormat)
|
38364
38364
|
* - [`defaultDate`](#defaultDate)
|
38365
38365
|
*
|
@@ -38382,16 +38382,16 @@ var _default = () => {
|
|
38382
38382
|
*/
|
38383
38383
|
dateFormat: 'DD/MM/YYYY',
|
38384
38384
|
/**
|
38385
|
-
* The `datePickerConfig` option configures the `date` [cell editor](@/guides/cell-functions/cell-editor.md)'s date picker, which uses an external dependency: [Pikaday](https://github.com/Pikaday/Pikaday/tree/1.8.2).
|
38385
|
+
* The `datePickerConfig` option configures the `date` [cell editor](@/guides/cell-functions/cell-editor/cell-editor.md)'s date picker, which uses an external dependency: [Pikaday](https://github.com/Pikaday/Pikaday/tree/1.8.2).
|
38386
38386
|
*
|
38387
38387
|
* You can set the `datePickerConfig` option to an object with any of the available [Pikaday options](https://github.com/Pikaday/Pikaday/tree/1.8.2#configuration),
|
38388
|
-
* except for the following, which are always overwritten by the `date` [cell editor](@/guides/cell-functions/cell-editor.md):
|
38388
|
+
* except for the following, which are always overwritten by the `date` [cell editor](@/guides/cell-functions/cell-editor/cell-editor.md):
|
38389
38389
|
* - `bound`
|
38390
38390
|
* - `container`
|
38391
38391
|
* - `field`
|
38392
38392
|
* - `trigger`
|
38393
38393
|
*
|
38394
|
-
* If the `datePickerConfig` option is not defined, the `date` [cell editor](@/guides/cell-functions/cell-editor.md) overwrites the following [Pikaday options](https://github.com/Pikaday/Pikaday/tree/1.8.2#configuration) as well:
|
38394
|
+
* If the `datePickerConfig` option is not defined, the `date` [cell editor](@/guides/cell-functions/cell-editor/cell-editor.md) overwrites the following [Pikaday options](https://github.com/Pikaday/Pikaday/tree/1.8.2#configuration) as well:
|
38395
38395
|
*
|
38396
38396
|
* | Pikaday option | Handsontable's setting |
|
38397
38397
|
* | -------------------- | ---------------------- |
|
@@ -38401,7 +38401,7 @@ var _default = () => {
|
|
38401
38401
|
* Read more:
|
38402
38402
|
* - [`editor`](#editor)
|
38403
38403
|
* - [`dateFormat`](#dateFormat)
|
38404
|
-
* - [Cell editor](@/guides/cell-functions/cell-editor.md)
|
38404
|
+
* - [Cell editor](@/guides/cell-functions/cell-editor/cell-editor.md)
|
38405
38405
|
* - [All Pikaday options →](https://github.com/Pikaday/Pikaday/tree/1.8.2#configuration)
|
38406
38406
|
*
|
38407
38407
|
* @memberof Options#
|
@@ -38412,12 +38412,12 @@ var _default = () => {
|
|
38412
38412
|
datePickerConfig: undefined,
|
38413
38413
|
/**
|
38414
38414
|
* The `defaultDate` option configures the date displayed
|
38415
|
-
* in empty [`date`](@/guides/cell-types/date-cell-type.md) cells.
|
38415
|
+
* in empty [`date`](@/guides/cell-types/date-cell-type/date-cell-type.md) cells.
|
38416
38416
|
*
|
38417
38417
|
* You can set the `defaultDate` option to a string.
|
38418
38418
|
*
|
38419
38419
|
* Read more:
|
38420
|
-
* - [Date cell type](@/guides/cell-types/date-cell-type.md)
|
38420
|
+
* - [Date cell type](@/guides/cell-types/date-cell-type/date-cell-type.md)
|
38421
38421
|
* - [`dateFormat`](#dateFormat)
|
38422
38422
|
*
|
38423
38423
|
* @memberof Options#
|
@@ -38441,7 +38441,7 @@ var _default = () => {
|
|
38441
38441
|
/**
|
38442
38442
|
* @description
|
38443
38443
|
* The `disableVisualSelection` option configures how
|
38444
|
-
* [selection](@/guides/cell-features/selection.md) is shown.
|
38444
|
+
* [selection](@/guides/cell-features/selection/selection.md) is shown.
|
38445
38445
|
*
|
38446
38446
|
* You can set the `disableVisualSelection` option to one of the following:
|
38447
38447
|
*
|
@@ -38455,7 +38455,7 @@ var _default = () => {
|
|
38455
38455
|
* | An array | A combination of `'current'`, `'area'`, and/or `'header'` |
|
38456
38456
|
*
|
38457
38457
|
* Read more:
|
38458
|
-
* - [Selection](@/guides/cell-features/selection.md)
|
38458
|
+
* - [Selection](@/guides/cell-features/selection/selection.md)
|
38459
38459
|
*
|
38460
38460
|
* @memberof Options#
|
38461
38461
|
* @type {boolean|string|string[]}
|
@@ -38515,12 +38515,12 @@ var _default = () => {
|
|
38515
38515
|
* | Setting | Description |
|
38516
38516
|
* | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
38517
38517
|
* | `false` | Disable the [`DropdownMenu`](@/api/dropdownMenu.md) plugin |
|
38518
|
-
* | `true` | - Enable the [`DropdownMenu`](@/api/dropdownMenu.md) plugin<br>- Use the [default context menu options](@/guides/accessories-and-menus/context-menu.md#context-menu-with-default-options) |
|
38519
|
-
* | An array | - Enable the [`DropdownMenu`](@/api/dropdownMenu.md) plugin<br>- Modify [individual context menu options](@/guides/accessories-and-menus/context-menu.md#context-menu-with-specific-options) |
|
38518
|
+
* | `true` | - Enable the [`DropdownMenu`](@/api/dropdownMenu.md) plugin<br>- Use the [default context menu options](@/guides/accessories-and-menus/context-menu/context-menu.md#context-menu-with-default-options) |
|
38519
|
+
* | An array | - Enable the [`DropdownMenu`](@/api/dropdownMenu.md) plugin<br>- Modify [individual context menu options](@/guides/accessories-and-menus/context-menu/context-menu.md#context-menu-with-specific-options) |
|
38520
38520
|
* | An object | - Enable the [`DropdownMenu`](@/api/dropdownMenu.md) plugin<br>- Apply a custom dropdown menu configuration |
|
38521
38521
|
*
|
38522
38522
|
* Read more:
|
38523
|
-
* - [Context menu](@/guides/accessories-and-menus/context-menu.md)
|
38523
|
+
* - [Context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)
|
38524
38524
|
* - [Plugins: `DropdownMenu`](@/api/dropdownMenu.md)
|
38525
38525
|
*
|
38526
38526
|
* @memberof Options#
|
@@ -38566,13 +38566,13 @@ var _default = () => {
|
|
38566
38566
|
*/
|
38567
38567
|
dropdownMenu: undefined,
|
38568
38568
|
/**
|
38569
|
-
* The `editor` option sets a [cell editor](@/guides/cell-functions/cell-editor.md) for a cell.
|
38569
|
+
* The `editor` option sets a [cell editor](@/guides/cell-functions/cell-editor/cell-editor.md) for a cell.
|
38570
38570
|
*
|
38571
|
-
* You can set the `editor` option to one of the following [cell editor aliases](@/guides/cell-functions/cell-editor.md):
|
38571
|
+
* You can set the `editor` option to one of the following [cell editor aliases](@/guides/cell-functions/cell-editor/cell-editor.md):
|
38572
38572
|
*
|
38573
38573
|
* | Alias | Cell editor function |
|
38574
38574
|
* | ------------------- | -------------------------------------------------------------------------- |
|
38575
|
-
* | A custom alias | Your [custom cell editor](@/guides/cell-functions/cell-editor.md) function |
|
38575
|
+
* | A custom alias | Your [custom cell editor](@/guides/cell-functions/cell-editor/cell-editor.md) function |
|
38576
38576
|
* | `'autocomplete'` | `AutocompleteEditor` |
|
38577
38577
|
* | `'base'` | `BaseEditor` |
|
38578
38578
|
* | `'checkbox'` | `CheckboxEditor` |
|
@@ -38594,9 +38594,9 @@ var _default = () => {
|
|
38594
38594
|
* options all at once, use the [`type`](#type) option.
|
38595
38595
|
*
|
38596
38596
|
* Read more:
|
38597
|
-
* - [Cell editor](@/guides/cell-functions/cell-editor.md)
|
38598
|
-
* - [Cell type](@/guides/cell-types/cell-type.md)
|
38599
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
38597
|
+
* - [Cell editor](@/guides/cell-functions/cell-editor/cell-editor.md)
|
38598
|
+
* - [Cell type](@/guides/cell-types/cell-type/cell-type.md)
|
38599
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
38600
38600
|
* - [`type`](#type)
|
38601
38601
|
*
|
38602
38602
|
* @memberof Options#
|
@@ -38716,7 +38716,7 @@ var _default = () => {
|
|
38716
38716
|
* | `direction` | `'vertical'` \| `'horizontal'` | `'vertical'`: Enable vertical autofill<br>`'horizontal'`: Enable horizontal autofill |
|
38717
38717
|
*
|
38718
38718
|
* Read more:
|
38719
|
-
* - [AutoFill values](@/guides/cell-features/autofill-values.md)
|
38719
|
+
* - [AutoFill values](@/guides/cell-features/autofill-values/autofill-values.md)
|
38720
38720
|
*
|
38721
38721
|
* @memberof Options#
|
38722
38722
|
* @type {boolean|string|object}
|
@@ -38755,7 +38755,7 @@ var _default = () => {
|
|
38755
38755
|
autoInsertRow: false
|
38756
38756
|
},
|
38757
38757
|
/**
|
38758
|
-
* The `filter` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md) cells'
|
38758
|
+
* The `filter` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) cells'
|
38759
38759
|
* lists are updated by the end user's input.
|
38760
38760
|
*
|
38761
38761
|
* You can set the `filter` option to one of the following:
|
@@ -38766,7 +38766,7 @@ var _default = () => {
|
|
38766
38766
|
* | `false` | When the end user types into the input area, all options are displayed<br>(options matching the input are put in bold |
|
38767
38767
|
*
|
38768
38768
|
* Read more:
|
38769
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
38769
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
38770
38770
|
* - [`source`](#source)
|
38771
38771
|
* - [`filteringCaseSensitive`](#filteringCaseSensitive)
|
38772
38772
|
*
|
@@ -38791,18 +38791,18 @@ var _default = () => {
|
|
38791
38791
|
*/
|
38792
38792
|
filter: true,
|
38793
38793
|
/**
|
38794
|
-
* The `filteringCaseSensitive` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md) cells'
|
38794
|
+
* The `filteringCaseSensitive` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) cells'
|
38795
38795
|
* input is case-sensitive.
|
38796
38796
|
*
|
38797
38797
|
* You can set the `filteringCaseSensitive` option to one of the following:
|
38798
38798
|
*
|
38799
38799
|
* | Setting | Description |
|
38800
38800
|
* | ----------------- | -------------------------------------------------------------------------------------------------- |
|
38801
|
-
* | `false` (default) | [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md) cells' input is not case-sensitive |
|
38802
|
-
* | `true` | [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md) cells' input is case-sensitive |
|
38801
|
+
* | `false` (default) | [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) cells' input is not case-sensitive |
|
38802
|
+
* | `true` | [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) cells' input is case-sensitive |
|
38803
38803
|
*
|
38804
38804
|
* Read more:
|
38805
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
38805
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
38806
38806
|
* - [`source`](#source)
|
38807
38807
|
* - [`filter`](#filter)
|
38808
38808
|
*
|
@@ -38835,7 +38835,7 @@ var _default = () => {
|
|
38835
38835
|
* | `true` | Enable the [`Filters`](@/api/filters.md) plugin |
|
38836
38836
|
*
|
38837
38837
|
* Read more:
|
38838
|
-
* - [Column filter](@/guides/columns/column-filter.md)
|
38838
|
+
* - [Column filter](@/guides/columns/column-filter/column-filter.md)
|
38839
38839
|
* - [Plugins: `Filters`](@/api/filters.md)
|
38840
38840
|
* - [`dropdownMenu`](#dropdownMenu)
|
38841
38841
|
*
|
@@ -38854,9 +38854,9 @@ var _default = () => {
|
|
38854
38854
|
/**
|
38855
38855
|
* `fixedColumnsLeft` is a legacy option.
|
38856
38856
|
*
|
38857
|
-
* If your grid's [layout direction](@/guides/internationalization/layout-direction.md) is LTR (default), `fixedColumnsLeft` acts like the [`fixedColumnsStart`](#fixedColumnsStart) option.
|
38857
|
+
* If your grid's [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) is LTR (default), `fixedColumnsLeft` acts like the [`fixedColumnsStart`](#fixedColumnsStart) option.
|
38858
38858
|
*
|
38859
|
-
* If your grid's [layout direction](@/guides/internationalization/layout-direction.md) is RTL, using `fixedColumnsLeft` throws an error.
|
38859
|
+
* If your grid's [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) is RTL, using `fixedColumnsLeft` throws an error.
|
38860
38860
|
*
|
38861
38861
|
* Use [`fixedColumnsStart`](#fixedColumnsStart), which works in any layout direction.
|
38862
38862
|
*
|
@@ -38876,13 +38876,13 @@ var _default = () => {
|
|
38876
38876
|
*/
|
38877
38877
|
fixedColumnsLeft: 0,
|
38878
38878
|
/**
|
38879
|
-
* If your grid's [layout direction](@/guides/internationalization/layout-direction.md) is LTR (default), the `fixedColumnsStart` option sets the number of [frozen columns](@/guides/columns/column-freezing.md) at the left-hand edge of the grid.
|
38879
|
+
* If your grid's [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) is LTR (default), the `fixedColumnsStart` option sets the number of [frozen columns](@/guides/columns/column-freezing/column-freezing.md) at the left-hand edge of the grid.
|
38880
38880
|
*
|
38881
|
-
* If your grid's [layout direction](@/guides/internationalization/layout-direction.md) is RTL, the `fixedColumnsStart` option sets the number of [frozen columns](@/guides/columns/column-freezing.md) at the right-hand edge of the grid.
|
38881
|
+
* If your grid's [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) is RTL, the `fixedColumnsStart` option sets the number of [frozen columns](@/guides/columns/column-freezing/column-freezing.md) at the right-hand edge of the grid.
|
38882
38882
|
*
|
38883
38883
|
* Read more:
|
38884
|
-
* - [Column freezing](@/guides/columns/column-freezing.md)
|
38885
|
-
* - [Layout direction](@/guides/internationalization/layout-direction.md)
|
38884
|
+
* - [Column freezing](@/guides/columns/column-freezing/column-freezing.md)
|
38885
|
+
* - [Layout direction](@/guides/internationalization/layout-direction/layout-direction.md)
|
38886
38886
|
* - [`fixedColumnsLeft`](#fixedcolumnsleft)
|
38887
38887
|
* - [`layoutDirection`](#layoutDirection)
|
38888
38888
|
*
|
@@ -38914,11 +38914,11 @@ var _default = () => {
|
|
38914
38914
|
*/
|
38915
38915
|
fixedColumnsStart: 0,
|
38916
38916
|
/**
|
38917
|
-
* The `fixedRowsBottom` option sets the number of [frozen rows](@/guides/rows/row-freezing.md)
|
38917
|
+
* The `fixedRowsBottom` option sets the number of [frozen rows](@/guides/rows/row-freezing/row-freezing.md)
|
38918
38918
|
* at the bottom of the grid.
|
38919
38919
|
*
|
38920
38920
|
* Read more:
|
38921
|
-
* - [Row freezing](@/guides/rows/row-freezing.md)
|
38921
|
+
* - [Row freezing](@/guides/rows/row-freezing/row-freezing.md)
|
38922
38922
|
*
|
38923
38923
|
* @memberof Options#
|
38924
38924
|
* @type {number}
|
@@ -38933,10 +38933,10 @@ var _default = () => {
|
|
38933
38933
|
*/
|
38934
38934
|
fixedRowsBottom: 0,
|
38935
38935
|
/**
|
38936
|
-
* The `fixedRowsTop` option sets the number of [frozen rows](@/guides/rows/row-freezing.md) at the top of the grid.
|
38936
|
+
* The `fixedRowsTop` option sets the number of [frozen rows](@/guides/rows/row-freezing/row-freezing.md) at the top of the grid.
|
38937
38937
|
*
|
38938
38938
|
* Read more:
|
38939
|
-
* - [Row freezing](@/guides/rows/row-freezing.md)
|
38939
|
+
* - [Row freezing](@/guides/rows/row-freezing/row-freezing.md)
|
38940
38940
|
*
|
38941
38941
|
* @memberof Options#
|
38942
38942
|
* @type {number}
|
@@ -38955,7 +38955,7 @@ var _default = () => {
|
|
38955
38955
|
*
|
38956
38956
|
* The [`Formulas`](@/api/formulas.md) plugin uses the [HyperFormula](https://handsontable.github.io/hyperformula/) calculation engine.
|
38957
38957
|
* To install [HyperFormula](https://handsontable.github.io/hyperformula/), read the following:
|
38958
|
-
* - [Formula calculation: Initialization methods](@/guides/formulas/formula-calculation.md#initialization-methods)
|
38958
|
+
* - [Formula calculation: Initialization methods](@/guides/formulas/formula-calculation/formula-calculation.md#initialization-methods)
|
38959
38959
|
*
|
38960
38960
|
* You can set the `formulas` option to an object with the following properties:
|
38961
38961
|
*
|
@@ -38967,7 +38967,7 @@ var _default = () => {
|
|
38967
38967
|
*
|
38968
38968
|
* Read more:
|
38969
38969
|
* - [Plugins: `Formulas`](@/api/formulas.md)
|
38970
|
-
* - [Formula calculation](@/guides/formulas/formula-calculation.md)
|
38970
|
+
* - [Formula calculation](@/guides/formulas/formula-calculation/formula-calculation.md)
|
38971
38971
|
* - [HyperFormula documentation: Client-side installation](https://handsontable.github.io/hyperformula/guide/client-side-installation)
|
38972
38972
|
* - [HyperFormula documentation: Configuration options](https://handsontable.github.io/hyperformula/api/interfaces/configparams.html)
|
38973
38973
|
*
|
@@ -39067,7 +39067,7 @@ var _default = () => {
|
|
39067
39067
|
* | A function that returns a valid number or string | `height() { return 500; }` |
|
39068
39068
|
*
|
39069
39069
|
* Read more:
|
39070
|
-
* - [Grid size](@/guides/getting-started/grid-size.md)
|
39070
|
+
* - [Grid size](@/guides/getting-started/grid-size/grid-size.md)
|
39071
39071
|
*
|
39072
39072
|
* @memberof Options#
|
39073
39073
|
* @type {number|string|Function}
|
@@ -39110,7 +39110,7 @@ var _default = () => {
|
|
39110
39110
|
*
|
39111
39111
|
* Read more:
|
39112
39112
|
* - [Plugins: `HiddenColumns`](@/api/hiddenColumns.md)
|
39113
|
-
* - [Column hiding](@/guides/columns/column-hiding.md)
|
39113
|
+
* - [Column hiding](@/guides/columns/column-hiding/column-hiding.md)
|
39114
39114
|
*
|
39115
39115
|
* @memberof Options#
|
39116
39116
|
* @type {boolean|object}
|
@@ -39155,7 +39155,7 @@ var _default = () => {
|
|
39155
39155
|
*
|
39156
39156
|
* Read more:
|
39157
39157
|
* - [Plugins: `HiddenRows`](@/api/hiddenRows.md)
|
39158
|
-
* - [Row hiding](@/guides/rows/row-hiding.md)
|
39158
|
+
* - [Row hiding](@/guides/rows/row-hiding/row-hiding.md)
|
39159
39159
|
*
|
39160
39160
|
* @memberof Options#
|
39161
39161
|
* @type {boolean|object}
|
@@ -39181,10 +39181,10 @@ var _default = () => {
|
|
39181
39181
|
hiddenRows: undefined,
|
39182
39182
|
/**
|
39183
39183
|
* The `invalidCellClassName` option lets you add a CSS class name to cells
|
39184
|
-
* that were marked as `invalid` by the [cell validator](@/guides/cell-functions/cell-validator.md).
|
39184
|
+
* that were marked as `invalid` by the [cell validator](@/guides/cell-functions/cell-validator/cell-validator.md).
|
39185
39185
|
*
|
39186
39186
|
* Read more:
|
39187
|
-
* - [Cell validator](@/guides/cell-functions/cell-validator.md)
|
39187
|
+
* - [Cell validator](@/guides/cell-functions/cell-validator/cell-validator.md)
|
39188
39188
|
* - [`currentRowClassName`](#currentRowClassName)
|
39189
39189
|
* - [`currentHeaderClassName`](#currentHeaderClassName)
|
39190
39190
|
* - [`activeHeaderClassName`](#activeHeaderClassName)
|
@@ -39293,7 +39293,7 @@ var _default = () => {
|
|
39293
39293
|
},
|
39294
39294
|
/**
|
39295
39295
|
* @description
|
39296
|
-
* The `label` option configures [`checkbox`](@/guides/cell-types/checkbox-cell-type.md) cells` labels.
|
39296
|
+
* The `label` option configures [`checkbox`](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md) cells` labels.
|
39297
39297
|
*
|
39298
39298
|
* You can set the `label` option to an object with the following properties:
|
39299
39299
|
*
|
@@ -39302,10 +39302,10 @@ var _default = () => {
|
|
39302
39302
|
* | `position` | `'after'` (default) \| `'before'` | `'after'`: place the label to the right of the checkbox<br>`'before'`: place the label to the left of the checkbox |
|
39303
39303
|
* | `value` | A string \| A function | The label's text |
|
39304
39304
|
* | `separated` | `false` (default) \| `true` | `false`: don't separate the label from the checkbox<br>`true`: separate the label from the checkbox |
|
39305
|
-
* | `property` | A string | - A [`data`](#data) object property name that's used as the label's text <br>- Works only when the [`data`](#data) option is set to an [array of objects](@/guides/getting-started/binding-to-data.md#array-of-objects) |
|
39305
|
+
* | `property` | A string | - A [`data`](#data) object property name that's used as the label's text <br>- Works only when the [`data`](#data) option is set to an [array of objects](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-objects) |
|
39306
39306
|
*
|
39307
39307
|
* Read more:
|
39308
|
-
* - [Checkbox cell type: Checkbox labels](@/guides/cell-types/checkbox-cell-type.md#checkbox-labels)
|
39308
|
+
* - [Checkbox cell type: Checkbox labels](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md#checkbox-labels)
|
39309
39309
|
*
|
39310
39310
|
* @memberof Options#
|
39311
39311
|
* @type {object}
|
@@ -39323,14 +39323,14 @@ var _default = () => {
|
|
39323
39323
|
*/
|
39324
39324
|
label: undefined,
|
39325
39325
|
/**
|
39326
|
-
* The `language` option configures Handsontable's [language](@/guides/internationalization/language.md) settings.
|
39326
|
+
* The `language` option configures Handsontable's [language](@/guides/internationalization/language/language.md) settings.
|
39327
39327
|
*
|
39328
39328
|
* You can set the `language` option to one of the following:
|
39329
39329
|
*
|
39330
39330
|
* | Setting | Description |
|
39331
39331
|
* | ------------------- | --------------------------- |
|
39332
39332
|
* | `'en-US'` (default) | English - United States |
|
39333
|
-
* | `'ar-AR'` | Arabic - Global<br><br>To properly render this language, set the [layout direction](@/guides/internationalization/layout-direction.md) to RTL. |
|
39333
|
+
* | `'ar-AR'` | Arabic - Global<br><br>To properly render this language, set the [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) to RTL. |
|
39334
39334
|
* | `'cs-CZ'` | Czech - Czech Republic |
|
39335
39335
|
* | `'de-CH'` | German - Switzerland |
|
39336
39336
|
* | `'de-DE'` | German - Germany |
|
@@ -39351,7 +39351,7 @@ var _default = () => {
|
|
39351
39351
|
* | `'zh-TW'` | Chinese - Taiwan |
|
39352
39352
|
*
|
39353
39353
|
* Read more:
|
39354
|
-
* - [Language](@/guides/internationalization/language.md)
|
39354
|
+
* - [Language](@/guides/internationalization/language/language.md)
|
39355
39355
|
* - [`locale`](#locale)
|
39356
39356
|
* - [`layoutDirection`](#layoutdirection)
|
39357
39357
|
*
|
@@ -39370,9 +39370,9 @@ var _default = () => {
|
|
39370
39370
|
/**
|
39371
39371
|
* The `layoutDirection` option configures whether Handsontable renders from the left to the right, or from the right to the left.
|
39372
39372
|
*
|
39373
|
-
* You can set the layout direction only at Handsontable's [initialization](@/guides/getting-started/installation.md#initialize-handsontable). Any change of the `layoutDirection` option after the initialization (e.g. using the [`updateSettings()`](@/api/core.md#updatesettings) method) is ignored.
|
39373
|
+
* You can set the layout direction only at Handsontable's [initialization](@/guides/getting-started/installation/installation.md#initialize-handsontable). Any change of the `layoutDirection` option after the initialization (e.g. using the [`updateSettings()`](@/api/core.md#updatesettings) method) is ignored.
|
39374
39374
|
*
|
39375
|
-
* You can set the `layoutDirection` option only [for the entire grid](@/guides/getting-started/configuration-options.md#set-grid-options).
|
39375
|
+
* You can set the `layoutDirection` option only [for the entire grid](@/guides/getting-started/configuration-options/configuration-options.md#set-grid-options).
|
39376
39376
|
* You can't set it for individual columns, rows, or cells.
|
39377
39377
|
*
|
39378
39378
|
* You can set the `layoutDirection` option to one of the following strings:
|
@@ -39384,8 +39384,8 @@ var _default = () => {
|
|
39384
39384
|
* | `ltr` | Render Handsontable from the left to the right,<br>even when your HTML document's [`dir`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir) attribute is set to `rtl` |
|
39385
39385
|
*
|
39386
39386
|
* Read more:
|
39387
|
-
* - [Layout direction](@/guides/internationalization/layout-direction.md)
|
39388
|
-
* - [Language](@/guides/internationalization/language.md)
|
39387
|
+
* - [Layout direction](@/guides/internationalization/layout-direction/layout-direction.md)
|
39388
|
+
* - [Language](@/guides/internationalization/language/language.md)
|
39389
39389
|
* - [`language`](#language)
|
39390
39390
|
* - [`locale`](#locale)
|
39391
39391
|
* - [`fixedColumnsStart`](#fixedcolumnsstart)
|
@@ -39419,11 +39419,11 @@ var _default = () => {
|
|
39419
39419
|
*
|
39420
39420
|
* | Setting | Description |
|
39421
39421
|
* | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
39422
|
-
* | A string with your [commercial license key](@/guides/getting-started/license-key.md#commercial-license) | For [commercial use](@/guides/technical-specification/software-license.md#commercial-use) |
|
39423
|
-
* | `'non-commercial-and-evaluation'` | For [non-commercial use](@/guides/technical-specification/software-license.md#non-commercial-use) |
|
39422
|
+
* | A string with your [commercial license key](@/guides/getting-started/license-key/license-key.md#commercial-license) | For [commercial use](@/guides/technical-specification/software-license/software-license.md#commercial-use) |
|
39423
|
+
* | `'non-commercial-and-evaluation'` | For [non-commercial use](@/guides/technical-specification/software-license/software-license.md#non-commercial-use) |
|
39424
39424
|
*
|
39425
39425
|
* Read more:
|
39426
|
-
* - [License key](@/guides/getting-started/license-key.md)
|
39426
|
+
* - [License key](@/guides/getting-started/license-key/license-key.md)
|
39427
39427
|
*
|
39428
39428
|
* @memberof Options#
|
39429
39429
|
* @type {string}
|
@@ -39441,14 +39441,14 @@ var _default = () => {
|
|
39441
39441
|
*/
|
39442
39442
|
licenseKey: undefined,
|
39443
39443
|
/**
|
39444
|
-
* The `locale` option configures Handsontable's [locale](@/guides/internationalization/locale.md) settings.
|
39444
|
+
* The `locale` option configures Handsontable's [locale](@/guides/internationalization/locale/locale.md) settings.
|
39445
39445
|
*
|
39446
39446
|
* You can set the `locale` option to any valid and canonicalized Unicode BCP 47 locale tag,
|
39447
|
-
* both for the [entire grid](@/guides/internationalization/locale.md#set-the-grid-s-locale),
|
39448
|
-
* and for [individual columns](@/guides/internationalization/locale.md#set-a-column-s-locale).
|
39447
|
+
* both for the [entire grid](@/guides/internationalization/locale/locale.md#set-the-grid-s-locale),
|
39448
|
+
* and for [individual columns](@/guides/internationalization/locale/locale.md#set-a-column-s-locale).
|
39449
39449
|
*
|
39450
39450
|
* Read more:
|
39451
|
-
* - [Locale](@/guides/internationalization/locale.md)
|
39451
|
+
* - [Locale](@/guides/internationalization/locale/locale.md)
|
39452
39452
|
* - [`language`](#language)
|
39453
39453
|
* - [`layoutDirection`](#layoutdirection)
|
39454
39454
|
*
|
@@ -39487,7 +39487,7 @@ var _default = () => {
|
|
39487
39487
|
* | `false` | Disable the [`ManualColumnFreeze`](@/api/manualColumnFreeze.md) plugin |
|
39488
39488
|
*
|
39489
39489
|
* Read more:
|
39490
|
-
* - [Column freezing](@/guides/columns/column-freezing.md#user-triggered-freeze)
|
39490
|
+
* - [Column freezing](@/guides/columns/column-freezing/column-freezing.md#user-triggered-freeze)
|
39491
39491
|
*
|
39492
39492
|
* @memberof Options#
|
39493
39493
|
* @type {boolean}
|
@@ -39513,7 +39513,7 @@ var _default = () => {
|
|
39513
39513
|
* | An array | - Enable the [`ManualColumnMove`](@/api/manualColumnMove.md) plugin<br>- Move individual columns at initialization |
|
39514
39514
|
*
|
39515
39515
|
* Read more:
|
39516
|
-
* - [Column moving](@/guides/columns/column-moving.md)
|
39516
|
+
* - [Column moving](@/guides/columns/column-moving/column-moving.md)
|
39517
39517
|
*
|
39518
39518
|
* @memberof Options#
|
39519
39519
|
* @type {boolean|number[]}
|
@@ -39546,7 +39546,7 @@ var _default = () => {
|
|
39546
39546
|
* | An array | - Enable the [`ManualColumnResize`](@/api/manualColumnResize.md) plugin<br>- Set initial widths of individual columns |
|
39547
39547
|
*
|
39548
39548
|
* Read more:
|
39549
|
-
* - [Column width: Column stretching](@/guides/columns/column-width.md#column-stretching)
|
39549
|
+
* - [Column width: Column stretching](@/guides/columns/column-width/column-width.md#column-stretching)
|
39550
39550
|
*
|
39551
39551
|
* @memberof Options#
|
39552
39552
|
* @type {boolean|number[]}
|
@@ -39579,7 +39579,7 @@ var _default = () => {
|
|
39579
39579
|
* | An array | - Enable the [`ManualRowMove`](@/api/manualRowMove.md) plugin<br>- Move individual rows at initialization |
|
39580
39580
|
*
|
39581
39581
|
* Read more:
|
39582
|
-
* - [Row moving](@/guides/rows/row-moving.md)
|
39582
|
+
* - [Row moving](@/guides/rows/row-moving/row-moving.md)
|
39583
39583
|
*
|
39584
39584
|
* @memberof Options#
|
39585
39585
|
* @type {boolean|number[]}
|
@@ -39612,7 +39612,7 @@ var _default = () => {
|
|
39612
39612
|
* | An array | - Enable the [`ManualRowResize`](@/api/manualRowResize.md) plugin<br>- Set initial heights of individual rows |
|
39613
39613
|
*
|
39614
39614
|
* Read more:
|
39615
|
-
* - [Row height: Adjust the row height manually](@/guides/rows/row-height.md#adjust-the-row-height-manually)
|
39615
|
+
* - [Row height: Adjust the row height manually](@/guides/rows/row-height/row-height.md#adjust-the-row-height-manually)
|
39616
39616
|
*
|
39617
39617
|
* @memberof Options#
|
39618
39618
|
* @type {boolean|number[]}
|
@@ -39695,7 +39695,7 @@ var _default = () => {
|
|
39695
39695
|
* | `colspan` | The height (as a number of columns ) of the merged section |
|
39696
39696
|
*
|
39697
39697
|
* Read more:
|
39698
|
-
* - [Merge cells](@/guides/cell-features/merge-cells.md)
|
39698
|
+
* - [Merge cells](@/guides/cell-features/merge-cells/merge-cells.md)
|
39699
39699
|
*
|
39700
39700
|
* @memberof Options#
|
39701
39701
|
* @type {boolean|object[]}
|
@@ -39728,8 +39728,8 @@ var _default = () => {
|
|
39728
39728
|
* Handsontable adds empty columns to the right.
|
39729
39729
|
* - At runtime: for example, when removing columns.
|
39730
39730
|
*
|
39731
|
-
* The `minCols` option works only when your [`data`](#data) is an [array of arrays](@/guides/getting-started/binding-to-data.md#array-of-arrays).
|
39732
|
-
* When your [`data`](#data) is an [array of objects](@/guides/getting-started/binding-to-data.md#array-of-objects),
|
39731
|
+
* The `minCols` option works only when your [`data`](#data) is an [array of arrays](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-arrays).
|
39732
|
+
* When your [`data`](#data) is an [array of objects](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-objects),
|
39733
39733
|
* you can only have as many columns as defined in:
|
39734
39734
|
* - The first data row
|
39735
39735
|
* - The [`dataSchema`](#dataSchema) option
|
@@ -39776,8 +39776,8 @@ var _default = () => {
|
|
39776
39776
|
*
|
39777
39777
|
* The total number of columns can't exceed the [`maxCols`](#maxCols) value.
|
39778
39778
|
*
|
39779
|
-
* The `minSpareCols` option works only when your [`data`](#data) is an [array of arrays](@/guides/getting-started/binding-to-data.md#array-of-arrays).
|
39780
|
-
* When your [`data`](#data) is an [array of objects](@/guides/getting-started/binding-to-data.md#array-of-objects),
|
39779
|
+
* The `minSpareCols` option works only when your [`data`](#data) is an [array of arrays](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-arrays).
|
39780
|
+
* When your [`data`](#data) is an [array of objects](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-objects),
|
39781
39781
|
* you can only have as many columns as defined in:
|
39782
39782
|
* - The first data row
|
39783
39783
|
* - The [`dataSchema`](#dataSchema) option
|
@@ -39836,7 +39836,7 @@ var _default = () => {
|
|
39836
39836
|
* | `indicator` | `true`: Display the arrow icon in the column header, to indicate a sortable column<br>`false`: Don't display the arrow icon in the column header |
|
39837
39837
|
* | `headerAction` | `true`: Enable clicking on the column header to sort the column<br>`false`: Disable clicking on the column header to sort the column |
|
39838
39838
|
* | `sortEmptyCells` | `true`: Sort empty cells as well<br>`false`: Place empty cells at the end |
|
39839
|
-
* | `compareFunctionFactory` | A [custom compare function](@/guides/rows/rows-sorting.md#add-a-custom-comparator) |
|
39839
|
+
* | `compareFunctionFactory` | A [custom compare function](@/guides/rows/rows-sorting/rows-sorting.md#add-a-custom-comparator) |
|
39840
39840
|
*
|
39841
39841
|
* If you set the `multiColumnSorting` option to an object,
|
39842
39842
|
* you can also sort individual columns at Handsontable's initialization.
|
@@ -39849,7 +39849,7 @@ var _default = () => {
|
|
39849
39849
|
* | `sortOrder` | `'asc'` \| `'desc'` | The sorting order:<br>`'asc'`: ascending<br>`'desc'`: descending |
|
39850
39850
|
*
|
39851
39851
|
* Read more:
|
39852
|
-
* - [Rows sorting](@/guides/rows/rows-sorting.md)
|
39852
|
+
* - [Rows sorting](@/guides/rows/rows-sorting/rows-sorting.md)
|
39853
39853
|
* - [`columnSorting`](#columnSorting)
|
39854
39854
|
*
|
39855
39855
|
* @memberof Options#
|
@@ -39895,7 +39895,7 @@ var _default = () => {
|
|
39895
39895
|
*/
|
39896
39896
|
multiColumnSorting: undefined,
|
39897
39897
|
/**
|
39898
|
-
* When set to `true`, the `navigableHeaders` option lets you navigate [row headers](@/guides/rows/row-header.md) and [column headers](@/guides/columns/column-header.md), using the arrow keys or the <kbd>**Tab**</kbd> key (if the [`tabNavigation`](#tabNavigation) option is set to `true`).
|
39898
|
+
* When set to `true`, the `navigableHeaders` option lets you navigate [row headers](@/guides/rows/row-header/row-header.md) and [column headers](@/guides/columns/column-header/column-header.md), using the arrow keys or the <kbd>**Tab**</kbd> key (if the [`tabNavigation`](#tabNavigation) option is set to `true`).
|
39899
39899
|
*
|
39900
39900
|
* @since 14.0.0
|
39901
39901
|
* @memberof Options#
|
@@ -39958,7 +39958,7 @@ var _default = () => {
|
|
39958
39958
|
*
|
39959
39959
|
* Read more:
|
39960
39960
|
* - [Plugins: `NestedHeaders`](@/api/nestedHeaders.md)
|
39961
|
-
* - [Column groups: Nested headers](@/guides/columns/column-groups.md#nested-headers)
|
39961
|
+
* - [Column groups: Nested headers](@/guides/columns/column-groups/column-groups.md#nested-headers)
|
39962
39962
|
*
|
39963
39963
|
* @memberof Options#
|
39964
39964
|
* @type {boolean|Array[]}
|
@@ -39987,7 +39987,7 @@ var _default = () => {
|
|
39987
39987
|
* | `true` | Enable the [`NestedRows`](@/api/nestedRows.md) plugin |
|
39988
39988
|
*
|
39989
39989
|
* Read more:
|
39990
|
-
* - [Plugins: `NestedRows`](@/guides/rows/row-parent-child.md)
|
39990
|
+
* - [Plugins: `NestedRows`](@/guides/rows/row-parent-child/row-parent-child.md)
|
39991
39991
|
*
|
39992
39992
|
* @example
|
39993
39993
|
* ```js
|
@@ -40032,7 +40032,7 @@ var _default = () => {
|
|
40032
40032
|
noWordWrapClassName: 'htNoWrap',
|
40033
40033
|
/**
|
40034
40034
|
* The `numericFormat` option configures the number format and the currency format
|
40035
|
-
* of [`numeric`](@/guides/cell-types/numeric-cell-type.md) cells` displayed output
|
40035
|
+
* of [`numeric`](@/guides/cell-types/numeric-cell-type/numeric-cell-type.md) cells` displayed output
|
40036
40036
|
* in the numeric cell renderer.
|
40037
40037
|
*
|
40038
40038
|
* You can set the `numericFormat` option to an object with the following properties:
|
@@ -40047,8 +40047,8 @@ var _default = () => {
|
|
40047
40047
|
* In the source data, numeric data is stored as JavaScript numbers.
|
40048
40048
|
*
|
40049
40049
|
* Read more:
|
40050
|
-
* - [Numeric cell type](@/guides/cell-types/numeric-cell-type.md)
|
40051
|
-
* - [Third-party licenses](@/guides/technical-specification/third-party-licenses.md)
|
40050
|
+
* - [Numeric cell type](@/guides/cell-types/numeric-cell-type/numeric-cell-type.md)
|
40051
|
+
* - [Third-party licenses](@/guides/technical-specification/third-party-licenses/third-party-licenses.md)
|
40052
40052
|
*
|
40053
40053
|
* @memberof Options#
|
40054
40054
|
* @since 0.35.0
|
@@ -40091,15 +40091,15 @@ var _default = () => {
|
|
40091
40091
|
*/
|
40092
40092
|
observeDOMVisibility: true,
|
40093
40093
|
/**
|
40094
|
-
* The `outsideClickDeselects` option determines what happens to the current [selection](@/guides/cell-features/selection.md)
|
40094
|
+
* The `outsideClickDeselects` option determines what happens to the current [selection](@/guides/cell-features/selection/selection.md)
|
40095
40095
|
* when you click outside of the grid.
|
40096
40096
|
*
|
40097
40097
|
* You can set the `outsideClickDeselects` option to one of the following:
|
40098
40098
|
*
|
40099
40099
|
* | Setting | Description |
|
40100
40100
|
* | ---------------- | -------------------------------------------------------------------------------------------------------- |
|
40101
|
-
* | `true` (default) | On a mouse click outside of the grid, clear the current [selection](@/guides/cell-features/selection.md) |
|
40102
|
-
* | `false` | On a mouse click outside of the grid, keep the current [selection](@/guides/cell-features/selection.md) |
|
40101
|
+
* | `true` (default) | On a mouse click outside of the grid, clear the current [selection](@/guides/cell-features/selection/selection.md) |
|
40102
|
+
* | `false` | On a mouse click outside of the grid, keep the current [selection](@/guides/cell-features/selection/selection.md) |
|
40103
40103
|
* | A function | A function that takes the click event target and returns a boolean |
|
40104
40104
|
*
|
40105
40105
|
* @memberof Options#
|
@@ -40139,7 +40139,7 @@ var _default = () => {
|
|
40139
40139
|
* | `true` | Enable the [`PersistentState`](@/api/persistentState.md) plugin |
|
40140
40140
|
*
|
40141
40141
|
* Read more:
|
40142
|
-
* - [Saving data: Saving data locally](@/guides/getting-started/saving-data.md#save-data-locally)
|
40142
|
+
* - [Saving data: Saving data locally](@/guides/getting-started/saving-data/saving-data.md#save-data-locally)
|
40143
40143
|
* - [Plugins: `PersistentState`](@/api/persistentState.md)
|
40144
40144
|
*
|
40145
40145
|
* @memberof Options#
|
@@ -40196,7 +40196,7 @@ var _default = () => {
|
|
40196
40196
|
* that contain [`placeholder`](#placeholder) text.
|
40197
40197
|
*
|
40198
40198
|
* Read more:
|
40199
|
-
* - [Cell validator](@/guides/cell-functions/cell-validator.md)
|
40199
|
+
* - [Cell validator](@/guides/cell-functions/cell-validator/cell-validator.md)
|
40200
40200
|
* - [`placeholder`](#placeholder)
|
40201
40201
|
* - [`currentRowClassName`](#currentRowClassName)
|
40202
40202
|
* - [`currentHeaderClassName`](#currentHeaderClassName)
|
@@ -40271,9 +40271,9 @@ var _default = () => {
|
|
40271
40271
|
preventWheel: false,
|
40272
40272
|
/**
|
40273
40273
|
* @description
|
40274
|
-
* The `readOnly` option determines whether a [cell](@/guides/cell-features/disabled-cells.md#read-only-specific-cells),
|
40275
|
-
* [comment](@/guides/cell-features/comments.md#make-a-comment-read-only), [column](@/guides/cell-features/disabled-cells.md#read-only-columns)
|
40276
|
-
* or the [entire grid](@/guides/cell-features/disabled-cells.md#read-only-grid) is editable or not. You can configure it as follows:
|
40274
|
+
* The `readOnly` option determines whether a [cell](@/guides/cell-features/disabled-cells/disabled-cells.md#read-only-specific-cells),
|
40275
|
+
* [comment](@/guides/cell-features/comments/comments.md#make-a-comment-read-only), [column](@/guides/cell-features/disabled-cells/disabled-cells.md#read-only-columns)
|
40276
|
+
* or the [entire grid](@/guides/cell-features/disabled-cells/disabled-cells.md#read-only-grid) is editable or not. You can configure it as follows:
|
40277
40277
|
*
|
40278
40278
|
* | Setting | Description |
|
40279
40279
|
* | ----------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
@@ -40283,8 +40283,8 @@ var _default = () => {
|
|
40283
40283
|
* `readOnly` cells can't be changed by the [`populateFromArray()`](@/api/core.md#populatefromarray) method.
|
40284
40284
|
*
|
40285
40285
|
* Read more:
|
40286
|
-
* - [Disabled cells](@/guides/cell-features/disabled-cells.md)
|
40287
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
40286
|
+
* - [Disabled cells](@/guides/cell-features/disabled-cells/disabled-cells.md)
|
40287
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
40288
40288
|
*
|
40289
40289
|
* @memberof Options#
|
40290
40290
|
* @type {boolean}
|
@@ -40350,18 +40350,18 @@ var _default = () => {
|
|
40350
40350
|
*/
|
40351
40351
|
readOnlyCellClassName: 'htDimmed',
|
40352
40352
|
/**
|
40353
|
-
* The `renderAllRows` option controls Handsontable's [row virtualization](@/guides/rows/row-virtualization.md).
|
40353
|
+
* The `renderAllRows` option controls Handsontable's [row virtualization](@/guides/rows/row-virtualization/row-virtualization.md).
|
40354
40354
|
* You can configure it as follows:
|
40355
40355
|
*
|
40356
40356
|
* | Setting | Description |
|
40357
40357
|
* | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
40358
|
-
* | `false` (default) | Enable [row virtualization](@/guides/rows/row-virtualization.md), rendering only the visible rows for optimal performance with large datasets. |
|
40359
|
-
* | `true` | Disable [row virtualization](@/guides/rows/row-virtualization.md)<br>(render all rows of the grid), rendering all rows in the dataset for consistent rendering and screen reader accessibility. |
|
40358
|
+
* | `false` (default) | Enable [row virtualization](@/guides/rows/row-virtualization/row-virtualization.md), rendering only the visible rows for optimal performance with large datasets. |
|
40359
|
+
* | `true` | Disable [row virtualization](@/guides/rows/row-virtualization/row-virtualization.md)<br>(render all rows of the grid), rendering all rows in the dataset for consistent rendering and screen reader accessibility. |
|
40360
40360
|
*
|
40361
40361
|
* Setting `renderAllRows` to `true` overwrites the [`viewportRowRenderingOffset`](#viewportRowRenderingOffset) setting.
|
40362
40362
|
*
|
40363
40363
|
* Read more:
|
40364
|
-
* - [Row virtualization](@/guides/rows/row-virtualization.md)
|
40364
|
+
* - [Row virtualization](@/guides/rows/row-virtualization/row-virtualization.md)
|
40365
40365
|
*
|
40366
40366
|
* @memberof Options#
|
40367
40367
|
* @type {boolean}
|
@@ -40376,19 +40376,19 @@ var _default = () => {
|
|
40376
40376
|
*/
|
40377
40377
|
renderAllRows: false,
|
40378
40378
|
/**
|
40379
|
-
* The `renderAllColumns` option configures Handsontable's [column virtualization](@/guides/columns/column-virtualization.md).
|
40379
|
+
* The `renderAllColumns` option configures Handsontable's [column virtualization](@/guides/columns/column-virtualization/column-virtualization.md).
|
40380
40380
|
*
|
40381
40381
|
* You can set the `renderAllColumns` option to one of the following:
|
40382
40382
|
*
|
40383
40383
|
* | Setting | Description |
|
40384
40384
|
* | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
40385
|
-
* | `false` (default) | Enable [column virtualization](@/guides/columns/column-virtualization.md), rendering only visible columns for better performance with many columns. |
|
40386
|
-
* | `true` | Disable [column virtualization](@/guides/columns/column-virtualization.md)<br>(render all columns of the grid), rendering all columns in the dataset, and ensuring all columns are available regardless of horizontal scrolling. |
|
40385
|
+
* | `false` (default) | Enable [column virtualization](@/guides/columns/column-virtualization/column-virtualization.md), rendering only visible columns for better performance with many columns. |
|
40386
|
+
* | `true` | Disable [column virtualization](@/guides/columns/column-virtualization/column-virtualization.md)<br>(render all columns of the grid), rendering all columns in the dataset, and ensuring all columns are available regardless of horizontal scrolling. |
|
40387
40387
|
*
|
40388
40388
|
* Setting `renderAllColumns` to `true` overwrites the [`viewportColumnRenderingOffset`](#viewportColumnRenderingOffset) setting.
|
40389
40389
|
*
|
40390
40390
|
* Read more:
|
40391
|
-
* - [Column virtualization](@/guides/columns/column-virtualization.md)
|
40391
|
+
* - [Column virtualization](@/guides/columns/column-virtualization/column-virtualization.md)
|
40392
40392
|
*
|
40393
40393
|
* @since 14.1.0
|
40394
40394
|
* @memberof Options#
|
@@ -40405,15 +40405,15 @@ var _default = () => {
|
|
40405
40405
|
renderAllColumns: false,
|
40406
40406
|
/**
|
40407
40407
|
* @description
|
40408
|
-
* The `renderer` option sets a [cell renderer](@/guides/cell-functions/cell-renderer.md) for a cell.
|
40408
|
+
* The `renderer` option sets a [cell renderer](@/guides/cell-functions/cell-renderer/cell-renderer.md) for a cell.
|
40409
40409
|
*
|
40410
40410
|
* You can set the `renderer` option to one of the following:
|
40411
40411
|
* - A custom renderer function
|
40412
|
-
* - One of the following [cell renderer aliases](@/guides/cell-functions/cell-renderer.md):
|
40412
|
+
* - One of the following [cell renderer aliases](@/guides/cell-functions/cell-renderer/cell-renderer.md):
|
40413
40413
|
*
|
40414
40414
|
* | Alias | Cell renderer function |
|
40415
40415
|
* | ------------------- | ------------------------------------------------------------------------------ |
|
40416
|
-
* | A custom alias | Your [custom cell renderer](@/guides/cell-functions/cell-renderer.md) function |
|
40416
|
+
* | A custom alias | Your [custom cell renderer](@/guides/cell-functions/cell-renderer/cell-renderer.md) function |
|
40417
40417
|
* | `'autocomplete'` | `AutocompleteRenderer` |
|
40418
40418
|
* | `'base'` | `BaseRenderer` |
|
40419
40419
|
* | `'checkbox'` | `CheckboxRenderer` |
|
@@ -40429,9 +40429,9 @@ var _default = () => {
|
|
40429
40429
|
* options all at once, use the [`type`](#type) option.
|
40430
40430
|
*
|
40431
40431
|
* Read more:
|
40432
|
-
* - [Cell renderer](@/guides/cell-functions/cell-renderer.md)
|
40433
|
-
* - [Cell type](@/guides/cell-types/cell-type.md)
|
40434
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
40432
|
+
* - [Cell renderer](@/guides/cell-functions/cell-renderer/cell-renderer.md)
|
40433
|
+
* - [Cell type](@/guides/cell-types/cell-type/cell-type.md)
|
40434
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
40435
40435
|
* - [`type`](#type)
|
40436
40436
|
*
|
40437
40437
|
* @memberof Options#
|
@@ -40477,7 +40477,7 @@ var _default = () => {
|
|
40477
40477
|
* | A function | Define your own row headers, using a function |
|
40478
40478
|
*
|
40479
40479
|
* Read more:
|
40480
|
-
* - [Row header](@/guides/rows/row-header.md)
|
40480
|
+
* - [Row header](@/guides/rows/row-header/row-header.md)
|
40481
40481
|
*
|
40482
40482
|
* @memberof Options#
|
40483
40483
|
* @type {boolean|string[]|Function}
|
@@ -40543,7 +40543,7 @@ var _default = () => {
|
|
40543
40543
|
* via the {@link ManualRowResize} and {@link AutoRowSize} plugins (if they are enabled).
|
40544
40544
|
*
|
40545
40545
|
* Read more:
|
40546
|
-
* - [Row height](@/guides/rows/row-height.md)
|
40546
|
+
* - [Row height](@/guides/rows/row-height/row-height.md)
|
40547
40547
|
*
|
40548
40548
|
* @memberof Options#
|
40549
40549
|
* @type {number|number[]|string|string[]|Array<undefined>|Function}
|
@@ -40588,13 +40588,13 @@ var _default = () => {
|
|
40588
40588
|
* | Option | Possible settings | Description |
|
40589
40589
|
* | ------------------- | ----------------- | ---------------------------------------------------------------------------------------------------- |
|
40590
40590
|
* | `searchResultClass` | A string | Add a custom CSS class name to search results |
|
40591
|
-
* | `queryMethod` | A function | Add a [custom query method](@/guides/navigation/searching-values.md#custom-query-method) |
|
40592
|
-
* | `callback` | A function | Add a [custom callback function](@/guides/navigation/searching-values.md#custom-callback) |
|
40591
|
+
* | `queryMethod` | A function | Add a [custom query method](@/guides/navigation/searching-values/searching-values.md#custom-query-method) |
|
40592
|
+
* | `callback` | A function | Add a [custom callback function](@/guides/navigation/searching-values/searching-values.md#custom-callback) |
|
40593
40593
|
*
|
40594
40594
|
* Read more:
|
40595
|
-
* - [Searching values](@/guides/navigation/searching-values.md)
|
40596
|
-
* - [Searching values: Custom query method](@/guides/navigation/searching-values.md#custom-query-method)
|
40597
|
-
* - [Searching values: Custom callback](@/guides/navigation/searching-values.md#custom-callback)
|
40595
|
+
* - [Searching values](@/guides/navigation/searching-values/searching-values.md)
|
40596
|
+
* - [Searching values: Custom query method](@/guides/navigation/searching-values/searching-values.md#custom-query-method)
|
40597
|
+
* - [Searching values: Custom callback](@/guides/navigation/searching-values/searching-values.md#custom-callback)
|
40598
40598
|
*
|
40599
40599
|
* @memberof Options#
|
40600
40600
|
* @type {boolean|object}
|
@@ -40624,7 +40624,7 @@ var _default = () => {
|
|
40624
40624
|
search: false,
|
40625
40625
|
/**
|
40626
40626
|
* @description
|
40627
|
-
* The `selectionMode` option configures how [selection](@/guides/cell-features/selection.md) works.
|
40627
|
+
* The `selectionMode` option configures how [selection](@/guides/cell-features/selection/selection.md) works.
|
40628
40628
|
*
|
40629
40629
|
* You can set the `selectionMode` option to one of the following:
|
40630
40630
|
*
|
@@ -40635,7 +40635,7 @@ var _default = () => {
|
|
40635
40635
|
* | `'multiple'` | Allow the user to select multiple ranges of cells at a time. |
|
40636
40636
|
*
|
40637
40637
|
* Read more:
|
40638
|
-
* - [Selection: Selecting ranges](@/guides/cell-features/selection.md#select-ranges)
|
40638
|
+
* - [Selection: Selecting ranges](@/guides/cell-features/selection/selection.md#select-ranges)
|
40639
40639
|
*
|
40640
40640
|
* @memberof Options#
|
40641
40641
|
* @type {string}
|
@@ -40656,7 +40656,7 @@ var _default = () => {
|
|
40656
40656
|
*/
|
40657
40657
|
selectionMode: 'multiple',
|
40658
40658
|
/**
|
40659
|
-
* The `selectOptions` option configures options that the end user can choose from in [`select`](@/guides/cell-types/select-cell-type.md) cells.
|
40659
|
+
* The `selectOptions` option configures options that the end user can choose from in [`select`](@/guides/cell-types/select-cell-type/select-cell-type.md) cells.
|
40660
40660
|
*
|
40661
40661
|
* You can set the `selectOptions` option to one of the following:
|
40662
40662
|
*
|
@@ -40667,7 +40667,7 @@ var _default = () => {
|
|
40667
40667
|
* | A function | A function that returns an object with key-string pairs |
|
40668
40668
|
*
|
40669
40669
|
* Read more:
|
40670
|
-
* - [Select cell type](@/guides/cell-types/select-cell-type.md)
|
40670
|
+
* - [Select cell type](@/guides/cell-types/select-cell-type/select-cell-type.md)
|
40671
40671
|
*
|
40672
40672
|
* @memberof Options#
|
40673
40673
|
* @type {string[]|object|Function}
|
@@ -40726,7 +40726,7 @@ var _default = () => {
|
|
40726
40726
|
* | `true` | - Disable pasting data into this column<br>- On pasting, paste data into the next column to the right |
|
40727
40727
|
*
|
40728
40728
|
* Read more:
|
40729
|
-
* - [Configuration options: Setting column options](@/guides/getting-started/configuration-options.md#set-column-options)
|
40729
|
+
* - [Configuration options: Setting column options](@/guides/getting-started/configuration-options/configuration-options.md#set-column-options)
|
40730
40730
|
*
|
40731
40731
|
* @memberof Options#
|
40732
40732
|
* @type {boolean}
|
@@ -40759,7 +40759,7 @@ var _default = () => {
|
|
40759
40759
|
* | `true` | - Disable pasting data into this row<br>- On pasting, paste data into the row below |
|
40760
40760
|
*
|
40761
40761
|
* Read more:
|
40762
|
-
* - [Configuration options: Setting row options](@/guides/getting-started/configuration-options.md#set-row-options)
|
40762
|
+
* - [Configuration options: Setting row options](@/guides/getting-started/configuration-options/configuration-options.md#set-row-options)
|
40763
40763
|
*
|
40764
40764
|
* @memberof Options#
|
40765
40765
|
* @type {boolean}
|
@@ -40782,7 +40782,7 @@ var _default = () => {
|
|
40782
40782
|
*/
|
40783
40783
|
skipRowOnPaste: false,
|
40784
40784
|
/**
|
40785
|
-
* The `sortByRelevance` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md) cells'
|
40785
|
+
* The `sortByRelevance` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) cells'
|
40786
40786
|
* lists are sorted in the same order as provided in the [`source`](#source) option.
|
40787
40787
|
*
|
40788
40788
|
* You can set the `sortByRelevance` option to one of the following:
|
@@ -40794,7 +40794,7 @@ var _default = () => {
|
|
40794
40794
|
*
|
40795
40795
|
* Read more:
|
40796
40796
|
* - [`source`](#source)
|
40797
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
40797
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
40798
40798
|
*
|
40799
40799
|
* @memberof Options#
|
40800
40800
|
* @type {boolean}
|
@@ -40815,8 +40815,8 @@ var _default = () => {
|
|
40815
40815
|
*/
|
40816
40816
|
sortByRelevance: true,
|
40817
40817
|
/**
|
40818
|
-
* The `source` option sets options available in [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md)
|
40819
|
-
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type.md) cells.
|
40818
|
+
* The `source` option sets options available in [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
40819
|
+
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md) cells.
|
40820
40820
|
*
|
40821
40821
|
* You can set the `source` option to one of the following:
|
40822
40822
|
*
|
@@ -40824,8 +40824,8 @@ var _default = () => {
|
|
40824
40824
|
* - A function
|
40825
40825
|
*
|
40826
40826
|
* Read more:
|
40827
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
40828
|
-
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type.md)
|
40827
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
40828
|
+
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md)
|
40829
40829
|
* - [`strict`](#strict)
|
40830
40830
|
* - [`allowHtml`](#allowHtml)
|
40831
40831
|
* - [`filter`](#filter)
|
@@ -40910,7 +40910,7 @@ var _default = () => {
|
|
40910
40910
|
* | `'all'` | Fit the grid to the container, by stretching all columns evenly |
|
40911
40911
|
*
|
40912
40912
|
* Read more:
|
40913
|
-
* - [Column width: Column stretching](@/guides/columns/column-width.md#column-stretching)
|
40913
|
+
* - [Column width: Column stretching](@/guides/columns/column-width/column-width.md#column-stretching)
|
40914
40914
|
*
|
40915
40915
|
* @memberof Options#
|
40916
40916
|
* @type {string}
|
@@ -40926,17 +40926,17 @@ var _default = () => {
|
|
40926
40926
|
*/
|
40927
40927
|
stretchH: 'none',
|
40928
40928
|
/**
|
40929
|
-
* The `strict` option configures the behavior of [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md) cells.
|
40929
|
+
* The `strict` option configures the behavior of [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) cells.
|
40930
40930
|
*
|
40931
40931
|
* You can set the `strict` option to one of the following:
|
40932
40932
|
*
|
40933
40933
|
* | Setting | Mode | Description |
|
40934
40934
|
* | ------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
|
40935
|
-
* | `true` | [Strict mode](@/guides/cell-types/autocomplete-cell-type.md#autocomplete-strict-mode) | The end user:<br>- Can only choose one of suggested values<br>- Can't enter a custom value |
|
40936
|
-
* | `false` | [Flexible mode](@/guides/cell-types/autocomplete-cell-type.md#autocomplete-flexible-mode) | The end user:<br>- Can choose one of suggested values<br>- Can enter a custom value |
|
40935
|
+
* | `true` | [Strict mode](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md#autocomplete-strict-mode) | The end user:<br>- Can only choose one of suggested values<br>- Can't enter a custom value |
|
40936
|
+
* | `false` | [Flexible mode](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md#autocomplete-flexible-mode) | The end user:<br>- Can choose one of suggested values<br>- Can enter a custom value |
|
40937
40937
|
*
|
40938
40938
|
* Read more:
|
40939
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
40939
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
40940
40940
|
* - [`source`](#source)
|
40941
40941
|
*
|
40942
40942
|
* @memberof Options#
|
@@ -41035,12 +41035,12 @@ var _default = () => {
|
|
41035
41035
|
},
|
41036
41036
|
/**
|
41037
41037
|
* @description
|
41038
|
-
* The `title` option configures [column header](@/guides/columns/column-header.md) names.
|
41038
|
+
* The `title` option configures [column header](@/guides/columns/column-header/column-header.md) names.
|
41039
41039
|
*
|
41040
41040
|
* You can set the `title` option to a string.
|
41041
41041
|
*
|
41042
41042
|
* Read more:
|
41043
|
-
* - [Column header](@/guides/columns/column-header.md)
|
41043
|
+
* - [Column header](@/guides/columns/column-header/column-header.md)
|
41044
41044
|
* - [`columns`](#columns)
|
41045
41045
|
*
|
41046
41046
|
* @memberof Options#
|
@@ -41066,8 +41066,8 @@ var _default = () => {
|
|
41066
41066
|
*/
|
41067
41067
|
title: undefined,
|
41068
41068
|
/**
|
41069
|
-
* The `trimDropdown` option configures the width of the [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md)
|
41070
|
-
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type.md) lists.
|
41069
|
+
* The `trimDropdown` option configures the width of the [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
41070
|
+
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md) lists.
|
41071
41071
|
*
|
41072
41072
|
* You can set the `trimDropdown` option to one of the following:
|
41073
41073
|
*
|
@@ -41077,8 +41077,8 @@ var _default = () => {
|
|
41077
41077
|
* | `false` | Scale the dropdown/autocomplete list's width to the list's content |
|
41078
41078
|
*
|
41079
41079
|
* Read more:
|
41080
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
41081
|
-
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type.md)
|
41080
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
41081
|
+
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md)
|
41082
41082
|
*
|
41083
41083
|
* @memberof Options#
|
41084
41084
|
* @type {boolean}
|
@@ -41118,7 +41118,7 @@ var _default = () => {
|
|
41118
41118
|
*
|
41119
41119
|
* Read more:
|
41120
41120
|
* - [Plugins: `TrimRows`](@/api/trimRows.md)
|
41121
|
-
* - [Row trimming](@/guides/rows/row-trimming.md)
|
41121
|
+
* - [Row trimming](@/guides/rows/row-trimming/row-trimming.md)
|
41122
41122
|
*
|
41123
41123
|
* @memberof Options#
|
41124
41124
|
* @type {boolean|number[]}
|
@@ -41167,29 +41167,29 @@ var _default = () => {
|
|
41167
41167
|
/**
|
41168
41168
|
* @description
|
41169
41169
|
* The `type` option lets you set the [`renderer`](#renderer), [`editor`](#editor), and [`validator`](#validator)
|
41170
|
-
* options all at once, by selecting a [cell type](@/guides/cell-types/cell-type.md).
|
41170
|
+
* options all at once, by selecting a [cell type](@/guides/cell-types/cell-type/cell-type.md).
|
41171
41171
|
*
|
41172
41172
|
* You can set the `type` option to one of the following:
|
41173
41173
|
*
|
41174
41174
|
* | Cell type | Renderer, editor & validator |
|
41175
41175
|
* | ----------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
41176
|
-
* | A [custom cell type](@/guides/cell-types/cell-type.md) | Renderer: your [custom cell renderer](@/guides/cell-functions/cell-renderer.md)<br>Editor: your [custom cell editor](@/guides/cell-functions/cell-editor.md)<br>Validator: your [custom cell validator](@/guides/cell-functions/cell-validator.md) |
|
41177
|
-
* | [`'autocomplete'`](@/guides/cell-types/autocomplete-cell-type.md) | Renderer: `AutocompleteRenderer`<br>Editor: `AutocompleteEditor`<br>Validator: `AutocompleteValidator` |
|
41178
|
-
* | [`'checkbox'`](@/guides/cell-types/checkbox-cell-type.md) | Renderer: `CheckboxRenderer`<br>Editor: `CheckboxEditor`<br>Validator: - |
|
41179
|
-
* | [`'date'`](@/guides/cell-types/date-cell-type.md) | Renderer: `DateRenderer`<br>Editor: `DateEditor`<br>Validator: `DateValidator` |
|
41180
|
-
* | [`'dropdown'`](@/guides/cell-types/dropdown-cell-type.md) | Renderer: `DropdownRenderer`<br>Editor: `DropdownEditor`<br>Validator: `DropdownValidator` |
|
41181
|
-
* | [`'handsontable'`](@/guides/cell-types/handsontable-cell-type.md) | Renderer: `AutocompleteRenderer`<br>Editor: `HandsontableEditor`<br>Validator: - |
|
41182
|
-
* | [`'numeric'`](@/guides/cell-types/numeric-cell-type.md) | Renderer: `NumericRenderer`<br>Editor: `NumericEditor`<br>Validator: `NumericValidator` |
|
41183
|
-
* | [`'password'`](@/guides/cell-types/password-cell-type.md) | Renderer: `PasswordRenderer`<br>Editor: `PasswordEditor`<br>Validator: - |
|
41176
|
+
* | A [custom cell type](@/guides/cell-types/cell-type/cell-type.md) | Renderer: your [custom cell renderer](@/guides/cell-functions/cell-renderer/cell-renderer.md)<br>Editor: your [custom cell editor](@/guides/cell-functions/cell-editor/cell-editor.md)<br>Validator: your [custom cell validator](@/guides/cell-functions/cell-validator/cell-validator.md) |
|
41177
|
+
* | [`'autocomplete'`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) | Renderer: `AutocompleteRenderer`<br>Editor: `AutocompleteEditor`<br>Validator: `AutocompleteValidator` |
|
41178
|
+
* | [`'checkbox'`](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md) | Renderer: `CheckboxRenderer`<br>Editor: `CheckboxEditor`<br>Validator: - |
|
41179
|
+
* | [`'date'`](@/guides/cell-types/date-cell-type/date-cell-type.md) | Renderer: `DateRenderer`<br>Editor: `DateEditor`<br>Validator: `DateValidator` |
|
41180
|
+
* | [`'dropdown'`](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md) | Renderer: `DropdownRenderer`<br>Editor: `DropdownEditor`<br>Validator: `DropdownValidator` |
|
41181
|
+
* | [`'handsontable'`](@/guides/cell-types/handsontable-cell-type/handsontable-cell-type.md) | Renderer: `AutocompleteRenderer`<br>Editor: `HandsontableEditor`<br>Validator: - |
|
41182
|
+
* | [`'numeric'`](@/guides/cell-types/numeric-cell-type/numeric-cell-type.md) | Renderer: `NumericRenderer`<br>Editor: `NumericEditor`<br>Validator: `NumericValidator` |
|
41183
|
+
* | [`'password'`](@/guides/cell-types/password-cell-type/password-cell-type.md) | Renderer: `PasswordRenderer`<br>Editor: `PasswordEditor`<br>Validator: - |
|
41184
41184
|
* | `'text'` | Renderer: `TextRenderer`<br>Editor: `TextEditor`<br>Validator: - |
|
41185
|
-
* | [`'time`'](@/guides/cell-types/time-cell-type.md) | Renderer: `TimeRenderer`<br>Editor: `TimeEditor`<br>Validator: `TimeValidator` |
|
41185
|
+
* | [`'time`'](@/guides/cell-types/time-cell-type/time-cell-type.md) | Renderer: `TimeRenderer`<br>Editor: `TimeEditor`<br>Validator: `TimeValidator` |
|
41186
41186
|
*
|
41187
41187
|
* Read more:
|
41188
|
-
* - [Cell type](@/guides/cell-types/cell-type.md)
|
41189
|
-
* - [Cell renderer](@/guides/cell-functions/cell-renderer.md)
|
41190
|
-
* - [Cell editor](@/guides/cell-functions/cell-editor.md)
|
41191
|
-
* - [Cell validator](@/guides/cell-functions/cell-validator.md)
|
41192
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
41188
|
+
* - [Cell type](@/guides/cell-types/cell-type/cell-type.md)
|
41189
|
+
* - [Cell renderer](@/guides/cell-functions/cell-renderer/cell-renderer.md)
|
41190
|
+
* - [Cell editor](@/guides/cell-functions/cell-editor/cell-editor.md)
|
41191
|
+
* - [Cell validator](@/guides/cell-functions/cell-validator/cell-validator.md)
|
41192
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
41193
41193
|
* - [`renderer`](#renderer)
|
41194
41194
|
* - [`editor`](#editor)
|
41195
41195
|
* - [`validator`](#validator)
|
@@ -41220,17 +41220,17 @@ var _default = () => {
|
|
41220
41220
|
type: 'text',
|
41221
41221
|
/**
|
41222
41222
|
* The `uncheckedTemplate` option lets you configure what value
|
41223
|
-
* an unchecked [`checkbox`](@/guides/cell-types/checkbox-cell-type.md) cell has.
|
41223
|
+
* an unchecked [`checkbox`](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md) cell has.
|
41224
41224
|
*
|
41225
41225
|
* You can set the `uncheckedTemplate` option to one of the following:
|
41226
41226
|
*
|
41227
41227
|
* | Setting | Description |
|
41228
41228
|
* | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
41229
|
-
* | `false` (default) | If a [`checkbox`](@/guides/cell-types/checkbox-cell-type.md) cell is unchecked,<br>the [`getDataAtCell`](@/api/core.md#getDataAtCell) method for this cell returns `false` |
|
41230
|
-
* | A string | If a [`checkbox`](@/guides/cell-types/checkbox-cell-type.md) cell is unchecked,<br>the [`getDataAtCell`](@/api/core.md#getDataAtCell) method for this cell returns a string of your choice |
|
41229
|
+
* | `false` (default) | If a [`checkbox`](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md) cell is unchecked,<br>the [`getDataAtCell`](@/api/core.md#getDataAtCell) method for this cell returns `false` |
|
41230
|
+
* | A string | If a [`checkbox`](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md) cell is unchecked,<br>the [`getDataAtCell`](@/api/core.md#getDataAtCell) method for this cell returns a string of your choice |
|
41231
41231
|
*
|
41232
41232
|
* Read more:
|
41233
|
-
* - [Checkbox cell type: Checkbox template](@/guides/cell-types/checkbox-cell-type.md#checkbox-template)
|
41233
|
+
* - [Checkbox cell type: Checkbox template](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md#checkbox-template)
|
41234
41234
|
* - [`getDataAtCell()`](@/api/core.md#getDataAtCell)
|
41235
41235
|
* - [`checkedTemplate`](#checkedTemplate)
|
41236
41236
|
*
|
@@ -41276,7 +41276,7 @@ var _default = () => {
|
|
41276
41276
|
* set the `undo` option to `false`.
|
41277
41277
|
*
|
41278
41278
|
* Read more:
|
41279
|
-
* - [Undo and redo](@/guides/accessories-and-menus/undo-redo.md)
|
41279
|
+
* - [Undo and redo](@/guides/accessories-and-menus/undo-redo/undo-redo.md)
|
41280
41280
|
*
|
41281
41281
|
* @memberof Options#
|
41282
41282
|
* @type {boolean}
|
@@ -41292,22 +41292,22 @@ var _default = () => {
|
|
41292
41292
|
undo: undefined,
|
41293
41293
|
/**
|
41294
41294
|
* @description
|
41295
|
-
* The `validator` option sets a [cell validator](@/guides/cell-functions/cell-validator.md) for a cell.
|
41295
|
+
* The `validator` option sets a [cell validator](@/guides/cell-functions/cell-validator/cell-validator.md) for a cell.
|
41296
41296
|
*
|
41297
41297
|
* You can set the `validator` option to one of the following:
|
41298
41298
|
*
|
41299
41299
|
* | Setting | Description |
|
41300
41300
|
* | -------------------- | -------------------------------------------------------------------------------- |
|
41301
|
-
* | A string | A [cell validator alias](@/guides/cell-functions/cell-validator.md) |
|
41302
|
-
* | A function | Your [custom cell validator function](@/guides/cell-functions/cell-validator.md) |
|
41301
|
+
* | A string | A [cell validator alias](@/guides/cell-functions/cell-validator/cell-validator.md) |
|
41302
|
+
* | A function | Your [custom cell validator function](@/guides/cell-functions/cell-validator/cell-validator.md) |
|
41303
41303
|
* | A regular expression | A regular expression used for cell validation |
|
41304
41304
|
*
|
41305
41305
|
* By setting the `validator` option to a string,
|
41306
|
-
* you can use one of the following [cell validator aliases](@/guides/cell-functions/cell-validator.md):
|
41306
|
+
* you can use one of the following [cell validator aliases](@/guides/cell-functions/cell-validator/cell-validator.md):
|
41307
41307
|
*
|
41308
41308
|
* | Alias | Cell validator function |
|
41309
41309
|
* | ------------------- | ----------------------------------------------------------------------- |
|
41310
|
-
* | A custom alias | Your [custom cell validator](@/guides/cell-functions/cell-validator.md) |
|
41310
|
+
* | A custom alias | Your [custom cell validator](@/guides/cell-functions/cell-validator/cell-validator.md) |
|
41311
41311
|
* | `'autocomplete'` | `AutocompleteValidator` |
|
41312
41312
|
* | `'date'` | `DateValidator` |
|
41313
41313
|
* | `'dropdown'` | `DropdownValidator` |
|
@@ -41318,9 +41318,9 @@ var _default = () => {
|
|
41318
41318
|
* options all at once, use the [`type`](#type) option.
|
41319
41319
|
*
|
41320
41320
|
* Read more:
|
41321
|
-
* - [Cell validator](@/guides/cell-functions/cell-validator.md)
|
41322
|
-
* - [Cell type](@/guides/cell-types/cell-type.md)
|
41323
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
41321
|
+
* - [Cell validator](@/guides/cell-functions/cell-validator/cell-validator.md)
|
41322
|
+
* - [Cell type](@/guides/cell-types/cell-type/cell-type.md)
|
41323
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
41324
41324
|
* - [`type`](#type)
|
41325
41325
|
*
|
41326
41326
|
* @memberof Options#
|
@@ -41364,7 +41364,7 @@ var _default = () => {
|
|
41364
41364
|
* The `viewportColumnRenderingOffset` setting is ignored when [`renderAllColumns`](#renderAllColumns) is set to `true`.
|
41365
41365
|
*
|
41366
41366
|
* Read more:
|
41367
|
-
* - [Performance: Define the number of pre-rendered rows and columns](@/guides/optimization/performance.md#define-the-number-of-pre-rendered-rows-and-columns)
|
41367
|
+
* - [Performance: Define the number of pre-rendered rows and columns](@/guides/optimization/performance/performance.md#define-the-number-of-pre-rendered-rows-and-columns)
|
41368
41368
|
*
|
41369
41369
|
* @memberof Options#
|
41370
41370
|
* @type {number|string}
|
@@ -41393,8 +41393,8 @@ var _default = () => {
|
|
41393
41393
|
* The `viewportRowRenderingOffset` setting is ignored when [`renderAllRows`](#renderAllRows) is set to `true`.
|
41394
41394
|
*
|
41395
41395
|
* Read more:
|
41396
|
-
* - [Performance: Define the number of pre-rendered rows and columns](@/guides/optimization/performance.md#define-the-number-of-pre-rendered-rows-and-columns)
|
41397
|
-
* - [Column virtualization](@/guides/columns/column-virtualization.md)
|
41396
|
+
* - [Performance: Define the number of pre-rendered rows and columns](@/guides/optimization/performance/performance.md#define-the-number-of-pre-rendered-rows-and-columns)
|
41397
|
+
* - [Column virtualization](@/guides/columns/column-virtualization/column-virtualization.md)
|
41398
41398
|
*
|
41399
41399
|
* @memberof Options#
|
41400
41400
|
* @type {number|string}
|
@@ -41409,14 +41409,14 @@ var _default = () => {
|
|
41409
41409
|
*/
|
41410
41410
|
viewportRowRenderingOffset: 'auto',
|
41411
41411
|
/**
|
41412
|
-
* The `visibleRows` option sets the height of the [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md)
|
41413
|
-
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type.md) lists.
|
41412
|
+
* The `visibleRows` option sets the height of the [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
41413
|
+
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md) lists.
|
41414
41414
|
*
|
41415
41415
|
* When the number of list options exceeds the `visibleRows` number, a scrollbar appears.
|
41416
41416
|
*
|
41417
41417
|
* Read more:
|
41418
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
41419
|
-
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type.md)
|
41418
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
41419
|
+
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md)
|
41420
41420
|
*
|
41421
41421
|
* @memberof Options#
|
41422
41422
|
* @type {number}
|
@@ -41454,7 +41454,7 @@ var _default = () => {
|
|
41454
41454
|
* | A function that returns a valid number or string | `width() { return 500; }` |
|
41455
41455
|
*
|
41456
41456
|
* Read more:
|
41457
|
-
* - [Grid size](@/guides/getting-started/grid-size.md)
|
41457
|
+
* - [Grid size](@/guides/getting-started/grid-size/grid-size.md)
|
41458
41458
|
*
|
41459
41459
|
* @memberof Options#
|
41460
41460
|
* @type {number|string|Function}
|
@@ -44528,7 +44528,7 @@ var _recorder = __webpack_require__(347);
|
|
44528
44528
|
var _templateLiteralTag = __webpack_require__(112);
|
44529
44529
|
/* eslint-disable jsdoc/require-description-complete-sentence */
|
44530
44530
|
/**
|
44531
|
-
* The `ShortcutManager` API lets you store and manage [keyboard shortcut contexts](@/guides/navigation/keyboard-shortcuts.md#keyboard-shortcut-contexts) ([`ShortcutContext`](@/api/shortcutContext.md)).
|
44531
|
+
* The `ShortcutManager` API lets you store and manage [keyboard shortcut contexts](@/guides/navigation/keyboard-shortcuts/keyboard-shortcuts.md#keyboard-shortcut-contexts) ([`ShortcutContext`](@/api/shortcutContext.md)).
|
44532
44532
|
*
|
44533
44533
|
* Each `ShortcutManager` object:
|
44534
44534
|
* - Stores and manages its own set of keyboard shortcut contexts.
|
@@ -44539,7 +44539,7 @@ var _templateLiteralTag = __webpack_require__(112);
|
|
44539
44539
|
* @param {object} options The manager's options
|
44540
44540
|
* @param {EventTarget} options.ownerWindow A starting `window` element
|
44541
44541
|
* @param {Function} options.handleEvent A condition on which `event` is handled.
|
44542
|
-
* @param {Function} options.beforeKeyDown A hook fired before the `keydown` event is handled. You can use it to [block a keyboard shortcut's actions](@/guides/navigation/keyboard-shortcuts.md#block-a-keyboard-shortcut-s-actions).
|
44542
|
+
* @param {Function} options.beforeKeyDown A hook fired before the `keydown` event is handled. You can use it to [block a keyboard shortcut's actions](@/guides/navigation/keyboard-shortcuts/keyboard-shortcuts.md#block-a-keyboard-shortcut-s-actions).
|
44543
44543
|
* @param {Function} options.afterKeyDown A hook fired after the `keydown` event is handled
|
44544
44544
|
*/
|
44545
44545
|
const createShortcutManager = _ref => {
|
@@ -44741,7 +44741,7 @@ function isContextObject(objectToCheck) {
|
|
44741
44741
|
|
44742
44742
|
/* eslint-disable jsdoc/require-description-complete-sentence */
|
44743
44743
|
/**
|
44744
|
-
* The `ShortcutContext` API lets you store and manage [keyboard shortcuts](@/guides/navigation/keyboard-shortcuts.md) in a given [context](@/guides/navigation/keyboard-shortcuts.md#keyboard-shortcut-contexts).
|
44744
|
+
* The `ShortcutContext` API lets you store and manage [keyboard shortcuts](@/guides/navigation/keyboard-shortcuts/keyboard-shortcuts.md) in a given [context](@/guides/navigation/keyboard-shortcuts/keyboard-shortcuts.md#keyboard-shortcut-contexts).
|
44745
44745
|
*
|
44746
44746
|
* Each `ShortcutContext` object stores and manages its own set of keyboard shortcuts.
|
44747
44747
|
*
|
@@ -55915,26 +55915,26 @@ const PLUGIN_PRIORITY = exports.PLUGIN_PRIORITY = 220;
|
|
55915
55915
|
* @class ColumnSummary
|
55916
55916
|
*
|
55917
55917
|
* @description
|
55918
|
-
* The `ColumnSummary` plugin lets you [easily summarize your columns](@/guides/columns/column-summary.md).
|
55918
|
+
* The `ColumnSummary` plugin lets you [easily summarize your columns](@/guides/columns/column-summary/column-summary.md).
|
55919
55919
|
*
|
55920
|
-
* You can use the [built-in summary functions](@/guides/columns/column-summary.md#built-in-summary-functions),
|
55921
|
-
* or implement a [custom summary function](@/guides/columns/column-summary.md#implement-a-custom-summary-function).
|
55920
|
+
* You can use the [built-in summary functions](@/guides/columns/column-summary/column-summary.md#built-in-summary-functions),
|
55921
|
+
* or implement a [custom summary function](@/guides/columns/column-summary/column-summary.md#implement-a-custom-summary-function).
|
55922
55922
|
*
|
55923
55923
|
* For each column summary, you can set the following configuration options:
|
55924
55924
|
*
|
55925
55925
|
* | Option | Required | Type | Default | Description |
|
55926
55926
|
* |---|---|---|---|---|
|
55927
|
-
* | `sourceColumn` | No | Number | Same as `destinationColumn` | [Selects a column to summarize](@/guides/columns/column-summary.md#step-2-select-cells-that-you-want-to-summarize) |
|
55928
|
-
* | `ranges` | No | Array | - | [Selects ranges of rows to summarize](@/guides/columns/column-summary.md#step-2-select-cells-that-you-want-to-summarize) |
|
55929
|
-
* | `type` | Yes | String | - | [Sets a summary function](@/guides/columns/column-summary.md#step-3-calculate-your-summary) |
|
55930
|
-
* | `destinationRow` | Yes | Number | - | [Sets the destination cell's row coordinate](@/guides/columns/column-summary.md#step-4-provide-the-destination-cell-s-coordinates) |
|
55931
|
-
* | `destinationColumn` | Yes | Number | - | [Sets the destination cell's column coordinate](@/guides/columns/column-summary.md#step-4-provide-the-destination-cell-s-coordinates) |
|
55932
|
-
* | `forceNumeric` | No | Boolean | `false` | [Forces the summary to treat non-numerics as numerics](@/guides/columns/column-summary.md#force-numeric-values) |
|
55933
|
-
* | `reversedRowCoords` | No | Boolean | `false` | [Reverses row coordinates](@/guides/columns/column-summary.md#step-5-make-room-for-the-destination-cell) |
|
55934
|
-
* | `suppressDataTypeErrors` | No | Boolean | `true` | [Suppresses data type errors](@/guides/columns/column-summary.md#throw-data-type-errors) |
|
55927
|
+
* | `sourceColumn` | No | Number | Same as `destinationColumn` | [Selects a column to summarize](@/guides/columns/column-summary/column-summary.md#step-2-select-cells-that-you-want-to-summarize) |
|
55928
|
+
* | `ranges` | No | Array | - | [Selects ranges of rows to summarize](@/guides/columns/column-summary/column-summary.md#step-2-select-cells-that-you-want-to-summarize) |
|
55929
|
+
* | `type` | Yes | String | - | [Sets a summary function](@/guides/columns/column-summary/column-summary.md#step-3-calculate-your-summary) |
|
55930
|
+
* | `destinationRow` | Yes | Number | - | [Sets the destination cell's row coordinate](@/guides/columns/column-summary/column-summary.md#step-4-provide-the-destination-cell-s-coordinates) |
|
55931
|
+
* | `destinationColumn` | Yes | Number | - | [Sets the destination cell's column coordinate](@/guides/columns/column-summary/column-summary.md#step-4-provide-the-destination-cell-s-coordinates) |
|
55932
|
+
* | `forceNumeric` | No | Boolean | `false` | [Forces the summary to treat non-numerics as numerics](@/guides/columns/column-summary/column-summary.md#force-numeric-values) |
|
55933
|
+
* | `reversedRowCoords` | No | Boolean | `false` | [Reverses row coordinates](@/guides/columns/column-summary/column-summary.md#step-5-make-room-for-the-destination-cell) |
|
55934
|
+
* | `suppressDataTypeErrors` | No | Boolean | `true` | [Suppresses data type errors](@/guides/columns/column-summary/column-summary.md#throw-data-type-errors) |
|
55935
55935
|
* | `readOnly` | No | Boolean | `true` | Makes summary cell read-only |
|
55936
|
-
* | `roundFloat` | No | Number/<br>Boolean | - | [Rounds summary result](@/guides/columns/column-summary.md#round-a-column-summary-result) |
|
55937
|
-
* | `customFunction` | No | Function | - | [Lets you add a custom summary function](@/guides/columns/column-summary.md#implement-a-custom-summary-function) |
|
55936
|
+
* | `roundFloat` | No | Number/<br>Boolean | - | [Rounds summary result](@/guides/columns/column-summary/column-summary.md#round-a-column-summary-result) |
|
55937
|
+
* | `customFunction` | No | Function | - | [Lets you add a custom summary function](@/guides/columns/column-summary/column-summary.md#implement-a-custom-summary-function) |
|
55938
55938
|
*
|
55939
55939
|
* @example
|
55940
55940
|
* ::: only-for javascript
|
@@ -56007,7 +56007,7 @@ class ColumnSummary extends _base.BasePlugin {
|
|
56007
56007
|
*
|
56008
56008
|
* @param {Array} rows Array of visual row indexes to be moved.
|
56009
56009
|
* @param {number} finalIndex Visual row index, being a start index for the moved rows. Points to where the elements will be placed after the moving action.
|
56010
|
-
* To check the visualization of the final index, please take a look at [documentation](@/guides/rows/row-moving.md).
|
56010
|
+
* To check the visualization of the final index, please take a look at [documentation](@/guides/rows/row-moving/row-moving.md).
|
56011
56011
|
*/
|
56012
56012
|
_classPrivateMethodInitSpec(this, _onAfterRowMove);
|
56013
56013
|
/**
|
@@ -59331,14 +59331,14 @@ _pluginHooks.default.getSingleton().register('afterContextMenuExecute');
|
|
59331
59331
|
* @class ContextMenu
|
59332
59332
|
* @description
|
59333
59333
|
* This plugin creates the Handsontable Context Menu. It allows to create a new row or column at any place in the
|
59334
|
-
* grid among [other features](@/guides/accessories-and-menus/context-menu.md#context-menu-with-specific-options).
|
59334
|
+
* grid among [other features](@/guides/accessories-and-menus/context-menu/context-menu.md#context-menu-with-specific-options).
|
59335
59335
|
* Possible values:
|
59336
59336
|
* * `true` (to enable default options),
|
59337
59337
|
* * `false` (to disable completely)
|
59338
59338
|
* * `{ uiContainer: containerDomElement }` (to declare a container for all of the Context Menu's dom elements to be placed in).
|
59339
|
-
* * An array of [the available strings](@/guides/accessories-and-menus/context-menu.md#context-menu-with-specific-options)
|
59339
|
+
* * An array of [the available strings](@/guides/accessories-and-menus/context-menu/context-menu.md#context-menu-with-specific-options)
|
59340
59340
|
*
|
59341
|
-
* See [the context menu demo](@/guides/accessories-and-menus/context-menu.md) for examples.
|
59341
|
+
* See [the context menu demo](@/guides/accessories-and-menus/context-menu/context-menu.md) for examples.
|
59342
59342
|
*
|
59343
59343
|
* @example
|
59344
59344
|
* ```js
|
@@ -61768,12 +61768,12 @@ const META_HEAD = ['<meta name="generator" content="Handsontable"/>', '<style ty
|
|
61768
61768
|
* Control the `CopyPaste` plugin programmatically through its [API methods](#methods).
|
61769
61769
|
*
|
61770
61770
|
* The user can access the copy-paste features through:
|
61771
|
-
* - The [context menu](@/guides/cell-features/clipboard.md#context-menu).
|
61772
|
-
* - The [keyboard shortcuts](@/guides/cell-features/clipboard.md#related-keyboard-shortcuts).
|
61771
|
+
* - The [context menu](@/guides/cell-features/clipboard/clipboard.md#context-menu).
|
61772
|
+
* - The [keyboard shortcuts](@/guides/cell-features/clipboard/clipboard.md#related-keyboard-shortcuts).
|
61773
61773
|
* - The browser's menu bar.
|
61774
61774
|
*
|
61775
61775
|
* Read more:
|
61776
|
-
* - [Guides: Clipboard](@/guides/cell-features/clipboard.md)
|
61776
|
+
* - [Guides: Clipboard](@/guides/cell-features/clipboard/clipboard.md)
|
61777
61777
|
* - [Configuration options: `copyPaste`](@/api/options.md#copypaste)
|
61778
61778
|
*
|
61779
61779
|
* @example
|
@@ -63161,7 +63161,7 @@ const PLUGIN_PRIORITY = exports.PLUGIN_PRIORITY = 90;
|
|
63161
63161
|
* of an array.
|
63162
63162
|
*
|
63163
63163
|
* See [`customBorders` configuration option](@/api/options.md#customBorders) or go to
|
63164
|
-
* [Custom cell borders demo](@/guides/cell-features/formatting-cells.md#custom-cell-borders) for more examples.
|
63164
|
+
* [Custom cell borders demo](@/guides/cell-features/formatting-cells/formatting-cells.md#custom-cell-borders) for more examples.
|
63165
63165
|
*
|
63166
63166
|
* @example
|
63167
63167
|
* ```js
|
@@ -64649,7 +64649,7 @@ const SHORTCUTS_GROUP = PLUGIN_KEY;
|
|
64649
64649
|
*
|
64650
64650
|
* @description
|
64651
64651
|
* This plugin creates the Handsontable Dropdown Menu. It allows to create a new row or column at any place in the grid
|
64652
|
-
* among [other features](@/guides/accessories-and-menus/context-menu.md#context-menu-with-specific-options).
|
64652
|
+
* among [other features](@/guides/accessories-and-menus/context-menu/context-menu.md#context-menu-with-specific-options).
|
64653
64653
|
* Possible values:
|
64654
64654
|
* * `true` (to enable default options),
|
64655
64655
|
* * `false` (to disable completely).
|
@@ -64658,7 +64658,7 @@ const SHORTCUTS_GROUP = PLUGIN_KEY;
|
|
64658
64658
|
* * `["row_above", "row_below", "col_left", "col_right",
|
64659
64659
|
* "remove_row", "remove_col", "---------", "undo", "redo"]`.
|
64660
64660
|
*
|
64661
|
-
* See [the dropdown menu demo](@/guides/columns/column-menu.md) for examples.
|
64661
|
+
* See [the dropdown menu demo](@/guides/columns/column-menu/column-menu.md) for examples.
|
64662
64662
|
*
|
64663
64663
|
* @example
|
64664
64664
|
* ::: only-for javascript
|
@@ -65227,7 +65227,7 @@ const PLUGIN_PRIORITY = exports.PLUGIN_PRIORITY = 240;
|
|
65227
65227
|
* @description
|
65228
65228
|
* The `ExportFile` plugin lets you export table data as a string, blob, or downloadable CSV file.
|
65229
65229
|
*
|
65230
|
-
* See [the export file demo](@/guides/accessories-and-menus/export-to-csv.md) for examples.
|
65230
|
+
* See [the export file demo](@/guides/accessories-and-menus/export-to-csv/export-to-csv.md) for examples.
|
65231
65231
|
*
|
65232
65232
|
* @example
|
65233
65233
|
* ::: only-for javascript
|
@@ -65845,7 +65845,7 @@ const SHORTCUTS_GROUP = PLUGIN_KEY;
|
|
65845
65845
|
* @description
|
65846
65846
|
* The plugin allows filtering the table data either by the built-in component or with the API.
|
65847
65847
|
*
|
65848
|
-
* See [the filtering demo](@/guides/columns/column-filter.md) for examples.
|
65848
|
+
* See [the filtering demo](@/guides/columns/column-filter/column-filter.md) for examples.
|
65849
65849
|
*
|
65850
65850
|
* @example
|
65851
65851
|
* ::: only-for javascript
|
@@ -70999,7 +70999,7 @@ const isBlockedSource = source => source === 'UndoRedo.undo' || source === 'Undo
|
|
70999
70999
|
* integration with our other product, [HyperFormula](https://github.com/handsontable/hyperformula/), which is a
|
71000
71000
|
* powerful calculation engine with an extensive number of features.
|
71001
71001
|
*
|
71002
|
-
* To test out HyperFormula, see [this guide](@/guides/formulas/formula-calculation.md#available-functions).
|
71002
|
+
* To test out HyperFormula, see [this guide](@/guides/formulas/formula-calculation/formula-calculation.md#available-functions).
|
71003
71003
|
*
|
71004
71004
|
* @plugin Formulas
|
71005
71005
|
* @class Formulas
|
@@ -73330,7 +73330,7 @@ const PLUGIN_PRIORITY = exports.PLUGIN_PRIORITY = 310;
|
|
73330
73330
|
* @class HiddenColumns
|
73331
73331
|
*
|
73332
73332
|
* @description
|
73333
|
-
* The `HiddenColumns` plugin lets you [hide specified columns](@/guides/columns/column-hiding.md).
|
73333
|
+
* The `HiddenColumns` plugin lets you [hide specified columns](@/guides/columns/column-hiding/column-hiding.md).
|
73334
73334
|
*
|
73335
73335
|
* "Hiding a column" means that the hidden column doesn't get rendered as a DOM element.
|
73336
73336
|
*
|
@@ -73342,9 +73342,9 @@ const PLUGIN_PRIORITY = exports.PLUGIN_PRIORITY = 310;
|
|
73342
73342
|
*
|
73343
73343
|
* | Option | Required | Type | Default | Description |
|
73344
73344
|
* |---|---|---|---|---|
|
73345
|
-
* | `columns` | No | Array | - | [Hides specified columns by default](@/guides/columns/column-hiding.md#step-1-specify-columns-hidden-by-default) |
|
73346
|
-
* | `indicators` | No | Boolean | `false` | [Shows UI indicators](@/guides/columns/column-hiding.md#step-2-show-ui-indicators) |
|
73347
|
-
* | `copyPasteEnabled` | No | Boolean | `true` | [Sets up copy/paste behavior](@/guides/columns/column-hiding.md#step-4-set-up-copy-and-paste-behavior) |
|
73345
|
+
* | `columns` | No | Array | - | [Hides specified columns by default](@/guides/columns/column-hiding/column-hiding.md#step-1-specify-columns-hidden-by-default) |
|
73346
|
+
* | `indicators` | No | Boolean | `false` | [Shows UI indicators](@/guides/columns/column-hiding/column-hiding.md#step-2-show-ui-indicators) |
|
73347
|
+
* | `copyPasteEnabled` | No | Boolean | `true` | [Sets up copy/paste behavior](@/guides/columns/column-hiding/column-hiding.md#step-4-set-up-copy-and-paste-behavior) |
|
73348
73348
|
*
|
73349
73349
|
* @example
|
73350
73350
|
*
|
@@ -74046,7 +74046,7 @@ const PLUGIN_PRIORITY = exports.PLUGIN_PRIORITY = 320;
|
|
74046
74046
|
* @class HiddenRows
|
74047
74047
|
*
|
74048
74048
|
* @description
|
74049
|
-
* The `HiddenRows` plugin lets you [hide specified rows](@/guides/rows/row-hiding.md).
|
74049
|
+
* The `HiddenRows` plugin lets you [hide specified rows](@/guides/rows/row-hiding/row-hiding.md).
|
74050
74050
|
*
|
74051
74051
|
* "Hiding a row" means that the hidden row doesn't get rendered as a DOM element.
|
74052
74052
|
*
|
@@ -74058,9 +74058,9 @@ const PLUGIN_PRIORITY = exports.PLUGIN_PRIORITY = 320;
|
|
74058
74058
|
*
|
74059
74059
|
* | Option | Required | Type | Default | Description |
|
74060
74060
|
* |---|---|---|---|---|
|
74061
|
-
* | `rows` | No | Array | - | [Hides specified rows by default](@/guides/rows/row-hiding.md#step-1-specify-rows-hidden-by-default) |
|
74062
|
-
* | `indicators` | No | Boolean | `false` | [Shows UI indicators](@/guides/rows/row-hiding.md#step-2-show-ui-indicators) |
|
74063
|
-
* | `copyPasteEnabled` | No | Boolean | `true` | [Sets up copy/paste behavior](@/guides/rows/row-hiding.md#step-4-set-up-copy-and-paste-behavior) |
|
74061
|
+
* | `rows` | No | Array | - | [Hides specified rows by default](@/guides/rows/row-hiding/row-hiding.md#step-1-specify-rows-hidden-by-default) |
|
74062
|
+
* | `indicators` | No | Boolean | `false` | [Shows UI indicators](@/guides/rows/row-hiding/row-hiding.md#step-2-show-ui-indicators) |
|
74063
|
+
* | `copyPasteEnabled` | No | Boolean | `true` | [Sets up copy/paste behavior](@/guides/rows/row-hiding/row-hiding.md#step-4-set-up-copy-and-paste-behavior) |
|
74064
74064
|
*
|
74065
74065
|
* @example
|
74066
74066
|
*
|
@@ -75083,7 +75083,7 @@ const CSS_AFTER_SELECTION = 'after-selection--columns';
|
|
75083
75083
|
* - `dragColumn` - drag single column to the new position.
|
75084
75084
|
* - `dragColumns` - drag many columns (as an array of indexes) to the new position.
|
75085
75085
|
*
|
75086
|
-
* [Documentation](@/guides/columns/column-moving.md) explain differences between drag and move actions.
|
75086
|
+
* [Documentation](@/guides/columns/column-moving/column-moving.md) explain differences between drag and move actions.
|
75087
75087
|
* Please keep in mind that if you want apply visual changes,
|
75088
75088
|
* you have to call manually the `render` method on the instance of Handsontable.
|
75089
75089
|
*
|
@@ -75316,7 +75316,7 @@ class ManualColumnMove extends _base.BasePlugin {
|
|
75316
75316
|
*
|
75317
75317
|
* @param {number} column Visual column index to be moved.
|
75318
75318
|
* @param {number} finalIndex Visual column index, being a start index for the moved columns. Points to where the elements will be placed after the moving action.
|
75319
|
-
* To check the visualization of the final index, please take a look at [documentation](@/guides/columns/column-moving.md#drag-and-move-actions-of-manualcolumnmove-plugin).
|
75319
|
+
* To check the visualization of the final index, please take a look at [documentation](@/guides/columns/column-moving/column-moving.md#drag-and-move-actions-of-manualcolumnmove-plugin).
|
75320
75320
|
* @fires Hooks#beforeColumnMove
|
75321
75321
|
* @fires Hooks#afterColumnMove
|
75322
75322
|
* @returns {boolean}
|
@@ -75330,7 +75330,7 @@ class ManualColumnMove extends _base.BasePlugin {
|
|
75330
75330
|
*
|
75331
75331
|
* @param {Array} columns Array of visual column indexes to be moved.
|
75332
75332
|
* @param {number} finalIndex Visual column index, being a start index for the moved columns. Points to where the elements will be placed after the moving action.
|
75333
|
-
* To check the visualization of the final index, please take a look at [documentation](@/guides/columns/column-moving.md#drag-and-move-actions-of-manualcolumnmove-plugin).
|
75333
|
+
* To check the visualization of the final index, please take a look at [documentation](@/guides/columns/column-moving/column-moving.md#drag-and-move-actions-of-manualcolumnmove-plugin).
|
75334
75334
|
* @fires Hooks#beforeColumnMove
|
75335
75335
|
* @fires Hooks#afterColumnMove
|
75336
75336
|
* @returns {boolean}
|
@@ -75356,7 +75356,7 @@ class ManualColumnMove extends _base.BasePlugin {
|
|
75356
75356
|
*
|
75357
75357
|
* @param {number} column Visual column index to be dragged.
|
75358
75358
|
* @param {number} dropIndex Visual column index, being a drop index for the moved columns. Points to where we are going to drop the moved elements.
|
75359
|
-
* To check visualization of drop index please take a look at [documentation](@/guides/columns/column-moving.md#drag-and-move-actions-of-manualcolumnmove-plugin).
|
75359
|
+
* To check visualization of drop index please take a look at [documentation](@/guides/columns/column-moving/column-moving.md#drag-and-move-actions-of-manualcolumnmove-plugin).
|
75360
75360
|
* @fires Hooks#beforeColumnMove
|
75361
75361
|
* @fires Hooks#afterColumnMove
|
75362
75362
|
* @returns {boolean}
|
@@ -75370,7 +75370,7 @@ class ManualColumnMove extends _base.BasePlugin {
|
|
75370
75370
|
*
|
75371
75371
|
* @param {Array} columns Array of visual column indexes to be dragged.
|
75372
75372
|
* @param {number} dropIndex Visual column index, being a drop index for the moved columns. Points to where we are going to drop the moved elements.
|
75373
|
-
* To check visualization of drop index please take a look at [documentation](@/guides/columns/column-moving.md#drag-and-move-actions-of-manualcolumnmove-plugin).
|
75373
|
+
* To check visualization of drop index please take a look at [documentation](@/guides/columns/column-moving/column-moving.md#drag-and-move-actions-of-manualcolumnmove-plugin).
|
75374
75374
|
* @fires Hooks#beforeColumnMove
|
75375
75375
|
* @fires Hooks#afterColumnMove
|
75376
75376
|
* @returns {boolean}
|
@@ -75387,7 +75387,7 @@ class ManualColumnMove extends _base.BasePlugin {
|
|
75387
75387
|
*
|
75388
75388
|
* @param {Array} movedColumns Array of visual column indexes to be moved.
|
75389
75389
|
* @param {number} finalIndex Visual column index, being a start index for the moved columns. Points to where the elements will be placed after the moving action.
|
75390
|
-
* To check the visualization of the final index, please take a look at [documentation](@/guides/columns/column-moving.md#drag-and-move-actions-of-manualcolumnmove-plugin).
|
75390
|
+
* To check the visualization of the final index, please take a look at [documentation](@/guides/columns/column-moving/column-moving.md#drag-and-move-actions-of-manualcolumnmove-plugin).
|
75391
75391
|
* @returns {boolean}
|
75392
75392
|
*/
|
75393
75393
|
isMovePossible(movedColumns, finalIndex) {
|
@@ -75410,7 +75410,7 @@ class ManualColumnMove extends _base.BasePlugin {
|
|
75410
75410
|
* @private
|
75411
75411
|
* @param {Array} movedColumns Array of visual column indexes to be moved.
|
75412
75412
|
* @param {number} finalIndex Visual column index, being a start index for the moved columns. Points to where the elements will be placed after the moving action.
|
75413
|
-
* To check the visualization of the final index, please take a look at [documentation](@/guides/columns/column-moving.md#drag-and-move-actions-of-manualcolumnmove-plugin).
|
75413
|
+
* To check the visualization of the final index, please take a look at [documentation](@/guides/columns/column-moving/column-moving.md#drag-and-move-actions-of-manualcolumnmove-plugin).
|
75414
75414
|
* @returns {boolean}
|
75415
75415
|
*/
|
75416
75416
|
isColumnOrderChanged(movedColumns, finalIndex) {
|
@@ -76797,7 +76797,7 @@ const CSS_AFTER_SELECTION = 'after-selection--rows';
|
|
76797
76797
|
* - `dragRow` - drag single row to the new position.
|
76798
76798
|
* - `dragRows` - drag many rows (as an array of indexes) to the new position.
|
76799
76799
|
*
|
76800
|
-
* [Documentation](@/guides/rows/row-moving.md) explain differences between drag and move actions. Please keep in mind that if you want apply visual changes,
|
76800
|
+
* [Documentation](@/guides/rows/row-moving/row-moving.md) explain differences between drag and move actions. Please keep in mind that if you want apply visual changes,
|
76801
76801
|
* you have to call manually the `render` method on the instance of Handsontable.
|
76802
76802
|
*
|
76803
76803
|
* The plugin creates additional components to make moving possibly using user interface:
|
@@ -76989,7 +76989,7 @@ class ManualRowMove extends _base.BasePlugin {
|
|
76989
76989
|
*
|
76990
76990
|
* @param {number} row Visual row index to be moved.
|
76991
76991
|
* @param {number} finalIndex Visual row index, being a start index for the moved rows. Points to where the elements will be placed after the moving action.
|
76992
|
-
* To check the visualization of the final index, please take a look at [documentation](@/guides/rows/row-moving.md#drag-and-move-actions-of-manualrowmove-plugin).
|
76992
|
+
* To check the visualization of the final index, please take a look at [documentation](@/guides/rows/row-moving/row-moving.md#drag-and-move-actions-of-manualrowmove-plugin).
|
76993
76993
|
* @fires Hooks#beforeRowMove
|
76994
76994
|
* @fires Hooks#afterRowMove
|
76995
76995
|
* @returns {boolean}
|
@@ -77005,7 +77005,7 @@ class ManualRowMove extends _base.BasePlugin {
|
|
77005
77005
|
*
|
77006
77006
|
* @param {Array} rows Array of visual row indexes to be moved.
|
77007
77007
|
* @param {number} finalIndex Visual row index, being a start index for the moved rows. Points to where the elements will be placed after the moving action.
|
77008
|
-
* To check the visualization of the final index, please take a look at [documentation](@/guides/rows/row-moving.md#drag-and-move-actions-of-manualrowmove-plugin).
|
77008
|
+
* To check the visualization of the final index, please take a look at [documentation](@/guides/rows/row-moving/row-moving.md#drag-and-move-actions-of-manualrowmove-plugin).
|
77009
77009
|
* @fires Hooks#beforeRowMove
|
77010
77010
|
* @fires Hooks#afterRowMove
|
77011
77011
|
* @returns {boolean}
|
@@ -77031,7 +77031,7 @@ class ManualRowMove extends _base.BasePlugin {
|
|
77031
77031
|
*
|
77032
77032
|
* @param {number} row Visual row index to be dragged.
|
77033
77033
|
* @param {number} dropIndex Visual row index, being a drop index for the moved rows. Points to where we are going to drop the moved elements.
|
77034
|
-
* To check visualization of drop index please take a look at [documentation](@/guides/rows/row-moving.md#drag-and-move-actions-of-manualrowmove-plugin).
|
77034
|
+
* To check visualization of drop index please take a look at [documentation](@/guides/rows/row-moving/row-moving.md#drag-and-move-actions-of-manualrowmove-plugin).
|
77035
77035
|
* @fires Hooks#beforeRowMove
|
77036
77036
|
* @fires Hooks#afterRowMove
|
77037
77037
|
* @returns {boolean}
|
@@ -77045,7 +77045,7 @@ class ManualRowMove extends _base.BasePlugin {
|
|
77045
77045
|
*
|
77046
77046
|
* @param {Array} rows Array of visual row indexes to be dragged.
|
77047
77047
|
* @param {number} dropIndex Visual row index, being a drop index for the moved rows. Points to where we are going to drop the moved elements.
|
77048
|
-
* To check visualization of drop index please take a look at [documentation](@/guides/rows/row-moving.md#drag-and-move-actions-of-manualrowmove-plugin).
|
77048
|
+
* To check visualization of drop index please take a look at [documentation](@/guides/rows/row-moving/row-moving.md#drag-and-move-actions-of-manualrowmove-plugin).
|
77049
77049
|
* @fires Hooks#beforeRowMove
|
77050
77050
|
* @fires Hooks#afterRowMove
|
77051
77051
|
* @returns {boolean}
|
@@ -77061,7 +77061,7 @@ class ManualRowMove extends _base.BasePlugin {
|
|
77061
77061
|
*
|
77062
77062
|
* @param {Array} movedRows Array of visual row indexes to be moved.
|
77063
77063
|
* @param {number} finalIndex Visual row index, being a start index for the moved rows. Points to where the elements will be placed after the moving action.
|
77064
|
-
* To check the visualization of the final index, please take a look at [documentation](@/guides/rows/row-moving.md#drag-and-move-actions-of-manualrowmove-plugin).
|
77064
|
+
* To check the visualization of the final index, please take a look at [documentation](@/guides/rows/row-moving/row-moving.md#drag-and-move-actions-of-manualrowmove-plugin).
|
77065
77065
|
* @returns {boolean}
|
77066
77066
|
*/
|
77067
77067
|
isMovePossible(movedRows, finalIndex) {
|
@@ -77084,7 +77084,7 @@ class ManualRowMove extends _base.BasePlugin {
|
|
77084
77084
|
* @private
|
77085
77085
|
* @param {Array} movedRows Array of visual row indexes to be moved.
|
77086
77086
|
* @param {number} finalIndex Visual row index, being a start index for the moved rows. Points to where the elements will be placed after the moving action.
|
77087
|
-
* To check the visualization of the final index, please take a look at [documentation](@/guides/rows/row-moving.md#drag-and-move-actions-of-manualrowmove-plugin).
|
77087
|
+
* To check the visualization of the final index, please take a look at [documentation](@/guides/rows/row-moving/row-moving.md#drag-and-move-actions-of-manualrowmove-plugin).
|
77088
77088
|
* @returns {boolean}
|
77089
77089
|
*/
|
77090
77090
|
isRowOrderChanged(movedRows, finalIndex) {
|
@@ -85067,10 +85067,10 @@ class NestedRows extends _base.BasePlugin {
|
|
85067
85067
|
* @param {Array} rows Array of visual row indexes to be moved.
|
85068
85068
|
* @param {number} finalIndex Visual row index, being a start index for the moved rows. Points to where the elements
|
85069
85069
|
* will be placed after the moving action. To check the visualization of the final index, please take a look at
|
85070
|
-
* [documentation](@/guides/rows/row-summary.md).
|
85070
|
+
* [documentation](@/guides/rows/row-summary/row-summary.md).
|
85071
85071
|
* @param {undefined|number} dropIndex Visual row index, being a drop index for the moved rows. Points to where we
|
85072
85072
|
* are going to drop the moved elements. To check visualization of drop index please take a look at
|
85073
|
-
* [documentation](@/guides/rows/row-summary.md).
|
85073
|
+
* [documentation](@/guides/rows/row-summary/row-summary.md).
|
85074
85074
|
* @param {boolean} movePossible Indicates if it's possible to move rows to the desired position.
|
85075
85075
|
* @fires Hooks#afterRowMove
|
85076
85076
|
* @returns {boolean}
|
@@ -87018,10 +87018,10 @@ class RowMoveController {
|
|
87018
87018
|
* @param {Array} rows Array of visual row indexes to be moved.
|
87019
87019
|
* @param {number} finalIndex Visual row index, being a start index for the moved rows. Points to where the elements
|
87020
87020
|
* will be placed after the moving action. To check the visualization of the final index, please take a look at
|
87021
|
-
* [documentation](@/guides/rows/row-moving.md).
|
87021
|
+
* [documentation](@/guides/rows/row-moving/row-moving.md).
|
87022
87022
|
* @param {undefined|number} dropIndex Visual row index, being a drop index for the moved rows. Points to where we
|
87023
87023
|
* are going to drop the moved elements. To check visualization of drop index please take a look at
|
87024
|
-
* [documentation](@/guides/rows/row-moving.md).
|
87024
|
+
* [documentation](@/guides/rows/row-moving/row-moving.md).
|
87025
87025
|
* @param {boolean} movePossible Indicates if it's possible to move rows to the desired position.
|
87026
87026
|
* @fires Hooks#afterRowMove
|
87027
87027
|
* @returns {boolean}
|
@@ -87202,7 +87202,7 @@ class RowMoveController {
|
|
87202
87202
|
* @param {Array} rows Array of visual row indexes to be moved.
|
87203
87203
|
* @param {undefined|number} dropIndex Visual row index, being a drop index for the moved rows. Points to where we
|
87204
87204
|
* are going to drop the moved elements. To check visualization of drop index please take a look at
|
87205
|
-
* [documentation](@/guides/rows/row-moving.md).
|
87205
|
+
* [documentation](@/guides/rows/row-moving/row-moving.md).
|
87206
87206
|
*/
|
87207
87207
|
selectCells(rows, dropIndex) {
|
87208
87208
|
const rowsLen = rows.length;
|
@@ -87241,7 +87241,7 @@ class RowMoveController {
|
|
87241
87241
|
* @param {Array} movedRows Array of visual row indexes to be moved.
|
87242
87242
|
* @param {number} finalIndex Visual row index, being a start index for the moved rows. Points to where the elements
|
87243
87243
|
* will be placed after the moving action. To check the visualization of the final index, please take a look at
|
87244
|
-
* [documentation](@/guides/rows/row-moving.md).
|
87244
|
+
* [documentation](@/guides/rows/row-moving/row-moving.md).
|
87245
87245
|
* @returns {boolean}
|
87246
87246
|
*/
|
87247
87247
|
isRowOrderChanged(movedRows, finalIndex) {
|