ApertureSubsetSelectMixin#

class jdaviz.core.template_mixin.ApertureSubsetSelectMixin(**kwargs: Any)[source]#

Bases: VuetifyTemplate, HubListener

Applies the ApertureSubsetSelect component as a mixin in the base plugin. This automatically adds traitlets as well as new properties to the plugin with minimal extra code. For multiple instances or custom traitlet names/defaults, use the component instead.

To use in a plugin:

  • add ApertureSubsetSelectMixin as a mixin to the class BEFORE DatasetSelectMixin

  • use the traitlets available from the plugin or properties/methods available from plugin.aperture.

Example template (label and hint are optional):

<plugin-subset-select
  :items="aperture_items"
  :selected.sync="aperture_selected"
  label="Aperture"
  hint="Select aperture."
/>

Public constructor

Attributes Summary

aperture_items

An instance of a Python list.

aperture_scale_factor

A float trait.

aperture_selected

A trait which allows any value.

aperture_selected_validity

An instance of a Python dict.

Attributes Documentation

aperture_items#

An instance of a Python list.

aperture_scale_factor#

A float trait.

aperture_selected#

A trait which allows any value.

aperture_selected_validity#

An instance of a Python dict.

One or more traits can be passed to the constructor to validate the keys and/or values of the dict. If you need more detailed validation, you may use a custom validator method.

Changed in version 5.0: Added key_trait for validating dict keys.

Changed in version 5.0: Deprecated ambiguous trait, traits args in favor of value_trait, per_key_traits.