shyft.dashboard.base.selector_views

Functions

calculate_layout_width(width, padding)

Classes

AutocompleteInput(*, title[, width, height, ...])

BokehViewBase(*, title, bokeh_model, width, ...)

CheckboxButtonGroup(*[, title, width, ...])

CheckboxGroup(*[, title, width, height, ...])

CheckboxGroupBokehViewBase(*[, title, ...])

FilterMultiSelect(*, title[, width, height, ...])

GroupBokehViewBase(*, title, bokeh_model[, ...])

MultiSelect(*, title[, width, height, ...])

RadioButtonGroup(*[, title, width, height, ...])

RadioGroup(*[, title, width, height, ...])

RadioGroupBokehViewBase(*[, title, width, ...])

Select(*[, title, width, height, padding, ...])

SelectorViewBase([logger])

The select view base class can be used to define custom selector views for the selector presenter.

TextInput([width, height, padding, title, ...])

A text input widget to get a text input and send it onward via a port.

TwoSelect(*[, title, width, height, ...])

class shyft.dashboard.base.selector_views.SelectorViewBase(logger=None)[source]

Bases: Widget

The select view base class can be used to define custom selector views for the selector presenter.

(For an custom select view see class SelectTwoView)

__init__(logger=None) → None[source]

Base class for all Widgets

Parameters:

logger – Optional logger, e.g composable_logger_box

abstract property layout_components: Dict[str, List[Any]]

Property to return all layout.dom components of an visualisation app such that they can be arranged by the parent layout obj as desired.

Returns:

layout_components as:
{‘widgets’: [],

’figures’: []}

Return type:

dict

abstract property width: int
abstract property layout: LayoutDOM
shyft.dashboard.base.selector_views.calculate_layout_width(width, padding)[source]
class shyft.dashboard.base.selector_views.TwoSelect(*, title: str | None = None, width: int | None = None, height: int | None = None, text_height: int | None = None, padding: int | None = None, sizing_mode: str | None = None, logger: Optional = None)[source]

Bases: SelectorViewBase

__init__(*, title: str | None = None, width: int | None = None, height: int | None = None, text_height: int | None = None, padding: int | None = None, sizing_mode: str | None = None, logger: Optional = None) → None[source]

Base class for all Widgets

Parameters:

logger – Optional logger, e.g composable_logger_box

property layout: LayoutDOM
property layout_components: Dict[str, List[Any]]

Property to return all layout.dom components of an visualisation app such that they can be arranged by the parent layout obj as desired.

Returns:

layout_components as:
{‘widgets’: [],

’figures’: []}

Return type:

dict

property disabled: bool
property width: int
class shyft.dashboard.base.selector_views.FilterMultiSelect(*, title: str, width: int | None = None, height: int | None = None, sizing_mode: str = None, size: int = 10, padding: int = None, filter_after_enter_is_pressed: bool = False, case_sensitive: bool = False, logger: Optional = None)[source]

Bases: SelectorViewBase

__init__(*, title: str, width: int | None = None, height: int | None = None, sizing_mode: str = None, size: int = 10, padding: int = None, filter_after_enter_is_pressed: bool = False, case_sensitive: bool = False, logger: Optional = None) → None[source]

Base class for all Widgets

Parameters:

logger – Optional logger, e.g composable_logger_box

property layout: LayoutDOM
property layout_components: Dict[str, List[Any]]

Property to return all layout.dom components of an visualisation app such that they can be arranged by the parent layout obj as desired.

Returns:

layout_components as:
{‘widgets’: [],

’figures’: []}

Return type:

dict

property disabled: bool
property width: int
class shyft.dashboard.base.selector_views.BokehViewBase(*, title: str, bokeh_model: <module 'bokeh.models' from '/usr/lib/python3.11/site-packages/bokeh/models/__init__.py'>, width: int | None = None, height: int | None = None, padding: int | None = None, sizing_mode: str | None = None, logger: ~typing.Optional = None, title_model: ~typing.Any | None = None, title_attribute: str | None = None, show_state_title: bool = True, **bkwargs)[source]

Bases: SelectorViewBase

