Method format

gspread/worksheet.py:1439–1486

Format a list of ranges with the given format. :param str|list ranges: Target ranges in the A1 notation. :param dict format: Dictionary containing the fields to update. See `CellFormat`_ in the Sheets API for available fields. Examples:: # Set 'A4'

(
        self, ranges: Union[List[str], str], format: JSONResponse
    )

        return self.client.batch_update(self.spreadsheet_id, body)

    def format(
        self, ranges: Union[List[str], str], format: JSONResponse
    ) -> JSONResponse:
        """Format a list of ranges with the given format.

        :param str|list ranges: Target ranges in the A1 notation.
        :param dict format: Dictionary containing the fields to update.
            See `CellFormat`_ in the Sheets API for available fields.

        Examples::

            # Set 'A4' cell's text format to bold
            worksheet.format("A4", {"textFormat": {"bold": True}})

            # Set 'A1:D4' and 'A10:D10' cells's text format to bold
            worksheet.format(["A1:D4", "A10:D10"], {"textFormat": {"bold": True}})

            # Color the background of 'A2:B2' cell range in black,
            # change horizontal alignment, text color and font size
            worksheet.format("A2:B2", {
                "backgroundColor": {
                  "red": 0.0,
                  "green": 0.0,
                  "blue": 0.0
                },
                "horizontalAlignment": "CENTER",
                "textFormat": {
                  "foregroundColor": {
                    "red": 1.0,
                    "green": 1.0,
                    "blue": 1.0
                  },
                  "fontSize": 12,
                  "bold": True
                }
            })

        .. versionadded:: 3.3
        """

        if isinstance(ranges, list):
            range_list = ranges
        else:
            range_list = [ranges]

        formats = [CellFormat(range=range, format=format) for range in range_list]

        return self.batch_format(formats)

    def resize(
        self, rows: Optional[int] = None, cols: Optional[int] = None