shapelets.apps.DataApp#

class shapelets.apps.DataApp(name: str, description: str = None, version: Version = None, tags: List[str] = [])#

Entry point for data app registration.

Attributes:
widget_compatibility

Methods

add_widget_providers(current_dict, providers)

When any attribute from a widget receives another widget inside, this widget is called a provider. This means that the widget attribute with the provider inside must update its value every time the provider changes. In order to do this, a list of providers is given to the UI. This list contains the id of the provider widget and the target attribute of the current widget. This list looks like: providers: [{ id: 85535b68-2dce-11ed-bd74-00155d7482db, target: title }] The list of providers is added to the bind section of the current widget.

altair_chart([title, chart])

Creates an Vega-Altair chart: a declarative statistical visualization library for Python (https://altair-viz.github.io/index.html).

bar_chart([data, x, y, y_axis_orientation, ...])

Produces a Bar Chart figure for your dataApp.

button([text])

Creates a button.

checkbox([title, checked, toggle])

Creates a Checkbox.

columns([n_columns])

Creates a Columns widget

countdown([duration, start_delay, unit])

Creates a CountDown for your dataApp.

datetime_range_selector([title, ...])

Creates a box that allows the user input as date range.

datetime_selector([title, date_time, ...])

Creates a box that allows the user input as date.

filter_panel([title, width])

Creates a fixed panel collapsible on left side

folium_chart([title, folium])

Creates a Folium map: a declarative statistical visualization library for Python (https://python-visualization.github.io/folium/quickstart.html)

gauge([title, value])

Creates a Gauge.

horizontal_layout([title, panel_id, ...])

Defines a layout where widgets are arranged side by side horizontally.

image([img, caption, placeholder])

Adds a placeholder for a Image on a DataApp.

line_chart([data, title, views, ...])

Creates a Line Chart figure.

metric([title, value, unit, delta, align])

Creates a Metric.

number_input([title, value, default_value, ...])

A basic widget for getting the user input as a number field.

place_grid(rows, *[, justify, align])

Places components automatically on a grid structure

progress([value, title, type, size, status, ...])

TODO

radio_group([options, title, label_by, ...])

Creates a radio button group for displaying multiple choices and allows to select one value out of a set.

register([host, user_name, groups])

Registers the DataApp.

ring([title, value, color])

Creates a Ring.

selector([options, title, placeholder, ...])

Creates a dropdown menu for displaying multiple choices.

set_title(title)

Sets the DataApp's title.

slider([title, value, min_value, max_value, ...])

Creates a slider that lets a user pick a value from a set range by moving a knob.

table([data, title, rows_per_page, ...])

Displays rows of data.

tabs_layout([title])

Defines a Tabs Layout, a layout that provides a horizontal layout to display tabs.

text([value, title, text_style, markdown])

Creates a Label.

text_input([title, value, placeholder, ...])

A basic widget for getting the user input as a text field.

timer([title, every, start_delay, times, ...])

Creates a Timer for your dataApp.

to_json([host])

Shows your dataApp specification in JSON format.

vertical_layout([title, panel_id, ...])

Creates a layout that holds widget inside it vertically (stacked on-top of one another).

DataAppEncoder

bind

container

now

place

to_dict_widget