Method createRow

handsontable/src/dataMap/dataMap.ts:357–449

* Creates row at the bottom of the data array. * * @param {number} [index] Physical index of the row before which the new row will be inserted. * @param {number} [amount=1] An amount of rows to add. * @param {object} [options] Additional options for created rows. * @param {string} [op

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

   * @returns {number} Returns number of created rows.
   */
  createRow(index: number | undefined, amount = 1,
            { source, mode = 'above' }: { source?: string; mode?: string } = {}) {
    const sourceRowsCount = this.hot!.countSourceRows();
    let physicalRowIndex = sourceRowsCount;
    let numberOfCreatedRows = 0;
    let rowIndex = index;

    if (typeof rowIndex !== 'number' || rowIndex >= sourceRowsCount) {
      rowIndex = sourceRowsCount;
    }

    if (rowIndex < this.hot!.countRows()) {
      physicalRowIndex = this.hot!.toPhysicalRow(rowIndex);
    }

    const continueProcess = this.hot!.runHooks('beforeCreateRow', rowIndex, amount, source);

    if (continueProcess === false || physicalRowIndex === null) {
      return {
        delta: 0,
      };
    }

    const maxRows = this.tableMeta.maxRows;
    const columnCount = (this.getSchema() as unknown[]).length;
    const rowsToAdd = [];

    while (numberOfCreatedRows < amount && sourceRowsCount + numberOfCreatedRows < (maxRows ?? Infinity)) {
      let row = null;

      if (this.hot!.dataType === 'array') {
        if (this.tableMeta.dataSchema) {
          // Clone template array
          row = deepClone(this.getSchema());

        } else {
          row = [];
          /* eslint-disable no-loop-func */
          rangeEach(columnCount - 1, () => row.push(null));
        }

      } else if (this.hot!.dataType === 'function') {
        const dataSchemaFn = this.tableMeta.dataSchema;

        if (typeof dataSchemaFn !== 'function') {
          throwWithCause('`dataSchema` must be a function when `dataType` is `function`');
        }
        row = (dataSchemaFn as (rowIndex: number) => unknown)(rowIndex + numberOfCreatedRows);

      } else {
        row = {};
        deepExtend(row, this.getSchema() as Record<string, unknown>);
      }

      rowsToAdd.push(row);

      numberOfCreatedRows += 1;
    }