handsontable 14.2.0 → 14.3.0-next-3fa6b18-20240410
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/3rdparty/walkontable/src/calculator/renderAllColumns.js +1 -1
- package/3rdparty/walkontable/src/calculator/renderAllColumns.mjs +1 -1
- package/3rdparty/walkontable/src/calculator/renderAllRows.js +1 -1
- package/3rdparty/walkontable/src/calculator/renderAllRows.mjs +1 -1
- package/3rdparty/walkontable/src/calculator/viewportColumns.js +13 -18
- package/3rdparty/walkontable/src/calculator/viewportColumns.mjs +13 -18
- package/3rdparty/walkontable/src/calculator/viewportRows.js +11 -16
- package/3rdparty/walkontable/src/calculator/viewportRows.mjs +11 -16
- package/3rdparty/walkontable/src/cell/coords.js +13 -18
- package/3rdparty/walkontable/src/cell/coords.mjs +13 -18
- package/3rdparty/walkontable/src/cell/range.d.ts +2 -1
- package/3rdparty/walkontable/src/cell/range.js +42 -30
- package/3rdparty/walkontable/src/cell/range.mjs +42 -30
- package/3rdparty/walkontable/src/core/_base.js +2 -2
- package/3rdparty/walkontable/src/core/_base.mjs +2 -2
- package/3rdparty/walkontable/src/core/clone.js +1 -1
- package/3rdparty/walkontable/src/core/clone.mjs +1 -1
- package/3rdparty/walkontable/src/event.js +72 -104
- package/3rdparty/walkontable/src/event.mjs +72 -104
- package/3rdparty/walkontable/src/filter/column.js +1 -1
- package/3rdparty/walkontable/src/filter/column.mjs +1 -1
- package/3rdparty/walkontable/src/filter/row.js +1 -1
- package/3rdparty/walkontable/src/filter/row.mjs +1 -1
- package/3rdparty/walkontable/src/index.js +1 -1
- package/3rdparty/walkontable/src/overlay/_base.js +1 -1
- package/3rdparty/walkontable/src/overlay/_base.mjs +1 -1
- package/3rdparty/walkontable/src/overlay/bottom.js +1 -1
- package/3rdparty/walkontable/src/overlay/bottom.mjs +1 -1
- package/3rdparty/walkontable/src/overlay/inlineStart.js +15 -1
- package/3rdparty/walkontable/src/overlay/inlineStart.mjs +16 -2
- package/3rdparty/walkontable/src/overlay/top.js +12 -1
- package/3rdparty/walkontable/src/overlay/top.mjs +13 -2
- package/3rdparty/walkontable/src/overlay/topInlineStartCorner.js +1 -1
- package/3rdparty/walkontable/src/overlay/topInlineStartCorner.mjs +1 -1
- package/3rdparty/walkontable/src/overlays.js +47 -5
- package/3rdparty/walkontable/src/overlays.mjs +47 -5
- package/3rdparty/walkontable/src/renderer/_base.js +1 -1
- package/3rdparty/walkontable/src/renderer/_base.mjs +1 -1
- package/3rdparty/walkontable/src/renderer/cells.js +1 -1
- package/3rdparty/walkontable/src/renderer/cells.mjs +1 -1
- package/3rdparty/walkontable/src/renderer/rowHeaders.js +1 -1
- package/3rdparty/walkontable/src/renderer/rowHeaders.mjs +1 -1
- package/3rdparty/walkontable/src/renderer/rows.js +1 -1
- package/3rdparty/walkontable/src/renderer/rows.mjs +1 -1
- package/3rdparty/walkontable/src/renderer/table.js +1 -1
- package/3rdparty/walkontable/src/renderer/table.mjs +1 -1
- package/3rdparty/walkontable/src/scroll.js +16 -18
- package/3rdparty/walkontable/src/scroll.mjs +16 -18
- package/3rdparty/walkontable/src/selection/manager.js +48 -69
- package/3rdparty/walkontable/src/selection/manager.mjs +48 -69
- package/3rdparty/walkontable/src/selection/scanner.js +33 -42
- package/3rdparty/walkontable/src/selection/scanner.mjs +33 -42
- package/3rdparty/walkontable/src/settings.js +1 -1
- package/3rdparty/walkontable/src/settings.mjs +1 -1
- package/3rdparty/walkontable/src/table.js +1 -1
- package/3rdparty/walkontable/src/table.mjs +1 -1
- package/3rdparty/walkontable/src/utils/column.js +1 -1
- package/3rdparty/walkontable/src/utils/column.mjs +1 -1
- package/3rdparty/walkontable/src/utils/columnStretching.js +28 -45
- package/3rdparty/walkontable/src/utils/columnStretching.mjs +28 -45
- package/3rdparty/walkontable/src/utils/nodesPool.js +1 -1
- package/3rdparty/walkontable/src/utils/nodesPool.mjs +1 -1
- package/3rdparty/walkontable/src/utils/orderView/view.js +2 -2
- package/3rdparty/walkontable/src/utils/orderView/view.mjs +2 -2
- package/3rdparty/walkontable/src/utils/orderView/viewSize.js +1 -1
- package/3rdparty/walkontable/src/utils/orderView/viewSize.mjs +1 -1
- package/3rdparty/walkontable/src/utils/orderView/viewSizeSet.js +1 -1
- package/3rdparty/walkontable/src/utils/orderView/viewSizeSet.mjs +1 -1
- package/3rdparty/walkontable/src/utils/row.js +1 -1
- package/3rdparty/walkontable/src/utils/row.mjs +1 -1
- package/CHANGELOG.md +20 -0
- package/base.js +2 -2
- package/base.mjs +2 -2
- package/core/viewportScroll/index.js +4 -1
- package/core/viewportScroll/index.mjs +4 -1
- package/core/viewportScroll/scrollStrategies/focusScroll.js +15 -0
- package/core/viewportScroll/scrollStrategies/focusScroll.mjs +11 -0
- package/core.d.ts +4 -3
- package/core.js +98 -43
- package/core.mjs +98 -43
- package/dataMap/dataMap.js +1 -1
- package/dataMap/dataMap.mjs +1 -1
- package/dataMap/dataSource.js +2 -2
- package/dataMap/dataSource.mjs +2 -2
- package/dataMap/metaManager/lazyFactoryMap.js +3 -5
- package/dataMap/metaManager/lazyFactoryMap.mjs +2 -4
- package/dataMap/metaManager/metaLayers/cellMeta.js +2 -2
- package/dataMap/metaManager/metaLayers/cellMeta.mjs +2 -2
- package/dataMap/metaManager/metaLayers/columnMeta.js +1 -1
- package/dataMap/metaManager/metaLayers/columnMeta.mjs +1 -1
- package/dataMap/metaManager/metaLayers/globalMeta.js +1 -1
- package/dataMap/metaManager/metaLayers/globalMeta.mjs +1 -1
- package/dataMap/metaManager/metaLayers/tableMeta.js +1 -1
- package/dataMap/metaManager/metaLayers/tableMeta.mjs +1 -1
- package/dataMap/metaManager/metaSchema.js +272 -272
- package/dataMap/metaManager/metaSchema.mjs +272 -272
- package/dataMap/metaManager/mods/dynamicCellMeta.js +1 -1
- package/dataMap/metaManager/mods/dynamicCellMeta.mjs +1 -1
- package/dataMap/metaManager/mods/extendMetaProperties.js +1 -1
- package/dataMap/metaManager/mods/extendMetaProperties.mjs +1 -1
- package/dataMap/replaceData.js +1 -1
- package/dataMap/replaceData.mjs +1 -1
- package/dist/handsontable.css +4 -4
- package/dist/handsontable.full.css +4 -4
- package/dist/handsontable.full.js +9814 -10020
- package/dist/handsontable.full.min.css +3 -3
- package/dist/handsontable.full.min.js +292 -292
- package/dist/handsontable.js +7484 -7056
- package/dist/handsontable.min.css +3 -3
- package/dist/handsontable.min.js +25 -25
- package/dist/languages/all.min.js +1 -1
- package/dist/languages/ar-AR.min.js +1 -1
- package/dist/languages/cs-CZ.min.js +1 -1
- package/dist/languages/de-CH.min.js +1 -1
- package/dist/languages/de-DE.min.js +1 -1
- package/dist/languages/en-US.min.js +1 -1
- package/dist/languages/es-MX.min.js +1 -1
- package/dist/languages/fr-FR.min.js +1 -1
- package/dist/languages/hr-HR.min.js +1 -1
- package/dist/languages/it-IT.min.js +1 -1
- package/dist/languages/ja-JP.min.js +1 -1
- package/dist/languages/ko-KR.min.js +1 -1
- package/dist/languages/lv-LV.min.js +1 -1
- package/dist/languages/nb-NO.min.js +1 -1
- package/dist/languages/nl-NL.min.js +1 -1
- package/dist/languages/pl-PL.min.js +1 -1
- package/dist/languages/pt-BR.min.js +1 -1
- package/dist/languages/ru-RU.min.js +1 -1
- package/dist/languages/sr-SP.min.js +1 -1
- package/dist/languages/zh-CN.min.js +1 -1
- package/dist/languages/zh-TW.min.js +1 -1
- package/editorManager.js +26 -24
- package/editorManager.mjs +26 -24
- package/editors/autocompleteEditor/autocompleteEditor.js +7 -11
- package/editors/autocompleteEditor/autocompleteEditor.mjs +7 -11
- package/editors/baseEditor/baseEditor.js +1 -1
- package/editors/baseEditor/baseEditor.mjs +1 -1
- package/editors/dateEditor/dateEditor.js +49 -11
- package/editors/dateEditor/dateEditor.mjs +49 -11
- package/editors/selectEditor/selectEditor.js +20 -19
- package/editors/selectEditor/selectEditor.mjs +20 -19
- package/editors/textEditor/textEditor.js +1 -1
- package/editors/textEditor/textEditor.mjs +1 -1
- package/eventManager.js +2 -2
- package/eventManager.mjs +2 -2
- package/focusManager.js +64 -82
- package/focusManager.mjs +64 -82
- package/helpers/dom/element.js +23 -1
- package/helpers/dom/element.mjs +21 -1
- package/helpers/mixed.js +2 -2
- package/helpers/mixed.mjs +2 -2
- package/helpers/object.js +2 -2
- package/helpers/object.mjs +2 -2
- package/i18n/languages/ar-AR.d.ts +5 -0
- package/i18n/languages/ar-AR.js +1 -1
- package/i18n/languages/cs-CZ.d.ts +5 -0
- package/i18n/languages/cs-CZ.js +1 -1
- package/i18n/languages/de-CH.js +1 -1
- package/i18n/languages/de-DE.js +1 -1
- package/i18n/languages/en-US.js +1 -1
- package/i18n/languages/es-MX.js +1 -1
- package/i18n/languages/fr-FR.js +1 -1
- package/i18n/languages/hr-HR.d.ts +5 -0
- package/i18n/languages/hr-HR.js +1 -1
- package/i18n/languages/it-IT.js +1 -1
- package/i18n/languages/ja-JP.js +1 -1
- package/i18n/languages/ko-KR.js +1 -1
- package/i18n/languages/lv-LV.js +1 -1
- package/i18n/languages/nb-NO.js +1 -1
- package/i18n/languages/nl-NL.js +1 -1
- package/i18n/languages/pl-PL.js +1 -1
- package/i18n/languages/pt-BR.js +1 -1
- package/i18n/languages/ru-RU.js +1 -1
- package/i18n/languages/sr-SP.d.ts +5 -0
- package/i18n/languages/sr-SP.js +1 -1
- package/i18n/languages/zh-CN.js +1 -1
- package/i18n/languages/zh-TW.js +1 -1
- package/i18n/registry.js +1 -1
- package/index.d.ts +10 -0
- package/index.js +1 -1
- package/package.json +14 -10
- package/pluginHooks.d.ts +4 -3
- package/pluginHooks.js +143 -82
- package/pluginHooks.mjs +143 -82
- package/plugins/autoColumnSize/autoColumnSize.js +50 -66
- package/plugins/autoColumnSize/autoColumnSize.mjs +50 -66
- package/plugins/autoRowSize/autoRowSize.js +29 -35
- package/plugins/autoRowSize/autoRowSize.mjs +29 -35
- package/plugins/autofill/autofill.js +31 -39
- package/plugins/autofill/autofill.mjs +31 -39
- package/plugins/base/base.js +13 -18
- package/plugins/base/base.mjs +13 -18
- package/plugins/bindRowsWithHeaders/bindRowsWithHeaders.js +6 -6
- package/plugins/bindRowsWithHeaders/bindRowsWithHeaders.mjs +6 -6
- package/plugins/collapsibleColumns/collapsibleColumns.js +60 -51
- package/plugins/collapsibleColumns/collapsibleColumns.mjs +60 -51
- package/plugins/columnSorting/columnSorting.js +50 -46
- package/plugins/columnSorting/columnSorting.mjs +50 -46
- package/plugins/columnSorting/columnStatesManager.js +1 -1
- package/plugins/columnSorting/columnStatesManager.mjs +1 -1
- package/plugins/columnSummary/columnSummary.js +36 -40
- package/plugins/columnSummary/columnSummary.mjs +36 -40
- package/plugins/columnSummary/endpoints.js +1 -1
- package/plugins/columnSummary/endpoints.mjs +1 -1
- package/plugins/comments/commentEditor.js +1 -1
- package/plugins/comments/commentEditor.mjs +1 -1
- package/plugins/comments/comments.js +117 -159
- package/plugins/comments/comments.mjs +117 -159
- package/plugins/comments/contextMenuItem/addEditComment.js +1 -1
- package/plugins/comments/contextMenuItem/readOnlyComment.js +1 -1
- package/plugins/comments/contextMenuItem/removeComment.js +1 -1
- package/plugins/comments/displaySwitch.js +1 -1
- package/plugins/comments/displaySwitch.mjs +1 -1
- package/plugins/contextMenu/commandExecutor.js +1 -1
- package/plugins/contextMenu/commandExecutor.mjs +1 -1
- package/plugins/contextMenu/contextMenu.js +24 -30
- package/plugins/contextMenu/contextMenu.mjs +24 -30
- package/plugins/contextMenu/itemsFactory.js +2 -2
- package/plugins/contextMenu/itemsFactory.mjs +2 -2
- package/plugins/contextMenu/menu/cursor.js +1 -1
- package/plugins/contextMenu/menu/cursor.mjs +1 -1
- package/plugins/contextMenu/menu/defaultShortcutsList.js +26 -10
- package/plugins/contextMenu/menu/defaultShortcutsList.mjs +26 -10
- package/plugins/contextMenu/menu/menu.js +14 -22
- package/plugins/contextMenu/menu/menu.mjs +14 -22
- package/plugins/contextMenu/menu/positioner.js +41 -58
- package/plugins/contextMenu/menu/positioner.mjs +41 -58
- package/plugins/contextMenu/predefinedItems/alignment.js +1 -1
- package/plugins/contextMenu/predefinedItems/clearColumn.js +1 -1
- package/plugins/contextMenu/predefinedItems/columnLeft.js +1 -1
- package/plugins/contextMenu/predefinedItems/columnRight.js +1 -1
- package/plugins/contextMenu/predefinedItems/index.js +1 -1
- package/plugins/contextMenu/predefinedItems/readOnly.js +1 -1
- package/plugins/contextMenu/predefinedItems/redo.js +1 -1
- package/plugins/contextMenu/predefinedItems/removeColumn.js +1 -1
- package/plugins/contextMenu/predefinedItems/removeRow.js +1 -1
- package/plugins/contextMenu/predefinedItems/rowAbove.js +1 -1
- package/plugins/contextMenu/predefinedItems/rowBelow.js +1 -1
- package/plugins/contextMenu/predefinedItems/undo.js +1 -1
- package/plugins/copyPaste/contextMenuItem/cut.js +1 -1
- package/plugins/copyPaste/copyPaste.js +120 -161
- package/plugins/copyPaste/copyPaste.mjs +120 -161
- package/plugins/copyPaste/copyableRanges.js +43 -66
- package/plugins/copyPaste/copyableRanges.mjs +43 -66
- package/plugins/customBorders/contextMenuItem/bottom.js +1 -1
- package/plugins/customBorders/contextMenuItem/left.js +1 -1
- package/plugins/customBorders/contextMenuItem/noBorders.js +1 -1
- package/plugins/customBorders/contextMenuItem/right.js +1 -1
- package/plugins/customBorders/contextMenuItem/top.js +1 -1
- package/plugins/customBorders/customBorders.js +14 -16
- package/plugins/customBorders/customBorders.mjs +13 -15
- package/plugins/dragToScroll/dragToScroll.js +7 -7
- package/plugins/dragToScroll/dragToScroll.mjs +7 -7
- package/plugins/dropdownMenu/dropdownMenu.js +84 -110
- package/plugins/dropdownMenu/dropdownMenu.mjs +84 -110
- package/plugins/exportFile/dataProvider.js +2 -2
- package/plugins/exportFile/dataProvider.mjs +2 -2
- package/plugins/exportFile/exportFile.js +2 -2
- package/plugins/exportFile/exportFile.mjs +1 -1
- package/plugins/exportFile/types/_base.js +1 -1
- package/plugins/exportFile/types/_base.mjs +1 -1
- package/plugins/filters/component/_base.js +1 -1
- package/plugins/filters/component/_base.mjs +1 -1
- package/plugins/filters/component/actionBar.js +11 -11
- package/plugins/filters/component/actionBar.mjs +9 -9
- package/plugins/filters/component/condition.js +15 -17
- package/plugins/filters/component/condition.mjs +14 -16
- package/plugins/filters/component/operators.js +7 -7
- package/plugins/filters/component/operators.mjs +7 -7
- package/plugins/filters/component/value.js +26 -30
- package/plugins/filters/component/value.mjs +25 -29
- package/plugins/filters/condition/beginsWith.js +1 -1
- package/plugins/filters/condition/between.js +1 -1
- package/plugins/filters/condition/contains.js +1 -1
- package/plugins/filters/condition/date/after.js +1 -1
- package/plugins/filters/condition/date/before.js +1 -1
- package/plugins/filters/condition/date/today.js +1 -1
- package/plugins/filters/condition/date/tomorrow.js +1 -1
- package/plugins/filters/condition/date/yesterday.js +1 -1
- package/plugins/filters/condition/empty.js +1 -1
- package/plugins/filters/condition/endsWith.js +1 -1
- package/plugins/filters/condition/equal.js +1 -1
- package/plugins/filters/condition/greaterThan.js +1 -1
- package/plugins/filters/condition/greaterThanOrEqual.js +1 -1
- package/plugins/filters/condition/lessThan.js +1 -1
- package/plugins/filters/condition/lessThanOrEqual.js +1 -1
- package/plugins/filters/condition/none.js +1 -1
- package/plugins/filters/condition/notBetween.js +1 -1
- package/plugins/filters/condition/notContains.js +1 -1
- package/plugins/filters/condition/notEmpty.js +1 -1
- package/plugins/filters/condition/notEqual.js +1 -1
- package/plugins/filters/conditionCollection.js +1 -1
- package/plugins/filters/conditionCollection.mjs +1 -1
- package/plugins/filters/conditionUpdateObserver.js +23 -25
- package/plugins/filters/conditionUpdateObserver.mjs +23 -25
- package/plugins/filters/dataFilter.js +2 -2
- package/plugins/filters/dataFilter.mjs +2 -2
- package/plugins/filters/filters.js +84 -98
- package/plugins/filters/filters.mjs +83 -97
- package/plugins/filters/logicalOperations/conjunction.js +1 -1
- package/plugins/filters/logicalOperations/disjunction.js +1 -1
- package/plugins/filters/logicalOperations/disjunctionWithExtraCondition.js +1 -1
- package/plugins/filters/ui/_base.js +2 -2
- package/plugins/filters/ui/_base.mjs +1 -1
- package/plugins/filters/ui/input.js +13 -19
- package/plugins/filters/ui/input.mjs +13 -19
- package/plugins/filters/ui/link.js +8 -13
- package/plugins/filters/ui/link.mjs +8 -13
- package/plugins/filters/ui/multipleSelect.js +86 -113
- package/plugins/filters/ui/multipleSelect.mjs +85 -112
- package/plugins/filters/ui/radioInput.js +12 -20
- package/plugins/filters/ui/radioInput.mjs +12 -20
- package/plugins/filters/ui/select.js +51 -73
- package/plugins/filters/ui/select.mjs +49 -71
- package/plugins/formulas/formulas.js +270 -328
- package/plugins/formulas/formulas.mjs +271 -329
- package/plugins/formulas/indexSyncer/axisSyncer.js +38 -61
- package/plugins/formulas/indexSyncer/axisSyncer.mjs +38 -61
- package/plugins/formulas/indexSyncer/index.js +25 -48
- package/plugins/formulas/indexSyncer/index.mjs +25 -48
- package/plugins/hiddenColumns/contextMenuItem/hideColumn.js +1 -1
- package/plugins/hiddenColumns/contextMenuItem/showColumn.js +1 -1
- package/plugins/hiddenColumns/hiddenColumns.js +68 -87
- package/plugins/hiddenColumns/hiddenColumns.mjs +68 -87
- package/plugins/hiddenRows/contextMenuItem/hideRow.js +1 -1
- package/plugins/hiddenRows/contextMenuItem/showRow.js +1 -1
- package/plugins/hiddenRows/hiddenRows.js +67 -86
- package/plugins/hiddenRows/hiddenRows.mjs +67 -86
- package/plugins/manualColumnFreeze/contextMenuItem/freezeColumn.js +1 -1
- package/plugins/manualColumnFreeze/contextMenuItem/unfreezeColumn.js +1 -1
- package/plugins/manualColumnFreeze/manualColumnFreeze.js +24 -32
- package/plugins/manualColumnFreeze/manualColumnFreeze.mjs +25 -33
- package/plugins/manualColumnMove/manualColumnMove.js +133 -177
- package/plugins/manualColumnMove/manualColumnMove.mjs +133 -177
- package/plugins/manualColumnMove/ui/_base.js +1 -1
- package/plugins/manualColumnMove/ui/_base.mjs +1 -1
- package/plugins/manualColumnResize/manualColumnResize.js +169 -230
- package/plugins/manualColumnResize/manualColumnResize.mjs +169 -230
- package/plugins/manualRowMove/manualRowMove.js +106 -135
- package/plugins/manualRowMove/manualRowMove.mjs +106 -135
- package/plugins/manualRowMove/ui/_base.js +1 -1
- package/plugins/manualRowMove/ui/_base.mjs +1 -1
- package/plugins/manualRowResize/manualRowResize.js +150 -209
- package/plugins/manualRowResize/manualRowResize.mjs +150 -209
- package/plugins/mergeCells/calculations/autofill.js +1 -1
- package/plugins/mergeCells/calculations/autofill.mjs +1 -1
- package/plugins/mergeCells/calculations/selection.js +3 -72
- package/plugins/mergeCells/calculations/selection.mjs +3 -72
- package/plugins/mergeCells/cellCoords.js +1 -1
- package/plugins/mergeCells/cellCoords.mjs +1 -1
- package/plugins/mergeCells/cellsCollection.js +118 -2
- package/plugins/mergeCells/cellsCollection.mjs +118 -2
- package/plugins/mergeCells/contextMenuItem/toggleMerge.js +12 -2
- package/plugins/mergeCells/contextMenuItem/toggleMerge.mjs +11 -1
- package/plugins/mergeCells/focusOrder.js +305 -0
- package/plugins/mergeCells/focusOrder.mjs +300 -0
- package/plugins/mergeCells/mergeCells.js +500 -398
- package/plugins/mergeCells/mergeCells.mjs +500 -398
- package/plugins/multiColumnSorting/multiColumnSorting.js +9 -3
- package/plugins/multiColumnSorting/multiColumnSorting.mjs +9 -3
- package/plugins/multipleSelectionHandles/multipleSelectionHandles.js +2 -2
- package/plugins/multipleSelectionHandles/multipleSelectionHandles.mjs +2 -2
- package/plugins/nestedHeaders/nestedHeaders.js +206 -254
- package/plugins/nestedHeaders/nestedHeaders.mjs +207 -255
- package/plugins/nestedHeaders/stateManager/headersTree.js +21 -32
- package/plugins/nestedHeaders/stateManager/headersTree.mjs +21 -32
- package/plugins/nestedHeaders/stateManager/index.js +30 -41
- package/plugins/nestedHeaders/stateManager/index.mjs +30 -41
- package/plugins/nestedHeaders/stateManager/sourceSettings.js +19 -30
- package/plugins/nestedHeaders/stateManager/sourceSettings.mjs +19 -30
- package/plugins/nestedHeaders/utils/ghostTable.js +1 -1
- package/plugins/nestedHeaders/utils/ghostTable.mjs +1 -1
- package/plugins/nestedRows/data/dataManager.js +2 -2
- package/plugins/nestedRows/data/dataManager.mjs +2 -2
- package/plugins/nestedRows/nestedRows.js +154 -185
- package/plugins/nestedRows/nestedRows.mjs +155 -186
- package/plugins/nestedRows/ui/_base.js +1 -1
- package/plugins/nestedRows/ui/_base.mjs +1 -1
- package/plugins/nestedRows/ui/contextMenu.js +13 -17
- package/plugins/nestedRows/ui/contextMenu.mjs +11 -15
- package/plugins/nestedRows/utils/rowMoveController.js +6 -6
- package/plugins/nestedRows/utils/rowMoveController.mjs +6 -6
- package/plugins/persistentState/persistentState.js +1 -1
- package/plugins/persistentState/persistentState.mjs +1 -1
- package/plugins/persistentState/storage.js +3 -3
- package/plugins/persistentState/storage.mjs +3 -3
- package/plugins/search/search.js +8 -8
- package/plugins/search/search.mjs +8 -8
- package/plugins/touchScroll/touchScroll.js +16 -20
- package/plugins/touchScroll/touchScroll.mjs +17 -21
- package/plugins/trimRows/trimRows.js +7 -7
- package/plugins/trimRows/trimRows.mjs +7 -7
- package/plugins/undoRedo/index.js +1 -1
- package/renderers/checkboxRenderer/checkboxRenderer.js +8 -5
- package/renderers/checkboxRenderer/checkboxRenderer.mjs +8 -5
- package/selection/highlight/highlight.js +16 -18
- package/selection/highlight/highlight.mjs +15 -17
- package/selection/highlight/visualSelection.js +3 -1
- package/selection/highlight/visualSelection.mjs +3 -1
- package/selection/range.js +3 -5
- package/selection/range.mjs +2 -4
- package/selection/selection.js +227 -69
- package/selection/selection.mjs +225 -67
- package/selection/transformation.js +149 -118
- package/selection/transformation.mjs +149 -118
- package/shortcutContexts/commands/editor/closeAndSave.js +2 -2
- package/shortcutContexts/commands/editor/closeAndSave.mjs +2 -2
- package/shortcutContexts/commands/editor/open.js +18 -3
- package/shortcutContexts/commands/editor/open.mjs +18 -3
- package/shortcutContexts/commands/extendCellsSelection/down.js +1 -1
- package/shortcutContexts/commands/extendCellsSelection/down.mjs +1 -1
- package/shortcutContexts/commands/extendCellsSelection/left.js +1 -1
- package/shortcutContexts/commands/extendCellsSelection/left.mjs +1 -1
- package/shortcutContexts/commands/extendCellsSelection/right.js +1 -1
- package/shortcutContexts/commands/extendCellsSelection/right.mjs +1 -1
- package/shortcutContexts/commands/extendCellsSelection/toColumns.js +1 -1
- package/shortcutContexts/commands/extendCellsSelection/toColumns.mjs +1 -1
- package/shortcutContexts/commands/extendCellsSelection/toMostBottom.js +3 -1
- package/shortcutContexts/commands/extendCellsSelection/toMostBottom.mjs +3 -1
- package/shortcutContexts/commands/extendCellsSelection/toMostInlineEnd.js +9 -3
- package/shortcutContexts/commands/extendCellsSelection/toMostInlineEnd.mjs +9 -3
- package/shortcutContexts/commands/extendCellsSelection/toMostInlineStart.js +10 -3
- package/shortcutContexts/commands/extendCellsSelection/toMostInlineStart.mjs +10 -3
- package/shortcutContexts/commands/extendCellsSelection/toMostLeft.js +3 -1
- package/shortcutContexts/commands/extendCellsSelection/toMostLeft.mjs +3 -1
- package/shortcutContexts/commands/extendCellsSelection/toMostRight.js +3 -1
- package/shortcutContexts/commands/extendCellsSelection/toMostRight.mjs +3 -1
- package/shortcutContexts/commands/extendCellsSelection/toMostTop.js +3 -1
- package/shortcutContexts/commands/extendCellsSelection/toMostTop.mjs +3 -1
- package/shortcutContexts/commands/extendCellsSelection/toRows.js +1 -1
- package/shortcutContexts/commands/extendCellsSelection/toRows.mjs +1 -1
- package/shortcutContexts/commands/extendCellsSelection/up.js +1 -1
- package/shortcutContexts/commands/extendCellsSelection/up.mjs +1 -1
- package/shortcutContexts/commands/moveCellSelection/inlineEnd.js +6 -1
- package/shortcutContexts/commands/moveCellSelection/inlineEnd.mjs +6 -1
- package/shortcutContexts/commands/moveCellSelection/inlineStart.js +6 -1
- package/shortcutContexts/commands/moveCellSelection/inlineStart.mjs +6 -1
- package/shortcutContexts/grid.js +9 -3
- package/shortcutContexts/grid.mjs +9 -3
- package/shortcuts/context.js +3 -2
- package/shortcuts/context.mjs +3 -2
- package/shortcuts/manager.js +2 -2
- package/shortcuts/manager.mjs +2 -2
- package/tableView.js +53 -79
- package/tableView.mjs +53 -79
- package/translations/changesObservable/observable.js +21 -38
- package/translations/changesObservable/observable.mjs +21 -38
- package/translations/changesObservable/observer.js +7 -12
- package/translations/changesObservable/observer.mjs +6 -11
- package/translations/indexMapper.js +1 -1
- package/translations/indexMapper.mjs +1 -1
- package/translations/mapCollections/aggregatedCollection.js +2 -2
- package/translations/mapCollections/aggregatedCollection.mjs +2 -2
- package/translations/mapCollections/mapCollection.js +1 -1
- package/translations/mapCollections/mapCollection.mjs +1 -1
- package/translations/maps/indexMap.js +2 -2
- package/translations/maps/indexMap.mjs +2 -2
- package/translations/maps/linkedPhysicalIndexToValueMap.js +1 -1
- package/translations/maps/linkedPhysicalIndexToValueMap.mjs +1 -1
- package/utils/dataStructures/linkedList.js +7 -2
- package/utils/dataStructures/linkedList.mjs +7 -2
- package/utils/dataStructures/tree.js +2 -2
- package/utils/dataStructures/tree.mjs +2 -2
- package/utils/ghostTable.js +1 -1
- package/utils/ghostTable.mjs +1 -1
- package/utils/interval.js +27 -45
- package/utils/interval.mjs +27 -45
- package/utils/samplesGenerator.js +1 -1
- package/utils/samplesGenerator.mjs +1 -1
@@ -9,7 +9,7 @@ var _object = require("../../helpers/object");
|
|
9
9
|
* @class Options
|
10
10
|
* @description
|
11
11
|
*
|
12
|
-
* [Configuration options](@/guides/getting-started/configuration-options.md) let you heavily customize your Handsontable instance. For example, you can:
|
12
|
+
* [Configuration options](@/guides/getting-started/configuration-options/configuration-options.md) let you heavily customize your Handsontable instance. For example, you can:
|
13
13
|
*
|
14
14
|
* - Enable and disable built-in features
|
15
15
|
* - Enable and configure additional [plugins](@/api/plugins.md)
|
@@ -19,11 +19,11 @@ var _object = require("../../helpers/object");
|
|
19
19
|
*
|
20
20
|
* ::: only-for javascript
|
21
21
|
*
|
22
|
-
* To apply [configuration options](@/guides/getting-started/configuration-options.md), pass them as
|
23
|
-
* a second argument of the [Handsontable constructor](@/guides/getting-started/installation.md#initialize-handsontable),
|
22
|
+
* To apply [configuration options](@/guides/getting-started/configuration-options/configuration-options.md), pass them as
|
23
|
+
* a second argument of the [Handsontable constructor](@/guides/getting-started/installation/installation.md#initialize-handsontable),
|
24
24
|
* using the [object literal notation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Object_initializer):
|
25
25
|
*
|
26
|
-
* Read more on the [Configuration options](@/guides/getting-started/configuration-options.md) page.
|
26
|
+
* Read more on the [Configuration options](@/guides/getting-started/configuration-options/configuration-options.md) page.
|
27
27
|
*
|
28
28
|
* ```js
|
29
29
|
* const container = document.getElementById('example');
|
@@ -54,10 +54,10 @@ var _object = require("../../helpers/object");
|
|
54
54
|
* ::: only-for react
|
55
55
|
*
|
56
56
|
* To apply configuration options, pass them as individual props
|
57
|
-
* of the [`HotTable`](@/guides/getting-started/installation.md#_4-use-the-hottable-component)
|
58
|
-
* or [`HotColumn`](@/guides/columns/react-hot-column.md) components.
|
57
|
+
* of the [`HotTable`](@/guides/getting-started/installation/installation.md#_4-use-the-hottable-component)
|
58
|
+
* or [`HotColumn`](@/guides/columns/react-hot-column/react-hot-column.md) components.
|
59
59
|
*
|
60
|
-
* Read more on the [Configuration options](@/guides/getting-started/configuration-options.md) page.
|
60
|
+
* Read more on the [Configuration options](@/guides/getting-started/configuration-options/configuration-options.md) page.
|
61
61
|
*
|
62
62
|
* ```jsx
|
63
63
|
* <HotTable
|
@@ -84,14 +84,14 @@ var _object = require("../../helpers/object");
|
|
84
84
|
* :::
|
85
85
|
*
|
86
86
|
* Depending on your needs, you can apply [configuration options](@/api/options.md) to different elements of your grid:
|
87
|
-
* - [The entire grid](@/guides/getting-started/configuration-options.md#set-grid-options)
|
88
|
-
* - [Individual columns](@/guides/getting-started/configuration-options.md#set-column-options)
|
89
|
-
* - [Individual rows](@/guides/getting-started/configuration-options.md#set-row-options)
|
90
|
-
* - [Individual cells](@/guides/getting-started/configuration-options.md#set-cell-options)
|
91
|
-
* - [Individual grid elements, based on any logic you implement](@/guides/getting-started/configuration-options.md#implementing-custom-logic)
|
87
|
+
* - [The entire grid](@/guides/getting-started/configuration-options/configuration-options.md#set-grid-options)
|
88
|
+
* - [Individual columns](@/guides/getting-started/configuration-options/configuration-options.md#set-column-options)
|
89
|
+
* - [Individual rows](@/guides/getting-started/configuration-options/configuration-options.md#set-row-options)
|
90
|
+
* - [Individual cells](@/guides/getting-started/configuration-options/configuration-options.md#set-cell-options)
|
91
|
+
* - [Individual grid elements, based on any logic you implement](@/guides/getting-started/configuration-options/configuration-options.md#implementing-custom-logic)
|
92
92
|
*
|
93
93
|
* Read more:
|
94
|
-
* - [Configuration options](@/guides/getting-started/configuration-options.md)
|
94
|
+
* - [Configuration options](@/guides/getting-started/configuration-options/configuration-options.md)
|
95
95
|
*/
|
96
96
|
var _default = () => {
|
97
97
|
return {
|
@@ -176,8 +176,8 @@ var _default = () => {
|
|
176
176
|
*/
|
177
177
|
allowEmpty: true,
|
178
178
|
/**
|
179
|
-
* The `allowHtml` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md)
|
180
|
-
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type.md) cells' [`source`](#source) data
|
179
|
+
* The `allowHtml` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
180
|
+
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md) cells' [`source`](#source) data
|
181
181
|
* is treated as HTML.
|
182
182
|
*
|
183
183
|
* You can set the `allowHtml` option to one of the following:
|
@@ -190,8 +190,8 @@ var _default = () => {
|
|
190
190
|
* __Warning:__ Setting the `allowHtml` option to `true` can cause serious XSS vulnerabilities.
|
191
191
|
*
|
192
192
|
* Read more:
|
193
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
194
|
-
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type.md)
|
193
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
194
|
+
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md)
|
195
195
|
* - [`source`](#source)
|
196
196
|
*
|
197
197
|
* @memberof Options#
|
@@ -215,7 +215,7 @@ var _default = () => {
|
|
215
215
|
*/
|
216
216
|
allowHtml: false,
|
217
217
|
/**
|
218
|
-
* If set to `true`, the `allowInsertColumn` option adds the following menu items to the [context menu](@/guides/accessories-and-menus/context-menu.md):
|
218
|
+
* 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):
|
219
219
|
* - **Insert column left**
|
220
220
|
* - **Insert column right**
|
221
221
|
*
|
@@ -232,7 +232,7 @@ var _default = () => {
|
|
232
232
|
*/
|
233
233
|
allowInsertColumn: true,
|
234
234
|
/**
|
235
|
-
* If set to `true`, the `allowInsertRow` option adds the following menu items to the [context menu](@/guides/accessories-and-menus/context-menu.md):
|
235
|
+
* 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):
|
236
236
|
* - **Insert row above**
|
237
237
|
* - **Insert row below**
|
238
238
|
*
|
@@ -250,21 +250,21 @@ var _default = () => {
|
|
250
250
|
allowInsertRow: true,
|
251
251
|
/**
|
252
252
|
* The `allowInvalid` option determines whether Handsontable accepts values
|
253
|
-
* that were marked as `invalid` by the [cell validator](@/guides/cell-functions/cell-validator.md).
|
253
|
+
* that were marked as `invalid` by the [cell validator](@/guides/cell-functions/cell-validator/cell-validator.md).
|
254
254
|
*
|
255
255
|
* You can set the `allowInvalid` option to one of the following:
|
256
256
|
*
|
257
257
|
* | Setting | Description |
|
258
258
|
* | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
259
|
-
* | `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 |
|
260
|
-
* | `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 |
|
259
|
+
* | `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 |
|
260
|
+
* | `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 |
|
261
261
|
*
|
262
|
-
* 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).
|
262
|
+
* 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).
|
263
263
|
*
|
264
264
|
* Read more:
|
265
|
-
* - [Cell validator](@/guides/cell-functions/cell-validator.md)
|
266
|
-
* - [Cell editor](@/guides/cell-functions/cell-editor.md)
|
267
|
-
* - [Autocomplete strict mode](@/guides/cell-types/autocomplete-cell-type.md#autocomplete-strict-mode)
|
265
|
+
* - [Cell validator](@/guides/cell-functions/cell-validator/cell-validator.md)
|
266
|
+
* - [Cell editor](@/guides/cell-functions/cell-editor/cell-editor.md)
|
267
|
+
* - [Autocomplete strict mode](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md#autocomplete-strict-mode)
|
268
268
|
*
|
269
269
|
* @memberof Options#
|
270
270
|
* @type {boolean}
|
@@ -281,11 +281,11 @@ var _default = () => {
|
|
281
281
|
*/
|
282
282
|
allowInvalid: true,
|
283
283
|
/**
|
284
|
-
* If set to `true`, the `allowRemoveColumn` option adds the following menu items to the [context menu](@/guides/accessories-and-menus/context-menu.md):
|
284
|
+
* 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):
|
285
285
|
* - **Remove column**
|
286
286
|
*
|
287
287
|
* Read more:
|
288
|
-
* - [Context menu](@/guides/accessories-and-menus/context-menu.md)
|
288
|
+
* - [Context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)
|
289
289
|
*
|
290
290
|
* @memberof Options#
|
291
291
|
* @type {boolean}
|
@@ -300,11 +300,11 @@ var _default = () => {
|
|
300
300
|
*/
|
301
301
|
allowRemoveColumn: true,
|
302
302
|
/**
|
303
|
-
* If set to `true`, the `allowRemoveRow` option adds the following menu items to the [context menu](@/guides/accessories-and-menus/context-menu.md):
|
303
|
+
* 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):
|
304
304
|
* - **Remove row**
|
305
305
|
*
|
306
306
|
* Read more:
|
307
|
-
* - [Context menu](@/guides/accessories-and-menus/context-menu.md)
|
307
|
+
* - [Context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)
|
308
308
|
*
|
309
309
|
* @memberof Options#
|
310
310
|
* @type {boolean}
|
@@ -495,13 +495,13 @@ var _default = () => {
|
|
495
495
|
*/
|
496
496
|
bindRowsWithHeaders: undefined,
|
497
497
|
/**
|
498
|
-
* The `cell` option lets you apply [configuration options](@/guides/getting-started/configuration-options.md) to individual cells.
|
498
|
+
* The `cell` option lets you apply [configuration options](@/guides/getting-started/configuration-options/configuration-options.md) to individual cells.
|
499
499
|
*
|
500
|
-
* The `cell` option overwrites the [top-level grid options](@/guides/getting-started/configuration-options.md#set-grid-options),
|
500
|
+
* The `cell` option overwrites the [top-level grid options](@/guides/getting-started/configuration-options/configuration-options.md#set-grid-options),
|
501
501
|
* and the [`columns`](#columns) options.
|
502
502
|
*
|
503
503
|
* Read more:
|
504
|
-
* - [Configuration options: Setting cell options](@/guides/getting-started/configuration-options.md#set-cell-options)
|
504
|
+
* - [Configuration options: Setting cell options](@/guides/getting-started/configuration-options/configuration-options.md#set-cell-options)
|
505
505
|
* - [`columns`](#columns)
|
506
506
|
*
|
507
507
|
* @memberof Options#
|
@@ -525,7 +525,7 @@ var _default = () => {
|
|
525
525
|
cell: [],
|
526
526
|
/**
|
527
527
|
* @description
|
528
|
-
* The `cells` option lets you apply any other [configuration options](@/guides/getting-started/configuration-options.md) to
|
528
|
+
* The `cells` option lets you apply any other [configuration options](@/guides/getting-started/configuration-options/configuration-options.md) to
|
529
529
|
* individual grid elements (columns, rows, cells), based on any logic you implement.
|
530
530
|
*
|
531
531
|
* The `cells` option overwrites all other options (including options set by [`columns`](#columns) and [`cell`](#cell)).
|
@@ -535,11 +535,11 @@ var _default = () => {
|
|
535
535
|
* | --------- | -------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
536
536
|
* | `row` | Yes | Number | A physical row index |
|
537
537
|
* | `column` | Yes | Number | A physical column index |
|
538
|
-
* | `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. |
|
538
|
+
* | `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. |
|
539
539
|
*
|
540
540
|
* Read more:
|
541
|
-
* - [Configuration options: Implementing custom logic](@/guides/getting-started/configuration-options.md#implement-custom-logic)
|
542
|
-
* - [Configuration options: Setting row options](@/guides/getting-started/configuration-options.md#set-row-options)
|
541
|
+
* - [Configuration options: Implementing custom logic](@/guides/getting-started/configuration-options/configuration-options.md#implement-custom-logic)
|
542
|
+
* - [Configuration options: Setting row options](@/guides/getting-started/configuration-options/configuration-options.md#set-row-options)
|
543
543
|
* - [`columns`](#columns)
|
544
544
|
* - [`cell`](#cell)
|
545
545
|
*
|
@@ -567,17 +567,17 @@ var _default = () => {
|
|
567
567
|
cells: undefined,
|
568
568
|
/**
|
569
569
|
* The `checkedTemplate` option lets you configure what value
|
570
|
-
* a checked [`checkbox`](@/guides/cell-types/checkbox-cell-type.md) cell has.
|
570
|
+
* a checked [`checkbox`](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md) cell has.
|
571
571
|
*
|
572
572
|
* You can set the `checkedTemplate` option to one of the following:
|
573
573
|
*
|
574
574
|
* | Setting | Description |
|
575
575
|
* | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
576
|
-
* | `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` |
|
577
|
-
* | 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 |
|
576
|
+
* | `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` |
|
577
|
+
* | 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 |
|
578
578
|
*
|
579
579
|
* Read more:
|
580
|
-
* - [Checkbox cell type: Checkbox template](@/guides/cell-types/checkbox-cell-type.md#checkbox-template)
|
580
|
+
* - [Checkbox cell type: Checkbox template](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md#checkbox-template)
|
581
581
|
* - [`getDataAtCell()`](@/api/core.md#getDataAtCell)
|
582
582
|
* - [`uncheckedTemplate`](#uncheckedTemplate)
|
583
583
|
*
|
@@ -618,14 +618,14 @@ var _default = () => {
|
|
618
618
|
* | An array of strings | Add multiple CSS class names to every currently-selected element |
|
619
619
|
*
|
620
620
|
* ::: tip
|
621
|
-
* Don't change the `className` metadata of the [column summary](@/guides/columns/column-summary.md) row.
|
621
|
+
* Don't change the `className` metadata of the [column summary](@/guides/columns/column-summary/column-summary.md) row.
|
622
622
|
* To style the summary row, use the class name assigned automatically by the [`ColumnSummary`](@/api/columnSummary.md) plugin: `columnSummaryResult`.
|
623
623
|
* :::
|
624
624
|
*
|
625
|
-
* To apply different CSS class names on different levels, use Handsontable's [cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration).
|
625
|
+
* To apply different CSS class names on different levels, use Handsontable's [cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration).
|
626
626
|
*
|
627
627
|
* Read more:
|
628
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
628
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
629
629
|
* - [`currentRowClassName`](#currentRowClassName)
|
630
630
|
* - [`currentColClassName`](#currentColClassName)
|
631
631
|
* - [`currentHeaderClassName`](#currentHeaderClassName)
|
@@ -667,7 +667,7 @@ var _default = () => {
|
|
667
667
|
* | A function | Define your own column headers, using a function |
|
668
668
|
*
|
669
669
|
* Read more:
|
670
|
-
* - [Column header](@/guides/columns/column-header.md)
|
670
|
+
* - [Column header](@/guides/columns/column-header/column-header.md)
|
671
671
|
*
|
672
672
|
* @memberof Options#
|
673
673
|
* @type {boolean|string[]|Function}
|
@@ -750,18 +750,18 @@ var _default = () => {
|
|
750
750
|
columnHeaderHeight: undefined,
|
751
751
|
/**
|
752
752
|
* @description
|
753
|
-
* The `columns` option lets you apply any other [configuration options](@/guides/getting-started/configuration-options.md) to individual columns (or ranges of columns).
|
753
|
+
* 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).
|
754
754
|
*
|
755
755
|
* You can set the `columns` option to one of the following:
|
756
756
|
* - An array of objects (each object represents one column)
|
757
757
|
* - A function that returns an array of objects
|
758
758
|
*
|
759
|
-
* The `columns` option overwrites the [top-level grid options](@/guides/getting-started/configuration-options.md#set-grid-options).
|
759
|
+
* The `columns` option overwrites the [top-level grid options](@/guides/getting-started/configuration-options/configuration-options.md#set-grid-options).
|
760
760
|
*
|
761
761
|
* When you use `columns`, the [`startCols`](#startCols), [`minCols`](#minCols), and [`maxCols`](#maxCols) options are ignored.
|
762
762
|
*
|
763
763
|
* Read more:
|
764
|
-
* - [Configuration options: Setting column options](@/guides/getting-started/configuration-options.md#set-column-options)
|
764
|
+
* - [Configuration options: Setting column options](@/guides/getting-started/configuration-options/configuration-options.md#set-column-options)
|
765
765
|
* - [`startCols`](#startCols)
|
766
766
|
* - [`minCols`](#minCols)
|
767
767
|
* - [`maxCols`](#maxCols)
|
@@ -821,7 +821,7 @@ var _default = () => {
|
|
821
821
|
* | `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 |
|
822
822
|
* | `headerAction` | `true`: Enable clicking on the column header to sort the column<br>`false`: Disable clicking on the column header to sort the column |
|
823
823
|
* | `sortEmptyCells` | `true`: Sort empty cells as well<br>`false`: Place empty cells at the end |
|
824
|
-
* | `compareFunctionFactory` | A [custom compare function](@/guides/rows/rows-sorting.md#add-a-custom-comparator) |
|
824
|
+
* | `compareFunctionFactory` | A [custom compare function](@/guides/rows/rows-sorting/rows-sorting.md#add-a-custom-comparator) |
|
825
825
|
*
|
826
826
|
* If you set the `columnSorting` option to an object,
|
827
827
|
* you can also sort individual columns at Handsontable's initialization.
|
@@ -834,8 +834,8 @@ var _default = () => {
|
|
834
834
|
* | `sortOrder` | `'asc'` \| `'desc'` | The sorting order:<br>`'asc'`: ascending<br>`'desc'`: descending |
|
835
835
|
*
|
836
836
|
* Read more:
|
837
|
-
* - [Rows sorting](@/guides/rows/rows-sorting.md)
|
838
|
-
* - [Rows sorting: Custom compare functions](@/guides/rows/rows-sorting.md#add-a-custom-comparator)
|
837
|
+
* - [Rows sorting](@/guides/rows/rows-sorting/rows-sorting.md)
|
838
|
+
* - [Rows sorting: Custom compare functions](@/guides/rows/rows-sorting/rows-sorting.md#add-a-custom-comparator)
|
839
839
|
* - [`multiColumnSorting`](#multiColumnSorting)
|
840
840
|
*
|
841
841
|
* @memberof Options#
|
@@ -889,20 +889,20 @@ var _default = () => {
|
|
889
889
|
*
|
890
890
|
* | Property | Possible values | Description |
|
891
891
|
* | ------------------------ | ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
892
|
-
* | `sourceColumn` | A number | [Column to summarize](@/guides/columns/column-summary.md#step-2-select-cells-that-you-want-to-summarize) |
|
893
|
-
* | `ranges` | An array | [Ranges of rows to summarize](@/guides/columns/column-summary.md#step-2-select-cells-that-you-want-to-summarize) |
|
894
|
-
* | `type` | `'sum'` \| `'min'` \| `'max'` \| `'count'` \| `'average'` \| `'custom'` | [Summary function](@/guides/columns/column-summary.md#step-3-calculate-your-summary) |
|
895
|
-
* | `destinationRow` | A number | [Destination cell's row coordinate](@/guides/columns/column-summary.md#step-4-provide-the-destination-cell-s-coordinates) |
|
896
|
-
* | `destinationColumn` | A number | [Destination cell's column coordinate](@/guides/columns/column-summary.md#step-4-provide-the-destination-cell-s-coordinates) |
|
897
|
-
* | `forceNumeric` | `true` \| `false` | [Treat non-numerics as numerics](@/guides/columns/column-summary.md#force-numeric-values) |
|
898
|
-
* | `reversedRowCoords` | `true` \| `false` | [Reverse row coordinates](@/guides/columns/column-summary.md#step-5-make-room-for-the-destination-cell) |
|
899
|
-
* | `suppressDataTypeErrors` | `true` \| `false` | [Suppress data type errors](@/guides/columns/column-summary.md#throw-data-type-errors) |
|
892
|
+
* | `sourceColumn` | A number | [Column to summarize](@/guides/columns/column-summary/column-summary.md#step-2-select-cells-that-you-want-to-summarize) |
|
893
|
+
* | `ranges` | An array | [Ranges of rows to summarize](@/guides/columns/column-summary/column-summary.md#step-2-select-cells-that-you-want-to-summarize) |
|
894
|
+
* | `type` | `'sum'` \| `'min'` \| `'max'` \| `'count'` \| `'average'` \| `'custom'` | [Summary function](@/guides/columns/column-summary/column-summary.md#step-3-calculate-your-summary) |
|
895
|
+
* | `destinationRow` | A number | [Destination cell's row coordinate](@/guides/columns/column-summary/column-summary.md#step-4-provide-the-destination-cell-s-coordinates) |
|
896
|
+
* | `destinationColumn` | A number | [Destination cell's column coordinate](@/guides/columns/column-summary/column-summary.md#step-4-provide-the-destination-cell-s-coordinates) |
|
897
|
+
* | `forceNumeric` | `true` \| `false` | [Treat non-numerics as numerics](@/guides/columns/column-summary/column-summary.md#force-numeric-values) |
|
898
|
+
* | `reversedRowCoords` | `true` \| `false` | [Reverse row coordinates](@/guides/columns/column-summary/column-summary.md#step-5-make-room-for-the-destination-cell) |
|
899
|
+
* | `suppressDataTypeErrors` | `true` \| `false` | [Suppress data type errors](@/guides/columns/column-summary/column-summary.md#throw-data-type-errors) |
|
900
900
|
* | `readOnly` | `true` \| `false` | Make summary cell read-only |
|
901
|
-
* | `roundFloat` | `true` \| `false` \| A number | [Round summary result](@/guides/columns/column-summary.md#round-a-column-summary-result) |
|
902
|
-
* | `customFunction` | A function | [Custom summary function](@/guides/columns/column-summary.md#implement-a-custom-summary-function) |
|
901
|
+
* | `roundFloat` | `true` \| `false` \| A number | [Round summary result](@/guides/columns/column-summary/column-summary.md#round-a-column-summary-result) |
|
902
|
+
* | `customFunction` | A function | [Custom summary function](@/guides/columns/column-summary/column-summary.md#implement-a-custom-summary-function) |
|
903
903
|
*
|
904
904
|
* Read more:
|
905
|
-
* - [Column summary](@/guides/columns/column-summary.md)
|
905
|
+
* - [Column summary](@/guides/columns/column-summary/column-summary.md)
|
906
906
|
* - [Plugins: `ColumnSummary`](@/api/columnSummary.md)
|
907
907
|
*
|
908
908
|
* @memberof Options#
|
@@ -953,7 +953,7 @@ var _default = () => {
|
|
953
953
|
* which may cut longer columns names.
|
954
954
|
*
|
955
955
|
* Read more:
|
956
|
-
* - [Column width](@/guides/columns/column-width.md)
|
956
|
+
* - [Column width](@/guides/columns/column-width/column-width.md)
|
957
957
|
* - [Hooks: `modifyColWidth`](@/api/hooks.md#modifyColWidth)
|
958
958
|
* - [`autoColumnSize`](#autoColumnSize)
|
959
959
|
*
|
@@ -988,7 +988,7 @@ var _default = () => {
|
|
988
988
|
* that have comments.
|
989
989
|
*
|
990
990
|
* Read more:
|
991
|
-
* - [Comments](@/guides/cell-features/comments.md)
|
991
|
+
* - [Comments](@/guides/cell-features/comments/comments.md)
|
992
992
|
* - [`comments`](#comments)
|
993
993
|
* - [`readOnlyCellClassName`](#readOnlyCellClassName)
|
994
994
|
* - [`currentRowClassName`](#currentRowClassName)
|
@@ -1022,9 +1022,9 @@ var _default = () => {
|
|
1022
1022
|
*
|
1023
1023
|
* | Setting | Description |
|
1024
1024
|
* | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
1025
|
-
* | `true` | - Enable the [`Comments`](@/api/comments.md) plugin<br>- Add comment menu items to the [context menu](@/guides/accessories-and-menus/context-menu.md) |
|
1025
|
+
* | `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) |
|
1026
1026
|
* | `false` | Disable the [`Comments`](@/api/comments.md) plugin |
|
1027
|
-
* | 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 |
|
1027
|
+
* | 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 |
|
1028
1028
|
*
|
1029
1029
|
* If you set the `comments` option to an object, you can configure the following comment options:
|
1030
1030
|
*
|
@@ -1035,8 +1035,8 @@ var _default = () => {
|
|
1035
1035
|
* | `style` | An object | Set comment boxes' `width` and `height` (in pixels) |
|
1036
1036
|
*
|
1037
1037
|
* Read more:
|
1038
|
-
* - [Comments](@/guides/cell-features/comments.md)
|
1039
|
-
* - [Context menu](@/guides/accessories-and-menus/context-menu.md)
|
1038
|
+
* - [Comments](@/guides/cell-features/comments/comments.md)
|
1039
|
+
* - [Context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)
|
1040
1040
|
* - [`width`](#width)
|
1041
1041
|
* - [`height`](#height)
|
1042
1042
|
* - [`readOnly`](#readOnly)
|
@@ -1077,15 +1077,15 @@ var _default = () => {
|
|
1077
1077
|
* | Setting | Description |
|
1078
1078
|
* | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
1079
1079
|
* | `false` | Disable the [`ContextMenu`](@/api/contextMenu.md) plugin |
|
1080
|
-
* | `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) |
|
1081
|
-
* | 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) |
|
1082
|
-
* | 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) |
|
1080
|
+
* | `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) |
|
1081
|
+
* | 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) |
|
1082
|
+
* | 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) |
|
1083
1083
|
*
|
1084
1084
|
* Read more:
|
1085
|
-
* - [Context menu](@/guides/accessories-and-menus/context-menu.md)
|
1086
|
-
* - [Context menu: Context menu with default options](@/guides/accessories-and-menus/context-menu.md#context-menu-with-default-options)
|
1087
|
-
* - [Context menu: Context menu with specific options](@/guides/accessories-and-menus/context-menu.md#context-menu-with-specific-options)
|
1088
|
-
* - [Context menu: Context menu with fully custom configuration options](@/guides/accessories-and-menus/context-menu.md#context-menu-with-a-fully-custom-configuration)
|
1085
|
+
* - [Context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)
|
1086
|
+
* - [Context menu: Context menu with default options](@/guides/accessories-and-menus/context-menu/context-menu.md#context-menu-with-default-options)
|
1087
|
+
* - [Context menu: Context menu with specific options](@/guides/accessories-and-menus/context-menu/context-menu.md#context-menu-with-specific-options)
|
1088
|
+
* - [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)
|
1089
1089
|
* - [Plugins: `ContextMenu`](@/api/contextMenu.md)
|
1090
1090
|
*
|
1091
1091
|
* @memberof Options#
|
@@ -1139,12 +1139,12 @@ var _default = () => {
|
|
1139
1139
|
* | Setting | Description |
|
1140
1140
|
* | -------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
1141
1141
|
* | `true` (default) | - On pressing <kbd>**Ctrl**</kbd>/<kbd>**Cmd**</kbd>+<kbd>**C**</kbd>, add the cell's value to the clipboard |
|
1142
|
-
* | `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 |
|
1142
|
+
* | `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 |
|
1143
1143
|
*
|
1144
1144
|
* Read more:
|
1145
|
-
* - [Clipboard](@/guides/cell-features/clipboard.md)
|
1146
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
1147
|
-
* - [Password cell type](@/guides/cell-types/password-cell-type.md)
|
1145
|
+
* - [Clipboard](@/guides/cell-features/clipboard/clipboard.md)
|
1146
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
1147
|
+
* - [Password cell type](@/guides/cell-types/password-cell-type/password-cell-type.md)
|
1148
1148
|
*
|
1149
1149
|
* @memberof Options#
|
1150
1150
|
* @type {boolean}
|
@@ -1171,7 +1171,7 @@ var _default = () => {
|
|
1171
1171
|
* // enable copying for specific cells
|
1172
1172
|
* cell: [
|
1173
1173
|
* {
|
1174
|
-
*
|
1174
|
+
* col: 0,
|
1175
1175
|
* row: 0,
|
1176
1176
|
* // disable copying for cell (0, 0)
|
1177
1177
|
* copyable: false,
|
@@ -1207,7 +1207,7 @@ var _default = () => {
|
|
1207
1207
|
*
|
1208
1208
|
* Read more:
|
1209
1209
|
* - [Plugins: `CopyPaste`](@/api/copyPaste.md)
|
1210
|
-
* - [Guides: Clipboard](@/guides/cell-features/clipboard.md)
|
1210
|
+
* - [Guides: Clipboard](@/guides/cell-features/clipboard/clipboard.md)
|
1211
1211
|
*
|
1212
1212
|
* @memberof Options#
|
1213
1213
|
* @type {object|boolean}
|
@@ -1252,18 +1252,18 @@ var _default = () => {
|
|
1252
1252
|
* The `correctFormat` option configures whether incorrectly-formatted times and dates are amended or not.
|
1253
1253
|
*
|
1254
1254
|
* When the user enters dates and times, Handsontable can automatically adjust their format
|
1255
|
-
* to match the [`dateFormat`](#dateFormat) and [`timeFormat`](@/guides/cell-types/time-cell-type.md) settings.
|
1255
|
+
* to match the [`dateFormat`](#dateFormat) and [`timeFormat`](@/guides/cell-types/time-cell-type/time-cell-type.md) settings.
|
1256
1256
|
*
|
1257
1257
|
* You can set the `correctFormat` option to one of the following:
|
1258
1258
|
*
|
1259
1259
|
* | Setting | Description |
|
1260
1260
|
* | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
1261
1261
|
* | `false` (default) | Don't correct the format of the entered date or time (treat the entered date or time as invalid) |
|
1262
|
-
* | `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 |
|
1262
|
+
* | `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 |
|
1263
1263
|
*
|
1264
1264
|
* Read more:
|
1265
|
-
* - [Date cell type](@/guides/cell-types/date-cell-type.md)
|
1266
|
-
* - [Time cell type](@/guides/cell-types/time-cell-type.md)
|
1265
|
+
* - [Date cell type](@/guides/cell-types/date-cell-type/date-cell-type.md)
|
1266
|
+
* - [Time cell type](@/guides/cell-types/time-cell-type/time-cell-type.md)
|
1267
1267
|
* - [`dateFormat`](#dateFormat)
|
1268
1268
|
*
|
1269
1269
|
* @memberof Options#
|
@@ -1386,7 +1386,7 @@ var _default = () => {
|
|
1386
1386
|
* The `customBorders` option configures the [`CustomBorders`](@/api/customBorders.md) plugin.
|
1387
1387
|
*
|
1388
1388
|
* To enable the [`CustomBorders`](@/api/customBorders.md) plugin
|
1389
|
-
* (and add its menu items to the [context menu](@/guides/accessories-and-menus/context-menu.md)),
|
1389
|
+
* (and add its menu items to the [context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)),
|
1390
1390
|
* set the `customBorders` option to `true`.
|
1391
1391
|
*
|
1392
1392
|
* To enable the [`CustomBorders`](@/api/customBorders.md) plugin
|
@@ -1398,8 +1398,8 @@ var _default = () => {
|
|
1398
1398
|
* | -------- | ------------------ | ---------------------------------- | ----------------------------------------------------------------- |
|
1399
1399
|
* | `row` | - | `row`: Number | The cell's row coordinate. |
|
1400
1400
|
* | `col` | - | `col`: Number | The cell's column coordinate. |
|
1401
|
-
* | `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. |
|
1402
|
-
* | `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. |
|
1401
|
+
* | `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. |
|
1402
|
+
* | `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. |
|
1403
1403
|
* | `top` | `width`<br>`color` | `width`: Number<br>`color`: String | Sets the width (`width`) and color (`color`) of the top border. |
|
1404
1404
|
* | `bottom` | `width`<br>`color` | `width`: Number<br>`color`: String | Sets the width (`width`) and color (`color`) of the bottom border. |
|
1405
1405
|
*
|
@@ -1410,17 +1410,17 @@ var _default = () => {
|
|
1410
1410
|
*
|
1411
1411
|
* | Property | Sub-properties | Types | Description |
|
1412
1412
|
* | -------- | -------------------------------------------- | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
1413
|
-
* | `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. |
|
1414
|
-
* | `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. |
|
1415
|
-
* | `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. |
|
1413
|
+
* | `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. |
|
1414
|
+
* | `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. |
|
1415
|
+
* | `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. |
|
1416
1416
|
* | `top` | `width`<br>`color` | `width`: Number<br>`color`: String | Sets the width (`width`) and color (`color`) of the top border. |
|
1417
1417
|
* | `bottom` | `width`<br>`color` | `width`: Number<br>`color`: String | Sets the width (`width`) and color (`color`) of the bottom border. |
|
1418
1418
|
*
|
1419
1419
|
* Read more:
|
1420
|
-
* - [Formatting cells: Custom cell borders](@/guides/cell-features/formatting-cells.md#custom-cell-borders)
|
1421
|
-
* - [Context menu](@/guides/accessories-and-menus/context-menu.md)
|
1420
|
+
* - [Formatting cells: Custom cell borders](@/guides/cell-features/formatting-cells/formatting-cells.md#custom-cell-borders)
|
1421
|
+
* - [Context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)
|
1422
1422
|
* - [Plugins: `CustomBorders`](@/api/customBorders.md)
|
1423
|
-
* - [Layout direction](@/guides/internationalization/layout-direction.md)
|
1423
|
+
* - [Layout direction](@/guides/internationalization/layout-direction/layout-direction.md)
|
1424
1424
|
* - [`layoutDirection`](#layoutDirection)
|
1425
1425
|
*
|
1426
1426
|
* @memberof Options#
|
@@ -1495,18 +1495,18 @@ var _default = () => {
|
|
1495
1495
|
customBorders: false,
|
1496
1496
|
/**
|
1497
1497
|
* @description
|
1498
|
-
* The `data` option sets the initial [data](@/guides/getting-started/binding-to-data.md) of your Handsontable instance.
|
1498
|
+
* The `data` option sets the initial [data](@/guides/getting-started/binding-to-data/binding-to-data.md) of your Handsontable instance.
|
1499
1499
|
*
|
1500
1500
|
* 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).
|
1501
1501
|
*
|
1502
1502
|
* You can set the `data` option:
|
1503
|
-
* - Either to an [array of arrays](@/guides/getting-started/binding-to-data.md#array-of-arrays).
|
1504
|
-
* - Or to an [array of objects](@/guides/getting-started/binding-to-data.md#array-of-objects).
|
1503
|
+
* - Either to an [array of arrays](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-arrays).
|
1504
|
+
* - Or to an [array of objects](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-objects).
|
1505
1505
|
*
|
1506
1506
|
* If you don't set the `data` option (or set it to `null`), Handsontable renders as an empty 5x5 grid by default.
|
1507
1507
|
*
|
1508
1508
|
* Read more:
|
1509
|
-
* - [Binding to data](@/guides/getting-started/binding-to-data.md)
|
1509
|
+
* - [Binding to data](@/guides/getting-started/binding-to-data/binding-to-data.md)
|
1510
1510
|
* - [`dataSchema`](#dataSchema)
|
1511
1511
|
* - [`startRows`](#startRows)
|
1512
1512
|
* - [`startCols`](#startCols)
|
@@ -1538,7 +1538,7 @@ var _default = () => {
|
|
1538
1538
|
data: undefined,
|
1539
1539
|
/**
|
1540
1540
|
* @description
|
1541
|
-
* When the [`data`](#data) option is set to an [array of objects](@/guides/getting-started/binding-to-data.md#array-of-objects)
|
1541
|
+
* 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)
|
1542
1542
|
* (or is empty), the `dataSchema` option defines the structure of new rows.
|
1543
1543
|
*
|
1544
1544
|
* Using the `dataSchema` option, you can start out with an empty grid.
|
@@ -1548,8 +1548,8 @@ var _default = () => {
|
|
1548
1548
|
* - A function
|
1549
1549
|
*
|
1550
1550
|
* Read more:
|
1551
|
-
* - [Binding to data: Array of objects with custom data schema](@/guides/getting-started/binding-to-data.md#array-of-objects-with-custom-data-schema)
|
1552
|
-
* - [Binding to data: Function data source and schema](@/guides/getting-started/binding-to-data.md#function-data-source-and-schema)
|
1551
|
+
* - [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)
|
1552
|
+
* - [Binding to data: Function data source and schema](@/guides/getting-started/binding-to-data/binding-to-data.md#function-data-source-and-schema)
|
1553
1553
|
* - [`data`](#data)
|
1554
1554
|
*
|
1555
1555
|
* @memberof Options#
|
@@ -1575,14 +1575,14 @@ var _default = () => {
|
|
1575
1575
|
*/
|
1576
1576
|
dataSchema: undefined,
|
1577
1577
|
/**
|
1578
|
-
* The `dateFormat` option configures the date format accepted by [`date`](@/guides/cell-types/date-cell-type.md) cells.
|
1578
|
+
* The `dateFormat` option configures the date format accepted by [`date`](@/guides/cell-types/date-cell-type/date-cell-type.md) cells.
|
1579
1579
|
*
|
1580
1580
|
* You can set the `dateFormat` option to a string with a proper date format. The default value is: `'DD/MM/YYYY'`.
|
1581
1581
|
*
|
1582
1582
|
* To automatically correct dates whose format doesn't match the `dateFormat` setting, use the [`correctFormat`](#correctFormat) option.
|
1583
1583
|
*
|
1584
1584
|
* Read more:
|
1585
|
-
* - [Date cell type](@/guides/cell-types/date-cell-type.md)
|
1585
|
+
* - [Date cell type](@/guides/cell-types/date-cell-type/date-cell-type.md)
|
1586
1586
|
* - [`correctFormat`](#correctFormat)
|
1587
1587
|
* - [`defaultDate`](#defaultDate)
|
1588
1588
|
*
|
@@ -1605,16 +1605,16 @@ var _default = () => {
|
|
1605
1605
|
*/
|
1606
1606
|
dateFormat: 'DD/MM/YYYY',
|
1607
1607
|
/**
|
1608
|
-
* 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).
|
1608
|
+
* 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).
|
1609
1609
|
*
|
1610
1610
|
* 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),
|
1611
|
-
* except for the following, which are always overwritten by the `date` [cell editor](@/guides/cell-functions/cell-editor.md):
|
1611
|
+
* except for the following, which are always overwritten by the `date` [cell editor](@/guides/cell-functions/cell-editor/cell-editor.md):
|
1612
1612
|
* - `bound`
|
1613
1613
|
* - `container`
|
1614
1614
|
* - `field`
|
1615
1615
|
* - `trigger`
|
1616
1616
|
*
|
1617
|
-
* 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:
|
1617
|
+
* 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:
|
1618
1618
|
*
|
1619
1619
|
* | Pikaday option | Handsontable's setting |
|
1620
1620
|
* | -------------------- | ---------------------- |
|
@@ -1624,7 +1624,7 @@ var _default = () => {
|
|
1624
1624
|
* Read more:
|
1625
1625
|
* - [`editor`](#editor)
|
1626
1626
|
* - [`dateFormat`](#dateFormat)
|
1627
|
-
* - [Cell editor](@/guides/cell-functions/cell-editor.md)
|
1627
|
+
* - [Cell editor](@/guides/cell-functions/cell-editor/cell-editor.md)
|
1628
1628
|
* - [All Pikaday options →](https://github.com/Pikaday/Pikaday/tree/1.8.2#configuration)
|
1629
1629
|
*
|
1630
1630
|
* @memberof Options#
|
@@ -1635,12 +1635,12 @@ var _default = () => {
|
|
1635
1635
|
datePickerConfig: undefined,
|
1636
1636
|
/**
|
1637
1637
|
* The `defaultDate` option configures the date displayed
|
1638
|
-
* in empty [`date`](@/guides/cell-types/date-cell-type.md) cells.
|
1638
|
+
* in empty [`date`](@/guides/cell-types/date-cell-type/date-cell-type.md) cells.
|
1639
1639
|
*
|
1640
1640
|
* You can set the `defaultDate` option to a string.
|
1641
1641
|
*
|
1642
1642
|
* Read more:
|
1643
|
-
* - [Date cell type](@/guides/cell-types/date-cell-type.md)
|
1643
|
+
* - [Date cell type](@/guides/cell-types/date-cell-type/date-cell-type.md)
|
1644
1644
|
* - [`dateFormat`](#dateFormat)
|
1645
1645
|
*
|
1646
1646
|
* @memberof Options#
|
@@ -1664,7 +1664,7 @@ var _default = () => {
|
|
1664
1664
|
/**
|
1665
1665
|
* @description
|
1666
1666
|
* The `disableVisualSelection` option configures how
|
1667
|
-
* [selection](@/guides/cell-features/selection.md) is shown.
|
1667
|
+
* [selection](@/guides/cell-features/selection/selection.md) is shown.
|
1668
1668
|
*
|
1669
1669
|
* You can set the `disableVisualSelection` option to one of the following:
|
1670
1670
|
*
|
@@ -1678,7 +1678,7 @@ var _default = () => {
|
|
1678
1678
|
* | An array | A combination of `'current'`, `'area'`, and/or `'header'` |
|
1679
1679
|
*
|
1680
1680
|
* Read more:
|
1681
|
-
* - [Selection](@/guides/cell-features/selection.md)
|
1681
|
+
* - [Selection](@/guides/cell-features/selection/selection.md)
|
1682
1682
|
*
|
1683
1683
|
* @memberof Options#
|
1684
1684
|
* @type {boolean|string|string[]}
|
@@ -1738,12 +1738,12 @@ var _default = () => {
|
|
1738
1738
|
* | Setting | Description |
|
1739
1739
|
* | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
1740
1740
|
* | `false` | Disable the [`DropdownMenu`](@/api/dropdownMenu.md) plugin |
|
1741
|
-
* | `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) |
|
1742
|
-
* | 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) |
|
1741
|
+
* | `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) |
|
1742
|
+
* | 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) |
|
1743
1743
|
* | An object | - Enable the [`DropdownMenu`](@/api/dropdownMenu.md) plugin<br>- Apply a custom dropdown menu configuration |
|
1744
1744
|
*
|
1745
1745
|
* Read more:
|
1746
|
-
* - [Context menu](@/guides/accessories-and-menus/context-menu.md)
|
1746
|
+
* - [Context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)
|
1747
1747
|
* - [Plugins: `DropdownMenu`](@/api/dropdownMenu.md)
|
1748
1748
|
*
|
1749
1749
|
* @memberof Options#
|
@@ -1759,7 +1759,7 @@ var _default = () => {
|
|
1759
1759
|
*
|
1760
1760
|
* // enable the `DropdownMenu` plugin
|
1761
1761
|
* // and modify individual context menu options
|
1762
|
-
* dropdownMenu: ['
|
1762
|
+
* dropdownMenu: ['---------', 'undo', 'redo'],
|
1763
1763
|
*
|
1764
1764
|
* // enable the `DropdownMenu` plugin
|
1765
1765
|
* // and apply a custom dropdown menu configuration
|
@@ -1789,13 +1789,13 @@ var _default = () => {
|
|
1789
1789
|
*/
|
1790
1790
|
dropdownMenu: undefined,
|
1791
1791
|
/**
|
1792
|
-
* The `editor` option sets a [cell editor](@/guides/cell-functions/cell-editor.md) for a cell.
|
1792
|
+
* The `editor` option sets a [cell editor](@/guides/cell-functions/cell-editor/cell-editor.md) for a cell.
|
1793
1793
|
*
|
1794
|
-
* You can set the `editor` option to one of the following [cell editor aliases](@/guides/cell-functions/cell-editor.md):
|
1794
|
+
* You can set the `editor` option to one of the following [cell editor aliases](@/guides/cell-functions/cell-editor/cell-editor.md):
|
1795
1795
|
*
|
1796
1796
|
* | Alias | Cell editor function |
|
1797
1797
|
* | ------------------- | -------------------------------------------------------------------------- |
|
1798
|
-
* | A custom alias | Your [custom cell editor](@/guides/cell-functions/cell-editor.md) function |
|
1798
|
+
* | A custom alias | Your [custom cell editor](@/guides/cell-functions/cell-editor/cell-editor.md) function |
|
1799
1799
|
* | `'autocomplete'` | `AutocompleteEditor` |
|
1800
1800
|
* | `'base'` | `BaseEditor` |
|
1801
1801
|
* | `'checkbox'` | `CheckboxEditor` |
|
@@ -1817,9 +1817,9 @@ var _default = () => {
|
|
1817
1817
|
* options all at once, use the [`type`](#type) option.
|
1818
1818
|
*
|
1819
1819
|
* Read more:
|
1820
|
-
* - [Cell editor](@/guides/cell-functions/cell-editor.md)
|
1821
|
-
* - [Cell type](@/guides/cell-types/cell-type.md)
|
1822
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
1820
|
+
* - [Cell editor](@/guides/cell-functions/cell-editor/cell-editor.md)
|
1821
|
+
* - [Cell type](@/guides/cell-types/cell-type/cell-type.md)
|
1822
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
1823
1823
|
* - [`type`](#type)
|
1824
1824
|
*
|
1825
1825
|
* @memberof Options#
|
@@ -1939,7 +1939,7 @@ var _default = () => {
|
|
1939
1939
|
* | `direction` | `'vertical'` \| `'horizontal'` | `'vertical'`: Enable vertical autofill<br>`'horizontal'`: Enable horizontal autofill |
|
1940
1940
|
*
|
1941
1941
|
* Read more:
|
1942
|
-
* - [AutoFill values](@/guides/cell-features/autofill-values.md)
|
1942
|
+
* - [AutoFill values](@/guides/cell-features/autofill-values/autofill-values.md)
|
1943
1943
|
*
|
1944
1944
|
* @memberof Options#
|
1945
1945
|
* @type {boolean|string|object}
|
@@ -1978,7 +1978,7 @@ var _default = () => {
|
|
1978
1978
|
autoInsertRow: false
|
1979
1979
|
},
|
1980
1980
|
/**
|
1981
|
-
* The `filter` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md) cells'
|
1981
|
+
* The `filter` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) cells'
|
1982
1982
|
* lists are updated by the end user's input.
|
1983
1983
|
*
|
1984
1984
|
* You can set the `filter` option to one of the following:
|
@@ -1989,7 +1989,7 @@ var _default = () => {
|
|
1989
1989
|
* | `false` | When the end user types into the input area, all options are displayed<br>(options matching the input are put in bold |
|
1990
1990
|
*
|
1991
1991
|
* Read more:
|
1992
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
1992
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
1993
1993
|
* - [`source`](#source)
|
1994
1994
|
* - [`filteringCaseSensitive`](#filteringCaseSensitive)
|
1995
1995
|
*
|
@@ -2014,18 +2014,18 @@ var _default = () => {
|
|
2014
2014
|
*/
|
2015
2015
|
filter: true,
|
2016
2016
|
/**
|
2017
|
-
* The `filteringCaseSensitive` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md) cells'
|
2017
|
+
* The `filteringCaseSensitive` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) cells'
|
2018
2018
|
* input is case-sensitive.
|
2019
2019
|
*
|
2020
2020
|
* You can set the `filteringCaseSensitive` option to one of the following:
|
2021
2021
|
*
|
2022
2022
|
* | Setting | Description |
|
2023
2023
|
* | ----------------- | -------------------------------------------------------------------------------------------------- |
|
2024
|
-
* | `false` (default) | [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md) cells' input is not case-sensitive |
|
2025
|
-
* | `true` | [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md) cells' input is case-sensitive |
|
2024
|
+
* | `false` (default) | [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) cells' input is not case-sensitive |
|
2025
|
+
* | `true` | [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) cells' input is case-sensitive |
|
2026
2026
|
*
|
2027
2027
|
* Read more:
|
2028
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
2028
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
2029
2029
|
* - [`source`](#source)
|
2030
2030
|
* - [`filter`](#filter)
|
2031
2031
|
*
|
@@ -2058,7 +2058,7 @@ var _default = () => {
|
|
2058
2058
|
* | `true` | Enable the [`Filters`](@/api/filters.md) plugin |
|
2059
2059
|
*
|
2060
2060
|
* Read more:
|
2061
|
-
* - [Column filter](@/guides/columns/column-filter.md)
|
2061
|
+
* - [Column filter](@/guides/columns/column-filter/column-filter.md)
|
2062
2062
|
* - [Plugins: `Filters`](@/api/filters.md)
|
2063
2063
|
* - [`dropdownMenu`](#dropdownMenu)
|
2064
2064
|
*
|
@@ -2077,9 +2077,9 @@ var _default = () => {
|
|
2077
2077
|
/**
|
2078
2078
|
* `fixedColumnsLeft` is a legacy option.
|
2079
2079
|
*
|
2080
|
-
* If your grid's [layout direction](@/guides/internationalization/layout-direction.md) is LTR (default), `fixedColumnsLeft` acts like the [`fixedColumnsStart`](#fixedColumnsStart) option.
|
2080
|
+
* If your grid's [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) is LTR (default), `fixedColumnsLeft` acts like the [`fixedColumnsStart`](#fixedColumnsStart) option.
|
2081
2081
|
*
|
2082
|
-
* If your grid's [layout direction](@/guides/internationalization/layout-direction.md) is RTL, using `fixedColumnsLeft` throws an error.
|
2082
|
+
* If your grid's [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) is RTL, using `fixedColumnsLeft` throws an error.
|
2083
2083
|
*
|
2084
2084
|
* Use [`fixedColumnsStart`](#fixedColumnsStart), which works in any layout direction.
|
2085
2085
|
*
|
@@ -2099,13 +2099,13 @@ var _default = () => {
|
|
2099
2099
|
*/
|
2100
2100
|
fixedColumnsLeft: 0,
|
2101
2101
|
/**
|
2102
|
-
* 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.
|
2102
|
+
* 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.
|
2103
2103
|
*
|
2104
|
-
* 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.
|
2104
|
+
* 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.
|
2105
2105
|
*
|
2106
2106
|
* Read more:
|
2107
|
-
* - [Column freezing](@/guides/columns/column-freezing.md)
|
2108
|
-
* - [Layout direction](@/guides/internationalization/layout-direction.md)
|
2107
|
+
* - [Column freezing](@/guides/columns/column-freezing/column-freezing.md)
|
2108
|
+
* - [Layout direction](@/guides/internationalization/layout-direction/layout-direction.md)
|
2109
2109
|
* - [`fixedColumnsLeft`](#fixedcolumnsleft)
|
2110
2110
|
* - [`layoutDirection`](#layoutDirection)
|
2111
2111
|
*
|
@@ -2137,11 +2137,11 @@ var _default = () => {
|
|
2137
2137
|
*/
|
2138
2138
|
fixedColumnsStart: 0,
|
2139
2139
|
/**
|
2140
|
-
* The `fixedRowsBottom` option sets the number of [frozen rows](@/guides/rows/row-freezing.md)
|
2140
|
+
* The `fixedRowsBottom` option sets the number of [frozen rows](@/guides/rows/row-freezing/row-freezing.md)
|
2141
2141
|
* at the bottom of the grid.
|
2142
2142
|
*
|
2143
2143
|
* Read more:
|
2144
|
-
* - [Row freezing](@/guides/rows/row-freezing.md)
|
2144
|
+
* - [Row freezing](@/guides/rows/row-freezing/row-freezing.md)
|
2145
2145
|
*
|
2146
2146
|
* @memberof Options#
|
2147
2147
|
* @type {number}
|
@@ -2156,10 +2156,10 @@ var _default = () => {
|
|
2156
2156
|
*/
|
2157
2157
|
fixedRowsBottom: 0,
|
2158
2158
|
/**
|
2159
|
-
* The `fixedRowsTop` option sets the number of [frozen rows](@/guides/rows/row-freezing.md) at the top of the grid.
|
2159
|
+
* The `fixedRowsTop` option sets the number of [frozen rows](@/guides/rows/row-freezing/row-freezing.md) at the top of the grid.
|
2160
2160
|
*
|
2161
2161
|
* Read more:
|
2162
|
-
* - [Row freezing](@/guides/rows/row-freezing.md)
|
2162
|
+
* - [Row freezing](@/guides/rows/row-freezing/row-freezing.md)
|
2163
2163
|
*
|
2164
2164
|
* @memberof Options#
|
2165
2165
|
* @type {number}
|
@@ -2178,7 +2178,7 @@ var _default = () => {
|
|
2178
2178
|
*
|
2179
2179
|
* The [`Formulas`](@/api/formulas.md) plugin uses the [HyperFormula](https://handsontable.github.io/hyperformula/) calculation engine.
|
2180
2180
|
* To install [HyperFormula](https://handsontable.github.io/hyperformula/), read the following:
|
2181
|
-
* - [Formula calculation: Initialization methods](@/guides/formulas/formula-calculation.md#initialization-methods)
|
2181
|
+
* - [Formula calculation: Initialization methods](@/guides/formulas/formula-calculation/formula-calculation.md#initialization-methods)
|
2182
2182
|
*
|
2183
2183
|
* You can set the `formulas` option to an object with the following properties:
|
2184
2184
|
*
|
@@ -2190,7 +2190,7 @@ var _default = () => {
|
|
2190
2190
|
*
|
2191
2191
|
* Read more:
|
2192
2192
|
* - [Plugins: `Formulas`](@/api/formulas.md)
|
2193
|
-
* - [Formula calculation](@/guides/formulas/formula-calculation.md)
|
2193
|
+
* - [Formula calculation](@/guides/formulas/formula-calculation/formula-calculation.md)
|
2194
2194
|
* - [HyperFormula documentation: Client-side installation](https://handsontable.github.io/hyperformula/guide/client-side-installation)
|
2195
2195
|
* - [HyperFormula documentation: Configuration options](https://handsontable.github.io/hyperformula/api/interfaces/configparams.html)
|
2196
2196
|
*
|
@@ -2290,7 +2290,7 @@ var _default = () => {
|
|
2290
2290
|
* | A function that returns a valid number or string | `height() { return 500; }` |
|
2291
2291
|
*
|
2292
2292
|
* Read more:
|
2293
|
-
* - [Grid size](@/guides/getting-started/grid-size.md)
|
2293
|
+
* - [Grid size](@/guides/getting-started/grid-size/grid-size.md)
|
2294
2294
|
*
|
2295
2295
|
* @memberof Options#
|
2296
2296
|
* @type {number|string|Function}
|
@@ -2333,7 +2333,7 @@ var _default = () => {
|
|
2333
2333
|
*
|
2334
2334
|
* Read more:
|
2335
2335
|
* - [Plugins: `HiddenColumns`](@/api/hiddenColumns.md)
|
2336
|
-
* - [Column hiding](@/guides/columns/column-hiding.md)
|
2336
|
+
* - [Column hiding](@/guides/columns/column-hiding/column-hiding.md)
|
2337
2337
|
*
|
2338
2338
|
* @memberof Options#
|
2339
2339
|
* @type {boolean|object}
|
@@ -2378,7 +2378,7 @@ var _default = () => {
|
|
2378
2378
|
*
|
2379
2379
|
* Read more:
|
2380
2380
|
* - [Plugins: `HiddenRows`](@/api/hiddenRows.md)
|
2381
|
-
* - [Row hiding](@/guides/rows/row-hiding.md)
|
2381
|
+
* - [Row hiding](@/guides/rows/row-hiding/row-hiding.md)
|
2382
2382
|
*
|
2383
2383
|
* @memberof Options#
|
2384
2384
|
* @type {boolean|object}
|
@@ -2404,10 +2404,10 @@ var _default = () => {
|
|
2404
2404
|
hiddenRows: undefined,
|
2405
2405
|
/**
|
2406
2406
|
* The `invalidCellClassName` option lets you add a CSS class name to cells
|
2407
|
-
* that were marked as `invalid` by the [cell validator](@/guides/cell-functions/cell-validator.md).
|
2407
|
+
* that were marked as `invalid` by the [cell validator](@/guides/cell-functions/cell-validator/cell-validator.md).
|
2408
2408
|
*
|
2409
2409
|
* Read more:
|
2410
|
-
* - [Cell validator](@/guides/cell-functions/cell-validator.md)
|
2410
|
+
* - [Cell validator](@/guides/cell-functions/cell-validator/cell-validator.md)
|
2411
2411
|
* - [`currentRowClassName`](#currentRowClassName)
|
2412
2412
|
* - [`currentHeaderClassName`](#currentHeaderClassName)
|
2413
2413
|
* - [`activeHeaderClassName`](#activeHeaderClassName)
|
@@ -2516,7 +2516,7 @@ var _default = () => {
|
|
2516
2516
|
},
|
2517
2517
|
/**
|
2518
2518
|
* @description
|
2519
|
-
* The `label` option configures [`checkbox`](@/guides/cell-types/checkbox-cell-type.md) cells` labels.
|
2519
|
+
* The `label` option configures [`checkbox`](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md) cells` labels.
|
2520
2520
|
*
|
2521
2521
|
* You can set the `label` option to an object with the following properties:
|
2522
2522
|
*
|
@@ -2525,10 +2525,10 @@ var _default = () => {
|
|
2525
2525
|
* | `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 |
|
2526
2526
|
* | `value` | A string \| A function | The label's text |
|
2527
2527
|
* | `separated` | `false` (default) \| `true` | `false`: don't separate the label from the checkbox<br>`true`: separate the label from the checkbox |
|
2528
|
-
* | `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) |
|
2528
|
+
* | `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) |
|
2529
2529
|
*
|
2530
2530
|
* Read more:
|
2531
|
-
* - [Checkbox cell type: Checkbox labels](@/guides/cell-types/checkbox-cell-type.md#checkbox-labels)
|
2531
|
+
* - [Checkbox cell type: Checkbox labels](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md#checkbox-labels)
|
2532
2532
|
*
|
2533
2533
|
* @memberof Options#
|
2534
2534
|
* @type {object}
|
@@ -2546,14 +2546,14 @@ var _default = () => {
|
|
2546
2546
|
*/
|
2547
2547
|
label: undefined,
|
2548
2548
|
/**
|
2549
|
-
* The `language` option configures Handsontable's [language](@/guides/internationalization/language.md) settings.
|
2549
|
+
* The `language` option configures Handsontable's [language](@/guides/internationalization/language/language.md) settings.
|
2550
2550
|
*
|
2551
2551
|
* You can set the `language` option to one of the following:
|
2552
2552
|
*
|
2553
2553
|
* | Setting | Description |
|
2554
2554
|
* | ------------------- | --------------------------- |
|
2555
2555
|
* | `'en-US'` (default) | English - United States |
|
2556
|
-
* | `'ar-AR'` | Arabic - Global<br><br>To properly render this language, set the [layout direction](@/guides/internationalization/layout-direction.md) to RTL. |
|
2556
|
+
* | `'ar-AR'` | Arabic - Global<br><br>To properly render this language, set the [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) to RTL. |
|
2557
2557
|
* | `'cs-CZ'` | Czech - Czech Republic |
|
2558
2558
|
* | `'de-CH'` | German - Switzerland |
|
2559
2559
|
* | `'de-DE'` | German - Germany |
|
@@ -2574,7 +2574,7 @@ var _default = () => {
|
|
2574
2574
|
* | `'zh-TW'` | Chinese - Taiwan |
|
2575
2575
|
*
|
2576
2576
|
* Read more:
|
2577
|
-
* - [Language](@/guides/internationalization/language.md)
|
2577
|
+
* - [Language](@/guides/internationalization/language/language.md)
|
2578
2578
|
* - [`locale`](#locale)
|
2579
2579
|
* - [`layoutDirection`](#layoutdirection)
|
2580
2580
|
*
|
@@ -2593,9 +2593,9 @@ var _default = () => {
|
|
2593
2593
|
/**
|
2594
2594
|
* The `layoutDirection` option configures whether Handsontable renders from the left to the right, or from the right to the left.
|
2595
2595
|
*
|
2596
|
-
* 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.
|
2596
|
+
* 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.
|
2597
2597
|
*
|
2598
|
-
* You can set the `layoutDirection` option only [for the entire grid](@/guides/getting-started/configuration-options.md#set-grid-options).
|
2598
|
+
* You can set the `layoutDirection` option only [for the entire grid](@/guides/getting-started/configuration-options/configuration-options.md#set-grid-options).
|
2599
2599
|
* You can't set it for individual columns, rows, or cells.
|
2600
2600
|
*
|
2601
2601
|
* You can set the `layoutDirection` option to one of the following strings:
|
@@ -2607,8 +2607,8 @@ var _default = () => {
|
|
2607
2607
|
* | `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` |
|
2608
2608
|
*
|
2609
2609
|
* Read more:
|
2610
|
-
* - [Layout direction](@/guides/internationalization/layout-direction.md)
|
2611
|
-
* - [Language](@/guides/internationalization/language.md)
|
2610
|
+
* - [Layout direction](@/guides/internationalization/layout-direction/layout-direction.md)
|
2611
|
+
* - [Language](@/guides/internationalization/language/language.md)
|
2612
2612
|
* - [`language`](#language)
|
2613
2613
|
* - [`locale`](#locale)
|
2614
2614
|
* - [`fixedColumnsStart`](#fixedcolumnsstart)
|
@@ -2642,11 +2642,11 @@ var _default = () => {
|
|
2642
2642
|
*
|
2643
2643
|
* | Setting | Description |
|
2644
2644
|
* | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
2645
|
-
* | 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) |
|
2646
|
-
* | `'non-commercial-and-evaluation'` | For [non-commercial use](@/guides/technical-specification/software-license.md#non-commercial-use) |
|
2645
|
+
* | 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) |
|
2646
|
+
* | `'non-commercial-and-evaluation'` | For [non-commercial use](@/guides/technical-specification/software-license/software-license.md#non-commercial-use) |
|
2647
2647
|
*
|
2648
2648
|
* Read more:
|
2649
|
-
* - [License key](@/guides/getting-started/license-key.md)
|
2649
|
+
* - [License key](@/guides/getting-started/license-key/license-key.md)
|
2650
2650
|
*
|
2651
2651
|
* @memberof Options#
|
2652
2652
|
* @type {string}
|
@@ -2664,14 +2664,14 @@ var _default = () => {
|
|
2664
2664
|
*/
|
2665
2665
|
licenseKey: undefined,
|
2666
2666
|
/**
|
2667
|
-
* The `locale` option configures Handsontable's [locale](@/guides/internationalization/locale.md) settings.
|
2667
|
+
* The `locale` option configures Handsontable's [locale](@/guides/internationalization/locale/locale.md) settings.
|
2668
2668
|
*
|
2669
2669
|
* You can set the `locale` option to any valid and canonicalized Unicode BCP 47 locale tag,
|
2670
|
-
* both for the [entire grid](@/guides/internationalization/locale.md#set-the-grid-s-locale),
|
2671
|
-
* and for [individual columns](@/guides/internationalization/locale.md#set-a-column-s-locale).
|
2670
|
+
* both for the [entire grid](@/guides/internationalization/locale/locale.md#set-the-grid-s-locale),
|
2671
|
+
* and for [individual columns](@/guides/internationalization/locale/locale.md#set-a-column-s-locale).
|
2672
2672
|
*
|
2673
2673
|
* Read more:
|
2674
|
-
* - [Locale](@/guides/internationalization/locale.md)
|
2674
|
+
* - [Locale](@/guides/internationalization/locale/locale.md)
|
2675
2675
|
* - [`language`](#language)
|
2676
2676
|
* - [`layoutDirection`](#layoutdirection)
|
2677
2677
|
*
|
@@ -2710,7 +2710,7 @@ var _default = () => {
|
|
2710
2710
|
* | `false` | Disable the [`ManualColumnFreeze`](@/api/manualColumnFreeze.md) plugin |
|
2711
2711
|
*
|
2712
2712
|
* Read more:
|
2713
|
-
* - [Column freezing](@/guides/columns/column-freezing.md#user-triggered-freeze)
|
2713
|
+
* - [Column freezing](@/guides/columns/column-freezing/column-freezing.md#user-triggered-freeze)
|
2714
2714
|
*
|
2715
2715
|
* @memberof Options#
|
2716
2716
|
* @type {boolean}
|
@@ -2736,7 +2736,7 @@ var _default = () => {
|
|
2736
2736
|
* | An array | - Enable the [`ManualColumnMove`](@/api/manualColumnMove.md) plugin<br>- Move individual columns at initialization |
|
2737
2737
|
*
|
2738
2738
|
* Read more:
|
2739
|
-
* - [Column moving](@/guides/columns/column-moving.md)
|
2739
|
+
* - [Column moving](@/guides/columns/column-moving/column-moving.md)
|
2740
2740
|
*
|
2741
2741
|
* @memberof Options#
|
2742
2742
|
* @type {boolean|number[]}
|
@@ -2769,7 +2769,7 @@ var _default = () => {
|
|
2769
2769
|
* | An array | - Enable the [`ManualColumnResize`](@/api/manualColumnResize.md) plugin<br>- Set initial widths of individual columns |
|
2770
2770
|
*
|
2771
2771
|
* Read more:
|
2772
|
-
* - [Column width: Column stretching](@/guides/columns/column-width.md#column-stretching)
|
2772
|
+
* - [Column width: Column stretching](@/guides/columns/column-width/column-width.md#column-stretching)
|
2773
2773
|
*
|
2774
2774
|
* @memberof Options#
|
2775
2775
|
* @type {boolean|number[]}
|
@@ -2802,7 +2802,7 @@ var _default = () => {
|
|
2802
2802
|
* | An array | - Enable the [`ManualRowMove`](@/api/manualRowMove.md) plugin<br>- Move individual rows at initialization |
|
2803
2803
|
*
|
2804
2804
|
* Read more:
|
2805
|
-
* - [Row moving](@/guides/rows/row-moving.md)
|
2805
|
+
* - [Row moving](@/guides/rows/row-moving/row-moving.md)
|
2806
2806
|
*
|
2807
2807
|
* @memberof Options#
|
2808
2808
|
* @type {boolean|number[]}
|
@@ -2835,7 +2835,7 @@ var _default = () => {
|
|
2835
2835
|
* | An array | - Enable the [`ManualRowResize`](@/api/manualRowResize.md) plugin<br>- Set initial heights of individual rows |
|
2836
2836
|
*
|
2837
2837
|
* Read more:
|
2838
|
-
* - [Row height: Adjust the row height manually](@/guides/rows/row-height.md#adjust-the-row-height-manually)
|
2838
|
+
* - [Row height: Adjust the row height manually](@/guides/rows/row-height/row-height.md#adjust-the-row-height-manually)
|
2839
2839
|
*
|
2840
2840
|
* @memberof Options#
|
2841
2841
|
* @type {boolean|number[]}
|
@@ -2918,7 +2918,7 @@ var _default = () => {
|
|
2918
2918
|
* | `colspan` | The height (as a number of columns ) of the merged section |
|
2919
2919
|
*
|
2920
2920
|
* Read more:
|
2921
|
-
* - [Merge cells](@/guides/cell-features/merge-cells.md)
|
2921
|
+
* - [Merge cells](@/guides/cell-features/merge-cells/merge-cells.md)
|
2922
2922
|
*
|
2923
2923
|
* @memberof Options#
|
2924
2924
|
* @type {boolean|object[]}
|
@@ -2951,8 +2951,8 @@ var _default = () => {
|
|
2951
2951
|
* Handsontable adds empty columns to the right.
|
2952
2952
|
* - At runtime: for example, when removing columns.
|
2953
2953
|
*
|
2954
|
-
* The `minCols` option works only when your [`data`](#data) is an [array of arrays](@/guides/getting-started/binding-to-data.md#array-of-arrays).
|
2955
|
-
* When your [`data`](#data) is an [array of objects](@/guides/getting-started/binding-to-data.md#array-of-objects),
|
2954
|
+
* 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).
|
2955
|
+
* When your [`data`](#data) is an [array of objects](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-objects),
|
2956
2956
|
* you can only have as many columns as defined in:
|
2957
2957
|
* - The first data row
|
2958
2958
|
* - The [`dataSchema`](#dataSchema) option
|
@@ -2999,8 +2999,8 @@ var _default = () => {
|
|
2999
2999
|
*
|
3000
3000
|
* The total number of columns can't exceed the [`maxCols`](#maxCols) value.
|
3001
3001
|
*
|
3002
|
-
* The `minSpareCols` option works only when your [`data`](#data) is an [array of arrays](@/guides/getting-started/binding-to-data.md#array-of-arrays).
|
3003
|
-
* When your [`data`](#data) is an [array of objects](@/guides/getting-started/binding-to-data.md#array-of-objects),
|
3002
|
+
* 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).
|
3003
|
+
* When your [`data`](#data) is an [array of objects](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-objects),
|
3004
3004
|
* you can only have as many columns as defined in:
|
3005
3005
|
* - The first data row
|
3006
3006
|
* - The [`dataSchema`](#dataSchema) option
|
@@ -3059,7 +3059,7 @@ var _default = () => {
|
|
3059
3059
|
* | `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 |
|
3060
3060
|
* | `headerAction` | `true`: Enable clicking on the column header to sort the column<br>`false`: Disable clicking on the column header to sort the column |
|
3061
3061
|
* | `sortEmptyCells` | `true`: Sort empty cells as well<br>`false`: Place empty cells at the end |
|
3062
|
-
* | `compareFunctionFactory` | A [custom compare function](@/guides/rows/rows-sorting.md#add-a-custom-comparator) |
|
3062
|
+
* | `compareFunctionFactory` | A [custom compare function](@/guides/rows/rows-sorting/rows-sorting.md#add-a-custom-comparator) |
|
3063
3063
|
*
|
3064
3064
|
* If you set the `multiColumnSorting` option to an object,
|
3065
3065
|
* you can also sort individual columns at Handsontable's initialization.
|
@@ -3072,7 +3072,7 @@ var _default = () => {
|
|
3072
3072
|
* | `sortOrder` | `'asc'` \| `'desc'` | The sorting order:<br>`'asc'`: ascending<br>`'desc'`: descending |
|
3073
3073
|
*
|
3074
3074
|
* Read more:
|
3075
|
-
* - [Rows sorting](@/guides/rows/rows-sorting.md)
|
3075
|
+
* - [Rows sorting](@/guides/rows/rows-sorting/rows-sorting.md)
|
3076
3076
|
* - [`columnSorting`](#columnSorting)
|
3077
3077
|
*
|
3078
3078
|
* @memberof Options#
|
@@ -3118,7 +3118,7 @@ var _default = () => {
|
|
3118
3118
|
*/
|
3119
3119
|
multiColumnSorting: undefined,
|
3120
3120
|
/**
|
3121
|
-
* 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`).
|
3121
|
+
* 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`).
|
3122
3122
|
*
|
3123
3123
|
* @since 14.0.0
|
3124
3124
|
* @memberof Options#
|
@@ -3181,7 +3181,7 @@ var _default = () => {
|
|
3181
3181
|
*
|
3182
3182
|
* Read more:
|
3183
3183
|
* - [Plugins: `NestedHeaders`](@/api/nestedHeaders.md)
|
3184
|
-
* - [Column groups: Nested headers](@/guides/columns/column-groups.md#nested-headers)
|
3184
|
+
* - [Column groups: Nested headers](@/guides/columns/column-groups/column-groups.md#nested-headers)
|
3185
3185
|
*
|
3186
3186
|
* @memberof Options#
|
3187
3187
|
* @type {boolean|Array[]}
|
@@ -3210,7 +3210,7 @@ var _default = () => {
|
|
3210
3210
|
* | `true` | Enable the [`NestedRows`](@/api/nestedRows.md) plugin |
|
3211
3211
|
*
|
3212
3212
|
* Read more:
|
3213
|
-
* - [Plugins: `NestedRows`](@/guides/rows/row-parent-child.md)
|
3213
|
+
* - [Plugins: `NestedRows`](@/guides/rows/row-parent-child/row-parent-child.md)
|
3214
3214
|
*
|
3215
3215
|
* @example
|
3216
3216
|
* ```js
|
@@ -3255,7 +3255,7 @@ var _default = () => {
|
|
3255
3255
|
noWordWrapClassName: 'htNoWrap',
|
3256
3256
|
/**
|
3257
3257
|
* The `numericFormat` option configures the number format and the currency format
|
3258
|
-
* of [`numeric`](@/guides/cell-types/numeric-cell-type.md) cells` displayed output
|
3258
|
+
* of [`numeric`](@/guides/cell-types/numeric-cell-type/numeric-cell-type.md) cells` displayed output
|
3259
3259
|
* in the numeric cell renderer.
|
3260
3260
|
*
|
3261
3261
|
* You can set the `numericFormat` option to an object with the following properties:
|
@@ -3270,8 +3270,8 @@ var _default = () => {
|
|
3270
3270
|
* In the source data, numeric data is stored as JavaScript numbers.
|
3271
3271
|
*
|
3272
3272
|
* Read more:
|
3273
|
-
* - [Numeric cell type](@/guides/cell-types/numeric-cell-type.md)
|
3274
|
-
* - [Third-party licenses](@/guides/technical-specification/third-party-licenses.md)
|
3273
|
+
* - [Numeric cell type](@/guides/cell-types/numeric-cell-type/numeric-cell-type.md)
|
3274
|
+
* - [Third-party licenses](@/guides/technical-specification/third-party-licenses/third-party-licenses.md)
|
3275
3275
|
*
|
3276
3276
|
* @memberof Options#
|
3277
3277
|
* @since 0.35.0
|
@@ -3314,15 +3314,15 @@ var _default = () => {
|
|
3314
3314
|
*/
|
3315
3315
|
observeDOMVisibility: true,
|
3316
3316
|
/**
|
3317
|
-
* The `outsideClickDeselects` option determines what happens to the current [selection](@/guides/cell-features/selection.md)
|
3317
|
+
* The `outsideClickDeselects` option determines what happens to the current [selection](@/guides/cell-features/selection/selection.md)
|
3318
3318
|
* when you click outside of the grid.
|
3319
3319
|
*
|
3320
3320
|
* You can set the `outsideClickDeselects` option to one of the following:
|
3321
3321
|
*
|
3322
3322
|
* | Setting | Description |
|
3323
3323
|
* | ---------------- | -------------------------------------------------------------------------------------------------------- |
|
3324
|
-
* | `true` (default) | On a mouse click outside of the grid, clear the current [selection](@/guides/cell-features/selection.md) |
|
3325
|
-
* | `false` | On a mouse click outside of the grid, keep the current [selection](@/guides/cell-features/selection.md) |
|
3324
|
+
* | `true` (default) | On a mouse click outside of the grid, clear the current [selection](@/guides/cell-features/selection/selection.md) |
|
3325
|
+
* | `false` | On a mouse click outside of the grid, keep the current [selection](@/guides/cell-features/selection/selection.md) |
|
3326
3326
|
* | A function | A function that takes the click event target and returns a boolean |
|
3327
3327
|
*
|
3328
3328
|
* @memberof Options#
|
@@ -3362,7 +3362,7 @@ var _default = () => {
|
|
3362
3362
|
* | `true` | Enable the [`PersistentState`](@/api/persistentState.md) plugin |
|
3363
3363
|
*
|
3364
3364
|
* Read more:
|
3365
|
-
* - [Saving data: Saving data locally](@/guides/getting-started/saving-data.md#save-data-locally)
|
3365
|
+
* - [Saving data: Saving data locally](@/guides/getting-started/saving-data/saving-data.md#save-data-locally)
|
3366
3366
|
* - [Plugins: `PersistentState`](@/api/persistentState.md)
|
3367
3367
|
*
|
3368
3368
|
* @memberof Options#
|
@@ -3419,7 +3419,7 @@ var _default = () => {
|
|
3419
3419
|
* that contain [`placeholder`](#placeholder) text.
|
3420
3420
|
*
|
3421
3421
|
* Read more:
|
3422
|
-
* - [Cell validator](@/guides/cell-functions/cell-validator.md)
|
3422
|
+
* - [Cell validator](@/guides/cell-functions/cell-validator/cell-validator.md)
|
3423
3423
|
* - [`placeholder`](#placeholder)
|
3424
3424
|
* - [`currentRowClassName`](#currentRowClassName)
|
3425
3425
|
* - [`currentHeaderClassName`](#currentHeaderClassName)
|
@@ -3494,9 +3494,9 @@ var _default = () => {
|
|
3494
3494
|
preventWheel: false,
|
3495
3495
|
/**
|
3496
3496
|
* @description
|
3497
|
-
* The `readOnly` option determines whether a [cell](@/guides/cell-features/disabled-cells.md#read-only-specific-cells),
|
3498
|
-
* [comment](@/guides/cell-features/comments.md#make-a-comment-read-only), [column](@/guides/cell-features/disabled-cells.md#read-only-columns)
|
3499
|
-
* or the [entire grid](@/guides/cell-features/disabled-cells.md#read-only-grid) is editable or not. You can configure it as follows:
|
3497
|
+
* The `readOnly` option determines whether a [cell](@/guides/cell-features/disabled-cells/disabled-cells.md#read-only-specific-cells),
|
3498
|
+
* [comment](@/guides/cell-features/comments/comments.md#make-a-comment-read-only), [column](@/guides/cell-features/disabled-cells/disabled-cells.md#read-only-columns)
|
3499
|
+
* 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:
|
3500
3500
|
*
|
3501
3501
|
* | Setting | Description |
|
3502
3502
|
* | ----------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
@@ -3506,8 +3506,8 @@ var _default = () => {
|
|
3506
3506
|
* `readOnly` cells can't be changed by the [`populateFromArray()`](@/api/core.md#populatefromarray) method.
|
3507
3507
|
*
|
3508
3508
|
* Read more:
|
3509
|
-
* - [Disabled cells](@/guides/cell-features/disabled-cells.md)
|
3510
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
3509
|
+
* - [Disabled cells](@/guides/cell-features/disabled-cells/disabled-cells.md)
|
3510
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
3511
3511
|
*
|
3512
3512
|
* @memberof Options#
|
3513
3513
|
* @type {boolean}
|
@@ -3573,18 +3573,18 @@ var _default = () => {
|
|
3573
3573
|
*/
|
3574
3574
|
readOnlyCellClassName: 'htDimmed',
|
3575
3575
|
/**
|
3576
|
-
* The `renderAllRows` option controls Handsontable's [row virtualization](@/guides/rows/row-virtualization.md).
|
3576
|
+
* The `renderAllRows` option controls Handsontable's [row virtualization](@/guides/rows/row-virtualization/row-virtualization.md).
|
3577
3577
|
* You can configure it as follows:
|
3578
3578
|
*
|
3579
3579
|
* | Setting | Description |
|
3580
3580
|
* | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
3581
|
-
* | `false` (default) | Enable [row virtualization](@/guides/rows/row-virtualization.md), rendering only the visible rows for optimal performance with large datasets. |
|
3582
|
-
* | `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. |
|
3581
|
+
* | `false` (default) | Enable [row virtualization](@/guides/rows/row-virtualization/row-virtualization.md), rendering only the visible rows for optimal performance with large datasets. |
|
3582
|
+
* | `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. |
|
3583
3583
|
*
|
3584
3584
|
* Setting `renderAllRows` to `true` overwrites the [`viewportRowRenderingOffset`](#viewportRowRenderingOffset) setting.
|
3585
3585
|
*
|
3586
3586
|
* Read more:
|
3587
|
-
* - [Row virtualization](@/guides/rows/row-virtualization.md)
|
3587
|
+
* - [Row virtualization](@/guides/rows/row-virtualization/row-virtualization.md)
|
3588
3588
|
*
|
3589
3589
|
* @memberof Options#
|
3590
3590
|
* @type {boolean}
|
@@ -3599,19 +3599,19 @@ var _default = () => {
|
|
3599
3599
|
*/
|
3600
3600
|
renderAllRows: false,
|
3601
3601
|
/**
|
3602
|
-
* The `renderAllColumns` option configures Handsontable's [column virtualization](@/guides/columns/column-virtualization.md).
|
3602
|
+
* The `renderAllColumns` option configures Handsontable's [column virtualization](@/guides/columns/column-virtualization/column-virtualization.md).
|
3603
3603
|
*
|
3604
3604
|
* You can set the `renderAllColumns` option to one of the following:
|
3605
3605
|
*
|
3606
3606
|
* | Setting | Description |
|
3607
3607
|
* | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
3608
|
-
* | `false` (default) | Enable [column virtualization](@/guides/columns/column-virtualization.md), rendering only visible columns for better performance with many columns. |
|
3609
|
-
* | `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. |
|
3608
|
+
* | `false` (default) | Enable [column virtualization](@/guides/columns/column-virtualization/column-virtualization.md), rendering only visible columns for better performance with many columns. |
|
3609
|
+
* | `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. |
|
3610
3610
|
*
|
3611
3611
|
* Setting `renderAllColumns` to `true` overwrites the [`viewportColumnRenderingOffset`](#viewportColumnRenderingOffset) setting.
|
3612
3612
|
*
|
3613
3613
|
* Read more:
|
3614
|
-
* - [Column virtualization](@/guides/columns/column-virtualization.md)
|
3614
|
+
* - [Column virtualization](@/guides/columns/column-virtualization/column-virtualization.md)
|
3615
3615
|
*
|
3616
3616
|
* @since 14.1.0
|
3617
3617
|
* @memberof Options#
|
@@ -3628,15 +3628,15 @@ var _default = () => {
|
|
3628
3628
|
renderAllColumns: false,
|
3629
3629
|
/**
|
3630
3630
|
* @description
|
3631
|
-
* The `renderer` option sets a [cell renderer](@/guides/cell-functions/cell-renderer.md) for a cell.
|
3631
|
+
* The `renderer` option sets a [cell renderer](@/guides/cell-functions/cell-renderer/cell-renderer.md) for a cell.
|
3632
3632
|
*
|
3633
3633
|
* You can set the `renderer` option to one of the following:
|
3634
3634
|
* - A custom renderer function
|
3635
|
-
* - One of the following [cell renderer aliases](@/guides/cell-functions/cell-renderer.md):
|
3635
|
+
* - One of the following [cell renderer aliases](@/guides/cell-functions/cell-renderer/cell-renderer.md):
|
3636
3636
|
*
|
3637
3637
|
* | Alias | Cell renderer function |
|
3638
3638
|
* | ------------------- | ------------------------------------------------------------------------------ |
|
3639
|
-
* | A custom alias | Your [custom cell renderer](@/guides/cell-functions/cell-renderer.md) function |
|
3639
|
+
* | A custom alias | Your [custom cell renderer](@/guides/cell-functions/cell-renderer/cell-renderer.md) function |
|
3640
3640
|
* | `'autocomplete'` | `AutocompleteRenderer` |
|
3641
3641
|
* | `'base'` | `BaseRenderer` |
|
3642
3642
|
* | `'checkbox'` | `CheckboxRenderer` |
|
@@ -3652,9 +3652,9 @@ var _default = () => {
|
|
3652
3652
|
* options all at once, use the [`type`](#type) option.
|
3653
3653
|
*
|
3654
3654
|
* Read more:
|
3655
|
-
* - [Cell renderer](@/guides/cell-functions/cell-renderer.md)
|
3656
|
-
* - [Cell type](@/guides/cell-types/cell-type.md)
|
3657
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
3655
|
+
* - [Cell renderer](@/guides/cell-functions/cell-renderer/cell-renderer.md)
|
3656
|
+
* - [Cell type](@/guides/cell-types/cell-type/cell-type.md)
|
3657
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
3658
3658
|
* - [`type`](#type)
|
3659
3659
|
*
|
3660
3660
|
* @memberof Options#
|
@@ -3700,7 +3700,7 @@ var _default = () => {
|
|
3700
3700
|
* | A function | Define your own row headers, using a function |
|
3701
3701
|
*
|
3702
3702
|
* Read more:
|
3703
|
-
* - [Row header](@/guides/rows/row-header.md)
|
3703
|
+
* - [Row header](@/guides/rows/row-header/row-header.md)
|
3704
3704
|
*
|
3705
3705
|
* @memberof Options#
|
3706
3706
|
* @type {boolean|string[]|Function}
|
@@ -3766,7 +3766,7 @@ var _default = () => {
|
|
3766
3766
|
* via the {@link ManualRowResize} and {@link AutoRowSize} plugins (if they are enabled).
|
3767
3767
|
*
|
3768
3768
|
* Read more:
|
3769
|
-
* - [Row height](@/guides/rows/row-height.md)
|
3769
|
+
* - [Row height](@/guides/rows/row-height/row-height.md)
|
3770
3770
|
*
|
3771
3771
|
* @memberof Options#
|
3772
3772
|
* @type {number|number[]|string|string[]|Array<undefined>|Function}
|
@@ -3811,13 +3811,13 @@ var _default = () => {
|
|
3811
3811
|
* | Option | Possible settings | Description |
|
3812
3812
|
* | ------------------- | ----------------- | ---------------------------------------------------------------------------------------------------- |
|
3813
3813
|
* | `searchResultClass` | A string | Add a custom CSS class name to search results |
|
3814
|
-
* | `queryMethod` | A function | Add a [custom query method](@/guides/navigation/searching-values.md#custom-query-method) |
|
3815
|
-
* | `callback` | A function | Add a [custom callback function](@/guides/navigation/searching-values.md#custom-callback) |
|
3814
|
+
* | `queryMethod` | A function | Add a [custom query method](@/guides/navigation/searching-values/searching-values.md#custom-query-method) |
|
3815
|
+
* | `callback` | A function | Add a [custom callback function](@/guides/navigation/searching-values/searching-values.md#custom-callback) |
|
3816
3816
|
*
|
3817
3817
|
* Read more:
|
3818
|
-
* - [Searching values](@/guides/navigation/searching-values.md)
|
3819
|
-
* - [Searching values: Custom query method](@/guides/navigation/searching-values.md#custom-query-method)
|
3820
|
-
* - [Searching values: Custom callback](@/guides/navigation/searching-values.md#custom-callback)
|
3818
|
+
* - [Searching values](@/guides/navigation/searching-values/searching-values.md)
|
3819
|
+
* - [Searching values: Custom query method](@/guides/navigation/searching-values/searching-values.md#custom-query-method)
|
3820
|
+
* - [Searching values: Custom callback](@/guides/navigation/searching-values/searching-values.md#custom-callback)
|
3821
3821
|
*
|
3822
3822
|
* @memberof Options#
|
3823
3823
|
* @type {boolean|object}
|
@@ -3847,7 +3847,7 @@ var _default = () => {
|
|
3847
3847
|
search: false,
|
3848
3848
|
/**
|
3849
3849
|
* @description
|
3850
|
-
* The `selectionMode` option configures how [selection](@/guides/cell-features/selection.md) works.
|
3850
|
+
* The `selectionMode` option configures how [selection](@/guides/cell-features/selection/selection.md) works.
|
3851
3851
|
*
|
3852
3852
|
* You can set the `selectionMode` option to one of the following:
|
3853
3853
|
*
|
@@ -3858,7 +3858,7 @@ var _default = () => {
|
|
3858
3858
|
* | `'multiple'` | Allow the user to select multiple ranges of cells at a time. |
|
3859
3859
|
*
|
3860
3860
|
* Read more:
|
3861
|
-
* - [Selection: Selecting ranges](@/guides/cell-features/selection.md#select-ranges)
|
3861
|
+
* - [Selection: Selecting ranges](@/guides/cell-features/selection/selection.md#select-ranges)
|
3862
3862
|
*
|
3863
3863
|
* @memberof Options#
|
3864
3864
|
* @type {string}
|
@@ -3879,7 +3879,7 @@ var _default = () => {
|
|
3879
3879
|
*/
|
3880
3880
|
selectionMode: 'multiple',
|
3881
3881
|
/**
|
3882
|
-
* The `selectOptions` option configures options that the end user can choose from in [`select`](@/guides/cell-types/select-cell-type.md) cells.
|
3882
|
+
* 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.
|
3883
3883
|
*
|
3884
3884
|
* You can set the `selectOptions` option to one of the following:
|
3885
3885
|
*
|
@@ -3890,7 +3890,7 @@ var _default = () => {
|
|
3890
3890
|
* | A function | A function that returns an object with key-string pairs |
|
3891
3891
|
*
|
3892
3892
|
* Read more:
|
3893
|
-
* - [Select cell type](@/guides/cell-types/select-cell-type.md)
|
3893
|
+
* - [Select cell type](@/guides/cell-types/select-cell-type/select-cell-type.md)
|
3894
3894
|
*
|
3895
3895
|
* @memberof Options#
|
3896
3896
|
* @type {string[]|object|Function}
|
@@ -3949,7 +3949,7 @@ var _default = () => {
|
|
3949
3949
|
* | `true` | - Disable pasting data into this column<br>- On pasting, paste data into the next column to the right |
|
3950
3950
|
*
|
3951
3951
|
* Read more:
|
3952
|
-
* - [Configuration options: Setting column options](@/guides/getting-started/configuration-options.md#set-column-options)
|
3952
|
+
* - [Configuration options: Setting column options](@/guides/getting-started/configuration-options/configuration-options.md#set-column-options)
|
3953
3953
|
*
|
3954
3954
|
* @memberof Options#
|
3955
3955
|
* @type {boolean}
|
@@ -3982,7 +3982,7 @@ var _default = () => {
|
|
3982
3982
|
* | `true` | - Disable pasting data into this row<br>- On pasting, paste data into the row below |
|
3983
3983
|
*
|
3984
3984
|
* Read more:
|
3985
|
-
* - [Configuration options: Setting row options](@/guides/getting-started/configuration-options.md#set-row-options)
|
3985
|
+
* - [Configuration options: Setting row options](@/guides/getting-started/configuration-options/configuration-options.md#set-row-options)
|
3986
3986
|
*
|
3987
3987
|
* @memberof Options#
|
3988
3988
|
* @type {boolean}
|
@@ -4005,7 +4005,7 @@ var _default = () => {
|
|
4005
4005
|
*/
|
4006
4006
|
skipRowOnPaste: false,
|
4007
4007
|
/**
|
4008
|
-
* The `sortByRelevance` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md) cells'
|
4008
|
+
* The `sortByRelevance` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) cells'
|
4009
4009
|
* lists are sorted in the same order as provided in the [`source`](#source) option.
|
4010
4010
|
*
|
4011
4011
|
* You can set the `sortByRelevance` option to one of the following:
|
@@ -4017,7 +4017,7 @@ var _default = () => {
|
|
4017
4017
|
*
|
4018
4018
|
* Read more:
|
4019
4019
|
* - [`source`](#source)
|
4020
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
4020
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
4021
4021
|
*
|
4022
4022
|
* @memberof Options#
|
4023
4023
|
* @type {boolean}
|
@@ -4038,8 +4038,8 @@ var _default = () => {
|
|
4038
4038
|
*/
|
4039
4039
|
sortByRelevance: true,
|
4040
4040
|
/**
|
4041
|
-
* The `source` option sets options available in [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md)
|
4042
|
-
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type.md) cells.
|
4041
|
+
* The `source` option sets options available in [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
4042
|
+
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md) cells.
|
4043
4043
|
*
|
4044
4044
|
* You can set the `source` option to one of the following:
|
4045
4045
|
*
|
@@ -4047,8 +4047,8 @@ var _default = () => {
|
|
4047
4047
|
* - A function
|
4048
4048
|
*
|
4049
4049
|
* Read more:
|
4050
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
4051
|
-
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type.md)
|
4050
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
4051
|
+
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md)
|
4052
4052
|
* - [`strict`](#strict)
|
4053
4053
|
* - [`allowHtml`](#allowHtml)
|
4054
4054
|
* - [`filter`](#filter)
|
@@ -4133,7 +4133,7 @@ var _default = () => {
|
|
4133
4133
|
* | `'all'` | Fit the grid to the container, by stretching all columns evenly |
|
4134
4134
|
*
|
4135
4135
|
* Read more:
|
4136
|
-
* - [Column width: Column stretching](@/guides/columns/column-width.md#column-stretching)
|
4136
|
+
* - [Column width: Column stretching](@/guides/columns/column-width/column-width.md#column-stretching)
|
4137
4137
|
*
|
4138
4138
|
* @memberof Options#
|
4139
4139
|
* @type {string}
|
@@ -4149,17 +4149,17 @@ var _default = () => {
|
|
4149
4149
|
*/
|
4150
4150
|
stretchH: 'none',
|
4151
4151
|
/**
|
4152
|
-
* The `strict` option configures the behavior of [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md) cells.
|
4152
|
+
* The `strict` option configures the behavior of [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) cells.
|
4153
4153
|
*
|
4154
4154
|
* You can set the `strict` option to one of the following:
|
4155
4155
|
*
|
4156
4156
|
* | Setting | Mode | Description |
|
4157
4157
|
* | ------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
|
4158
|
-
* | `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 |
|
4159
|
-
* | `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 |
|
4158
|
+
* | `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 |
|
4159
|
+
* | `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 |
|
4160
4160
|
*
|
4161
4161
|
* Read more:
|
4162
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
4162
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
4163
4163
|
* - [`source`](#source)
|
4164
4164
|
*
|
4165
4165
|
* @memberof Options#
|
@@ -4258,12 +4258,12 @@ var _default = () => {
|
|
4258
4258
|
},
|
4259
4259
|
/**
|
4260
4260
|
* @description
|
4261
|
-
* The `title` option configures [column header](@/guides/columns/column-header.md) names.
|
4261
|
+
* The `title` option configures [column header](@/guides/columns/column-header/column-header.md) names.
|
4262
4262
|
*
|
4263
4263
|
* You can set the `title` option to a string.
|
4264
4264
|
*
|
4265
4265
|
* Read more:
|
4266
|
-
* - [Column header](@/guides/columns/column-header.md)
|
4266
|
+
* - [Column header](@/guides/columns/column-header/column-header.md)
|
4267
4267
|
* - [`columns`](#columns)
|
4268
4268
|
*
|
4269
4269
|
* @memberof Options#
|
@@ -4289,8 +4289,8 @@ var _default = () => {
|
|
4289
4289
|
*/
|
4290
4290
|
title: undefined,
|
4291
4291
|
/**
|
4292
|
-
* The `trimDropdown` option configures the width of the [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md)
|
4293
|
-
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type.md) lists.
|
4292
|
+
* The `trimDropdown` option configures the width of the [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
4293
|
+
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md) lists.
|
4294
4294
|
*
|
4295
4295
|
* You can set the `trimDropdown` option to one of the following:
|
4296
4296
|
*
|
@@ -4300,8 +4300,8 @@ var _default = () => {
|
|
4300
4300
|
* | `false` | Scale the dropdown/autocomplete list's width to the list's content |
|
4301
4301
|
*
|
4302
4302
|
* Read more:
|
4303
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
4304
|
-
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type.md)
|
4303
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
4304
|
+
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md)
|
4305
4305
|
*
|
4306
4306
|
* @memberof Options#
|
4307
4307
|
* @type {boolean}
|
@@ -4341,7 +4341,7 @@ var _default = () => {
|
|
4341
4341
|
*
|
4342
4342
|
* Read more:
|
4343
4343
|
* - [Plugins: `TrimRows`](@/api/trimRows.md)
|
4344
|
-
* - [Row trimming](@/guides/rows/row-trimming.md)
|
4344
|
+
* - [Row trimming](@/guides/rows/row-trimming/row-trimming.md)
|
4345
4345
|
*
|
4346
4346
|
* @memberof Options#
|
4347
4347
|
* @type {boolean|number[]}
|
@@ -4390,29 +4390,29 @@ var _default = () => {
|
|
4390
4390
|
/**
|
4391
4391
|
* @description
|
4392
4392
|
* The `type` option lets you set the [`renderer`](#renderer), [`editor`](#editor), and [`validator`](#validator)
|
4393
|
-
* options all at once, by selecting a [cell type](@/guides/cell-types/cell-type.md).
|
4393
|
+
* options all at once, by selecting a [cell type](@/guides/cell-types/cell-type/cell-type.md).
|
4394
4394
|
*
|
4395
4395
|
* You can set the `type` option to one of the following:
|
4396
4396
|
*
|
4397
4397
|
* | Cell type | Renderer, editor & validator |
|
4398
4398
|
* | ----------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
4399
|
-
* | 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) |
|
4400
|
-
* | [`'autocomplete'`](@/guides/cell-types/autocomplete-cell-type.md) | Renderer: `AutocompleteRenderer`<br>Editor: `AutocompleteEditor`<br>Validator: `AutocompleteValidator` |
|
4401
|
-
* | [`'checkbox'`](@/guides/cell-types/checkbox-cell-type.md) | Renderer: `CheckboxRenderer`<br>Editor: `CheckboxEditor`<br>Validator: - |
|
4402
|
-
* | [`'date'`](@/guides/cell-types/date-cell-type.md) | Renderer: `DateRenderer`<br>Editor: `DateEditor`<br>Validator: `DateValidator` |
|
4403
|
-
* | [`'dropdown'`](@/guides/cell-types/dropdown-cell-type.md) | Renderer: `DropdownRenderer`<br>Editor: `DropdownEditor`<br>Validator: `DropdownValidator` |
|
4404
|
-
* | [`'handsontable'`](@/guides/cell-types/handsontable-cell-type.md) | Renderer: `AutocompleteRenderer`<br>Editor: `HandsontableEditor`<br>Validator: - |
|
4405
|
-
* | [`'numeric'`](@/guides/cell-types/numeric-cell-type.md) | Renderer: `NumericRenderer`<br>Editor: `NumericEditor`<br>Validator: `NumericValidator` |
|
4406
|
-
* | [`'password'`](@/guides/cell-types/password-cell-type.md) | Renderer: `PasswordRenderer`<br>Editor: `PasswordEditor`<br>Validator: - |
|
4399
|
+
* | 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) |
|
4400
|
+
* | [`'autocomplete'`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) | Renderer: `AutocompleteRenderer`<br>Editor: `AutocompleteEditor`<br>Validator: `AutocompleteValidator` |
|
4401
|
+
* | [`'checkbox'`](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md) | Renderer: `CheckboxRenderer`<br>Editor: `CheckboxEditor`<br>Validator: - |
|
4402
|
+
* | [`'date'`](@/guides/cell-types/date-cell-type/date-cell-type.md) | Renderer: `DateRenderer`<br>Editor: `DateEditor`<br>Validator: `DateValidator` |
|
4403
|
+
* | [`'dropdown'`](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md) | Renderer: `DropdownRenderer`<br>Editor: `DropdownEditor`<br>Validator: `DropdownValidator` |
|
4404
|
+
* | [`'handsontable'`](@/guides/cell-types/handsontable-cell-type/handsontable-cell-type.md) | Renderer: `AutocompleteRenderer`<br>Editor: `HandsontableEditor`<br>Validator: - |
|
4405
|
+
* | [`'numeric'`](@/guides/cell-types/numeric-cell-type/numeric-cell-type.md) | Renderer: `NumericRenderer`<br>Editor: `NumericEditor`<br>Validator: `NumericValidator` |
|
4406
|
+
* | [`'password'`](@/guides/cell-types/password-cell-type/password-cell-type.md) | Renderer: `PasswordRenderer`<br>Editor: `PasswordEditor`<br>Validator: - |
|
4407
4407
|
* | `'text'` | Renderer: `TextRenderer`<br>Editor: `TextEditor`<br>Validator: - |
|
4408
|
-
* | [`'time`'](@/guides/cell-types/time-cell-type.md) | Renderer: `TimeRenderer`<br>Editor: `TimeEditor`<br>Validator: `TimeValidator` |
|
4408
|
+
* | [`'time`'](@/guides/cell-types/time-cell-type/time-cell-type.md) | Renderer: `TimeRenderer`<br>Editor: `TimeEditor`<br>Validator: `TimeValidator` |
|
4409
4409
|
*
|
4410
4410
|
* Read more:
|
4411
|
-
* - [Cell type](@/guides/cell-types/cell-type.md)
|
4412
|
-
* - [Cell renderer](@/guides/cell-functions/cell-renderer.md)
|
4413
|
-
* - [Cell editor](@/guides/cell-functions/cell-editor.md)
|
4414
|
-
* - [Cell validator](@/guides/cell-functions/cell-validator.md)
|
4415
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
4411
|
+
* - [Cell type](@/guides/cell-types/cell-type/cell-type.md)
|
4412
|
+
* - [Cell renderer](@/guides/cell-functions/cell-renderer/cell-renderer.md)
|
4413
|
+
* - [Cell editor](@/guides/cell-functions/cell-editor/cell-editor.md)
|
4414
|
+
* - [Cell validator](@/guides/cell-functions/cell-validator/cell-validator.md)
|
4415
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
4416
4416
|
* - [`renderer`](#renderer)
|
4417
4417
|
* - [`editor`](#editor)
|
4418
4418
|
* - [`validator`](#validator)
|
@@ -4443,17 +4443,17 @@ var _default = () => {
|
|
4443
4443
|
type: 'text',
|
4444
4444
|
/**
|
4445
4445
|
* The `uncheckedTemplate` option lets you configure what value
|
4446
|
-
* an unchecked [`checkbox`](@/guides/cell-types/checkbox-cell-type.md) cell has.
|
4446
|
+
* an unchecked [`checkbox`](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md) cell has.
|
4447
4447
|
*
|
4448
4448
|
* You can set the `uncheckedTemplate` option to one of the following:
|
4449
4449
|
*
|
4450
4450
|
* | Setting | Description |
|
4451
4451
|
* | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
4452
|
-
* | `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` |
|
4453
|
-
* | 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 |
|
4452
|
+
* | `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` |
|
4453
|
+
* | 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 |
|
4454
4454
|
*
|
4455
4455
|
* Read more:
|
4456
|
-
* - [Checkbox cell type: Checkbox template](@/guides/cell-types/checkbox-cell-type.md#checkbox-template)
|
4456
|
+
* - [Checkbox cell type: Checkbox template](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md#checkbox-template)
|
4457
4457
|
* - [`getDataAtCell()`](@/api/core.md#getDataAtCell)
|
4458
4458
|
* - [`checkedTemplate`](#checkedTemplate)
|
4459
4459
|
*
|
@@ -4499,7 +4499,7 @@ var _default = () => {
|
|
4499
4499
|
* set the `undo` option to `false`.
|
4500
4500
|
*
|
4501
4501
|
* Read more:
|
4502
|
-
* - [Undo and redo](@/guides/accessories-and-menus/undo-redo.md)
|
4502
|
+
* - [Undo and redo](@/guides/accessories-and-menus/undo-redo/undo-redo.md)
|
4503
4503
|
*
|
4504
4504
|
* @memberof Options#
|
4505
4505
|
* @type {boolean}
|
@@ -4515,22 +4515,22 @@ var _default = () => {
|
|
4515
4515
|
undo: undefined,
|
4516
4516
|
/**
|
4517
4517
|
* @description
|
4518
|
-
* The `validator` option sets a [cell validator](@/guides/cell-functions/cell-validator.md) for a cell.
|
4518
|
+
* The `validator` option sets a [cell validator](@/guides/cell-functions/cell-validator/cell-validator.md) for a cell.
|
4519
4519
|
*
|
4520
4520
|
* You can set the `validator` option to one of the following:
|
4521
4521
|
*
|
4522
4522
|
* | Setting | Description |
|
4523
4523
|
* | -------------------- | -------------------------------------------------------------------------------- |
|
4524
|
-
* | A string | A [cell validator alias](@/guides/cell-functions/cell-validator.md) |
|
4525
|
-
* | A function | Your [custom cell validator function](@/guides/cell-functions/cell-validator.md) |
|
4524
|
+
* | A string | A [cell validator alias](@/guides/cell-functions/cell-validator/cell-validator.md) |
|
4525
|
+
* | A function | Your [custom cell validator function](@/guides/cell-functions/cell-validator/cell-validator.md) |
|
4526
4526
|
* | A regular expression | A regular expression used for cell validation |
|
4527
4527
|
*
|
4528
4528
|
* By setting the `validator` option to a string,
|
4529
|
-
* you can use one of the following [cell validator aliases](@/guides/cell-functions/cell-validator.md):
|
4529
|
+
* you can use one of the following [cell validator aliases](@/guides/cell-functions/cell-validator/cell-validator.md):
|
4530
4530
|
*
|
4531
4531
|
* | Alias | Cell validator function |
|
4532
4532
|
* | ------------------- | ----------------------------------------------------------------------- |
|
4533
|
-
* | A custom alias | Your [custom cell validator](@/guides/cell-functions/cell-validator.md) |
|
4533
|
+
* | A custom alias | Your [custom cell validator](@/guides/cell-functions/cell-validator/cell-validator.md) |
|
4534
4534
|
* | `'autocomplete'` | `AutocompleteValidator` |
|
4535
4535
|
* | `'date'` | `DateValidator` |
|
4536
4536
|
* | `'dropdown'` | `DropdownValidator` |
|
@@ -4541,9 +4541,9 @@ var _default = () => {
|
|
4541
4541
|
* options all at once, use the [`type`](#type) option.
|
4542
4542
|
*
|
4543
4543
|
* Read more:
|
4544
|
-
* - [Cell validator](@/guides/cell-functions/cell-validator.md)
|
4545
|
-
* - [Cell type](@/guides/cell-types/cell-type.md)
|
4546
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
4544
|
+
* - [Cell validator](@/guides/cell-functions/cell-validator/cell-validator.md)
|
4545
|
+
* - [Cell type](@/guides/cell-types/cell-type/cell-type.md)
|
4546
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
4547
4547
|
* - [`type`](#type)
|
4548
4548
|
*
|
4549
4549
|
* @memberof Options#
|
@@ -4587,7 +4587,7 @@ var _default = () => {
|
|
4587
4587
|
* The `viewportColumnRenderingOffset` setting is ignored when [`renderAllColumns`](#renderAllColumns) is set to `true`.
|
4588
4588
|
*
|
4589
4589
|
* Read more:
|
4590
|
-
* - [Performance: Define the number of pre-rendered rows and columns](@/guides/optimization/performance.md#define-the-number-of-pre-rendered-rows-and-columns)
|
4590
|
+
* - [Performance: Define the number of pre-rendered rows and columns](@/guides/optimization/performance/performance.md#define-the-number-of-pre-rendered-rows-and-columns)
|
4591
4591
|
*
|
4592
4592
|
* @memberof Options#
|
4593
4593
|
* @type {number|string}
|
@@ -4616,8 +4616,8 @@ var _default = () => {
|
|
4616
4616
|
* The `viewportRowRenderingOffset` setting is ignored when [`renderAllRows`](#renderAllRows) is set to `true`.
|
4617
4617
|
*
|
4618
4618
|
* Read more:
|
4619
|
-
* - [Performance: Define the number of pre-rendered rows and columns](@/guides/optimization/performance.md#define-the-number-of-pre-rendered-rows-and-columns)
|
4620
|
-
* - [Column virtualization](@/guides/columns/column-virtualization.md)
|
4619
|
+
* - [Performance: Define the number of pre-rendered rows and columns](@/guides/optimization/performance/performance.md#define-the-number-of-pre-rendered-rows-and-columns)
|
4620
|
+
* - [Column virtualization](@/guides/columns/column-virtualization/column-virtualization.md)
|
4621
4621
|
*
|
4622
4622
|
* @memberof Options#
|
4623
4623
|
* @type {number|string}
|
@@ -4632,14 +4632,14 @@ var _default = () => {
|
|
4632
4632
|
*/
|
4633
4633
|
viewportRowRenderingOffset: 'auto',
|
4634
4634
|
/**
|
4635
|
-
* The `visibleRows` option sets the height of the [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md)
|
4636
|
-
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type.md) lists.
|
4635
|
+
* The `visibleRows` option sets the height of the [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
4636
|
+
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md) lists.
|
4637
4637
|
*
|
4638
4638
|
* When the number of list options exceeds the `visibleRows` number, a scrollbar appears.
|
4639
4639
|
*
|
4640
4640
|
* Read more:
|
4641
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
4642
|
-
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type.md)
|
4641
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
4642
|
+
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md)
|
4643
4643
|
*
|
4644
4644
|
* @memberof Options#
|
4645
4645
|
* @type {number}
|
@@ -4677,7 +4677,7 @@ var _default = () => {
|
|
4677
4677
|
* | A function that returns a valid number or string | `width() { return 500; }` |
|
4678
4678
|
*
|
4679
4679
|
* Read more:
|
4680
|
-
* - [Grid size](@/guides/getting-started/grid-size.md)
|
4680
|
+
* - [Grid size](@/guides/getting-started/grid-size/grid-size.md)
|
4681
4681
|
*
|
4682
4682
|
* @memberof Options#
|
4683
4683
|
* @type {number|string|Function}
|