dash.contrib.plugins.image package¶

Submodules¶

dash.contrib.plugins.image.conf module¶

dash.contrib.plugins.image.conf.get_setting(setting, override=None)[source]¶

Get a setting from dash.contrib.plugins.image conf module, falling back to the default.

If override is not None, it will be used instead of the setting.

Parameters:	setting – String with setting name override – Value to use when no setting is available. Defaults to None.
Returns:	Setting value.

dash.contrib.plugins.image.dash_plugins module¶

dash.contrib.plugins.image.dash_widgets module¶

class dash.contrib.plugins.image.dash_widgets.Image1x1AndroidMainWidget(plugin)[source]¶

Bases: dash.base.BaseDashboardPluginWidget

Image1x1 plugin widget for Android layout (placeholder main).

cols = 1¶

layout_uid = 'android'¶

media_css = ('css/dash_plugin_image.css',)¶

media_js = ('js/dash_plugin_image.js',)¶

placeholder_uid = 'main'¶

plugin_uid = 'image_1x1'¶

render(request=None)[source]¶

rows = 1¶

class dash.contrib.plugins.image.dash_widgets.Image2x2AndroidMainWidget(plugin)[source]¶

Bases: dash.contrib.plugins.image.dash_widgets.Image1x1AndroidMainWidget

Image2x2 plugin widget for Android layout (placeholder main).

cols = 2¶

plugin_uid = 'image_2x2'¶

rows = 2¶

class dash.contrib.plugins.image.dash_widgets.Image3x3AndroidMainWidget(plugin)[source]¶

Bases: dash.contrib.plugins.image.dash_widgets.Image1x1AndroidMainWidget

Image3x3 plugin widget for Android layout (placeholder main).

cols = 3¶

plugin_uid = 'image_3x3'¶

rows = 3¶

class dash.contrib.plugins.image.dash_widgets.Image3x2AndroidMainWidget(plugin)[source]¶

Bases: dash.contrib.plugins.image.dash_widgets.Image1x1AndroidMainWidget

Image3x2 plugin widget for Android layout (placeholder main).

cols = 3¶

plugin_uid = 'image_3x2'¶

rows = 2¶

class dash.contrib.plugins.image.dash_widgets.Image2x3AndroidMainWidget(plugin)[source]¶

Bases: dash.contrib.plugins.image.dash_widgets.Image1x1AndroidMainWidget

Image2x3 plugin widget for Android layout (placeholder main).

cols = 2¶

plugin_uid = 'image_2x3'¶

rows = 3¶

class dash.contrib.plugins.image.dash_widgets.Image1x1Windows8MainWidget(plugin)[source]¶

Bases: dash.contrib.plugins.image.dash_widgets.Image1x1AndroidMainWidget

Image1x1 plugin widget for Windows 8 layout (placeholder main).

cols = 1¶

layout_uid = 'windows8'¶

placeholder_uid = 'main'¶

plugin_uid = 'image_1x1'¶

rows = 1¶

class dash.contrib.plugins.image.dash_widgets.Image1x1Windows8SidebarWidget(plugin)[source]¶

Bases: dash.contrib.plugins.image.dash_widgets.Image1x1Windows8MainWidget

Image plugin widget for Windows 8 layout (placeholder sidebar).

placeholder_uid = 'sidebar'¶

dash.contrib.plugins.image.defaults module¶

dash.contrib.plugins.image.forms module¶

class dash.contrib.plugins.image.forms.ImageForm(data=None, files=None, auto_id=u'id_%s', prefix=None, initial=None, error_class=<class 'django.forms.util.ErrorList'>, label_suffix=u':', empty_permitted=False)[source]¶

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

Image form for ImagePlugin plugin.

base_fields = {'title': <django.forms.fields.CharField object at 0x4f80b50>, 'image': <django.forms.fields.ImageField object at 0x4f80bd0>, 'fit_method': <django.forms.fields.ChoiceField object at 0x4bc8ed0>, 'show_link': <django.forms.fields.BooleanField object at 0x4bc8a90>}¶

media¶

plugin_data_fields = [('title', ''), ('image', ''), ('fit_method', 'center'), ('show_link', True)]¶

save_plugin_data(request=None)[source]¶

Saving the plugin data and moving the file.

dash.contrib.plugins.image.helpers module¶

dash.contrib.plugins.image.helpers.handle_uploaded_file(image_file)[source]¶

Parameters:	image_file (django.core.files.uploadedfile.InMemoryUploadedFile) –
Return string:	Path to the image (relative).

dash.contrib.plugins.image.helpers.get_crop_filter(fit_method)[source]¶

dash.contrib.plugins.image.helpers.delete_file(image_file)[source]¶

Delete file from disc.

dash.contrib.plugins.image.helpers.ensure_unique_filename(destination)[source]¶

Makes sure filenames are never overwritten.

Parameters:	destination (string) –
Return string:

dash.contrib.plugins.image.settings module¶

• FIT_METHOD_CROP_SMART (string)
• FIT_METHOD_CROP_CENTER (string)
• FIT_METHOD_CROP_SCALE (string)
• FIT_METHOD_FIT_WIDTH (string)
• FIT_METHOD_FIT_HEIGHT (string)
• DEFAULT_FIT_METHOD (string)
• FIT_METHODS_CHOICES (tuple)
• FIT_METHODS_CHOICES_WITH_EMPTY_OPTION (list)
• IMAGES_UPLOAD_DIR (string)

Module contents¶