Method createCol

handsontable/src/dataMap/dataMap.ts:463–525

* Creates column at the right of the data array. * * @param {number} [index] Visual index of the column before which the new column will be inserted. * @param {number} [amount=1] An amount of columns to add. * @param {object} [options] Additional options for created columns. * @param

(index: number | undefined, amount = 1,
            { source, mode = 'start' }: { source?: string; mode?: 'start' | 'end' } = {})

   * @returns {number} Returns number of created columns.
   */
  createCol(index: number | undefined, amount = 1,
            { source, mode = 'start' }: { source?: string; mode?: 'start' | 'end' } = {}) {
    if (!this.hot!.isColumnModificationAllowed()) {
      throwWithCause('Cannot create new column. When data source in an object, ' +
        // eslint-disable-next-line max-len
        'you can only have as much columns as defined in first data row, data schema or in the \'columns\' setting.' +
        'If you want to be able to add new columns, you have to use array datasource.');
    }

    const dataSource = this.dataSource ?? [];
    const maxCols = this.tableMeta.maxCols;
    const numberOfSourceCols = this.hot!.countSourceCols();
    const numberOfVisualCols = this.hot!.countCols();
    const numberOfSourceRows = this.hot!.countSourceRows();
    const visualColumnIndex = (typeof index === 'number' && index <= numberOfSourceCols) ? index : numberOfVisualCols;

    if (this.hot!.runHooks('beforeCreateCol', visualColumnIndex, amount, source) === false) {
      return { delta: 0 };
    }

    const physicalColumnIndex = (visualColumnIndex < numberOfVisualCols) ?
      this.hot!.toPhysicalColumn(visualColumnIndex) : numberOfSourceCols;
    const firstNewPhysicalColumnIndex = (mode === 'end') ?
      Math.min(physicalColumnIndex + 1, numberOfSourceCols) : physicalColumnIndex;

    let numberOfCreatedCols = 0;

    for (
      let col = firstNewPhysicalColumnIndex;
      numberOfCreatedCols < amount && numberOfVisualCols + numberOfCreatedCols < (maxCols ?? Infinity);
      col++, numberOfCreatedCols++
    ) {
      this.#insertColumnIntoDataSource(
        dataSource, col, visualColumnIndex, numberOfVisualCols + numberOfCreatedCols, numberOfSourceRows
      );
    }

    if (numberOfCreatedCols > 0) {
      if ((index === undefined || index === null)) {
        // Creates the meta columns at the end of the columns collection without shifting the cells
        // that were defined out of the range of the dataset.
        this.metaManager!.createColumn(null, numberOfCreatedCols);

      } else if (source !== 'auto') {
        this.metaManager!.createColumn(firstNewPhysicalColumnIndex, amount);
      }
    }

    this.hot!.columnIndexMapper.insertIndexes(visualColumnIndex, numberOfCreatedCols, mode);

    this.hot!.runHooks(
      'afterCreateCol',
      this.hot!.toVisualColumn(firstNewPhysicalColumnIndex),
      numberOfCreatedCols,
      source
    );
    this.refreshDuckSchema();