handsontable 15.3.0 → 16.0.0-next-f486b48-20250702

package/core/hooks/constants.js

@@ -49,6 +49,22 @@ exports.__esModule = true;
  * />
  * :::
  *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   afterChange: (changes, source) => {
+ *     changes?.forEach(([row, prop, oldValue, newValue]) => {
+ *       // Some logic...
+ *     });
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings" />
+ * ```
+ * :::
+ *
  * ::: only-for javascript
  * ```js
  * // using events as plugin hooks
@@ -153,6 +169,22 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   afterChange: (changes, source) => {
+ *     changes?.forEach(([row, prop, oldValue, newValue]) => {
+ *       // Some logic...
+ *     });
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'afterChange',
 /**
@@ -256,6 +288,21 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   beforeCreateCol: (data, coords) => {
+ *     // Return `false` to cancel column inserting.
+ *     return false;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'beforeCreateCol',
 /**
@@ -640,6 +687,31 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   afterSelection: (
+ *     row,
+ *     column,
+ *     row2,
+ *     column2,
+ *     preventScrolling,
+ *     selectionLayerLevel
+ *   ) => {
+ *     // If set to `false` (default): when cell selection is outside the viewport,
+ *     // Handsontable scrolls the viewport to cell selection's end corner.
+ *     // If set to `true`: when cell selection is outside the viewport,
+ *     // Handsontable doesn't scroll to cell selection's end corner.
+ *     preventScrolling.value = true;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'afterSelection',
 /**
@@ -678,6 +750,28 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   afterSelectionByProp: (
+ *     row,
+ *     column,
+ *     row2,
+ *     column2,
+ *     preventScrolling,
+ *     selectionLayerLevel
+ *   ) => {
+ *     // Setting if prevent scrolling after selection
+ *     preventScrolling.value = true;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'afterSelectionByProp',
 /**
@@ -742,6 +836,24 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   afterSelectionFocusSet: (row, column, preventScrolling) => {
+ *     // If set to `false` (default): when focused cell selection is outside the viewport,
+ *     // Handsontable scrolls the viewport to that cell.
+ *     // If set to `true`: when focused cell selection is outside the viewport,
+ *     // Handsontable doesn't scroll the viewport.
+ *     preventScrolling.value = true;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'afterSelectionFocusSet',
 /**
@@ -776,6 +888,22 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   beforeSelectColumns: (from, to, highlight) => {
+ *     // Extend the column selection by one column left and one column right.
+ *     from.col = Math.max(from.col - 1, 0);
+ *     to.col = Math.min(to.col + 1, this.countCols() - 1);
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'beforeSelectColumns',
 /**
@@ -820,6 +948,22 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   beforeSelectRows: (from, to, highlight) => {
+ *     // Extend the row selection by one row up and one row down.
+ *     from.row = Math.max(from.row - 1, 0);
+ *     to.row = Math.min(to.row + 1, this.countRows() - 1);
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'beforeSelectRows',
 /**
@@ -1040,6 +1184,42 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * />
  * ```
  * :::
+ * ::: only-for angular
+ *```ts
+ * // To alter a single change, overwrite the desired value with `changes[i][3]`
+ * settings1 = {
+ *   beforeChange: (changes, source) => {
+ *     // [[row, prop, oldVal, newVal], ...]
+ *     changes[0][3] = 10;
+ *   },
+ * };
+ *
+ * // To ignore a single change, set `changes[i]` to `null`
+ * // or remove `changes[i]` from the array, by using changes.splice(i, 1).
+ * settings2 = {
+ *   beforeChange: (changes, source) => {
+ *     // [[row, prop, oldVal, newVal], ...]
+ *     changes[0] = null;
+ *   },
+ * };
+ *
+ * // To ignore all changes, return `false`
+ * // or set the array's length to 0 (`changes.length = 0`)
+ * settings3 = {
+ *   beforeChange: (changes, source) => {
+ *     // [[row, prop, oldVal, newVal], ...]
+ *     return false;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings1"></hot-table>
+ * <hot-table [settings]="settings2"></hot-table>
+ * <hot-table [settings]="settings3"></hot-table>
+ * ```
+ *
+ * :::
  */
 'beforeChange',
 /**
@@ -1447,7 +1627,7 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * Fired when a data was retrieved or modified.
  *
  * @event Hooks#modifyData
- * @param {number} row Physical row index.
+ * @param {number} row Visual row index.
  * @param {number} column Visual column index.
  * @param {object} valueHolder Object which contains original value which can be modified by overwriting `.value` property.
  * @param {string} ioMode String which indicates for what operation hook is fired (`get` or `set`).
@@ -1650,6 +1830,32 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ *```ts
+ * // To disregard a single row, remove it from the array using data.splice(i, 1).
+ * settings1 = {
+ *   beforeCut: (data, coords) => {
+ *     // data -> [[1, 2, 3], [4, 5, 6]]
+ *     data.splice(0, 1);
+ *     // data -> [[4, 5, 6]]
+ *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
+ *   },
+ * };
+ *
+ * // To cancel a cutting action, just return `false`.
+ * settings2 = {
+ *   beforeCut: (data, coords) => {
+ *     return false;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings1"></hot-table>
+ * <hot-table [settings]="settings2"></hot-table>
+ * ```
+ * :::
  */
 'beforeCut',
 /**
@@ -1722,6 +1928,32 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * ...
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * // To disregard a single row, remove it from the array using data.splice(i, 1).
+ * settings1 = {
+ *   beforeCopy: (data, coords) => {
+ *     // data -> [[1, 2, 3], [4, 5, 6]]
+ *     data.splice(0, 1);
+ *     // data -> [[4, 5, 6]]
+ *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
+ *   },
+ * };
+ *
+ * // To cancel copying, return false from the callback.
+ * settings2 = {
+ *   beforeCopy: (data, coords) => {
+ *     return false;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings1"></hot-table>
+ * <hot-table [settings]="settings2"></hot-table>
+ * ```
+ * :::
  */
 'beforeCopy',
 /**
@@ -1784,6 +2016,32 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * // To disregard a single row, remove it from the array using data.splice(i, 1).
+ * settings1 = {
+ *   beforePaste: (data, coords) => {
+ *     // data -> [[1, 2, 3], [4, 5, 6]]
+ *     data.splice(0, 1);
+ *     // data -> [[4, 5, 6]]
+ *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
+ *   },
+ * };
+ *
+ * // To cancel pasting, return false from the callback.
+ * settings2 = {
+ *   beforePaste: (data, coords) => {
+ *     return false;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings1"></hot-table>
+ * <hot-table [settings]="settings2"></hot-table>
+ * ```
+ * :::
  */
 'beforePaste',
 /**

package/core/hooks/constants.mjs

@@ -46,6 +46,22 @@
  * />
  * :::
  *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   afterChange: (changes, source) => {
+ *     changes?.forEach(([row, prop, oldValue, newValue]) => {
+ *       // Some logic...
+ *     });
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings" />
+ * ```
+ * :::
+ *
  * ::: only-for javascript
  * ```js
  * // using events as plugin hooks
@@ -150,6 +166,22 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   afterChange: (changes, source) => {
+ *     changes?.forEach(([row, prop, oldValue, newValue]) => {
+ *       // Some logic...
+ *     });
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'afterChange',
 /**
@@ -253,6 +285,21 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   beforeCreateCol: (data, coords) => {
+ *     // Return `false` to cancel column inserting.
+ *     return false;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'beforeCreateCol',
 /**
@@ -637,6 +684,31 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   afterSelection: (
+ *     row,
+ *     column,
+ *     row2,
+ *     column2,
+ *     preventScrolling,
+ *     selectionLayerLevel
+ *   ) => {
+ *     // If set to `false` (default): when cell selection is outside the viewport,
+ *     // Handsontable scrolls the viewport to cell selection's end corner.
+ *     // If set to `true`: when cell selection is outside the viewport,
+ *     // Handsontable doesn't scroll to cell selection's end corner.
+ *     preventScrolling.value = true;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'afterSelection',
 /**
@@ -675,6 +747,28 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   afterSelectionByProp: (
+ *     row,
+ *     column,
+ *     row2,
+ *     column2,
+ *     preventScrolling,
+ *     selectionLayerLevel
+ *   ) => {
+ *     // Setting if prevent scrolling after selection
+ *     preventScrolling.value = true;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'afterSelectionByProp',
 /**
@@ -739,6 +833,24 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   afterSelectionFocusSet: (row, column, preventScrolling) => {
+ *     // If set to `false` (default): when focused cell selection is outside the viewport,
+ *     // Handsontable scrolls the viewport to that cell.
+ *     // If set to `true`: when focused cell selection is outside the viewport,
+ *     // Handsontable doesn't scroll the viewport.
+ *     preventScrolling.value = true;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'afterSelectionFocusSet',
 /**
@@ -773,6 +885,22 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   beforeSelectColumns: (from, to, highlight) => {
+ *     // Extend the column selection by one column left and one column right.
+ *     from.col = Math.max(from.col - 1, 0);
+ *     to.col = Math.min(to.col + 1, this.countCols() - 1);
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'beforeSelectColumns',
 /**
@@ -817,6 +945,22 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   beforeSelectRows: (from, to, highlight) => {
+ *     // Extend the row selection by one row up and one row down.
+ *     from.row = Math.max(from.row - 1, 0);
+ *     to.row = Math.min(to.row + 1, this.countRows() - 1);
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'beforeSelectRows',
 /**
@@ -1037,6 +1181,42 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * />
  * ```
  * :::
+ * ::: only-for angular
+ *```ts
+ * // To alter a single change, overwrite the desired value with `changes[i][3]`
+ * settings1 = {
+ *   beforeChange: (changes, source) => {
+ *     // [[row, prop, oldVal, newVal], ...]
+ *     changes[0][3] = 10;
+ *   },
+ * };
+ *
+ * // To ignore a single change, set `changes[i]` to `null`
+ * // or remove `changes[i]` from the array, by using changes.splice(i, 1).
+ * settings2 = {
+ *   beforeChange: (changes, source) => {
+ *     // [[row, prop, oldVal, newVal], ...]
+ *     changes[0] = null;
+ *   },
+ * };
+ *
+ * // To ignore all changes, return `false`
+ * // or set the array's length to 0 (`changes.length = 0`)
+ * settings3 = {
+ *   beforeChange: (changes, source) => {
+ *     // [[row, prop, oldVal, newVal], ...]
+ *     return false;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings1"></hot-table>
+ * <hot-table [settings]="settings2"></hot-table>
+ * <hot-table [settings]="settings3"></hot-table>
+ * ```
+ *
+ * :::
  */
 'beforeChange',
 /**
@@ -1444,7 +1624,7 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * Fired when a data was retrieved or modified.
  *
  * @event Hooks#modifyData
- * @param {number} row Physical row index.
+ * @param {number} row Visual row index.
  * @param {number} column Visual column index.
  * @param {object} valueHolder Object which contains original value which can be modified by overwriting `.value` property.
  * @param {string} ioMode String which indicates for what operation hook is fired (`get` or `set`).
@@ -1647,6 +1827,32 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ *```ts
+ * // To disregard a single row, remove it from the array using data.splice(i, 1).
+ * settings1 = {
+ *   beforeCut: (data, coords) => {
+ *     // data -> [[1, 2, 3], [4, 5, 6]]
+ *     data.splice(0, 1);
+ *     // data -> [[4, 5, 6]]
+ *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
+ *   },
+ * };
+ *
+ * // To cancel a cutting action, just return `false`.
+ * settings2 = {
+ *   beforeCut: (data, coords) => {
+ *     return false;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings1"></hot-table>
+ * <hot-table [settings]="settings2"></hot-table>
+ * ```
+ * :::
  */
 'beforeCut',
 /**
@@ -1719,6 +1925,32 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * ...
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * // To disregard a single row, remove it from the array using data.splice(i, 1).
+ * settings1 = {
+ *   beforeCopy: (data, coords) => {
+ *     // data -> [[1, 2, 3], [4, 5, 6]]
+ *     data.splice(0, 1);
+ *     // data -> [[4, 5, 6]]
+ *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
+ *   },
+ * };
+ *
+ * // To cancel copying, return false from the callback.
+ * settings2 = {
+ *   beforeCopy: (data, coords) => {
+ *     return false;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings1"></hot-table>
+ * <hot-table [settings]="settings2"></hot-table>
+ * ```
+ * :::
  */
 'beforeCopy',
 /**
@@ -1781,6 +2013,32 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * // To disregard a single row, remove it from the array using data.splice(i, 1).
+ * settings1 = {
+ *   beforePaste: (data, coords) => {
+ *     // data -> [[1, 2, 3], [4, 5, 6]]
+ *     data.splice(0, 1);
+ *     // data -> [[4, 5, 6]]
+ *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
+ *   },
+ * };
+ *
+ * // To cancel pasting, return false from the callback.
+ * settings2 = {
+ *   beforePaste: (data, coords) => {
+ *     return false;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings1"></hot-table>
+ * <hot-table [settings]="settings2"></hot-table>
+ * ```
+ * :::
  */
 'beforePaste',
 /**

package/core.d.ts

@@ -113,6 +113,8 @@ export default class Core {
   getSourceDataAtCell(row: number, column: number): CellValue;
   getSourceDataAtCol(column: number): CellValue[];
   getSourceDataAtRow(row: number): CellValue[] | RowObject;
+  getTableWidth(): number;
+  getTableHeight(): number;
   getTranslatedPhrase(dictionaryKey: string, extraArguments: any): string | null;
   getValue(): CellValue;
   hasColHeaders(): boolean;