CTRL + K
Stories
Apps
Agents
Bricks
Constellab Space LogoSpace
Login

gws_core

Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

HistogramView

HistogramView

Base class for creating histograms.

:property x_label: The X-axis label :type x_label: str :property y_label: The Y-axis label :type y_label: str :property nbins: The number of bins :type nbins: int :property density: True to plot the density, The frequency is plotted overwise (default) :type density: bool :property x_tick_labels: The labels of X-ticks :type x_tick_labels: list[str]

The view model is:

{
    "type": "histogram-view",
    "title": str,
    "caption": str,
    "data": {
        "x_label": str,
        "y_label": str,
        "series": [
            {
                "data": {
                    "x": List[Float],
                    "y": List[Float],
                },
                "name": str,
            },
            ...
        ]
    }
}
Attributes
mode: Literalnbins: intx_label: strx_tick_labels: Listy_label: str
Functions
__init__

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

nbins : int - 10
mode : Literal - FREQUENCY
add_data

Add series of raw data.

data : List
name : str
add_data_from_dataframe

Add series of raw data from a dataframe. The values are flattened by column

dataframe : DataFrame
name : str
add_series

Add series of pre-computed x and y histogram values. Vector x is the vector of bin centers and y contains the magnitudes at corresponding x positions.

x : Union
y : List
name : str
add_technical_info

Add technical info

technical_info : TechnicalInfo
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_style

Get style

Return type : TypingStyle
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
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