dash.contrib.plugins.dummy package

Submodules

dash.contrib.plugins.dummy.apps module

class dash.contrib.plugins.dummy.apps.Config(app_name, app_module)

Bases: django.apps.config.AppConfig

label = 'dash_contrib_plugins_dummy'

name = 'dash.contrib.plugins.dummy'

dash.contrib.plugins.dummy.dash_plugins module

class dash.contrib.plugins.dummy.dash_plugins.BaseDummyPlugin(layout_uid, placeholder_uid, workspace=None, user=None, position=None)

Bases: dash.base.BaseDashboardPlugin

Base dummy plugin.

form

alias of dash.contrib.plugins.dummy.forms.DummyForm

get_form()

Get form.

group

name

post_processor()

If no text available, use dummy.

dash.contrib.plugins.dummy.dash_widgets module

class dash.contrib.plugins.dummy.dash_widgets.BaseDummyWidget(plugin)

Bases: dash.base.BaseDashboardPluginWidget

Base dummy plugin widget.

media_css = []

media_js = []

render(request=None)

Render.

class dash.contrib.plugins.dummy.dash_widgets.Dummy1x1Widget(plugin)

Bases: dash.contrib.plugins.dummy.dash_widgets.BaseDummyWidget

1x1 dummy plugin widget.

plugin_uid = 'dummy_1x1'

class dash.contrib.plugins.dummy.dash_widgets.Dummy1x2Widget(plugin)

Bases: dash.contrib.plugins.dummy.dash_widgets.BaseDummyWidget

1x2 dummy plugin widget.

cols = 1

plugin_uid = 'dummy_1x2'

rows = 2

class dash.contrib.plugins.dummy.dash_widgets.Dummy2x1Widget(plugin)

Bases: dash.contrib.plugins.dummy.dash_widgets.BaseDummyWidget

2x1 dummy plugin widget.

cols = 2

plugin_uid = 'dummy_2x1'

rows = 1

class dash.contrib.plugins.dummy.dash_widgets.Dummy2x2Widget(plugin)

Bases: dash.contrib.plugins.dummy.dash_widgets.BaseDummyWidget

2x2 dummy plugin widget.

cols = 2

plugin_uid = 'dummy_2x2'

rows = 2

class dash.contrib.plugins.dummy.dash_widgets.Dummy3x3Widget(plugin)

Bases: dash.contrib.plugins.dummy.dash_widgets.BaseDummyWidget

3x3 dummy plugin widget.

cols = 3

plugin_uid = 'dummy_3x3'

rows = 3

dash.contrib.plugins.dummy.defaults module

dash.contrib.plugins.dummy.forms module

class dash.contrib.plugins.dummy.forms.DummyForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, field_order=None, use_required_attribute=None, renderer=None)

Bases: django.forms.forms.Form, dash.base.DashboardPluginFormBase

Dummy form (for main placeholder).

base_fields = {'generate_lipsum': <django.forms.fields.BooleanField object>, 'lipsum_language': <django.forms.fields.ChoiceField object>, 'lipsum_max_chars': <django.forms.fields.IntegerField object>, 'show_title': <django.forms.fields.BooleanField object>, 'text': <django.forms.fields.CharField object>}

declared_fields = {'generate_lipsum': <django.forms.fields.BooleanField object>, 'lipsum_language': <django.forms.fields.ChoiceField object>, 'lipsum_max_chars': <django.forms.fields.IntegerField object>, 'show_title': <django.forms.fields.BooleanField object>, 'text': <django.forms.fields.CharField object>}

media

plugin_data_fields = [('show_title', False), ('generate_lipsum', False), ('lipsum_language', ''), ('lipsum_max_chars', 40), ('text', '')]

save_plugin_data(request=None)

Save plugin data.

We want to save the generated lorem ipsum text for later use. Thus, although we don’t show it to the user, in case when generate_lipsum field is set to True, we silently generate the text and save it into the plugin data.

class dash.contrib.plugins.dummy.forms.DummyShortcutsForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, field_order=None, use_required_attribute=None, renderer=None)

Bases: dash.contrib.plugins.dummy.forms.DummyForm

Dummy form for shortucts placeholder.

base_fields = {'generate_lipsum': <django.forms.fields.BooleanField object>, 'lipsum_language': <django.forms.fields.ChoiceField object>, 'lipsum_max_chars': <django.forms.fields.IntegerField object>, 'show_title': <django.forms.fields.BooleanField object>, 'text': <django.forms.fields.CharField object>}

declared_fields = {'generate_lipsum': <django.forms.fields.BooleanField object>, 'lipsum_language': <django.forms.fields.ChoiceField object>, 'lipsum_max_chars': <django.forms.fields.IntegerField object>, 'show_title': <django.forms.fields.BooleanField object>, 'text': <django.forms.fields.CharField object>}

media

Module contents