ZoomOneScaleWidget¶

class menpowidgets.tools.ZoomOneScaleWidget(zoom_options, render_function=None, description='Figure scale: ', minus_description='fa-search-minus', plus_description='fa-search-plus', continuous_update=False)[source]¶

Bases: MenpoWidget

Creates a widget for selecting zoom options with a single scale.

The selected values are stored in the self.selected_values trait.
To set the styling of this widget please refer to the style() method.
To update the state of the widget, please refer to the set_widget_state() method.
To update the handler callback function of the widget, please refer to the replace_render_function() method.

Parameters:

zoom_options (dict) –
The dict with the default options. It must have the following keys:
- min : (float) The minimum value (e.g. 0.1).
- max : (float) The maximum value (e.g. 4.).
- step : (float) The zoom step (e.g. 0.05).
- zoom : (float) The zoom value (e.g. 1.).
render_function (callable or None, optional) – The render function that is executed when the index value changes. If None, then nothing is assigned.
description (str, optional) – The title of the widget.
minus_description (str, optional) – The text/icon of the button that zooms_out. If the str starts with ‘fa-‘, then a font-awesome icon is defined.
plus_description (str, optional) – The title of the button that zooms in. If the str starts with ‘fa-‘, then a font-awesome icon is defined.
continuous_update (bool, optional) – If True, then the render and update functions are called while moving the zoom slider’s handle. If False, then the the functions are called only when the handle (mouse click) is released.

add_render_function(render_function)¶

Method that adds the provided render_function() as a callback handler to the selected_values trait of the widget. The given function is also stored in self._render_function.

Parameters:

render_function (callable or None, optional) –

The render function that behaves as a callback handler of the selected_values trait for the change event. Its signature can be render_function() or render_function(change), where change is a dict with the following keys:

owner : the HasTraits instance
old : the old value of the modified trait attribute
new : the new value of the modified trait attribute
name : the name of the modified trait attribute.
type : 'change'

If None, then nothing is added.

add_traits(**traits)¶: Dynamically add trait attributes to the Widget.

call_render_function(old_value, new_value, type_value='change')¶

Method that calls the existing render_function() callback handler.

Parameters:	old_value (int or float or dict or list or tuple) – The old selected_values value. new_value (int or float or dict or list or tuple) – The new selected_values value. type_value (str, optional) – The trait event type.

close()¶

Close method.

Closes the underlying comm. When the comm is closed, all of the widget views are automatically removed from the front-end.

has_trait(name)¶: Returns True if the object has a trait with the specified name.

observe(handler, names=traitlets.All, type='change')¶

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Parameters:

handler (callable) – A callable that is called when a trait changes. Its signature should be handler(change), where change```is a dictionary. The change dictionary at least holds a 'type' key. * ``type: the type of notification. Other keys may be passed depending on the value of ‘type’. In the case where type is ‘change’, we also have the following keys: * owner : the HasTraits instance * old : the old value of the modified trait attribute * new : the new value of the modified trait attribute * name : the name of the modified trait attribute.
names (list, str, All) – If names is All, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.
type (str, All (default: 'change')) – The type of notification to filter by. If equal to All, then all notifications are passed to the observe handler.

remove_render_function()¶: Method that removes the current self._render_function() as a callback handler to the selected_values trait of the widget and sets self._render_function = None.

replace_render_function(render_function)¶

Method that replaces the current self._render_function() with the given render_function() as a callback handler to the selected_values trait of the widget.

Parameters:

render_function (callable or None, optional) –

The render function that behaves as a callback handler of the selected_values trait for the change event. Its signature can be render_function() or render_function(change), where change is a dict with the following keys:

owner : the HasTraits instance
old : the old value of the modified trait attribute
new : the new value of the modified trait attribute
name : the name of the modified trait attribute.
type : 'change'

If None, then nothing is added.

set_widget_state(zoom_options, allow_callback=True)[source]¶

Method that updates the state of the widget, if the provided zoom_options value is different than self.selected_values.

Parameters:	zoom_options (dict) – The dict with the selected options. It must have the following keys: `min` : (float) The minimum value (e.g. `0.1`). `max` : (float) The maximum value (e.g. `4.`). `step` : (float) The zoom step (e.g. `0.05`). `zoom` : (float) The zoom value (e.g. `1.`). allow_callback (bool, optional) – If `True`, it allows triggering of any callback functions.

style(box_style=None, border_visible=False, border_colour='black', border_style='solid', border_width=1, border_radius=0, padding=0, margin=0, font_family='', font_size=None, font_style='', font_weight='', slider_width='6cm')[source]¶

Function that defines the styling of the widget.

Parameters:

box_style (str or None (see below), optional) –
Possible widget style options:
```
'success', 'info', 'warning', 'danger', '', None
```
border_visible (bool, optional) – Defines whether to draw the border line around the widget.
border_colour (str, optional) – The colour of the border around the widget.
border_style (str, optional) – The line style of the border around the widget.
border_width (float, optional) – The line width of the border around the widget.
border_radius (float, optional) – The radius of the border around the widget.
padding (float, optional) – The padding around the widget.
margin (float, optional) – The margin around the widget.
font_family (str (see below), optional) –
The font family to be used. Example options:
```
'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace',
'helvetica'
```
font_size (int, optional) – The font size.
font_style (str (see below), optional) –
The font style. Example options:
```
'normal', 'italic', 'oblique'
```

font_weight (See Below, optional) –

The font weight. Example options:

'ultralight', 'light', 'normal', 'regular', 'book', 'medium',
'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy',
'extra bold', 'black'

slider_width (float, optional) – The width of the slider

trait_names(**metadata)¶: Get a list of all the names of this class’ traits.

traits(**metadata)¶

Get a dict of all the traits of this class. The dictionary is keyed on the name and the values are the TraitType objects.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

The metadata kwargs allow functions to be passed in which filter traits based on metadata values. The functions should take a single value as an argument and return a boolean. If any function returns False, then the trait is not included in the output. If a metadata key doesn’t exist, None will be passed to the function.

unobserve(handler, names=traitlets.All, type='change')¶

Remove a trait change handler.

This is used to unregister handlers to trait change notificiations.

Parameters:

handler (callable) – The callable called when a trait attribute changes.
names (list, str, All (default: All)) – The names of the traits for which the specified handler should be uninstalled. If names is All, the specified handler is uninstalled from the list of notifiers corresponding to all changes.
type (str or All (default: 'change')) – The type of notification to filter by. If All, the specified handler is uninstalled from the list of notifiers corresponding to all types.

unobserve_all(name=traitlets.All)¶: Remove trait change handlers of any type for the specified name. If name is not specified, removes all trait notifiers.