gws_core

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