Method removeCol

handsontable/src/dataMap/dataMap.ts:626–668

* Removes column from the data array. * * @fires Hooks#beforeRemoveCol * @fires Hooks#afterRemoveCol * @param {number} [index] Visual index of the column to be removed. If not provided, the last column will be removed. * @param {number} [amount=1] Amount of the columns to be removed.

(index: number, amount = 1, source: string)

   * @returns {boolean} Returns `false` when action was cancelled, otherwise `true`.
   */
  removeCol(index: number, amount = 1, source: string) {
    if (this.hot!.dataType === 'object' || this.tableMeta.columns) {
      throwWithCause('cannot remove column with object data source or columns option specified');
    }
    let columnIndex = typeof index !== 'number' ? -amount : index;

    columnIndex = (this.hot!.countCols() + columnIndex) % this.hot!.countCols();

    const removedPhysicalIndexes = this.visualColumnsToPhysical(columnIndex, amount);
    const descendingPhysicalColumns = removedPhysicalIndexes.slice(0).sort((a, b) => b - a);
    const actionWasNotCancelled = this.hot!.runHooks(
      'beforeRemoveCol', columnIndex, amount, removedPhysicalIndexes, source
    );

    if (actionWasNotCancelled === false) {
      return false;
    }

    let isTableUniform = true;
    const removedColumnsCount = descendingPhysicalColumns.length;
    const data = this.dataSource ?? [];

    for (let c = 0; c < removedColumnsCount; c++) {
      if (isTableUniform && removedPhysicalIndexes[0] !== removedPhysicalIndexes[c] - c) {
        isTableUniform = false;
      }
    }

    this.#spliceRemovedColumns(data, isTableUniform, removedPhysicalIndexes, descendingPhysicalColumns, amount);

    if (columnIndex < this.hot!.countCols()) {
      this.hot!.columnIndexMapper.removeIndexes(removedPhysicalIndexes);

      if (!this.tableMeta.rowHeaders && this.hot!.columnIndexMapper.getNotTrimmedIndexesLength() === 0) {
        this.hot!.rowIndexMapper.setIndexesSequence([]);
      }
    }

    this.hot!.runHooks('afterRemoveCol', columnIndex, amount, removedPhysicalIndexes, source);
    this.refreshDuckSchema();

    return true;
  }

  /**
   * Splices the removed physical columns from each row in the data source,