Skip to content

Sheet properties

GridProperties dataclass

GridProperties: Properties of a grid.

Google Docs: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets#GridProperties

Source code in pygsuite/sheets/sheet_properties.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
@dataclass
class GridProperties:
    """GridProperties: Properties of a grid.

    Google Docs: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets#GridProperties
    """

    row_count: Optional[int] = None
    column_count: Optional[int] = None
    frozen_row_count: Optional[int] = None
    frozen_column_count: Optional[int] = None
    hide_gridlines: Optional[bool] = None
    row_group_control_after: Optional[bool] = None
    colum_group_control_after: Optional[bool] = None

    def to_json(self):  # noqa: C901

        base = {}

        if self.row_count is not None:
            base["rowCount"] = self.row_count
        if self.column_count is not None:
            base["columnCount"] = self.column_count
        if self.frozen_row_count is not None:
            base["frozenRowCount"] = self.frozen_row_count
        if self.frozen_column_count is not None:
            base["frozenColumnCount"] = self.frozen_column_count
        if self.hide_gridlines is not None:
            base["hideGridlines"] = self.hide_gridlines
        if self.row_group_control_after is not None:
            base["rowGroupControlAfter"] = self.row_group_control_after
        if self.colum_group_control_after is not None:
            base["columnGroupControlAfter"] = self.colum_group_control_after

        return base

SheetType

Bases: Enum

SheetType: The kind of sheet.

Google Docs: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets#SheetType

Source code in pygsuite/sheets/sheet_properties.py 
 8
 9
10
11
12
13
14
15
class SheetType(Enum):
    """SheetType: The kind of sheet.

    Google Docs: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets#SheetType
    """

    GRID = "GRID"
    OBJECT = "OBJECT"