BarPlotView

Base class for creating bar plots.

:property x_label: The X-axis label :type x_label: str :property y_label: The Y-axis label :type y_label: str :property x_tick_labels: The labels of X-ticks :type x_tick_labels: list[str]

The view model is:

{
    "type": "bar-plot-view",
    "title": str,
    "caption": str,
    "data": {
        "x_label": str,
        "y_label": str,
        "x_tick_labels": List[str] | None,
        "series": [
            {
                "data": {
                    "x": List[Float],
                    "y": List[Float],
                    "tags": List[Dict[str,str]] | None
                },
                "name": str,
            },
            ...
        ]
    }
}

Attributes

x_label: strx_tick_labels: Listx_tick_tags: Listy_label: str

Functions

__INIT__

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

ADD_SERIES

Add a series of bars to plot

Parameters:

Name	Type	Description
x	`Union`	List of float
y	`List`	List of float
name	`str`
tags	`List`	[dict[str, str]]

ADD_TECHNICAL_INFO

Add technical info

Parameters:

Name	Type	Default value	Description
technical_info	`TechnicalInfo`

COPY_INFO

Copy the view information from another view

Parameters:

Name	Type	Default value	Description
view	`View`		View to copy the information from

DATA_TO_DICT

Convert to dictionary

Parameters:

Name	Type	Default value	Description
params	`ConfigParams`

Return type:

dict

DISABLE_PAGINATION

Mark the view as not interactive, disable the pagination

GET_STYLE

Get style

Return type:

TypingStyle

GET_TECHNICAL_INFO

Get technical info dict

Parameters:

Name	Type	Default value	Description
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

IS_FAVORITE

Is favorite

Return type:

bool

IS_PAGINATION_DISABLED

Is interaction disabled

Return type:

bool

SET_FAVORITE

Set favorite

Parameters:

Name	Type	Default value	Description
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.

Parameters:

Name	Type	Default value	Description
style	`TypingStyle`

SET_TECHNICAL_INFO_DICT

Set technical info

Parameters:

Name	Type	Default value	Description
technical_info	`TechnicalInfoDict`

SET_TITLE

Set title

Parameters:

Name	Type	Default value	Description
title	`str`

TO_DTO

Convert to DTO

Parameters:

Name	Type	Default value	Description
params	`ConfigParams`

Return type:

ViewDTO

GENERATE_RANGE - @classmethod

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

Parameters:

Name	Type	Default value	Description
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

Parameters:

Name	Type	Default value	Description
json_	`Any`

Return type:

bool