Back to bricks list
Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
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.

table : Table
ADD_TECHNICAL_INFO

Add technical info

technical_info : TechnicalInfo
CHECK_COLUMN_NAMES
column_names : Any
COPY_INFO

Copy the view information from another view

View : View
view to copy the information from
DATA_TO_DICT

Convert to dictionary

params : ConfigParams
Return type : dict
DISABLE_PAGINATION

Mark the view as not interactive, disable the pagination

GET_DATAFRAME_FROM_COLUMNS

Extract a new dataframe

column_names : List[str]
Return type : DataFrame
GET_DATAFRAME_FROM_COORDS

Get a dataframe from a single range

range : CellRange
Return type : DataFrame
GET_ROW_TAGS
Return type : List[Dict[str, str]]
GET_ROW_TAGS_FROM_COORDS
ranges : List[CellRange]
Return type : List[Dict[str, str]]
GET_ROW_TAGS_FROM_SELECTION_RANGE
selection_range : TableSelection
Return type : List[Dict[str, str]]
GET_SINGLE_COLUMN_TAGS_FROM_SELECTION_RANGE
selection_range : TableSelection
Return type : List[Dict[str, str]]
GET_STYLE

Get style

Return type : TypingStyle
GET_TABLE
GET_TECHNICAL_INFO

Get technical info dict

key : str
Return type : TechnicalInfo
GET_TECHNICAL_INFO_DICT

Get technical info

Return type : TechnicalInfoDict
GET_TITLE

Get title

Return type : Optional
GET_TYPE

Get type

Return type : ViewType
GET_VALUES_FROM_COLUMNS

Get all the values of multiple column flattened

column_names : List[str]
Return type : List[Any]
GET_VALUES_FROM_COORDS

Get flattened values from a list of ranges

ranges : List[CellRange]
Return type : List[Any]
GET_VALUES_FROM_SELECTION_RANGE

Get table flattened value form a SelectionRange

selection_range : TableSelection
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

serie_list : Serie1dList
Return type : Optional[List[str]]
IS_FAVORITE

Is favorite

Return type : bool
IS_PAGINATION_DISABLED

Is interaction disabled

Return type : bool
SET_FAVORITE

Set favorite

favorite : bool
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.

style : TypingStyle
SET_TECHNICAL_INFO_DICT

Set technical info

technical_info : TechnicalInfoDict
SET_TITLE

Set title

Title : str
TO_DTO

Convert to DTO

params : ConfigParams
Return type : ViewDTO
GENERATE_RANGE - @classmethod

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

length : int
Return type : List
GET_SPECS - @classmethod
Return type : Dict
JSON_IS_FROM_VIEW - @classmethod

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

json_ : Any
Return type : bool