__init__(*, title: str, bokeh_model: <module 'bokeh.models' from '/usr/lib/python3.11/site-packages/bokeh/models/__init__.py'>, width: int | None = None, height: int | None = None, padding: int | None = None, sizing_mode: str | None = None, logger: ~typing.Optional = None, title_model: ~typing.Any | None = None, title_attribute: str | None = None, show_state_title: bool = True, **bkwargs) → None[source]

Base class for all Widgets

Parameters:

logger – Optional logger, e.g composable_logger_box

property layout: LayoutDOM
property disabled: bool
property layout_components: Dict[str, List[Any]]

Property to return all layout.dom components of an visualisation app such that they can be arranged by the parent layout obj as desired.

Returns:

layout_components as:
{‘widgets’: [],

’figures’: []}

Return type:

dict

property width: int
class shyft.dashboard.base.selector_views.Select(*, title: str | None = None, width: int | None = None, height: int | None = None, padding: int | None = None, sizing_mode: str | None = None, logger: Optional = None, show_state_title: bool = True, **bkwargs)[source]

Bases: BokehViewBase

__init__(*, title: str | None = None, width: int | None = None, height: int | None = None, padding: int | None = None, sizing_mode: str | None = None, logger: Optional = None, show_state_title: bool = True, **bkwargs) → None[source]

Base class for all Widgets

Parameters:

logger – Optional logger, e.g composable_logger_box

class shyft.dashboard.base.selector_views.MultiSelect(*, title: str, width: int | None = None, height: int | None = None, padding: int | None = None, sizing_mode: str | None = None, logger: Optional = None, show_state_title: bool = True, **bkwargs)[source]

Bases: BokehViewBase

__init__(*, title: str, width: int | None = None, height: int | None = None, padding: int | None = None, sizing_mode: str | None = None, logger: Optional = None, show_state_title: bool = True, **bkwargs) → None[source]

Base class for all Widgets

Parameters:

logger – Optional logger, e.g composable_logger_box

class shyft.dashboard.base.selector_views.AutocompleteInput(*, title: str, width: int | None = None, height: int | None = None, padding: int | None = None, sizing_mode: str | None = None, logger: Optional = None, placeholder: str | None = None, keep_text_value: bool = True, show_state_title: bool = True, **bkwargs)[source]

Bases: BokehViewBase

__init__(*, title: str, width: int | None = None, height: int | None = None, padding: int | None = None, sizing_mode: str | None = None, logger: Optional = None, placeholder: str | None = None, keep_text_value: bool = True, show_state_title: bool = True, **bkwargs) → None[source]

Base class for all Widgets

Parameters:

logger – Optional logger, e.g composable_logger_box

class shyft.dashboard.base.selector_views.GroupBokehViewBase(*, title: str, bokeh_model, width: int | None = None, height: int | None = None, text_height: int | None = None, padding: int | None = None, sizing_mode: str | None = None, logger: Optional = None, show_state_title: bool = True, **bkwargs)[source]

Bases: BokehViewBase

__init__(*, title: str, bokeh_model, width: int | None = None, height: int | None = None, text_height: int | None = None, padding: int | None = None, sizing_mode: str | None = None, logger: Optional = None, show_state_title: bool = True, **bkwargs) → None[source]

Base class for all Widgets

Parameters:

logger – Optional logger, e.g composable_logger_box

property layout: LayoutDOM
property layout_components: Dict[str, List[Any]]

Property to return all layout.dom components of an visualisation app such that they can be arranged by the parent layout obj as desired.

Returns:

layout_components as:
{‘widgets’: [],

’figures’: []}

Return type:

dict

class shyft.dashboard.base.selector_views.RadioGroupBokehViewBase(*, title: str | None = None, bokeh_model, width: int | None = None, height: int | None = None, padding: int | None = None, text_height: int | None = None, sizing_mode: str | None = None, logger: Optional = None, show_state_title=True, **bkwargs)[source]

Bases: GroupBokehViewBase

__init__(*, title: str | None = None, bokeh_model, width: int | None = None, height: int | None = None, padding: int | None = None, text_height: int | None = None, sizing_mode: str | None = None, logger: Optional = None, show_state_title=True, **bkwargs) → None[source]

Base class for all Widgets

Parameters:

