handsontable 14.2.0 → 14.3.0-next-13fe676-20240409
Sign up to get free protection for your applications and to get access to all the features.
- 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 +9800 -10020
- package/dist/handsontable.full.min.css +3 -3
- package/dist/handsontable.full.min.js +292 -292
- package/dist/handsontable.js +7470 -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 +35 -11
- package/editors/dateEditor/dateEditor.mjs +35 -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
@@ -6,7 +6,7 @@ import { isObjectEqual } from "../../helpers/object.mjs";
|
|
6
6
|
* @class Options
|
7
7
|
* @description
|
8
8
|
*
|
9
|
-
* [Configuration options](@/guides/getting-started/configuration-options.md) let you heavily customize your Handsontable instance. For example, you can:
|
9
|
+
* [Configuration options](@/guides/getting-started/configuration-options/configuration-options.md) let you heavily customize your Handsontable instance. For example, you can:
|
10
10
|
*
|
11
11
|
* - Enable and disable built-in features
|
12
12
|
* - Enable and configure additional [plugins](@/api/plugins.md)
|
@@ -16,11 +16,11 @@ import { isObjectEqual } from "../../helpers/object.mjs";
|
|
16
16
|
*
|
17
17
|
* ::: only-for javascript
|
18
18
|
*
|
19
|
-
* To apply [configuration options](@/guides/getting-started/configuration-options.md), pass them as
|
20
|
-
* a second argument of the [Handsontable constructor](@/guides/getting-started/installation.md#initialize-handsontable),
|
19
|
+
* To apply [configuration options](@/guides/getting-started/configuration-options/configuration-options.md), pass them as
|
20
|
+
* a second argument of the [Handsontable constructor](@/guides/getting-started/installation/installation.md#initialize-handsontable),
|
21
21
|
* using the [object literal notation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Object_initializer):
|
22
22
|
*
|
23
|
-
* Read more on the [Configuration options](@/guides/getting-started/configuration-options.md) page.
|
23
|
+
* Read more on the [Configuration options](@/guides/getting-started/configuration-options/configuration-options.md) page.
|
24
24
|
*
|
25
25
|
* ```js
|
26
26
|
* const container = document.getElementById('example');
|
@@ -51,10 +51,10 @@ import { isObjectEqual } from "../../helpers/object.mjs";
|
|
51
51
|
* ::: only-for react
|
52
52
|
*
|
53
53
|
* To apply configuration options, pass them as individual props
|
54
|
-
* of the [`HotTable`](@/guides/getting-started/installation.md#_4-use-the-hottable-component)
|
55
|
-
* or [`HotColumn`](@/guides/columns/react-hot-column.md) components.
|
54
|
+
* of the [`HotTable`](@/guides/getting-started/installation/installation.md#_4-use-the-hottable-component)
|
55
|
+
* or [`HotColumn`](@/guides/columns/react-hot-column/react-hot-column.md) components.
|
56
56
|
*
|
57
|
-
* Read more on the [Configuration options](@/guides/getting-started/configuration-options.md) page.
|
57
|
+
* Read more on the [Configuration options](@/guides/getting-started/configuration-options/configuration-options.md) page.
|
58
58
|
*
|
59
59
|
* ```jsx
|
60
60
|
* <HotTable
|
@@ -81,14 +81,14 @@ import { isObjectEqual } from "../../helpers/object.mjs";
|
|
81
81
|
* :::
|
82
82
|
*
|
83
83
|
* Depending on your needs, you can apply [configuration options](@/api/options.md) to different elements of your grid:
|
84
|
-
* - [The entire grid](@/guides/getting-started/configuration-options.md#set-grid-options)
|
85
|
-
* - [Individual columns](@/guides/getting-started/configuration-options.md#set-column-options)
|
86
|
-
* - [Individual rows](@/guides/getting-started/configuration-options.md#set-row-options)
|
87
|
-
* - [Individual cells](@/guides/getting-started/configuration-options.md#set-cell-options)
|
88
|
-
* - [Individual grid elements, based on any logic you implement](@/guides/getting-started/configuration-options.md#implementing-custom-logic)
|
84
|
+
* - [The entire grid](@/guides/getting-started/configuration-options/configuration-options.md#set-grid-options)
|
85
|
+
* - [Individual columns](@/guides/getting-started/configuration-options/configuration-options.md#set-column-options)
|
86
|
+
* - [Individual rows](@/guides/getting-started/configuration-options/configuration-options.md#set-row-options)
|
87
|
+
* - [Individual cells](@/guides/getting-started/configuration-options/configuration-options.md#set-cell-options)
|
88
|
+
* - [Individual grid elements, based on any logic you implement](@/guides/getting-started/configuration-options/configuration-options.md#implementing-custom-logic)
|
89
89
|
*
|
90
90
|
* Read more:
|
91
|
-
* - [Configuration options](@/guides/getting-started/configuration-options.md)
|
91
|
+
* - [Configuration options](@/guides/getting-started/configuration-options/configuration-options.md)
|
92
92
|
*/
|
93
93
|
export default (() => {
|
94
94
|
return {
|
@@ -173,8 +173,8 @@ export default (() => {
|
|
173
173
|
*/
|
174
174
|
allowEmpty: true,
|
175
175
|
/**
|
176
|
-
* The `allowHtml` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md)
|
177
|
-
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type.md) cells' [`source`](#source) data
|
176
|
+
* The `allowHtml` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
177
|
+
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md) cells' [`source`](#source) data
|
178
178
|
* is treated as HTML.
|
179
179
|
*
|
180
180
|
* You can set the `allowHtml` option to one of the following:
|
@@ -187,8 +187,8 @@ export default (() => {
|
|
187
187
|
* __Warning:__ Setting the `allowHtml` option to `true` can cause serious XSS vulnerabilities.
|
188
188
|
*
|
189
189
|
* Read more:
|
190
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
191
|
-
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type.md)
|
190
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
191
|
+
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md)
|
192
192
|
* - [`source`](#source)
|
193
193
|
*
|
194
194
|
* @memberof Options#
|
@@ -212,7 +212,7 @@ export default (() => {
|
|
212
212
|
*/
|
213
213
|
allowHtml: false,
|
214
214
|
/**
|
215
|
-
* If set to `true`, the `allowInsertColumn` option adds the following menu items to the [context menu](@/guides/accessories-and-menus/context-menu.md):
|
215
|
+
* 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):
|
216
216
|
* - **Insert column left**
|
217
217
|
* - **Insert column right**
|
218
218
|
*
|
@@ -229,7 +229,7 @@ export default (() => {
|
|
229
229
|
*/
|
230
230
|
allowInsertColumn: true,
|
231
231
|
/**
|
232
|
-
* If set to `true`, the `allowInsertRow` option adds the following menu items to the [context menu](@/guides/accessories-and-menus/context-menu.md):
|
232
|
+
* 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):
|
233
233
|
* - **Insert row above**
|
234
234
|
* - **Insert row below**
|
235
235
|
*
|
@@ -247,21 +247,21 @@ export default (() => {
|
|
247
247
|
allowInsertRow: true,
|
248
248
|
/**
|
249
249
|
* The `allowInvalid` option determines whether Handsontable accepts values
|
250
|
-
* that were marked as `invalid` by the [cell validator](@/guides/cell-functions/cell-validator.md).
|
250
|
+
* that were marked as `invalid` by the [cell validator](@/guides/cell-functions/cell-validator/cell-validator.md).
|
251
251
|
*
|
252
252
|
* You can set the `allowInvalid` option to one of the following:
|
253
253
|
*
|
254
254
|
* | Setting | Description |
|
255
255
|
* | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
256
|
-
* | `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 |
|
257
|
-
* | `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 |
|
256
|
+
* | `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 |
|
257
|
+
* | `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 |
|
258
258
|
*
|
259
|
-
* 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).
|
259
|
+
* 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).
|
260
260
|
*
|
261
261
|
* Read more:
|
262
|
-
* - [Cell validator](@/guides/cell-functions/cell-validator.md)
|
263
|
-
* - [Cell editor](@/guides/cell-functions/cell-editor.md)
|
264
|
-
* - [Autocomplete strict mode](@/guides/cell-types/autocomplete-cell-type.md#autocomplete-strict-mode)
|
262
|
+
* - [Cell validator](@/guides/cell-functions/cell-validator/cell-validator.md)
|
263
|
+
* - [Cell editor](@/guides/cell-functions/cell-editor/cell-editor.md)
|
264
|
+
* - [Autocomplete strict mode](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md#autocomplete-strict-mode)
|
265
265
|
*
|
266
266
|
* @memberof Options#
|
267
267
|
* @type {boolean}
|
@@ -278,11 +278,11 @@ export default (() => {
|
|
278
278
|
*/
|
279
279
|
allowInvalid: true,
|
280
280
|
/**
|
281
|
-
* If set to `true`, the `allowRemoveColumn` option adds the following menu items to the [context menu](@/guides/accessories-and-menus/context-menu.md):
|
281
|
+
* 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):
|
282
282
|
* - **Remove column**
|
283
283
|
*
|
284
284
|
* Read more:
|
285
|
-
* - [Context menu](@/guides/accessories-and-menus/context-menu.md)
|
285
|
+
* - [Context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)
|
286
286
|
*
|
287
287
|
* @memberof Options#
|
288
288
|
* @type {boolean}
|
@@ -297,11 +297,11 @@ export default (() => {
|
|
297
297
|
*/
|
298
298
|
allowRemoveColumn: true,
|
299
299
|
/**
|
300
|
-
* If set to `true`, the `allowRemoveRow` option adds the following menu items to the [context menu](@/guides/accessories-and-menus/context-menu.md):
|
300
|
+
* 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):
|
301
301
|
* - **Remove row**
|
302
302
|
*
|
303
303
|
* Read more:
|
304
|
-
* - [Context menu](@/guides/accessories-and-menus/context-menu.md)
|
304
|
+
* - [Context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)
|
305
305
|
*
|
306
306
|
* @memberof Options#
|
307
307
|
* @type {boolean}
|
@@ -492,13 +492,13 @@ export default (() => {
|
|
492
492
|
*/
|
493
493
|
bindRowsWithHeaders: undefined,
|
494
494
|
/**
|
495
|
-
* The `cell` option lets you apply [configuration options](@/guides/getting-started/configuration-options.md) to individual cells.
|
495
|
+
* The `cell` option lets you apply [configuration options](@/guides/getting-started/configuration-options/configuration-options.md) to individual cells.
|
496
496
|
*
|
497
|
-
* The `cell` option overwrites the [top-level grid options](@/guides/getting-started/configuration-options.md#set-grid-options),
|
497
|
+
* The `cell` option overwrites the [top-level grid options](@/guides/getting-started/configuration-options/configuration-options.md#set-grid-options),
|
498
498
|
* and the [`columns`](#columns) options.
|
499
499
|
*
|
500
500
|
* Read more:
|
501
|
-
* - [Configuration options: Setting cell options](@/guides/getting-started/configuration-options.md#set-cell-options)
|
501
|
+
* - [Configuration options: Setting cell options](@/guides/getting-started/configuration-options/configuration-options.md#set-cell-options)
|
502
502
|
* - [`columns`](#columns)
|
503
503
|
*
|
504
504
|
* @memberof Options#
|
@@ -522,7 +522,7 @@ export default (() => {
|
|
522
522
|
cell: [],
|
523
523
|
/**
|
524
524
|
* @description
|
525
|
-
* The `cells` option lets you apply any other [configuration options](@/guides/getting-started/configuration-options.md) to
|
525
|
+
* The `cells` option lets you apply any other [configuration options](@/guides/getting-started/configuration-options/configuration-options.md) to
|
526
526
|
* individual grid elements (columns, rows, cells), based on any logic you implement.
|
527
527
|
*
|
528
528
|
* The `cells` option overwrites all other options (including options set by [`columns`](#columns) and [`cell`](#cell)).
|
@@ -532,11 +532,11 @@ export default (() => {
|
|
532
532
|
* | --------- | -------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
533
533
|
* | `row` | Yes | Number | A physical row index |
|
534
534
|
* | `column` | Yes | Number | A physical column index |
|
535
|
-
* | `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. |
|
535
|
+
* | `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. |
|
536
536
|
*
|
537
537
|
* Read more:
|
538
|
-
* - [Configuration options: Implementing custom logic](@/guides/getting-started/configuration-options.md#implement-custom-logic)
|
539
|
-
* - [Configuration options: Setting row options](@/guides/getting-started/configuration-options.md#set-row-options)
|
538
|
+
* - [Configuration options: Implementing custom logic](@/guides/getting-started/configuration-options/configuration-options.md#implement-custom-logic)
|
539
|
+
* - [Configuration options: Setting row options](@/guides/getting-started/configuration-options/configuration-options.md#set-row-options)
|
540
540
|
* - [`columns`](#columns)
|
541
541
|
* - [`cell`](#cell)
|
542
542
|
*
|
@@ -564,17 +564,17 @@ export default (() => {
|
|
564
564
|
cells: undefined,
|
565
565
|
/**
|
566
566
|
* The `checkedTemplate` option lets you configure what value
|
567
|
-
* a checked [`checkbox`](@/guides/cell-types/checkbox-cell-type.md) cell has.
|
567
|
+
* a checked [`checkbox`](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md) cell has.
|
568
568
|
*
|
569
569
|
* You can set the `checkedTemplate` option to one of the following:
|
570
570
|
*
|
571
571
|
* | Setting | Description |
|
572
572
|
* | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
573
|
-
* | `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` |
|
574
|
-
* | 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 |
|
573
|
+
* | `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` |
|
574
|
+
* | 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 |
|
575
575
|
*
|
576
576
|
* Read more:
|
577
|
-
* - [Checkbox cell type: Checkbox template](@/guides/cell-types/checkbox-cell-type.md#checkbox-template)
|
577
|
+
* - [Checkbox cell type: Checkbox template](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md#checkbox-template)
|
578
578
|
* - [`getDataAtCell()`](@/api/core.md#getDataAtCell)
|
579
579
|
* - [`uncheckedTemplate`](#uncheckedTemplate)
|
580
580
|
*
|
@@ -615,14 +615,14 @@ export default (() => {
|
|
615
615
|
* | An array of strings | Add multiple CSS class names to every currently-selected element |
|
616
616
|
*
|
617
617
|
* ::: tip
|
618
|
-
* Don't change the `className` metadata of the [column summary](@/guides/columns/column-summary.md) row.
|
618
|
+
* Don't change the `className` metadata of the [column summary](@/guides/columns/column-summary/column-summary.md) row.
|
619
619
|
* To style the summary row, use the class name assigned automatically by the [`ColumnSummary`](@/api/columnSummary.md) plugin: `columnSummaryResult`.
|
620
620
|
* :::
|
621
621
|
*
|
622
|
-
* To apply different CSS class names on different levels, use Handsontable's [cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration).
|
622
|
+
* To apply different CSS class names on different levels, use Handsontable's [cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration).
|
623
623
|
*
|
624
624
|
* Read more:
|
625
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
625
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
626
626
|
* - [`currentRowClassName`](#currentRowClassName)
|
627
627
|
* - [`currentColClassName`](#currentColClassName)
|
628
628
|
* - [`currentHeaderClassName`](#currentHeaderClassName)
|
@@ -664,7 +664,7 @@ export default (() => {
|
|
664
664
|
* | A function | Define your own column headers, using a function |
|
665
665
|
*
|
666
666
|
* Read more:
|
667
|
-
* - [Column header](@/guides/columns/column-header.md)
|
667
|
+
* - [Column header](@/guides/columns/column-header/column-header.md)
|
668
668
|
*
|
669
669
|
* @memberof Options#
|
670
670
|
* @type {boolean|string[]|Function}
|
@@ -747,18 +747,18 @@ export default (() => {
|
|
747
747
|
columnHeaderHeight: undefined,
|
748
748
|
/**
|
749
749
|
* @description
|
750
|
-
* The `columns` option lets you apply any other [configuration options](@/guides/getting-started/configuration-options.md) to individual columns (or ranges of columns).
|
750
|
+
* 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).
|
751
751
|
*
|
752
752
|
* You can set the `columns` option to one of the following:
|
753
753
|
* - An array of objects (each object represents one column)
|
754
754
|
* - A function that returns an array of objects
|
755
755
|
*
|
756
|
-
* The `columns` option overwrites the [top-level grid options](@/guides/getting-started/configuration-options.md#set-grid-options).
|
756
|
+
* The `columns` option overwrites the [top-level grid options](@/guides/getting-started/configuration-options/configuration-options.md#set-grid-options).
|
757
757
|
*
|
758
758
|
* When you use `columns`, the [`startCols`](#startCols), [`minCols`](#minCols), and [`maxCols`](#maxCols) options are ignored.
|
759
759
|
*
|
760
760
|
* Read more:
|
761
|
-
* - [Configuration options: Setting column options](@/guides/getting-started/configuration-options.md#set-column-options)
|
761
|
+
* - [Configuration options: Setting column options](@/guides/getting-started/configuration-options/configuration-options.md#set-column-options)
|
762
762
|
* - [`startCols`](#startCols)
|
763
763
|
* - [`minCols`](#minCols)
|
764
764
|
* - [`maxCols`](#maxCols)
|
@@ -818,7 +818,7 @@ export default (() => {
|
|
818
818
|
* | `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 |
|
819
819
|
* | `headerAction` | `true`: Enable clicking on the column header to sort the column<br>`false`: Disable clicking on the column header to sort the column |
|
820
820
|
* | `sortEmptyCells` | `true`: Sort empty cells as well<br>`false`: Place empty cells at the end |
|
821
|
-
* | `compareFunctionFactory` | A [custom compare function](@/guides/rows/rows-sorting.md#add-a-custom-comparator) |
|
821
|
+
* | `compareFunctionFactory` | A [custom compare function](@/guides/rows/rows-sorting/rows-sorting.md#add-a-custom-comparator) |
|
822
822
|
*
|
823
823
|
* If you set the `columnSorting` option to an object,
|
824
824
|
* you can also sort individual columns at Handsontable's initialization.
|
@@ -831,8 +831,8 @@ export default (() => {
|
|
831
831
|
* | `sortOrder` | `'asc'` \| `'desc'` | The sorting order:<br>`'asc'`: ascending<br>`'desc'`: descending |
|
832
832
|
*
|
833
833
|
* Read more:
|
834
|
-
* - [Rows sorting](@/guides/rows/rows-sorting.md)
|
835
|
-
* - [Rows sorting: Custom compare functions](@/guides/rows/rows-sorting.md#add-a-custom-comparator)
|
834
|
+
* - [Rows sorting](@/guides/rows/rows-sorting/rows-sorting.md)
|
835
|
+
* - [Rows sorting: Custom compare functions](@/guides/rows/rows-sorting/rows-sorting.md#add-a-custom-comparator)
|
836
836
|
* - [`multiColumnSorting`](#multiColumnSorting)
|
837
837
|
*
|
838
838
|
* @memberof Options#
|
@@ -886,20 +886,20 @@ export default (() => {
|
|
886
886
|
*
|
887
887
|
* | Property | Possible values | Description |
|
888
888
|
* | ------------------------ | ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
889
|
-
* | `sourceColumn` | A number | [Column to summarize](@/guides/columns/column-summary.md#step-2-select-cells-that-you-want-to-summarize) |
|
890
|
-
* | `ranges` | An array | [Ranges of rows to summarize](@/guides/columns/column-summary.md#step-2-select-cells-that-you-want-to-summarize) |
|
891
|
-
* | `type` | `'sum'` \| `'min'` \| `'max'` \| `'count'` \| `'average'` \| `'custom'` | [Summary function](@/guides/columns/column-summary.md#step-3-calculate-your-summary) |
|
892
|
-
* | `destinationRow` | A number | [Destination cell's row coordinate](@/guides/columns/column-summary.md#step-4-provide-the-destination-cell-s-coordinates) |
|
893
|
-
* | `destinationColumn` | A number | [Destination cell's column coordinate](@/guides/columns/column-summary.md#step-4-provide-the-destination-cell-s-coordinates) |
|
894
|
-
* | `forceNumeric` | `true` \| `false` | [Treat non-numerics as numerics](@/guides/columns/column-summary.md#force-numeric-values) |
|
895
|
-
* | `reversedRowCoords` | `true` \| `false` | [Reverse row coordinates](@/guides/columns/column-summary.md#step-5-make-room-for-the-destination-cell) |
|
896
|
-
* | `suppressDataTypeErrors` | `true` \| `false` | [Suppress data type errors](@/guides/columns/column-summary.md#throw-data-type-errors) |
|
889
|
+
* | `sourceColumn` | A number | [Column to summarize](@/guides/columns/column-summary/column-summary.md#step-2-select-cells-that-you-want-to-summarize) |
|
890
|
+
* | `ranges` | An array | [Ranges of rows to summarize](@/guides/columns/column-summary/column-summary.md#step-2-select-cells-that-you-want-to-summarize) |
|
891
|
+
* | `type` | `'sum'` \| `'min'` \| `'max'` \| `'count'` \| `'average'` \| `'custom'` | [Summary function](@/guides/columns/column-summary/column-summary.md#step-3-calculate-your-summary) |
|
892
|
+
* | `destinationRow` | A number | [Destination cell's row coordinate](@/guides/columns/column-summary/column-summary.md#step-4-provide-the-destination-cell-s-coordinates) |
|
893
|
+
* | `destinationColumn` | A number | [Destination cell's column coordinate](@/guides/columns/column-summary/column-summary.md#step-4-provide-the-destination-cell-s-coordinates) |
|
894
|
+
* | `forceNumeric` | `true` \| `false` | [Treat non-numerics as numerics](@/guides/columns/column-summary/column-summary.md#force-numeric-values) |
|
895
|
+
* | `reversedRowCoords` | `true` \| `false` | [Reverse row coordinates](@/guides/columns/column-summary/column-summary.md#step-5-make-room-for-the-destination-cell) |
|
896
|
+
* | `suppressDataTypeErrors` | `true` \| `false` | [Suppress data type errors](@/guides/columns/column-summary/column-summary.md#throw-data-type-errors) |
|
897
897
|
* | `readOnly` | `true` \| `false` | Make summary cell read-only |
|
898
|
-
* | `roundFloat` | `true` \| `false` \| A number | [Round summary result](@/guides/columns/column-summary.md#round-a-column-summary-result) |
|
899
|
-
* | `customFunction` | A function | [Custom summary function](@/guides/columns/column-summary.md#implement-a-custom-summary-function) |
|
898
|
+
* | `roundFloat` | `true` \| `false` \| A number | [Round summary result](@/guides/columns/column-summary/column-summary.md#round-a-column-summary-result) |
|
899
|
+
* | `customFunction` | A function | [Custom summary function](@/guides/columns/column-summary/column-summary.md#implement-a-custom-summary-function) |
|
900
900
|
*
|
901
901
|
* Read more:
|
902
|
-
* - [Column summary](@/guides/columns/column-summary.md)
|
902
|
+
* - [Column summary](@/guides/columns/column-summary/column-summary.md)
|
903
903
|
* - [Plugins: `ColumnSummary`](@/api/columnSummary.md)
|
904
904
|
*
|
905
905
|
* @memberof Options#
|
@@ -950,7 +950,7 @@ export default (() => {
|
|
950
950
|
* which may cut longer columns names.
|
951
951
|
*
|
952
952
|
* Read more:
|
953
|
-
* - [Column width](@/guides/columns/column-width.md)
|
953
|
+
* - [Column width](@/guides/columns/column-width/column-width.md)
|
954
954
|
* - [Hooks: `modifyColWidth`](@/api/hooks.md#modifyColWidth)
|
955
955
|
* - [`autoColumnSize`](#autoColumnSize)
|
956
956
|
*
|
@@ -985,7 +985,7 @@ export default (() => {
|
|
985
985
|
* that have comments.
|
986
986
|
*
|
987
987
|
* Read more:
|
988
|
-
* - [Comments](@/guides/cell-features/comments.md)
|
988
|
+
* - [Comments](@/guides/cell-features/comments/comments.md)
|
989
989
|
* - [`comments`](#comments)
|
990
990
|
* - [`readOnlyCellClassName`](#readOnlyCellClassName)
|
991
991
|
* - [`currentRowClassName`](#currentRowClassName)
|
@@ -1019,9 +1019,9 @@ export default (() => {
|
|
1019
1019
|
*
|
1020
1020
|
* | Setting | Description |
|
1021
1021
|
* | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
1022
|
-
* | `true` | - Enable the [`Comments`](@/api/comments.md) plugin<br>- Add comment menu items to the [context menu](@/guides/accessories-and-menus/context-menu.md) |
|
1022
|
+
* | `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) |
|
1023
1023
|
* | `false` | Disable the [`Comments`](@/api/comments.md) plugin |
|
1024
|
-
* | 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 |
|
1024
|
+
* | 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 |
|
1025
1025
|
*
|
1026
1026
|
* If you set the `comments` option to an object, you can configure the following comment options:
|
1027
1027
|
*
|
@@ -1032,8 +1032,8 @@ export default (() => {
|
|
1032
1032
|
* | `style` | An object | Set comment boxes' `width` and `height` (in pixels) |
|
1033
1033
|
*
|
1034
1034
|
* Read more:
|
1035
|
-
* - [Comments](@/guides/cell-features/comments.md)
|
1036
|
-
* - [Context menu](@/guides/accessories-and-menus/context-menu.md)
|
1035
|
+
* - [Comments](@/guides/cell-features/comments/comments.md)
|
1036
|
+
* - [Context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)
|
1037
1037
|
* - [`width`](#width)
|
1038
1038
|
* - [`height`](#height)
|
1039
1039
|
* - [`readOnly`](#readOnly)
|
@@ -1074,15 +1074,15 @@ export default (() => {
|
|
1074
1074
|
* | Setting | Description |
|
1075
1075
|
* | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
1076
1076
|
* | `false` | Disable the [`ContextMenu`](@/api/contextMenu.md) plugin |
|
1077
|
-
* | `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) |
|
1078
|
-
* | 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) |
|
1079
|
-
* | 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) |
|
1077
|
+
* | `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) |
|
1078
|
+
* | 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) |
|
1079
|
+
* | 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) |
|
1080
1080
|
*
|
1081
1081
|
* Read more:
|
1082
|
-
* - [Context menu](@/guides/accessories-and-menus/context-menu.md)
|
1083
|
-
* - [Context menu: Context menu with default options](@/guides/accessories-and-menus/context-menu.md#context-menu-with-default-options)
|
1084
|
-
* - [Context menu: Context menu with specific options](@/guides/accessories-and-menus/context-menu.md#context-menu-with-specific-options)
|
1085
|
-
* - [Context menu: Context menu with fully custom configuration options](@/guides/accessories-and-menus/context-menu.md#context-menu-with-a-fully-custom-configuration)
|
1082
|
+
* - [Context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)
|
1083
|
+
* - [Context menu: Context menu with default options](@/guides/accessories-and-menus/context-menu/context-menu.md#context-menu-with-default-options)
|
1084
|
+
* - [Context menu: Context menu with specific options](@/guides/accessories-and-menus/context-menu/context-menu.md#context-menu-with-specific-options)
|
1085
|
+
* - [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)
|
1086
1086
|
* - [Plugins: `ContextMenu`](@/api/contextMenu.md)
|
1087
1087
|
*
|
1088
1088
|
* @memberof Options#
|
@@ -1136,12 +1136,12 @@ export default (() => {
|
|
1136
1136
|
* | Setting | Description |
|
1137
1137
|
* | -------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
1138
1138
|
* | `true` (default) | - On pressing <kbd>**Ctrl**</kbd>/<kbd>**Cmd**</kbd>+<kbd>**C**</kbd>, add the cell's value to the clipboard |
|
1139
|
-
* | `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 |
|
1139
|
+
* | `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 |
|
1140
1140
|
*
|
1141
1141
|
* Read more:
|
1142
|
-
* - [Clipboard](@/guides/cell-features/clipboard.md)
|
1143
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
1144
|
-
* - [Password cell type](@/guides/cell-types/password-cell-type.md)
|
1142
|
+
* - [Clipboard](@/guides/cell-features/clipboard/clipboard.md)
|
1143
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
1144
|
+
* - [Password cell type](@/guides/cell-types/password-cell-type/password-cell-type.md)
|
1145
1145
|
*
|
1146
1146
|
* @memberof Options#
|
1147
1147
|
* @type {boolean}
|
@@ -1168,7 +1168,7 @@ export default (() => {
|
|
1168
1168
|
* // enable copying for specific cells
|
1169
1169
|
* cell: [
|
1170
1170
|
* {
|
1171
|
-
*
|
1171
|
+
* col: 0,
|
1172
1172
|
* row: 0,
|
1173
1173
|
* // disable copying for cell (0, 0)
|
1174
1174
|
* copyable: false,
|
@@ -1204,7 +1204,7 @@ export default (() => {
|
|
1204
1204
|
*
|
1205
1205
|
* Read more:
|
1206
1206
|
* - [Plugins: `CopyPaste`](@/api/copyPaste.md)
|
1207
|
-
* - [Guides: Clipboard](@/guides/cell-features/clipboard.md)
|
1207
|
+
* - [Guides: Clipboard](@/guides/cell-features/clipboard/clipboard.md)
|
1208
1208
|
*
|
1209
1209
|
* @memberof Options#
|
1210
1210
|
* @type {object|boolean}
|
@@ -1249,18 +1249,18 @@ export default (() => {
|
|
1249
1249
|
* The `correctFormat` option configures whether incorrectly-formatted times and dates are amended or not.
|
1250
1250
|
*
|
1251
1251
|
* When the user enters dates and times, Handsontable can automatically adjust their format
|
1252
|
-
* to match the [`dateFormat`](#dateFormat) and [`timeFormat`](@/guides/cell-types/time-cell-type.md) settings.
|
1252
|
+
* to match the [`dateFormat`](#dateFormat) and [`timeFormat`](@/guides/cell-types/time-cell-type/time-cell-type.md) settings.
|
1253
1253
|
*
|
1254
1254
|
* You can set the `correctFormat` option to one of the following:
|
1255
1255
|
*
|
1256
1256
|
* | Setting | Description |
|
1257
1257
|
* | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
1258
1258
|
* | `false` (default) | Don't correct the format of the entered date or time (treat the entered date or time as invalid) |
|
1259
|
-
* | `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 |
|
1259
|
+
* | `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 |
|
1260
1260
|
*
|
1261
1261
|
* Read more:
|
1262
|
-
* - [Date cell type](@/guides/cell-types/date-cell-type.md)
|
1263
|
-
* - [Time cell type](@/guides/cell-types/time-cell-type.md)
|
1262
|
+
* - [Date cell type](@/guides/cell-types/date-cell-type/date-cell-type.md)
|
1263
|
+
* - [Time cell type](@/guides/cell-types/time-cell-type/time-cell-type.md)
|
1264
1264
|
* - [`dateFormat`](#dateFormat)
|
1265
1265
|
*
|
1266
1266
|
* @memberof Options#
|
@@ -1383,7 +1383,7 @@ export default (() => {
|
|
1383
1383
|
* The `customBorders` option configures the [`CustomBorders`](@/api/customBorders.md) plugin.
|
1384
1384
|
*
|
1385
1385
|
* To enable the [`CustomBorders`](@/api/customBorders.md) plugin
|
1386
|
-
* (and add its menu items to the [context menu](@/guides/accessories-and-menus/context-menu.md)),
|
1386
|
+
* (and add its menu items to the [context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)),
|
1387
1387
|
* set the `customBorders` option to `true`.
|
1388
1388
|
*
|
1389
1389
|
* To enable the [`CustomBorders`](@/api/customBorders.md) plugin
|
@@ -1395,8 +1395,8 @@ export default (() => {
|
|
1395
1395
|
* | -------- | ------------------ | ---------------------------------- | ----------------------------------------------------------------- |
|
1396
1396
|
* | `row` | - | `row`: Number | The cell's row coordinate. |
|
1397
1397
|
* | `col` | - | `col`: Number | The cell's column coordinate. |
|
1398
|
-
* | `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. |
|
1399
|
-
* | `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. |
|
1398
|
+
* | `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. |
|
1399
|
+
* | `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. |
|
1400
1400
|
* | `top` | `width`<br>`color` | `width`: Number<br>`color`: String | Sets the width (`width`) and color (`color`) of the top border. |
|
1401
1401
|
* | `bottom` | `width`<br>`color` | `width`: Number<br>`color`: String | Sets the width (`width`) and color (`color`) of the bottom border. |
|
1402
1402
|
*
|
@@ -1407,17 +1407,17 @@ export default (() => {
|
|
1407
1407
|
*
|
1408
1408
|
* | Property | Sub-properties | Types | Description |
|
1409
1409
|
* | -------- | -------------------------------------------- | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
1410
|
-
* | `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. |
|
1411
|
-
* | `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. |
|
1412
|
-
* | `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. |
|
1410
|
+
* | `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. |
|
1411
|
+
* | `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. |
|
1412
|
+
* | `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. |
|
1413
1413
|
* | `top` | `width`<br>`color` | `width`: Number<br>`color`: String | Sets the width (`width`) and color (`color`) of the top border. |
|
1414
1414
|
* | `bottom` | `width`<br>`color` | `width`: Number<br>`color`: String | Sets the width (`width`) and color (`color`) of the bottom border. |
|
1415
1415
|
*
|
1416
1416
|
* Read more:
|
1417
|
-
* - [Formatting cells: Custom cell borders](@/guides/cell-features/formatting-cells.md#custom-cell-borders)
|
1418
|
-
* - [Context menu](@/guides/accessories-and-menus/context-menu.md)
|
1417
|
+
* - [Formatting cells: Custom cell borders](@/guides/cell-features/formatting-cells/formatting-cells.md#custom-cell-borders)
|
1418
|
+
* - [Context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)
|
1419
1419
|
* - [Plugins: `CustomBorders`](@/api/customBorders.md)
|
1420
|
-
* - [Layout direction](@/guides/internationalization/layout-direction.md)
|
1420
|
+
* - [Layout direction](@/guides/internationalization/layout-direction/layout-direction.md)
|
1421
1421
|
* - [`layoutDirection`](#layoutDirection)
|
1422
1422
|
*
|
1423
1423
|
* @memberof Options#
|
@@ -1492,18 +1492,18 @@ export default (() => {
|
|
1492
1492
|
customBorders: false,
|
1493
1493
|
/**
|
1494
1494
|
* @description
|
1495
|
-
* The `data` option sets the initial [data](@/guides/getting-started/binding-to-data.md) of your Handsontable instance.
|
1495
|
+
* The `data` option sets the initial [data](@/guides/getting-started/binding-to-data/binding-to-data.md) of your Handsontable instance.
|
1496
1496
|
*
|
1497
1497
|
* 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).
|
1498
1498
|
*
|
1499
1499
|
* You can set the `data` option:
|
1500
|
-
* - Either to an [array of arrays](@/guides/getting-started/binding-to-data.md#array-of-arrays).
|
1501
|
-
* - Or to an [array of objects](@/guides/getting-started/binding-to-data.md#array-of-objects).
|
1500
|
+
* - Either to an [array of arrays](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-arrays).
|
1501
|
+
* - Or to an [array of objects](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-objects).
|
1502
1502
|
*
|
1503
1503
|
* If you don't set the `data` option (or set it to `null`), Handsontable renders as an empty 5x5 grid by default.
|
1504
1504
|
*
|
1505
1505
|
* Read more:
|
1506
|
-
* - [Binding to data](@/guides/getting-started/binding-to-data.md)
|
1506
|
+
* - [Binding to data](@/guides/getting-started/binding-to-data/binding-to-data.md)
|
1507
1507
|
* - [`dataSchema`](#dataSchema)
|
1508
1508
|
* - [`startRows`](#startRows)
|
1509
1509
|
* - [`startCols`](#startCols)
|
@@ -1535,7 +1535,7 @@ export default (() => {
|
|
1535
1535
|
data: undefined,
|
1536
1536
|
/**
|
1537
1537
|
* @description
|
1538
|
-
* When the [`data`](#data) option is set to an [array of objects](@/guides/getting-started/binding-to-data.md#array-of-objects)
|
1538
|
+
* 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)
|
1539
1539
|
* (or is empty), the `dataSchema` option defines the structure of new rows.
|
1540
1540
|
*
|
1541
1541
|
* Using the `dataSchema` option, you can start out with an empty grid.
|
@@ -1545,8 +1545,8 @@ export default (() => {
|
|
1545
1545
|
* - A function
|
1546
1546
|
*
|
1547
1547
|
* Read more:
|
1548
|
-
* - [Binding to data: Array of objects with custom data schema](@/guides/getting-started/binding-to-data.md#array-of-objects-with-custom-data-schema)
|
1549
|
-
* - [Binding to data: Function data source and schema](@/guides/getting-started/binding-to-data.md#function-data-source-and-schema)
|
1548
|
+
* - [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)
|
1549
|
+
* - [Binding to data: Function data source and schema](@/guides/getting-started/binding-to-data/binding-to-data.md#function-data-source-and-schema)
|
1550
1550
|
* - [`data`](#data)
|
1551
1551
|
*
|
1552
1552
|
* @memberof Options#
|
@@ -1572,14 +1572,14 @@ export default (() => {
|
|
1572
1572
|
*/
|
1573
1573
|
dataSchema: undefined,
|
1574
1574
|
/**
|
1575
|
-
* The `dateFormat` option configures the date format accepted by [`date`](@/guides/cell-types/date-cell-type.md) cells.
|
1575
|
+
* The `dateFormat` option configures the date format accepted by [`date`](@/guides/cell-types/date-cell-type/date-cell-type.md) cells.
|
1576
1576
|
*
|
1577
1577
|
* You can set the `dateFormat` option to a string with a proper date format. The default value is: `'DD/MM/YYYY'`.
|
1578
1578
|
*
|
1579
1579
|
* To automatically correct dates whose format doesn't match the `dateFormat` setting, use the [`correctFormat`](#correctFormat) option.
|
1580
1580
|
*
|
1581
1581
|
* Read more:
|
1582
|
-
* - [Date cell type](@/guides/cell-types/date-cell-type.md)
|
1582
|
+
* - [Date cell type](@/guides/cell-types/date-cell-type/date-cell-type.md)
|
1583
1583
|
* - [`correctFormat`](#correctFormat)
|
1584
1584
|
* - [`defaultDate`](#defaultDate)
|
1585
1585
|
*
|
@@ -1602,16 +1602,16 @@ export default (() => {
|
|
1602
1602
|
*/
|
1603
1603
|
dateFormat: 'DD/MM/YYYY',
|
1604
1604
|
/**
|
1605
|
-
* 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).
|
1605
|
+
* 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).
|
1606
1606
|
*
|
1607
1607
|
* 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),
|
1608
|
-
* except for the following, which are always overwritten by the `date` [cell editor](@/guides/cell-functions/cell-editor.md):
|
1608
|
+
* except for the following, which are always overwritten by the `date` [cell editor](@/guides/cell-functions/cell-editor/cell-editor.md):
|
1609
1609
|
* - `bound`
|
1610
1610
|
* - `container`
|
1611
1611
|
* - `field`
|
1612
1612
|
* - `trigger`
|
1613
1613
|
*
|
1614
|
-
* 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:
|
1614
|
+
* 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:
|
1615
1615
|
*
|
1616
1616
|
* | Pikaday option | Handsontable's setting |
|
1617
1617
|
* | -------------------- | ---------------------- |
|
@@ -1621,7 +1621,7 @@ export default (() => {
|
|
1621
1621
|
* Read more:
|
1622
1622
|
* - [`editor`](#editor)
|
1623
1623
|
* - [`dateFormat`](#dateFormat)
|
1624
|
-
* - [Cell editor](@/guides/cell-functions/cell-editor.md)
|
1624
|
+
* - [Cell editor](@/guides/cell-functions/cell-editor/cell-editor.md)
|
1625
1625
|
* - [All Pikaday options →](https://github.com/Pikaday/Pikaday/tree/1.8.2#configuration)
|
1626
1626
|
*
|
1627
1627
|
* @memberof Options#
|
@@ -1632,12 +1632,12 @@ export default (() => {
|
|
1632
1632
|
datePickerConfig: undefined,
|
1633
1633
|
/**
|
1634
1634
|
* The `defaultDate` option configures the date displayed
|
1635
|
-
* in empty [`date`](@/guides/cell-types/date-cell-type.md) cells.
|
1635
|
+
* in empty [`date`](@/guides/cell-types/date-cell-type/date-cell-type.md) cells.
|
1636
1636
|
*
|
1637
1637
|
* You can set the `defaultDate` option to a string.
|
1638
1638
|
*
|
1639
1639
|
* Read more:
|
1640
|
-
* - [Date cell type](@/guides/cell-types/date-cell-type.md)
|
1640
|
+
* - [Date cell type](@/guides/cell-types/date-cell-type/date-cell-type.md)
|
1641
1641
|
* - [`dateFormat`](#dateFormat)
|
1642
1642
|
*
|
1643
1643
|
* @memberof Options#
|
@@ -1661,7 +1661,7 @@ export default (() => {
|
|
1661
1661
|
/**
|
1662
1662
|
* @description
|
1663
1663
|
* The `disableVisualSelection` option configures how
|
1664
|
-
* [selection](@/guides/cell-features/selection.md) is shown.
|
1664
|
+
* [selection](@/guides/cell-features/selection/selection.md) is shown.
|
1665
1665
|
*
|
1666
1666
|
* You can set the `disableVisualSelection` option to one of the following:
|
1667
1667
|
*
|
@@ -1675,7 +1675,7 @@ export default (() => {
|
|
1675
1675
|
* | An array | A combination of `'current'`, `'area'`, and/or `'header'` |
|
1676
1676
|
*
|
1677
1677
|
* Read more:
|
1678
|
-
* - [Selection](@/guides/cell-features/selection.md)
|
1678
|
+
* - [Selection](@/guides/cell-features/selection/selection.md)
|
1679
1679
|
*
|
1680
1680
|
* @memberof Options#
|
1681
1681
|
* @type {boolean|string|string[]}
|
@@ -1735,12 +1735,12 @@ export default (() => {
|
|
1735
1735
|
* | Setting | Description |
|
1736
1736
|
* | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
1737
1737
|
* | `false` | Disable the [`DropdownMenu`](@/api/dropdownMenu.md) plugin |
|
1738
|
-
* | `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) |
|
1739
|
-
* | 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) |
|
1738
|
+
* | `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) |
|
1739
|
+
* | 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) |
|
1740
1740
|
* | An object | - Enable the [`DropdownMenu`](@/api/dropdownMenu.md) plugin<br>- Apply a custom dropdown menu configuration |
|
1741
1741
|
*
|
1742
1742
|
* Read more:
|
1743
|
-
* - [Context menu](@/guides/accessories-and-menus/context-menu.md)
|
1743
|
+
* - [Context menu](@/guides/accessories-and-menus/context-menu/context-menu.md)
|
1744
1744
|
* - [Plugins: `DropdownMenu`](@/api/dropdownMenu.md)
|
1745
1745
|
*
|
1746
1746
|
* @memberof Options#
|
@@ -1756,7 +1756,7 @@ export default (() => {
|
|
1756
1756
|
*
|
1757
1757
|
* // enable the `DropdownMenu` plugin
|
1758
1758
|
* // and modify individual context menu options
|
1759
|
-
* dropdownMenu: ['
|
1759
|
+
* dropdownMenu: ['---------', 'undo', 'redo'],
|
1760
1760
|
*
|
1761
1761
|
* // enable the `DropdownMenu` plugin
|
1762
1762
|
* // and apply a custom dropdown menu configuration
|
@@ -1786,13 +1786,13 @@ export default (() => {
|
|
1786
1786
|
*/
|
1787
1787
|
dropdownMenu: undefined,
|
1788
1788
|
/**
|
1789
|
-
* The `editor` option sets a [cell editor](@/guides/cell-functions/cell-editor.md) for a cell.
|
1789
|
+
* The `editor` option sets a [cell editor](@/guides/cell-functions/cell-editor/cell-editor.md) for a cell.
|
1790
1790
|
*
|
1791
|
-
* You can set the `editor` option to one of the following [cell editor aliases](@/guides/cell-functions/cell-editor.md):
|
1791
|
+
* You can set the `editor` option to one of the following [cell editor aliases](@/guides/cell-functions/cell-editor/cell-editor.md):
|
1792
1792
|
*
|
1793
1793
|
* | Alias | Cell editor function |
|
1794
1794
|
* | ------------------- | -------------------------------------------------------------------------- |
|
1795
|
-
* | A custom alias | Your [custom cell editor](@/guides/cell-functions/cell-editor.md) function |
|
1795
|
+
* | A custom alias | Your [custom cell editor](@/guides/cell-functions/cell-editor/cell-editor.md) function |
|
1796
1796
|
* | `'autocomplete'` | `AutocompleteEditor` |
|
1797
1797
|
* | `'base'` | `BaseEditor` |
|
1798
1798
|
* | `'checkbox'` | `CheckboxEditor` |
|
@@ -1814,9 +1814,9 @@ export default (() => {
|
|
1814
1814
|
* options all at once, use the [`type`](#type) option.
|
1815
1815
|
*
|
1816
1816
|
* Read more:
|
1817
|
-
* - [Cell editor](@/guides/cell-functions/cell-editor.md)
|
1818
|
-
* - [Cell type](@/guides/cell-types/cell-type.md)
|
1819
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
1817
|
+
* - [Cell editor](@/guides/cell-functions/cell-editor/cell-editor.md)
|
1818
|
+
* - [Cell type](@/guides/cell-types/cell-type/cell-type.md)
|
1819
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
1820
1820
|
* - [`type`](#type)
|
1821
1821
|
*
|
1822
1822
|
* @memberof Options#
|
@@ -1936,7 +1936,7 @@ export default (() => {
|
|
1936
1936
|
* | `direction` | `'vertical'` \| `'horizontal'` | `'vertical'`: Enable vertical autofill<br>`'horizontal'`: Enable horizontal autofill |
|
1937
1937
|
*
|
1938
1938
|
* Read more:
|
1939
|
-
* - [AutoFill values](@/guides/cell-features/autofill-values.md)
|
1939
|
+
* - [AutoFill values](@/guides/cell-features/autofill-values/autofill-values.md)
|
1940
1940
|
*
|
1941
1941
|
* @memberof Options#
|
1942
1942
|
* @type {boolean|string|object}
|
@@ -1975,7 +1975,7 @@ export default (() => {
|
|
1975
1975
|
autoInsertRow: false
|
1976
1976
|
},
|
1977
1977
|
/**
|
1978
|
-
* The `filter` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md) cells'
|
1978
|
+
* The `filter` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) cells'
|
1979
1979
|
* lists are updated by the end user's input.
|
1980
1980
|
*
|
1981
1981
|
* You can set the `filter` option to one of the following:
|
@@ -1986,7 +1986,7 @@ export default (() => {
|
|
1986
1986
|
* | `false` | When the end user types into the input area, all options are displayed<br>(options matching the input are put in bold |
|
1987
1987
|
*
|
1988
1988
|
* Read more:
|
1989
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
1989
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
1990
1990
|
* - [`source`](#source)
|
1991
1991
|
* - [`filteringCaseSensitive`](#filteringCaseSensitive)
|
1992
1992
|
*
|
@@ -2011,18 +2011,18 @@ export default (() => {
|
|
2011
2011
|
*/
|
2012
2012
|
filter: true,
|
2013
2013
|
/**
|
2014
|
-
* The `filteringCaseSensitive` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md) cells'
|
2014
|
+
* The `filteringCaseSensitive` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) cells'
|
2015
2015
|
* input is case-sensitive.
|
2016
2016
|
*
|
2017
2017
|
* You can set the `filteringCaseSensitive` option to one of the following:
|
2018
2018
|
*
|
2019
2019
|
* | Setting | Description |
|
2020
2020
|
* | ----------------- | -------------------------------------------------------------------------------------------------- |
|
2021
|
-
* | `false` (default) | [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md) cells' input is not case-sensitive |
|
2022
|
-
* | `true` | [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md) cells' input is case-sensitive |
|
2021
|
+
* | `false` (default) | [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) cells' input is not case-sensitive |
|
2022
|
+
* | `true` | [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) cells' input is case-sensitive |
|
2023
2023
|
*
|
2024
2024
|
* Read more:
|
2025
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
2025
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
2026
2026
|
* - [`source`](#source)
|
2027
2027
|
* - [`filter`](#filter)
|
2028
2028
|
*
|
@@ -2055,7 +2055,7 @@ export default (() => {
|
|
2055
2055
|
* | `true` | Enable the [`Filters`](@/api/filters.md) plugin |
|
2056
2056
|
*
|
2057
2057
|
* Read more:
|
2058
|
-
* - [Column filter](@/guides/columns/column-filter.md)
|
2058
|
+
* - [Column filter](@/guides/columns/column-filter/column-filter.md)
|
2059
2059
|
* - [Plugins: `Filters`](@/api/filters.md)
|
2060
2060
|
* - [`dropdownMenu`](#dropdownMenu)
|
2061
2061
|
*
|
@@ -2074,9 +2074,9 @@ export default (() => {
|
|
2074
2074
|
/**
|
2075
2075
|
* `fixedColumnsLeft` is a legacy option.
|
2076
2076
|
*
|
2077
|
-
* If your grid's [layout direction](@/guides/internationalization/layout-direction.md) is LTR (default), `fixedColumnsLeft` acts like the [`fixedColumnsStart`](#fixedColumnsStart) option.
|
2077
|
+
* If your grid's [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) is LTR (default), `fixedColumnsLeft` acts like the [`fixedColumnsStart`](#fixedColumnsStart) option.
|
2078
2078
|
*
|
2079
|
-
* If your grid's [layout direction](@/guides/internationalization/layout-direction.md) is RTL, using `fixedColumnsLeft` throws an error.
|
2079
|
+
* If your grid's [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) is RTL, using `fixedColumnsLeft` throws an error.
|
2080
2080
|
*
|
2081
2081
|
* Use [`fixedColumnsStart`](#fixedColumnsStart), which works in any layout direction.
|
2082
2082
|
*
|
@@ -2096,13 +2096,13 @@ export default (() => {
|
|
2096
2096
|
*/
|
2097
2097
|
fixedColumnsLeft: 0,
|
2098
2098
|
/**
|
2099
|
-
* 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.
|
2099
|
+
* 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.
|
2100
2100
|
*
|
2101
|
-
* 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.
|
2101
|
+
* 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.
|
2102
2102
|
*
|
2103
2103
|
* Read more:
|
2104
|
-
* - [Column freezing](@/guides/columns/column-freezing.md)
|
2105
|
-
* - [Layout direction](@/guides/internationalization/layout-direction.md)
|
2104
|
+
* - [Column freezing](@/guides/columns/column-freezing/column-freezing.md)
|
2105
|
+
* - [Layout direction](@/guides/internationalization/layout-direction/layout-direction.md)
|
2106
2106
|
* - [`fixedColumnsLeft`](#fixedcolumnsleft)
|
2107
2107
|
* - [`layoutDirection`](#layoutDirection)
|
2108
2108
|
*
|
@@ -2134,11 +2134,11 @@ export default (() => {
|
|
2134
2134
|
*/
|
2135
2135
|
fixedColumnsStart: 0,
|
2136
2136
|
/**
|
2137
|
-
* The `fixedRowsBottom` option sets the number of [frozen rows](@/guides/rows/row-freezing.md)
|
2137
|
+
* The `fixedRowsBottom` option sets the number of [frozen rows](@/guides/rows/row-freezing/row-freezing.md)
|
2138
2138
|
* at the bottom of the grid.
|
2139
2139
|
*
|
2140
2140
|
* Read more:
|
2141
|
-
* - [Row freezing](@/guides/rows/row-freezing.md)
|
2141
|
+
* - [Row freezing](@/guides/rows/row-freezing/row-freezing.md)
|
2142
2142
|
*
|
2143
2143
|
* @memberof Options#
|
2144
2144
|
* @type {number}
|
@@ -2153,10 +2153,10 @@ export default (() => {
|
|
2153
2153
|
*/
|
2154
2154
|
fixedRowsBottom: 0,
|
2155
2155
|
/**
|
2156
|
-
* The `fixedRowsTop` option sets the number of [frozen rows](@/guides/rows/row-freezing.md) at the top of the grid.
|
2156
|
+
* The `fixedRowsTop` option sets the number of [frozen rows](@/guides/rows/row-freezing/row-freezing.md) at the top of the grid.
|
2157
2157
|
*
|
2158
2158
|
* Read more:
|
2159
|
-
* - [Row freezing](@/guides/rows/row-freezing.md)
|
2159
|
+
* - [Row freezing](@/guides/rows/row-freezing/row-freezing.md)
|
2160
2160
|
*
|
2161
2161
|
* @memberof Options#
|
2162
2162
|
* @type {number}
|
@@ -2175,7 +2175,7 @@ export default (() => {
|
|
2175
2175
|
*
|
2176
2176
|
* The [`Formulas`](@/api/formulas.md) plugin uses the [HyperFormula](https://handsontable.github.io/hyperformula/) calculation engine.
|
2177
2177
|
* To install [HyperFormula](https://handsontable.github.io/hyperformula/), read the following:
|
2178
|
-
* - [Formula calculation: Initialization methods](@/guides/formulas/formula-calculation.md#initialization-methods)
|
2178
|
+
* - [Formula calculation: Initialization methods](@/guides/formulas/formula-calculation/formula-calculation.md#initialization-methods)
|
2179
2179
|
*
|
2180
2180
|
* You can set the `formulas` option to an object with the following properties:
|
2181
2181
|
*
|
@@ -2187,7 +2187,7 @@ export default (() => {
|
|
2187
2187
|
*
|
2188
2188
|
* Read more:
|
2189
2189
|
* - [Plugins: `Formulas`](@/api/formulas.md)
|
2190
|
-
* - [Formula calculation](@/guides/formulas/formula-calculation.md)
|
2190
|
+
* - [Formula calculation](@/guides/formulas/formula-calculation/formula-calculation.md)
|
2191
2191
|
* - [HyperFormula documentation: Client-side installation](https://handsontable.github.io/hyperformula/guide/client-side-installation)
|
2192
2192
|
* - [HyperFormula documentation: Configuration options](https://handsontable.github.io/hyperformula/api/interfaces/configparams.html)
|
2193
2193
|
*
|
@@ -2287,7 +2287,7 @@ export default (() => {
|
|
2287
2287
|
* | A function that returns a valid number or string | `height() { return 500; }` |
|
2288
2288
|
*
|
2289
2289
|
* Read more:
|
2290
|
-
* - [Grid size](@/guides/getting-started/grid-size.md)
|
2290
|
+
* - [Grid size](@/guides/getting-started/grid-size/grid-size.md)
|
2291
2291
|
*
|
2292
2292
|
* @memberof Options#
|
2293
2293
|
* @type {number|string|Function}
|
@@ -2330,7 +2330,7 @@ export default (() => {
|
|
2330
2330
|
*
|
2331
2331
|
* Read more:
|
2332
2332
|
* - [Plugins: `HiddenColumns`](@/api/hiddenColumns.md)
|
2333
|
-
* - [Column hiding](@/guides/columns/column-hiding.md)
|
2333
|
+
* - [Column hiding](@/guides/columns/column-hiding/column-hiding.md)
|
2334
2334
|
*
|
2335
2335
|
* @memberof Options#
|
2336
2336
|
* @type {boolean|object}
|
@@ -2375,7 +2375,7 @@ export default (() => {
|
|
2375
2375
|
*
|
2376
2376
|
* Read more:
|
2377
2377
|
* - [Plugins: `HiddenRows`](@/api/hiddenRows.md)
|
2378
|
-
* - [Row hiding](@/guides/rows/row-hiding.md)
|
2378
|
+
* - [Row hiding](@/guides/rows/row-hiding/row-hiding.md)
|
2379
2379
|
*
|
2380
2380
|
* @memberof Options#
|
2381
2381
|
* @type {boolean|object}
|
@@ -2401,10 +2401,10 @@ export default (() => {
|
|
2401
2401
|
hiddenRows: undefined,
|
2402
2402
|
/**
|
2403
2403
|
* The `invalidCellClassName` option lets you add a CSS class name to cells
|
2404
|
-
* that were marked as `invalid` by the [cell validator](@/guides/cell-functions/cell-validator.md).
|
2404
|
+
* that were marked as `invalid` by the [cell validator](@/guides/cell-functions/cell-validator/cell-validator.md).
|
2405
2405
|
*
|
2406
2406
|
* Read more:
|
2407
|
-
* - [Cell validator](@/guides/cell-functions/cell-validator.md)
|
2407
|
+
* - [Cell validator](@/guides/cell-functions/cell-validator/cell-validator.md)
|
2408
2408
|
* - [`currentRowClassName`](#currentRowClassName)
|
2409
2409
|
* - [`currentHeaderClassName`](#currentHeaderClassName)
|
2410
2410
|
* - [`activeHeaderClassName`](#activeHeaderClassName)
|
@@ -2513,7 +2513,7 @@ export default (() => {
|
|
2513
2513
|
},
|
2514
2514
|
/**
|
2515
2515
|
* @description
|
2516
|
-
* The `label` option configures [`checkbox`](@/guides/cell-types/checkbox-cell-type.md) cells` labels.
|
2516
|
+
* The `label` option configures [`checkbox`](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md) cells` labels.
|
2517
2517
|
*
|
2518
2518
|
* You can set the `label` option to an object with the following properties:
|
2519
2519
|
*
|
@@ -2522,10 +2522,10 @@ export default (() => {
|
|
2522
2522
|
* | `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 |
|
2523
2523
|
* | `value` | A string \| A function | The label's text |
|
2524
2524
|
* | `separated` | `false` (default) \| `true` | `false`: don't separate the label from the checkbox<br>`true`: separate the label from the checkbox |
|
2525
|
-
* | `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) |
|
2525
|
+
* | `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) |
|
2526
2526
|
*
|
2527
2527
|
* Read more:
|
2528
|
-
* - [Checkbox cell type: Checkbox labels](@/guides/cell-types/checkbox-cell-type.md#checkbox-labels)
|
2528
|
+
* - [Checkbox cell type: Checkbox labels](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md#checkbox-labels)
|
2529
2529
|
*
|
2530
2530
|
* @memberof Options#
|
2531
2531
|
* @type {object}
|
@@ -2543,14 +2543,14 @@ export default (() => {
|
|
2543
2543
|
*/
|
2544
2544
|
label: undefined,
|
2545
2545
|
/**
|
2546
|
-
* The `language` option configures Handsontable's [language](@/guides/internationalization/language.md) settings.
|
2546
|
+
* The `language` option configures Handsontable's [language](@/guides/internationalization/language/language.md) settings.
|
2547
2547
|
*
|
2548
2548
|
* You can set the `language` option to one of the following:
|
2549
2549
|
*
|
2550
2550
|
* | Setting | Description |
|
2551
2551
|
* | ------------------- | --------------------------- |
|
2552
2552
|
* | `'en-US'` (default) | English - United States |
|
2553
|
-
* | `'ar-AR'` | Arabic - Global<br><br>To properly render this language, set the [layout direction](@/guides/internationalization/layout-direction.md) to RTL. |
|
2553
|
+
* | `'ar-AR'` | Arabic - Global<br><br>To properly render this language, set the [layout direction](@/guides/internationalization/layout-direction/layout-direction.md) to RTL. |
|
2554
2554
|
* | `'cs-CZ'` | Czech - Czech Republic |
|
2555
2555
|
* | `'de-CH'` | German - Switzerland |
|
2556
2556
|
* | `'de-DE'` | German - Germany |
|
@@ -2571,7 +2571,7 @@ export default (() => {
|
|
2571
2571
|
* | `'zh-TW'` | Chinese - Taiwan |
|
2572
2572
|
*
|
2573
2573
|
* Read more:
|
2574
|
-
* - [Language](@/guides/internationalization/language.md)
|
2574
|
+
* - [Language](@/guides/internationalization/language/language.md)
|
2575
2575
|
* - [`locale`](#locale)
|
2576
2576
|
* - [`layoutDirection`](#layoutdirection)
|
2577
2577
|
*
|
@@ -2590,9 +2590,9 @@ export default (() => {
|
|
2590
2590
|
/**
|
2591
2591
|
* The `layoutDirection` option configures whether Handsontable renders from the left to the right, or from the right to the left.
|
2592
2592
|
*
|
2593
|
-
* 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.
|
2593
|
+
* 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.
|
2594
2594
|
*
|
2595
|
-
* You can set the `layoutDirection` option only [for the entire grid](@/guides/getting-started/configuration-options.md#set-grid-options).
|
2595
|
+
* You can set the `layoutDirection` option only [for the entire grid](@/guides/getting-started/configuration-options/configuration-options.md#set-grid-options).
|
2596
2596
|
* You can't set it for individual columns, rows, or cells.
|
2597
2597
|
*
|
2598
2598
|
* You can set the `layoutDirection` option to one of the following strings:
|
@@ -2604,8 +2604,8 @@ export default (() => {
|
|
2604
2604
|
* | `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` |
|
2605
2605
|
*
|
2606
2606
|
* Read more:
|
2607
|
-
* - [Layout direction](@/guides/internationalization/layout-direction.md)
|
2608
|
-
* - [Language](@/guides/internationalization/language.md)
|
2607
|
+
* - [Layout direction](@/guides/internationalization/layout-direction/layout-direction.md)
|
2608
|
+
* - [Language](@/guides/internationalization/language/language.md)
|
2609
2609
|
* - [`language`](#language)
|
2610
2610
|
* - [`locale`](#locale)
|
2611
2611
|
* - [`fixedColumnsStart`](#fixedcolumnsstart)
|
@@ -2639,11 +2639,11 @@ export default (() => {
|
|
2639
2639
|
*
|
2640
2640
|
* | Setting | Description |
|
2641
2641
|
* | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
2642
|
-
* | 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) |
|
2643
|
-
* | `'non-commercial-and-evaluation'` | For [non-commercial use](@/guides/technical-specification/software-license.md#non-commercial-use) |
|
2642
|
+
* | 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) |
|
2643
|
+
* | `'non-commercial-and-evaluation'` | For [non-commercial use](@/guides/technical-specification/software-license/software-license.md#non-commercial-use) |
|
2644
2644
|
*
|
2645
2645
|
* Read more:
|
2646
|
-
* - [License key](@/guides/getting-started/license-key.md)
|
2646
|
+
* - [License key](@/guides/getting-started/license-key/license-key.md)
|
2647
2647
|
*
|
2648
2648
|
* @memberof Options#
|
2649
2649
|
* @type {string}
|
@@ -2661,14 +2661,14 @@ export default (() => {
|
|
2661
2661
|
*/
|
2662
2662
|
licenseKey: undefined,
|
2663
2663
|
/**
|
2664
|
-
* The `locale` option configures Handsontable's [locale](@/guides/internationalization/locale.md) settings.
|
2664
|
+
* The `locale` option configures Handsontable's [locale](@/guides/internationalization/locale/locale.md) settings.
|
2665
2665
|
*
|
2666
2666
|
* You can set the `locale` option to any valid and canonicalized Unicode BCP 47 locale tag,
|
2667
|
-
* both for the [entire grid](@/guides/internationalization/locale.md#set-the-grid-s-locale),
|
2668
|
-
* and for [individual columns](@/guides/internationalization/locale.md#set-a-column-s-locale).
|
2667
|
+
* both for the [entire grid](@/guides/internationalization/locale/locale.md#set-the-grid-s-locale),
|
2668
|
+
* and for [individual columns](@/guides/internationalization/locale/locale.md#set-a-column-s-locale).
|
2669
2669
|
*
|
2670
2670
|
* Read more:
|
2671
|
-
* - [Locale](@/guides/internationalization/locale.md)
|
2671
|
+
* - [Locale](@/guides/internationalization/locale/locale.md)
|
2672
2672
|
* - [`language`](#language)
|
2673
2673
|
* - [`layoutDirection`](#layoutdirection)
|
2674
2674
|
*
|
@@ -2707,7 +2707,7 @@ export default (() => {
|
|
2707
2707
|
* | `false` | Disable the [`ManualColumnFreeze`](@/api/manualColumnFreeze.md) plugin |
|
2708
2708
|
*
|
2709
2709
|
* Read more:
|
2710
|
-
* - [Column freezing](@/guides/columns/column-freezing.md#user-triggered-freeze)
|
2710
|
+
* - [Column freezing](@/guides/columns/column-freezing/column-freezing.md#user-triggered-freeze)
|
2711
2711
|
*
|
2712
2712
|
* @memberof Options#
|
2713
2713
|
* @type {boolean}
|
@@ -2733,7 +2733,7 @@ export default (() => {
|
|
2733
2733
|
* | An array | - Enable the [`ManualColumnMove`](@/api/manualColumnMove.md) plugin<br>- Move individual columns at initialization |
|
2734
2734
|
*
|
2735
2735
|
* Read more:
|
2736
|
-
* - [Column moving](@/guides/columns/column-moving.md)
|
2736
|
+
* - [Column moving](@/guides/columns/column-moving/column-moving.md)
|
2737
2737
|
*
|
2738
2738
|
* @memberof Options#
|
2739
2739
|
* @type {boolean|number[]}
|
@@ -2766,7 +2766,7 @@ export default (() => {
|
|
2766
2766
|
* | An array | - Enable the [`ManualColumnResize`](@/api/manualColumnResize.md) plugin<br>- Set initial widths of individual columns |
|
2767
2767
|
*
|
2768
2768
|
* Read more:
|
2769
|
-
* - [Column width: Column stretching](@/guides/columns/column-width.md#column-stretching)
|
2769
|
+
* - [Column width: Column stretching](@/guides/columns/column-width/column-width.md#column-stretching)
|
2770
2770
|
*
|
2771
2771
|
* @memberof Options#
|
2772
2772
|
* @type {boolean|number[]}
|
@@ -2799,7 +2799,7 @@ export default (() => {
|
|
2799
2799
|
* | An array | - Enable the [`ManualRowMove`](@/api/manualRowMove.md) plugin<br>- Move individual rows at initialization |
|
2800
2800
|
*
|
2801
2801
|
* Read more:
|
2802
|
-
* - [Row moving](@/guides/rows/row-moving.md)
|
2802
|
+
* - [Row moving](@/guides/rows/row-moving/row-moving.md)
|
2803
2803
|
*
|
2804
2804
|
* @memberof Options#
|
2805
2805
|
* @type {boolean|number[]}
|
@@ -2832,7 +2832,7 @@ export default (() => {
|
|
2832
2832
|
* | An array | - Enable the [`ManualRowResize`](@/api/manualRowResize.md) plugin<br>- Set initial heights of individual rows |
|
2833
2833
|
*
|
2834
2834
|
* Read more:
|
2835
|
-
* - [Row height: Adjust the row height manually](@/guides/rows/row-height.md#adjust-the-row-height-manually)
|
2835
|
+
* - [Row height: Adjust the row height manually](@/guides/rows/row-height/row-height.md#adjust-the-row-height-manually)
|
2836
2836
|
*
|
2837
2837
|
* @memberof Options#
|
2838
2838
|
* @type {boolean|number[]}
|
@@ -2915,7 +2915,7 @@ export default (() => {
|
|
2915
2915
|
* | `colspan` | The height (as a number of columns ) of the merged section |
|
2916
2916
|
*
|
2917
2917
|
* Read more:
|
2918
|
-
* - [Merge cells](@/guides/cell-features/merge-cells.md)
|
2918
|
+
* - [Merge cells](@/guides/cell-features/merge-cells/merge-cells.md)
|
2919
2919
|
*
|
2920
2920
|
* @memberof Options#
|
2921
2921
|
* @type {boolean|object[]}
|
@@ -2948,8 +2948,8 @@ export default (() => {
|
|
2948
2948
|
* Handsontable adds empty columns to the right.
|
2949
2949
|
* - At runtime: for example, when removing columns.
|
2950
2950
|
*
|
2951
|
-
* The `minCols` option works only when your [`data`](#data) is an [array of arrays](@/guides/getting-started/binding-to-data.md#array-of-arrays).
|
2952
|
-
* When your [`data`](#data) is an [array of objects](@/guides/getting-started/binding-to-data.md#array-of-objects),
|
2951
|
+
* 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).
|
2952
|
+
* When your [`data`](#data) is an [array of objects](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-objects),
|
2953
2953
|
* you can only have as many columns as defined in:
|
2954
2954
|
* - The first data row
|
2955
2955
|
* - The [`dataSchema`](#dataSchema) option
|
@@ -2996,8 +2996,8 @@ export default (() => {
|
|
2996
2996
|
*
|
2997
2997
|
* The total number of columns can't exceed the [`maxCols`](#maxCols) value.
|
2998
2998
|
*
|
2999
|
-
* The `minSpareCols` option works only when your [`data`](#data) is an [array of arrays](@/guides/getting-started/binding-to-data.md#array-of-arrays).
|
3000
|
-
* When your [`data`](#data) is an [array of objects](@/guides/getting-started/binding-to-data.md#array-of-objects),
|
2999
|
+
* 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).
|
3000
|
+
* When your [`data`](#data) is an [array of objects](@/guides/getting-started/binding-to-data/binding-to-data.md#array-of-objects),
|
3001
3001
|
* you can only have as many columns as defined in:
|
3002
3002
|
* - The first data row
|
3003
3003
|
* - The [`dataSchema`](#dataSchema) option
|
@@ -3056,7 +3056,7 @@ export default (() => {
|
|
3056
3056
|
* | `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 |
|
3057
3057
|
* | `headerAction` | `true`: Enable clicking on the column header to sort the column<br>`false`: Disable clicking on the column header to sort the column |
|
3058
3058
|
* | `sortEmptyCells` | `true`: Sort empty cells as well<br>`false`: Place empty cells at the end |
|
3059
|
-
* | `compareFunctionFactory` | A [custom compare function](@/guides/rows/rows-sorting.md#add-a-custom-comparator) |
|
3059
|
+
* | `compareFunctionFactory` | A [custom compare function](@/guides/rows/rows-sorting/rows-sorting.md#add-a-custom-comparator) |
|
3060
3060
|
*
|
3061
3061
|
* If you set the `multiColumnSorting` option to an object,
|
3062
3062
|
* you can also sort individual columns at Handsontable's initialization.
|
@@ -3069,7 +3069,7 @@ export default (() => {
|
|
3069
3069
|
* | `sortOrder` | `'asc'` \| `'desc'` | The sorting order:<br>`'asc'`: ascending<br>`'desc'`: descending |
|
3070
3070
|
*
|
3071
3071
|
* Read more:
|
3072
|
-
* - [Rows sorting](@/guides/rows/rows-sorting.md)
|
3072
|
+
* - [Rows sorting](@/guides/rows/rows-sorting/rows-sorting.md)
|
3073
3073
|
* - [`columnSorting`](#columnSorting)
|
3074
3074
|
*
|
3075
3075
|
* @memberof Options#
|
@@ -3115,7 +3115,7 @@ export default (() => {
|
|
3115
3115
|
*/
|
3116
3116
|
multiColumnSorting: undefined,
|
3117
3117
|
/**
|
3118
|
-
* 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`).
|
3118
|
+
* 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`).
|
3119
3119
|
*
|
3120
3120
|
* @since 14.0.0
|
3121
3121
|
* @memberof Options#
|
@@ -3178,7 +3178,7 @@ export default (() => {
|
|
3178
3178
|
*
|
3179
3179
|
* Read more:
|
3180
3180
|
* - [Plugins: `NestedHeaders`](@/api/nestedHeaders.md)
|
3181
|
-
* - [Column groups: Nested headers](@/guides/columns/column-groups.md#nested-headers)
|
3181
|
+
* - [Column groups: Nested headers](@/guides/columns/column-groups/column-groups.md#nested-headers)
|
3182
3182
|
*
|
3183
3183
|
* @memberof Options#
|
3184
3184
|
* @type {boolean|Array[]}
|
@@ -3207,7 +3207,7 @@ export default (() => {
|
|
3207
3207
|
* | `true` | Enable the [`NestedRows`](@/api/nestedRows.md) plugin |
|
3208
3208
|
*
|
3209
3209
|
* Read more:
|
3210
|
-
* - [Plugins: `NestedRows`](@/guides/rows/row-parent-child.md)
|
3210
|
+
* - [Plugins: `NestedRows`](@/guides/rows/row-parent-child/row-parent-child.md)
|
3211
3211
|
*
|
3212
3212
|
* @example
|
3213
3213
|
* ```js
|
@@ -3252,7 +3252,7 @@ export default (() => {
|
|
3252
3252
|
noWordWrapClassName: 'htNoWrap',
|
3253
3253
|
/**
|
3254
3254
|
* The `numericFormat` option configures the number format and the currency format
|
3255
|
-
* of [`numeric`](@/guides/cell-types/numeric-cell-type.md) cells` displayed output
|
3255
|
+
* of [`numeric`](@/guides/cell-types/numeric-cell-type/numeric-cell-type.md) cells` displayed output
|
3256
3256
|
* in the numeric cell renderer.
|
3257
3257
|
*
|
3258
3258
|
* You can set the `numericFormat` option to an object with the following properties:
|
@@ -3267,8 +3267,8 @@ export default (() => {
|
|
3267
3267
|
* In the source data, numeric data is stored as JavaScript numbers.
|
3268
3268
|
*
|
3269
3269
|
* Read more:
|
3270
|
-
* - [Numeric cell type](@/guides/cell-types/numeric-cell-type.md)
|
3271
|
-
* - [Third-party licenses](@/guides/technical-specification/third-party-licenses.md)
|
3270
|
+
* - [Numeric cell type](@/guides/cell-types/numeric-cell-type/numeric-cell-type.md)
|
3271
|
+
* - [Third-party licenses](@/guides/technical-specification/third-party-licenses/third-party-licenses.md)
|
3272
3272
|
*
|
3273
3273
|
* @memberof Options#
|
3274
3274
|
* @since 0.35.0
|
@@ -3311,15 +3311,15 @@ export default (() => {
|
|
3311
3311
|
*/
|
3312
3312
|
observeDOMVisibility: true,
|
3313
3313
|
/**
|
3314
|
-
* The `outsideClickDeselects` option determines what happens to the current [selection](@/guides/cell-features/selection.md)
|
3314
|
+
* The `outsideClickDeselects` option determines what happens to the current [selection](@/guides/cell-features/selection/selection.md)
|
3315
3315
|
* when you click outside of the grid.
|
3316
3316
|
*
|
3317
3317
|
* You can set the `outsideClickDeselects` option to one of the following:
|
3318
3318
|
*
|
3319
3319
|
* | Setting | Description |
|
3320
3320
|
* | ---------------- | -------------------------------------------------------------------------------------------------------- |
|
3321
|
-
* | `true` (default) | On a mouse click outside of the grid, clear the current [selection](@/guides/cell-features/selection.md) |
|
3322
|
-
* | `false` | On a mouse click outside of the grid, keep the current [selection](@/guides/cell-features/selection.md) |
|
3321
|
+
* | `true` (default) | On a mouse click outside of the grid, clear the current [selection](@/guides/cell-features/selection/selection.md) |
|
3322
|
+
* | `false` | On a mouse click outside of the grid, keep the current [selection](@/guides/cell-features/selection/selection.md) |
|
3323
3323
|
* | A function | A function that takes the click event target and returns a boolean |
|
3324
3324
|
*
|
3325
3325
|
* @memberof Options#
|
@@ -3359,7 +3359,7 @@ export default (() => {
|
|
3359
3359
|
* | `true` | Enable the [`PersistentState`](@/api/persistentState.md) plugin |
|
3360
3360
|
*
|
3361
3361
|
* Read more:
|
3362
|
-
* - [Saving data: Saving data locally](@/guides/getting-started/saving-data.md#save-data-locally)
|
3362
|
+
* - [Saving data: Saving data locally](@/guides/getting-started/saving-data/saving-data.md#save-data-locally)
|
3363
3363
|
* - [Plugins: `PersistentState`](@/api/persistentState.md)
|
3364
3364
|
*
|
3365
3365
|
* @memberof Options#
|
@@ -3416,7 +3416,7 @@ export default (() => {
|
|
3416
3416
|
* that contain [`placeholder`](#placeholder) text.
|
3417
3417
|
*
|
3418
3418
|
* Read more:
|
3419
|
-
* - [Cell validator](@/guides/cell-functions/cell-validator.md)
|
3419
|
+
* - [Cell validator](@/guides/cell-functions/cell-validator/cell-validator.md)
|
3420
3420
|
* - [`placeholder`](#placeholder)
|
3421
3421
|
* - [`currentRowClassName`](#currentRowClassName)
|
3422
3422
|
* - [`currentHeaderClassName`](#currentHeaderClassName)
|
@@ -3491,9 +3491,9 @@ export default (() => {
|
|
3491
3491
|
preventWheel: false,
|
3492
3492
|
/**
|
3493
3493
|
* @description
|
3494
|
-
* The `readOnly` option determines whether a [cell](@/guides/cell-features/disabled-cells.md#read-only-specific-cells),
|
3495
|
-
* [comment](@/guides/cell-features/comments.md#make-a-comment-read-only), [column](@/guides/cell-features/disabled-cells.md#read-only-columns)
|
3496
|
-
* or the [entire grid](@/guides/cell-features/disabled-cells.md#read-only-grid) is editable or not. You can configure it as follows:
|
3494
|
+
* The `readOnly` option determines whether a [cell](@/guides/cell-features/disabled-cells/disabled-cells.md#read-only-specific-cells),
|
3495
|
+
* [comment](@/guides/cell-features/comments/comments.md#make-a-comment-read-only), [column](@/guides/cell-features/disabled-cells/disabled-cells.md#read-only-columns)
|
3496
|
+
* 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:
|
3497
3497
|
*
|
3498
3498
|
* | Setting | Description |
|
3499
3499
|
* | ----------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
@@ -3503,8 +3503,8 @@ export default (() => {
|
|
3503
3503
|
* `readOnly` cells can't be changed by the [`populateFromArray()`](@/api/core.md#populatefromarray) method.
|
3504
3504
|
*
|
3505
3505
|
* Read more:
|
3506
|
-
* - [Disabled cells](@/guides/cell-features/disabled-cells.md)
|
3507
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
3506
|
+
* - [Disabled cells](@/guides/cell-features/disabled-cells/disabled-cells.md)
|
3507
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
3508
3508
|
*
|
3509
3509
|
* @memberof Options#
|
3510
3510
|
* @type {boolean}
|
@@ -3570,18 +3570,18 @@ export default (() => {
|
|
3570
3570
|
*/
|
3571
3571
|
readOnlyCellClassName: 'htDimmed',
|
3572
3572
|
/**
|
3573
|
-
* The `renderAllRows` option controls Handsontable's [row virtualization](@/guides/rows/row-virtualization.md).
|
3573
|
+
* The `renderAllRows` option controls Handsontable's [row virtualization](@/guides/rows/row-virtualization/row-virtualization.md).
|
3574
3574
|
* You can configure it as follows:
|
3575
3575
|
*
|
3576
3576
|
* | Setting | Description |
|
3577
3577
|
* | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
3578
|
-
* | `false` (default) | Enable [row virtualization](@/guides/rows/row-virtualization.md), rendering only the visible rows for optimal performance with large datasets. |
|
3579
|
-
* | `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. |
|
3578
|
+
* | `false` (default) | Enable [row virtualization](@/guides/rows/row-virtualization/row-virtualization.md), rendering only the visible rows for optimal performance with large datasets. |
|
3579
|
+
* | `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. |
|
3580
3580
|
*
|
3581
3581
|
* Setting `renderAllRows` to `true` overwrites the [`viewportRowRenderingOffset`](#viewportRowRenderingOffset) setting.
|
3582
3582
|
*
|
3583
3583
|
* Read more:
|
3584
|
-
* - [Row virtualization](@/guides/rows/row-virtualization.md)
|
3584
|
+
* - [Row virtualization](@/guides/rows/row-virtualization/row-virtualization.md)
|
3585
3585
|
*
|
3586
3586
|
* @memberof Options#
|
3587
3587
|
* @type {boolean}
|
@@ -3596,19 +3596,19 @@ export default (() => {
|
|
3596
3596
|
*/
|
3597
3597
|
renderAllRows: false,
|
3598
3598
|
/**
|
3599
|
-
* The `renderAllColumns` option configures Handsontable's [column virtualization](@/guides/columns/column-virtualization.md).
|
3599
|
+
* The `renderAllColumns` option configures Handsontable's [column virtualization](@/guides/columns/column-virtualization/column-virtualization.md).
|
3600
3600
|
*
|
3601
3601
|
* You can set the `renderAllColumns` option to one of the following:
|
3602
3602
|
*
|
3603
3603
|
* | Setting | Description |
|
3604
3604
|
* | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
3605
|
-
* | `false` (default) | Enable [column virtualization](@/guides/columns/column-virtualization.md), rendering only visible columns for better performance with many columns. |
|
3606
|
-
* | `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. |
|
3605
|
+
* | `false` (default) | Enable [column virtualization](@/guides/columns/column-virtualization/column-virtualization.md), rendering only visible columns for better performance with many columns. |
|
3606
|
+
* | `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. |
|
3607
3607
|
*
|
3608
3608
|
* Setting `renderAllColumns` to `true` overwrites the [`viewportColumnRenderingOffset`](#viewportColumnRenderingOffset) setting.
|
3609
3609
|
*
|
3610
3610
|
* Read more:
|
3611
|
-
* - [Column virtualization](@/guides/columns/column-virtualization.md)
|
3611
|
+
* - [Column virtualization](@/guides/columns/column-virtualization/column-virtualization.md)
|
3612
3612
|
*
|
3613
3613
|
* @since 14.1.0
|
3614
3614
|
* @memberof Options#
|
@@ -3625,15 +3625,15 @@ export default (() => {
|
|
3625
3625
|
renderAllColumns: false,
|
3626
3626
|
/**
|
3627
3627
|
* @description
|
3628
|
-
* The `renderer` option sets a [cell renderer](@/guides/cell-functions/cell-renderer.md) for a cell.
|
3628
|
+
* The `renderer` option sets a [cell renderer](@/guides/cell-functions/cell-renderer/cell-renderer.md) for a cell.
|
3629
3629
|
*
|
3630
3630
|
* You can set the `renderer` option to one of the following:
|
3631
3631
|
* - A custom renderer function
|
3632
|
-
* - One of the following [cell renderer aliases](@/guides/cell-functions/cell-renderer.md):
|
3632
|
+
* - One of the following [cell renderer aliases](@/guides/cell-functions/cell-renderer/cell-renderer.md):
|
3633
3633
|
*
|
3634
3634
|
* | Alias | Cell renderer function |
|
3635
3635
|
* | ------------------- | ------------------------------------------------------------------------------ |
|
3636
|
-
* | A custom alias | Your [custom cell renderer](@/guides/cell-functions/cell-renderer.md) function |
|
3636
|
+
* | A custom alias | Your [custom cell renderer](@/guides/cell-functions/cell-renderer/cell-renderer.md) function |
|
3637
3637
|
* | `'autocomplete'` | `AutocompleteRenderer` |
|
3638
3638
|
* | `'base'` | `BaseRenderer` |
|
3639
3639
|
* | `'checkbox'` | `CheckboxRenderer` |
|
@@ -3649,9 +3649,9 @@ export default (() => {
|
|
3649
3649
|
* options all at once, use the [`type`](#type) option.
|
3650
3650
|
*
|
3651
3651
|
* Read more:
|
3652
|
-
* - [Cell renderer](@/guides/cell-functions/cell-renderer.md)
|
3653
|
-
* - [Cell type](@/guides/cell-types/cell-type.md)
|
3654
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
3652
|
+
* - [Cell renderer](@/guides/cell-functions/cell-renderer/cell-renderer.md)
|
3653
|
+
* - [Cell type](@/guides/cell-types/cell-type/cell-type.md)
|
3654
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
3655
3655
|
* - [`type`](#type)
|
3656
3656
|
*
|
3657
3657
|
* @memberof Options#
|
@@ -3697,7 +3697,7 @@ export default (() => {
|
|
3697
3697
|
* | A function | Define your own row headers, using a function |
|
3698
3698
|
*
|
3699
3699
|
* Read more:
|
3700
|
-
* - [Row header](@/guides/rows/row-header.md)
|
3700
|
+
* - [Row header](@/guides/rows/row-header/row-header.md)
|
3701
3701
|
*
|
3702
3702
|
* @memberof Options#
|
3703
3703
|
* @type {boolean|string[]|Function}
|
@@ -3763,7 +3763,7 @@ export default (() => {
|
|
3763
3763
|
* via the {@link ManualRowResize} and {@link AutoRowSize} plugins (if they are enabled).
|
3764
3764
|
*
|
3765
3765
|
* Read more:
|
3766
|
-
* - [Row height](@/guides/rows/row-height.md)
|
3766
|
+
* - [Row height](@/guides/rows/row-height/row-height.md)
|
3767
3767
|
*
|
3768
3768
|
* @memberof Options#
|
3769
3769
|
* @type {number|number[]|string|string[]|Array<undefined>|Function}
|
@@ -3808,13 +3808,13 @@ export default (() => {
|
|
3808
3808
|
* | Option | Possible settings | Description |
|
3809
3809
|
* | ------------------- | ----------------- | ---------------------------------------------------------------------------------------------------- |
|
3810
3810
|
* | `searchResultClass` | A string | Add a custom CSS class name to search results |
|
3811
|
-
* | `queryMethod` | A function | Add a [custom query method](@/guides/navigation/searching-values.md#custom-query-method) |
|
3812
|
-
* | `callback` | A function | Add a [custom callback function](@/guides/navigation/searching-values.md#custom-callback) |
|
3811
|
+
* | `queryMethod` | A function | Add a [custom query method](@/guides/navigation/searching-values/searching-values.md#custom-query-method) |
|
3812
|
+
* | `callback` | A function | Add a [custom callback function](@/guides/navigation/searching-values/searching-values.md#custom-callback) |
|
3813
3813
|
*
|
3814
3814
|
* Read more:
|
3815
|
-
* - [Searching values](@/guides/navigation/searching-values.md)
|
3816
|
-
* - [Searching values: Custom query method](@/guides/navigation/searching-values.md#custom-query-method)
|
3817
|
-
* - [Searching values: Custom callback](@/guides/navigation/searching-values.md#custom-callback)
|
3815
|
+
* - [Searching values](@/guides/navigation/searching-values/searching-values.md)
|
3816
|
+
* - [Searching values: Custom query method](@/guides/navigation/searching-values/searching-values.md#custom-query-method)
|
3817
|
+
* - [Searching values: Custom callback](@/guides/navigation/searching-values/searching-values.md#custom-callback)
|
3818
3818
|
*
|
3819
3819
|
* @memberof Options#
|
3820
3820
|
* @type {boolean|object}
|
@@ -3844,7 +3844,7 @@ export default (() => {
|
|
3844
3844
|
search: false,
|
3845
3845
|
/**
|
3846
3846
|
* @description
|
3847
|
-
* The `selectionMode` option configures how [selection](@/guides/cell-features/selection.md) works.
|
3847
|
+
* The `selectionMode` option configures how [selection](@/guides/cell-features/selection/selection.md) works.
|
3848
3848
|
*
|
3849
3849
|
* You can set the `selectionMode` option to one of the following:
|
3850
3850
|
*
|
@@ -3855,7 +3855,7 @@ export default (() => {
|
|
3855
3855
|
* | `'multiple'` | Allow the user to select multiple ranges of cells at a time. |
|
3856
3856
|
*
|
3857
3857
|
* Read more:
|
3858
|
-
* - [Selection: Selecting ranges](@/guides/cell-features/selection.md#select-ranges)
|
3858
|
+
* - [Selection: Selecting ranges](@/guides/cell-features/selection/selection.md#select-ranges)
|
3859
3859
|
*
|
3860
3860
|
* @memberof Options#
|
3861
3861
|
* @type {string}
|
@@ -3876,7 +3876,7 @@ export default (() => {
|
|
3876
3876
|
*/
|
3877
3877
|
selectionMode: 'multiple',
|
3878
3878
|
/**
|
3879
|
-
* The `selectOptions` option configures options that the end user can choose from in [`select`](@/guides/cell-types/select-cell-type.md) cells.
|
3879
|
+
* 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.
|
3880
3880
|
*
|
3881
3881
|
* You can set the `selectOptions` option to one of the following:
|
3882
3882
|
*
|
@@ -3887,7 +3887,7 @@ export default (() => {
|
|
3887
3887
|
* | A function | A function that returns an object with key-string pairs |
|
3888
3888
|
*
|
3889
3889
|
* Read more:
|
3890
|
-
* - [Select cell type](@/guides/cell-types/select-cell-type.md)
|
3890
|
+
* - [Select cell type](@/guides/cell-types/select-cell-type/select-cell-type.md)
|
3891
3891
|
*
|
3892
3892
|
* @memberof Options#
|
3893
3893
|
* @type {string[]|object|Function}
|
@@ -3946,7 +3946,7 @@ export default (() => {
|
|
3946
3946
|
* | `true` | - Disable pasting data into this column<br>- On pasting, paste data into the next column to the right |
|
3947
3947
|
*
|
3948
3948
|
* Read more:
|
3949
|
-
* - [Configuration options: Setting column options](@/guides/getting-started/configuration-options.md#set-column-options)
|
3949
|
+
* - [Configuration options: Setting column options](@/guides/getting-started/configuration-options/configuration-options.md#set-column-options)
|
3950
3950
|
*
|
3951
3951
|
* @memberof Options#
|
3952
3952
|
* @type {boolean}
|
@@ -3979,7 +3979,7 @@ export default (() => {
|
|
3979
3979
|
* | `true` | - Disable pasting data into this row<br>- On pasting, paste data into the row below |
|
3980
3980
|
*
|
3981
3981
|
* Read more:
|
3982
|
-
* - [Configuration options: Setting row options](@/guides/getting-started/configuration-options.md#set-row-options)
|
3982
|
+
* - [Configuration options: Setting row options](@/guides/getting-started/configuration-options/configuration-options.md#set-row-options)
|
3983
3983
|
*
|
3984
3984
|
* @memberof Options#
|
3985
3985
|
* @type {boolean}
|
@@ -4002,7 +4002,7 @@ export default (() => {
|
|
4002
4002
|
*/
|
4003
4003
|
skipRowOnPaste: false,
|
4004
4004
|
/**
|
4005
|
-
* The `sortByRelevance` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md) cells'
|
4005
|
+
* The `sortByRelevance` option configures whether [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) cells'
|
4006
4006
|
* lists are sorted in the same order as provided in the [`source`](#source) option.
|
4007
4007
|
*
|
4008
4008
|
* You can set the `sortByRelevance` option to one of the following:
|
@@ -4014,7 +4014,7 @@ export default (() => {
|
|
4014
4014
|
*
|
4015
4015
|
* Read more:
|
4016
4016
|
* - [`source`](#source)
|
4017
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
4017
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
4018
4018
|
*
|
4019
4019
|
* @memberof Options#
|
4020
4020
|
* @type {boolean}
|
@@ -4035,8 +4035,8 @@ export default (() => {
|
|
4035
4035
|
*/
|
4036
4036
|
sortByRelevance: true,
|
4037
4037
|
/**
|
4038
|
-
* The `source` option sets options available in [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md)
|
4039
|
-
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type.md) cells.
|
4038
|
+
* The `source` option sets options available in [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
4039
|
+
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md) cells.
|
4040
4040
|
*
|
4041
4041
|
* You can set the `source` option to one of the following:
|
4042
4042
|
*
|
@@ -4044,8 +4044,8 @@ export default (() => {
|
|
4044
4044
|
* - A function
|
4045
4045
|
*
|
4046
4046
|
* Read more:
|
4047
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
4048
|
-
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type.md)
|
4047
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
4048
|
+
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md)
|
4049
4049
|
* - [`strict`](#strict)
|
4050
4050
|
* - [`allowHtml`](#allowHtml)
|
4051
4051
|
* - [`filter`](#filter)
|
@@ -4130,7 +4130,7 @@ export default (() => {
|
|
4130
4130
|
* | `'all'` | Fit the grid to the container, by stretching all columns evenly |
|
4131
4131
|
*
|
4132
4132
|
* Read more:
|
4133
|
-
* - [Column width: Column stretching](@/guides/columns/column-width.md#column-stretching)
|
4133
|
+
* - [Column width: Column stretching](@/guides/columns/column-width/column-width.md#column-stretching)
|
4134
4134
|
*
|
4135
4135
|
* @memberof Options#
|
4136
4136
|
* @type {string}
|
@@ -4146,17 +4146,17 @@ export default (() => {
|
|
4146
4146
|
*/
|
4147
4147
|
stretchH: 'none',
|
4148
4148
|
/**
|
4149
|
-
* The `strict` option configures the behavior of [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md) cells.
|
4149
|
+
* The `strict` option configures the behavior of [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) cells.
|
4150
4150
|
*
|
4151
4151
|
* You can set the `strict` option to one of the following:
|
4152
4152
|
*
|
4153
4153
|
* | Setting | Mode | Description |
|
4154
4154
|
* | ------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
|
4155
|
-
* | `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 |
|
4156
|
-
* | `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 |
|
4155
|
+
* | `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 |
|
4156
|
+
* | `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 |
|
4157
4157
|
*
|
4158
4158
|
* Read more:
|
4159
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
4159
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
4160
4160
|
* - [`source`](#source)
|
4161
4161
|
*
|
4162
4162
|
* @memberof Options#
|
@@ -4255,12 +4255,12 @@ export default (() => {
|
|
4255
4255
|
},
|
4256
4256
|
/**
|
4257
4257
|
* @description
|
4258
|
-
* The `title` option configures [column header](@/guides/columns/column-header.md) names.
|
4258
|
+
* The `title` option configures [column header](@/guides/columns/column-header/column-header.md) names.
|
4259
4259
|
*
|
4260
4260
|
* You can set the `title` option to a string.
|
4261
4261
|
*
|
4262
4262
|
* Read more:
|
4263
|
-
* - [Column header](@/guides/columns/column-header.md)
|
4263
|
+
* - [Column header](@/guides/columns/column-header/column-header.md)
|
4264
4264
|
* - [`columns`](#columns)
|
4265
4265
|
*
|
4266
4266
|
* @memberof Options#
|
@@ -4286,8 +4286,8 @@ export default (() => {
|
|
4286
4286
|
*/
|
4287
4287
|
title: undefined,
|
4288
4288
|
/**
|
4289
|
-
* The `trimDropdown` option configures the width of the [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md)
|
4290
|
-
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type.md) lists.
|
4289
|
+
* The `trimDropdown` option configures the width of the [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
4290
|
+
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md) lists.
|
4291
4291
|
*
|
4292
4292
|
* You can set the `trimDropdown` option to one of the following:
|
4293
4293
|
*
|
@@ -4297,8 +4297,8 @@ export default (() => {
|
|
4297
4297
|
* | `false` | Scale the dropdown/autocomplete list's width to the list's content |
|
4298
4298
|
*
|
4299
4299
|
* Read more:
|
4300
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
4301
|
-
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type.md)
|
4300
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
4301
|
+
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md)
|
4302
4302
|
*
|
4303
4303
|
* @memberof Options#
|
4304
4304
|
* @type {boolean}
|
@@ -4338,7 +4338,7 @@ export default (() => {
|
|
4338
4338
|
*
|
4339
4339
|
* Read more:
|
4340
4340
|
* - [Plugins: `TrimRows`](@/api/trimRows.md)
|
4341
|
-
* - [Row trimming](@/guides/rows/row-trimming.md)
|
4341
|
+
* - [Row trimming](@/guides/rows/row-trimming/row-trimming.md)
|
4342
4342
|
*
|
4343
4343
|
* @memberof Options#
|
4344
4344
|
* @type {boolean|number[]}
|
@@ -4387,29 +4387,29 @@ export default (() => {
|
|
4387
4387
|
/**
|
4388
4388
|
* @description
|
4389
4389
|
* The `type` option lets you set the [`renderer`](#renderer), [`editor`](#editor), and [`validator`](#validator)
|
4390
|
-
* options all at once, by selecting a [cell type](@/guides/cell-types/cell-type.md).
|
4390
|
+
* options all at once, by selecting a [cell type](@/guides/cell-types/cell-type/cell-type.md).
|
4391
4391
|
*
|
4392
4392
|
* You can set the `type` option to one of the following:
|
4393
4393
|
*
|
4394
4394
|
* | Cell type | Renderer, editor & validator |
|
4395
4395
|
* | ----------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
4396
|
-
* | 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) |
|
4397
|
-
* | [`'autocomplete'`](@/guides/cell-types/autocomplete-cell-type.md) | Renderer: `AutocompleteRenderer`<br>Editor: `AutocompleteEditor`<br>Validator: `AutocompleteValidator` |
|
4398
|
-
* | [`'checkbox'`](@/guides/cell-types/checkbox-cell-type.md) | Renderer: `CheckboxRenderer`<br>Editor: `CheckboxEditor`<br>Validator: - |
|
4399
|
-
* | [`'date'`](@/guides/cell-types/date-cell-type.md) | Renderer: `DateRenderer`<br>Editor: `DateEditor`<br>Validator: `DateValidator` |
|
4400
|
-
* | [`'dropdown'`](@/guides/cell-types/dropdown-cell-type.md) | Renderer: `DropdownRenderer`<br>Editor: `DropdownEditor`<br>Validator: `DropdownValidator` |
|
4401
|
-
* | [`'handsontable'`](@/guides/cell-types/handsontable-cell-type.md) | Renderer: `AutocompleteRenderer`<br>Editor: `HandsontableEditor`<br>Validator: - |
|
4402
|
-
* | [`'numeric'`](@/guides/cell-types/numeric-cell-type.md) | Renderer: `NumericRenderer`<br>Editor: `NumericEditor`<br>Validator: `NumericValidator` |
|
4403
|
-
* | [`'password'`](@/guides/cell-types/password-cell-type.md) | Renderer: `PasswordRenderer`<br>Editor: `PasswordEditor`<br>Validator: - |
|
4396
|
+
* | 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) |
|
4397
|
+
* | [`'autocomplete'`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md) | Renderer: `AutocompleteRenderer`<br>Editor: `AutocompleteEditor`<br>Validator: `AutocompleteValidator` |
|
4398
|
+
* | [`'checkbox'`](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md) | Renderer: `CheckboxRenderer`<br>Editor: `CheckboxEditor`<br>Validator: - |
|
4399
|
+
* | [`'date'`](@/guides/cell-types/date-cell-type/date-cell-type.md) | Renderer: `DateRenderer`<br>Editor: `DateEditor`<br>Validator: `DateValidator` |
|
4400
|
+
* | [`'dropdown'`](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md) | Renderer: `DropdownRenderer`<br>Editor: `DropdownEditor`<br>Validator: `DropdownValidator` |
|
4401
|
+
* | [`'handsontable'`](@/guides/cell-types/handsontable-cell-type/handsontable-cell-type.md) | Renderer: `AutocompleteRenderer`<br>Editor: `HandsontableEditor`<br>Validator: - |
|
4402
|
+
* | [`'numeric'`](@/guides/cell-types/numeric-cell-type/numeric-cell-type.md) | Renderer: `NumericRenderer`<br>Editor: `NumericEditor`<br>Validator: `NumericValidator` |
|
4403
|
+
* | [`'password'`](@/guides/cell-types/password-cell-type/password-cell-type.md) | Renderer: `PasswordRenderer`<br>Editor: `PasswordEditor`<br>Validator: - |
|
4404
4404
|
* | `'text'` | Renderer: `TextRenderer`<br>Editor: `TextEditor`<br>Validator: - |
|
4405
|
-
* | [`'time`'](@/guides/cell-types/time-cell-type.md) | Renderer: `TimeRenderer`<br>Editor: `TimeEditor`<br>Validator: `TimeValidator` |
|
4405
|
+
* | [`'time`'](@/guides/cell-types/time-cell-type/time-cell-type.md) | Renderer: `TimeRenderer`<br>Editor: `TimeEditor`<br>Validator: `TimeValidator` |
|
4406
4406
|
*
|
4407
4407
|
* Read more:
|
4408
|
-
* - [Cell type](@/guides/cell-types/cell-type.md)
|
4409
|
-
* - [Cell renderer](@/guides/cell-functions/cell-renderer.md)
|
4410
|
-
* - [Cell editor](@/guides/cell-functions/cell-editor.md)
|
4411
|
-
* - [Cell validator](@/guides/cell-functions/cell-validator.md)
|
4412
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
4408
|
+
* - [Cell type](@/guides/cell-types/cell-type/cell-type.md)
|
4409
|
+
* - [Cell renderer](@/guides/cell-functions/cell-renderer/cell-renderer.md)
|
4410
|
+
* - [Cell editor](@/guides/cell-functions/cell-editor/cell-editor.md)
|
4411
|
+
* - [Cell validator](@/guides/cell-functions/cell-validator/cell-validator.md)
|
4412
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
4413
4413
|
* - [`renderer`](#renderer)
|
4414
4414
|
* - [`editor`](#editor)
|
4415
4415
|
* - [`validator`](#validator)
|
@@ -4440,17 +4440,17 @@ export default (() => {
|
|
4440
4440
|
type: 'text',
|
4441
4441
|
/**
|
4442
4442
|
* The `uncheckedTemplate` option lets you configure what value
|
4443
|
-
* an unchecked [`checkbox`](@/guides/cell-types/checkbox-cell-type.md) cell has.
|
4443
|
+
* an unchecked [`checkbox`](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md) cell has.
|
4444
4444
|
*
|
4445
4445
|
* You can set the `uncheckedTemplate` option to one of the following:
|
4446
4446
|
*
|
4447
4447
|
* | Setting | Description |
|
4448
4448
|
* | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
4449
|
-
* | `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` |
|
4450
|
-
* | 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 |
|
4449
|
+
* | `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` |
|
4450
|
+
* | 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 |
|
4451
4451
|
*
|
4452
4452
|
* Read more:
|
4453
|
-
* - [Checkbox cell type: Checkbox template](@/guides/cell-types/checkbox-cell-type.md#checkbox-template)
|
4453
|
+
* - [Checkbox cell type: Checkbox template](@/guides/cell-types/checkbox-cell-type/checkbox-cell-type.md#checkbox-template)
|
4454
4454
|
* - [`getDataAtCell()`](@/api/core.md#getDataAtCell)
|
4455
4455
|
* - [`checkedTemplate`](#checkedTemplate)
|
4456
4456
|
*
|
@@ -4496,7 +4496,7 @@ export default (() => {
|
|
4496
4496
|
* set the `undo` option to `false`.
|
4497
4497
|
*
|
4498
4498
|
* Read more:
|
4499
|
-
* - [Undo and redo](@/guides/accessories-and-menus/undo-redo.md)
|
4499
|
+
* - [Undo and redo](@/guides/accessories-and-menus/undo-redo/undo-redo.md)
|
4500
4500
|
*
|
4501
4501
|
* @memberof Options#
|
4502
4502
|
* @type {boolean}
|
@@ -4512,22 +4512,22 @@ export default (() => {
|
|
4512
4512
|
undo: undefined,
|
4513
4513
|
/**
|
4514
4514
|
* @description
|
4515
|
-
* The `validator` option sets a [cell validator](@/guides/cell-functions/cell-validator.md) for a cell.
|
4515
|
+
* The `validator` option sets a [cell validator](@/guides/cell-functions/cell-validator/cell-validator.md) for a cell.
|
4516
4516
|
*
|
4517
4517
|
* You can set the `validator` option to one of the following:
|
4518
4518
|
*
|
4519
4519
|
* | Setting | Description |
|
4520
4520
|
* | -------------------- | -------------------------------------------------------------------------------- |
|
4521
|
-
* | A string | A [cell validator alias](@/guides/cell-functions/cell-validator.md) |
|
4522
|
-
* | A function | Your [custom cell validator function](@/guides/cell-functions/cell-validator.md) |
|
4521
|
+
* | A string | A [cell validator alias](@/guides/cell-functions/cell-validator/cell-validator.md) |
|
4522
|
+
* | A function | Your [custom cell validator function](@/guides/cell-functions/cell-validator/cell-validator.md) |
|
4523
4523
|
* | A regular expression | A regular expression used for cell validation |
|
4524
4524
|
*
|
4525
4525
|
* By setting the `validator` option to a string,
|
4526
|
-
* you can use one of the following [cell validator aliases](@/guides/cell-functions/cell-validator.md):
|
4526
|
+
* you can use one of the following [cell validator aliases](@/guides/cell-functions/cell-validator/cell-validator.md):
|
4527
4527
|
*
|
4528
4528
|
* | Alias | Cell validator function |
|
4529
4529
|
* | ------------------- | ----------------------------------------------------------------------- |
|
4530
|
-
* | A custom alias | Your [custom cell validator](@/guides/cell-functions/cell-validator.md) |
|
4530
|
+
* | A custom alias | Your [custom cell validator](@/guides/cell-functions/cell-validator/cell-validator.md) |
|
4531
4531
|
* | `'autocomplete'` | `AutocompleteValidator` |
|
4532
4532
|
* | `'date'` | `DateValidator` |
|
4533
4533
|
* | `'dropdown'` | `DropdownValidator` |
|
@@ -4538,9 +4538,9 @@ export default (() => {
|
|
4538
4538
|
* options all at once, use the [`type`](#type) option.
|
4539
4539
|
*
|
4540
4540
|
* Read more:
|
4541
|
-
* - [Cell validator](@/guides/cell-functions/cell-validator.md)
|
4542
|
-
* - [Cell type](@/guides/cell-types/cell-type.md)
|
4543
|
-
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
|
4541
|
+
* - [Cell validator](@/guides/cell-functions/cell-validator/cell-validator.md)
|
4542
|
+
* - [Cell type](@/guides/cell-types/cell-type/cell-type.md)
|
4543
|
+
* - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options/configuration-options.md#cascading-configuration)
|
4544
4544
|
* - [`type`](#type)
|
4545
4545
|
*
|
4546
4546
|
* @memberof Options#
|
@@ -4584,7 +4584,7 @@ export default (() => {
|
|
4584
4584
|
* The `viewportColumnRenderingOffset` setting is ignored when [`renderAllColumns`](#renderAllColumns) is set to `true`.
|
4585
4585
|
*
|
4586
4586
|
* Read more:
|
4587
|
-
* - [Performance: Define the number of pre-rendered rows and columns](@/guides/optimization/performance.md#define-the-number-of-pre-rendered-rows-and-columns)
|
4587
|
+
* - [Performance: Define the number of pre-rendered rows and columns](@/guides/optimization/performance/performance.md#define-the-number-of-pre-rendered-rows-and-columns)
|
4588
4588
|
*
|
4589
4589
|
* @memberof Options#
|
4590
4590
|
* @type {number|string}
|
@@ -4613,8 +4613,8 @@ export default (() => {
|
|
4613
4613
|
* The `viewportRowRenderingOffset` setting is ignored when [`renderAllRows`](#renderAllRows) is set to `true`.
|
4614
4614
|
*
|
4615
4615
|
* Read more:
|
4616
|
-
* - [Performance: Define the number of pre-rendered rows and columns](@/guides/optimization/performance.md#define-the-number-of-pre-rendered-rows-and-columns)
|
4617
|
-
* - [Column virtualization](@/guides/columns/column-virtualization.md)
|
4616
|
+
* - [Performance: Define the number of pre-rendered rows and columns](@/guides/optimization/performance/performance.md#define-the-number-of-pre-rendered-rows-and-columns)
|
4617
|
+
* - [Column virtualization](@/guides/columns/column-virtualization/column-virtualization.md)
|
4618
4618
|
*
|
4619
4619
|
* @memberof Options#
|
4620
4620
|
* @type {number|string}
|
@@ -4629,14 +4629,14 @@ export default (() => {
|
|
4629
4629
|
*/
|
4630
4630
|
viewportRowRenderingOffset: 'auto',
|
4631
4631
|
/**
|
4632
|
-
* The `visibleRows` option sets the height of the [`autocomplete`](@/guides/cell-types/autocomplete-cell-type.md)
|
4633
|
-
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type.md) lists.
|
4632
|
+
* The `visibleRows` option sets the height of the [`autocomplete`](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
4633
|
+
* and [`dropdown`](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md) lists.
|
4634
4634
|
*
|
4635
4635
|
* When the number of list options exceeds the `visibleRows` number, a scrollbar appears.
|
4636
4636
|
*
|
4637
4637
|
* Read more:
|
4638
|
-
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type.md)
|
4639
|
-
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type.md)
|
4638
|
+
* - [Autocomplete cell type](@/guides/cell-types/autocomplete-cell-type/autocomplete-cell-type.md)
|
4639
|
+
* - [Dropdown cell type](@/guides/cell-types/dropdown-cell-type/dropdown-cell-type.md)
|
4640
4640
|
*
|
4641
4641
|
* @memberof Options#
|
4642
4642
|
* @type {number}
|
@@ -4674,7 +4674,7 @@ export default (() => {
|
|
4674
4674
|
* | A function that returns a valid number or string | `width() { return 500; }` |
|
4675
4675
|
*
|
4676
4676
|
* Read more:
|
4677
|
-
* - [Grid size](@/guides/getting-started/grid-size.md)
|
4677
|
+
* - [Grid size](@/guides/getting-started/grid-size/grid-size.md)
|
4678
4678
|
*
|
4679
4679
|
* @memberof Options#
|
4680
4680
|
* @type {number|string|Function}
|