Method insert_cols

gspread/worksheet.py:1978–2041

Adds multiple new cols to the worksheet at specified index and populates them with values. :param list values: List of col lists. a list of lists, with the lists each containing one col's values. Increases the number of rows if there are more values than colu

(
        self,
        values: Sequence[Sequence[Union[str, int, float]]],
        col: int = 1,
        value_input_option: ValueInputOption = ValueInputOption.raw,
        inherit_from_before: bool = False,
    )

        return res

    def insert_cols(
        self,
        values: Sequence[Sequence[Union[str, int, float]]],
        col: int = 1,
        value_input_option: ValueInputOption = ValueInputOption.raw,
        inherit_from_before: bool = False,
    ) -> JSONResponse:
        """Adds multiple new cols to the worksheet at specified index and
        populates them with values.

        :param list values: List of col lists. a list of lists, with the lists
            each containing one col's values. Increases the number of rows
            if there are more values than columns.
        :param int col: Start col to update (one-based). Defaults to 1 (one).
        :param str value_input_option: (optional) Determines how input data
            should be interpreted. Possible values are ``ValueInputOption.raw``
            or ``ValueInputOption.user_entered``.
            See `ValueInputOption`_ in the Sheets API.
        :type value_input_option: :class:`~gspread.utils.ValueInputOption`
        :param bool inherit_from_before: (optional) If True, new columns will
            inherit their properties from the previous column. Defaults to
            False, meaning that new columns acquire the properties of the
            column immediately after them.

            .. warning::

               `inherit_from_before` must be False if adding at the left edge
               of a spreadsheet (`col=1`), and must be True if adding at the
               right edge of the spreadsheet.
        """

        if inherit_from_before and col == 1:
            raise GSpreadException(
                "inherit_from_before cannot be used when inserting column(s) at the left edge of a spreadsheet"
            )

        insert_dimension_body = {
            "requests": [
                {
                    "insertDimension": {
                        "range": {
                            "sheetId": self.id,
                            "dimension": Dimension.cols,
                            "startIndex": col - 1,
                            "endIndex": len(values) + col - 1,
                        },
                        "inheritFromBefore": inherit_from_before,
                    }
                }
            ]
        }

        self.client.batch_update(self.spreadsheet_id, insert_dimension_body)

        range_label = absolute_range_name(self.title, rowcol_to_a1(1, col))

        params: ParamsType = {"valueInputOption": value_input_option}