logger – Optional logger, e.g composable_logger_box

class shyft.dashboard.base.selector_views.RadioButtonGroup(*, title: str | None = None, width: int | None = None, height: int | None = None, text_height: int | None = None, padding: int | None = None, sizing_mode: str | None = None, logger=None, **bkwargs)[source]

Bases: RadioGroupBokehViewBase

__init__(*, title: str | None = None, width: int | None = None, height: int | None = None, text_height: int | None = None, padding: int | None = None, sizing_mode: str | None = None, logger=None, **bkwargs) → None[source]

Base class for all Widgets

Parameters:

logger – Optional logger, e.g composable_logger_box

class shyft.dashboard.base.selector_views.RadioGroup(*, title: str | None = None, width: int | None = None, height: int | None = None, text_height: int | None = None, padding: int | None = None, sizing_mode: str | None = None, logger=None, **bkwargs)[source]

Bases: RadioGroupBokehViewBase

__init__(*, title: str | None = None, width: int | None = None, height: int | None = None, text_height: int | None = None, padding: int | None = None, sizing_mode: str | None = None, logger=None, **bkwargs) → None[source]

Base class for all Widgets

Parameters:

logger – Optional logger, e.g composable_logger_box

class shyft.dashboard.base.selector_views.CheckboxGroupBokehViewBase(*, title: str | None = None, bokeh_model, width: int | None = None, height: int | None = None, text_height: int | None = None, padding: int | None = None, sizing_mode: str | None = None, logger: Optional = None, show_state_title: bool = True, **bkwargs)[source]

Bases: GroupBokehViewBase

__init__(*, title: str | None = None, bokeh_model, width: int | None = None, height: int | None = None, text_height: int | None = None, padding: int | None = None, sizing_mode: str | None = None, logger: Optional = None, show_state_title: bool = True, **bkwargs) → None[source]

Base class for all Widgets

Parameters:

logger – Optional logger, e.g composable_logger_box

class shyft.dashboard.base.selector_views.CheckboxGroup(*, title: str | None = None, width: int | None = None, height: int | None = None, text_height: int | None = None, logger=None, **bkwargs)[source]

Bases: CheckboxGroupBokehViewBase

__init__(*, title: str | None = None, width: int | None = None, height: int | None = None, text_height: int | None = None, logger=None, **bkwargs) → None[source]

Base class for all Widgets

Parameters:

logger – Optional logger, e.g composable_logger_box

class shyft.dashboard.base.selector_views.CheckboxButtonGroup(*, title: str | None = None, width: int | None = None, height: int | None = None, text_height: int | None = None, logger=None, **bkwargs)[source]

Bases: CheckboxGroupBokehViewBase

__init__(*, title: str | None = None, width: int | None = None, height: int | None = None, text_height: int | None = None, logger=None, **bkwargs) → None[source]

Base class for all Widgets

Parameters:

logger – Optional logger, e.g composable_logger_box

class shyft.dashboard.base.selector_views.TextInput(width: int | None = None, height: int | None = None, padding: int | None = None, title: str = 'Text input', sizing_mode: str | None = None, logger: Optional = None, **kwargs)[source]

Bases: Widget

A text input widget to get a text input and send it onward via a port.

The TextInput widget reads a string from the user, which then will be passed to the TextInputPresenter via the send_text_input port.

__init__(width: int | None = None, height: int | None = None, padding: int | None = None, title: str = 'Text input', sizing_mode: str | None = None, logger: Optional = None, **kwargs) → None[source]

Constructor.

Parameters:

  • width – The width of the widget.

  • height – The height of the widget.

  • title – The title of the widget.

  • padding – Padding.

  • sizing_mode – Sizing mode (options: “fixed”, “stretch_both”, “scale_width”, “scale_height”, “scale_both”).

  • logger – A logger

  • kwargs –

property layout: LayoutDOM

The layout of the widget. :return: self._layout

property layout_components: Dict[str, List[Any]]

Returns the components contained in the layout. :return: Dict of components (widgets and figures)

on_change(attr, old, new)[source]

Sends input value (a string) with the connection port (self.send_text_input).

Parameters:

  • attr – a sting (‘value’)

  • old – the previous string

  • new – the new string