Method clear_tab_color

gspread/worksheet.py:1650–1671

Clears the worksheet's tab color. Use update_tab_color() to set the color.

(self)

        return response

    def clear_tab_color(self) -> JSONResponse:
        """Clears the worksheet's tab color.
        Use update_tab_color() to set the color.
        """
        body = {
            "requests": [
                {
                    "updateSheetProperties": {
                        "properties": {
                            "sheetId": self.id,
                            "tabColorStyle": {
                                "rgbColor": None,
                            },
                        },
                        "fields": "tabColorStyle",
                    },
                },
            ],
        }
        response = self.client.batch_update(self.spreadsheet_id, body)
        self._properties.pop("tabColorStyle")
        return response

    def update_index(self, index: int) -> JSONResponse:
        """Updates the ``index`` property for the worksheet.