ColourSelectionWidget

class menpowidgets.tools.ColourSelectionWidget(colours_list, render_function=None, description='Colour', labels=None)[source]

Bases: MenpoWidget

Creates a widget for colour selection of a single or multiple objects.

  • 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:
  • colours_list (list of str or [float, float, float]) –

    A list of colours. If a colour is defined as an str, then it must either be a hex code or a colour name, such as

    'blue', 'green', 'red', 'cyan', 'magenta', 'yellow', 'black',
    'white', 'pink', 'orange'
    

    If a colour has the form [float, float, float], then it defines an RGB value and must have length 3.

  • render_function (callable or None, optional) – The render function that is executed when a widgets’ value changes. If None, then nothing is assigned.
  • description (str, optional) – The description of the widget.
  • labels (list of str or None, optional) – A list with the labels’ names. If None, then a list of the form label {} is automatically defined.
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_colours(colours_list, allow_callback=True)[source]

Method that updates the colour values of the widget.

Parameters:
  • colours_list (list of str or [float, float, float]) –

    A list of colours. If a colour is defined as an str, then it must either be a hex code or a colour name, such as

    'blue', 'green', 'red', 'cyan', 'magenta', 'yellow', 'black',
    'white', 'pink', 'orange'
    

    If a colour has the form [float, float, float], then it defines an RGB value and must have length 3.

  • allow_callback (bool, optional) – If True, it allows triggering of any callback functions.
Raises:

ValueError – You must provide a colour per label.

set_widget_state(colours_list, labels=None, allow_callback=True)[source]

Method that updates the state of the widget, if the provided colours_list and labels values are different than self.selected_values and self.labels respectively.

Parameters:
  • colours_list (list of str or [float, float, float]) –

    A list of colours. If a colour is defined as an str, then it must either be a hex code or a colour name, such as

    'blue', 'green', 'red', 'cyan', 'magenta', 'yellow', 'black',
    'white', 'pink', 'orange'
    

    If a colour has the form [float, float, float], then it defines an RGB value and must have length 3.

  • labels (list of str or None, optional) – A list with the labels’ names. If None, then a list of the form label {} is automatically defined.
  • 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='', label_colour=None, label_background_colour=None, picker_colour=None, picker_background_colour=None, apply_to_all_style='')[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'
    
  • label_colour (str, optional) – The text colour of the labels dropdown selection.
  • label_background_colour (str, optional) – The background colour of the labels dropdown selection.
  • picker_colour (str, optional) – The text colour of the colour picker.
  • picker_background_colour (str, optional) – The background colour of the colour picker.
  • apply_to_all_style (str,) –

    Style options

    'success', 'info', 'warning', 'danger', 'primary', '', None
    
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.