hw.hg Module for TableView#

TableOverlay class#

class TableOverlay(page: int | str | Page = None, window: int | Window = None, table: Table = None, id: int = 0)#

A class representing TableOverlay.

Parameters:

page (Union[Page, int, str]) – Page of the Table, default is the active page.
window (Union[Window, int]) – Window of the Table, default is the active window.
table (Table or None) – Table. Default None
id (int) – Table id.Default is 0.
kwargs (dict) – To set the other attributes of TableOverlay class.

property id: int#

Attribute to get the TableOverlay id.

Getter:: Gets the TableOverlay id.
Type:: int

property name#

Attribute to set or get name of the TableOverlay.

Getter:: Gets the name.
Setter:: Sets the name.
Type:: str

property page: Page#: Returns the Page Object.

property range#

Attribute to get or set the cellrange to the TableOverlay.

Getter:: Gets the list of cells participating the overlay operation.
Setter:: Sets the list of cells participating the overlay operation.
Type:: list[str]

property table#

Attribute to get the Table associated with the TableOverlay object.

Getter:: Gets the Table object.
Type:: Table

property type#

Attribute to get the type of the TableOverlay. The value is one of from “appendAsRows”,”appendAsColumns”,”insertAsRows”,insertAsColumns”

Getter:: Gets the type of the TableOverlay object.
Type:: str

property window: Window#: Returns the Window Object.

TableRule class#

class TableRule(page: int | str | Page = None, window: int | Window = None, table: Table = None, id: int = 0)#

A class representing TableRule.

Parameters:

page (Union[Page, int, str]) – Page of the TableRule. Default is the active page.
window (Union[Window, int]) – Window of the TableRule. Default is the active window.
table (Table or None) – Table of the TableRule. Default is None
id (int) – TableRule id. Default is 0.
kwargs (dict) – To set the other attributes of TableRule class.

property backgroundColor#

Attribute to set or get BackgroundColor associated with the TableRule.

Getter:: Gets the background color associated with the TableRule.
Setter:: Sets the background color associated with the TableRule.
Type:: Color

property cellList#

Attribute to set or get cells associated with the TableRule.

Getter:: Gets the list of TableRule cells
Setter:: Sets the cells to the TableRule.
Type:: list[str]

property id: int#

Attribute to get the TableRule id.

Getter:: Gets the TableRule id.
Type:: int

property operator#

Attribute to set or get operator associated with the TableRule. Valid values are ‘<’, ‘>’, ‘=’, ‘!=’, ‘<=’ or ‘>=’.

Getter:: Gets the operator.
Setter:: Sets the operator.
Type:: str

property page: Page#: Returns the Page Object.

property table#

Attribute to get the Table associated with the TableRule object.

Getter:: Gets the Table object.
Type:: Table

property textColor#

Attribute to set or get TextColor associated with the TableRule.

Getter:: Gets the text color associated with the TableRule.
Setter:: Sets the text color associated with the TableRule.
Type:: Color

property value#

Attribute to set or get value associated with the TableRule.

Getter:: Gets the value associated with the TableRule.
Setter:: Sets the value associated with the TableRule.
Type:: str

property window: Window#: Returns the Window Object.