Login
Back to bricks list
Introduction Version

TableView

Use this view to return a section of a Table and enable pagination to retrieve other section. This view embed config to enable pagination.

The view model is:

{
    "type": "table"
    "title": str,
    "caption": str,
    "data" List[List[float]],
    "rows": List[Dict["name": str, tags: Dict[str, str]]],
    "columns": List[Dict["name": str, tags: Dict[str, str]]],
    "from_row": int,
    "number_of_rows_per_page": int,
    "from_column": int,
    "number_of_columns_per_page": int,
    "total_number_of_rows": int,
    "total_number_of_columns": int,
}

Functions

__INIT__

Initialize self. See help(type(self)) for accurate signature.

Parameters:
NameTypeDefault valueDescription
tableTable
ADD_TECHNICAL_INFO

Add technical info

Parameters:
NameTypeDefault valueDescription
technical_infoTechnicalInfo
CHECK_COLUMN_NAMES
Parameters:
NameTypeDefault valueDescription
column_namesAny
DATA_TO_DICT

Convert to dictionary

Parameters:
NameTypeDefault valueDescription
paramsConfigParams
Return type:
dict
GET_DATAFRAME_FROM_COLUMNS

Extract a new dataframe

Parameters:
NameTypeDefault valueDescription
column_namesList[str]
Return type:
DataFrame
GET_DATAFRAME_FROM_COORDS

Get a dataframe from a single range

Parameters:
NameTypeDefault valueDescription
rangeCellRange
Return type:
DataFrame
GET_ROW_TAGS
Return type:
List[Dict[str, str]]
GET_ROW_TAGS_FROM_COORDS
Parameters:
NameTypeDefault valueDescription
rangesList[CellRange]
Return type:
List[Dict[str, str]]
GET_ROW_TAGS_FROM_SELECTION_RANGE
Parameters:
NameTypeDefault valueDescription
selection_rangeTableSelection
Return type:
List[Dict[str, str]]
GET_SINGLE_COLUMN_TAGS_FROM_SELECTION_RANGE
Parameters:
NameTypeDefault valueDescription
selection_rangeTableSelection
Return type:
List[Dict[str, str]]
GET_STYLE

Get style

Return type:
TypingStyle
GET_TABLE
GET_TECHNICAL_INFO

Get technical info dict

Parameters:
NameTypeDefault valueDescription
keystr
Return type:
TechnicalInfo
GET_TECHNICAL_INFO_DICT

Get technical info

Return type:
TechnicalInfoDict
GET_TITLE

Get title

Return type:
str
GET_TYPE

Get type

Return type:
ViewType
GET_VALUES_FROM_COLUMNS

Get all the values of multiple column flattened

Parameters:
NameTypeDefault valueDescription
column_namesList[str]
Return type:
List[Any]
GET_VALUES_FROM_COORDS

Get flattened values from a list of ranges

Parameters:
NameTypeDefault valueDescription
rangesList[CellRange]
Return type:
List[Any]
GET_VALUES_FROM_SELECTION_RANGE

Get table flattened value form a SelectionRange

Parameters:
NameTypeDefault valueDescription
selection_rangeTableSelection
Return type:
List[Any]
GET_X_TICK_LABELS_FROM_SERIES_LIST

Get the x tick labels from a serie list if possible, if all the series have the same rows selection

Parameters:
NameTypeDefault valueDescription
serie_listSerie1dList
Return type:
Optional[List[str]]
IS_FAVORITE

Is favorite

Return type:
bool
SET_FAVORITE

Set favorite

Parameters:
NameTypeDefault valueDescription
favoritebool
SET_STYLE

Set typing style for this view instance. This overrides the style defines in the view decorator and the default style of the view type With this you can define a custom style for a specific view instance when you view is generic.

Parameters:
NameTypeDefault valueDescription
styleTypingStyle
SET_TECHNICAL_INFO_DICT

Set technical info

Parameters:
NameTypeDefault valueDescription
technical_infoTechnicalInfoDict
SET_TITLE

Set title

Parameters:
NameTypeDefault valueDescription
titlestr
TO_DTO

Convert to DTO

Parameters:
NameTypeDefault valueDescription
paramsConfigParams
Return type:
ViewDTO
GENERATE_RANGE - @classmethod

Generate range list like 0,1,2...length

Parameters:
NameTypeDefault valueDescription
lengthint
Return type:
List
JSON_IS_FROM_VIEW - @classmethod

Method that return true is the provided json is a json of a view

Parameters:
NameTypeDefault valueDescription
json_Any
Return type:
bool