API hints tweaks (#3159)

* fix hint-styling in slice plugin

* allow downstream override of plugin key

when inheriting from upstream plugin, currently only used for Slice (called Time Selector in lcviz) and cubeviz's Spectral Extraction (will be used downstream by both lcviz and rampviz)

* append to existing changelog entry

* ignore codestyle complaint

* fix styling for button in plot options

* fix options for orientation when api hints enabled

* add quotes around color string in color picker API hints

CHANGES.rst

@@ -16,7 +16,7 @@ New Features
 
 - The colormap menu for image layers now shows in-line previews of the colormaps. [#2900]
 
-- Plugins can now expose in-UI API hints. [#3137]
+- Plugins can now expose in-UI API hints. [#3137, #3159]
 
 Cubeviz
 ^^^^^^^

jdaviz/components/plugin_color_picker.vue

@@ -3,7 +3,7 @@
     <plugin-input-header
       v-if="label && !label_inline"
       :label="label"
-      :api_hint="api_hint + value"
+      :api_hint="api_hint + '\''+value+'\''"
       :api_hints_enabled="api_hints_enabled"
     ></plugin-input-header>
     <v-menu>

jdaviz/configs/cubeviz/plugins/slice/slice.vue

@@ -1,7 +1,7 @@
 <template>
   <j-tray-plugin
     :config="config"
-    plugin_key="Slice"
+    :plugin_key="plugin_key || 'Slice'"
     :api_hints_enabled.sync="api_hints_enabled"
     :description="docs_description || 'Select slice of the cube to show in the image viewers.  The slice can also be changed interactively in the spectrum viewer by activating the slice tool.'"
     :irrelevant_msg="irrelevant_msg"
@@ -60,8 +60,8 @@
         v-model.number="value"
         @focus="(e) => value_editing = true"
         @blur="(e) => value_editing = false"
-        class="mt-0 pt-0"
         :label="api_hints_enabled ? 'plg.value =' : value_label"
+        :class="api_hints_enabled ? 'api-hint' : null"
         :hint="value_label+' corresponding to slice.'+(snap_to_slice && value_editing ? '  Indicator will snap to slice when clicking or tabbing away from input.' : '')"
         :suffix="value_unit"
       ></v-text-field>

jdaviz/configs/cubeviz/plugins/spectral_extraction/spectral_extraction.vue

@@ -1,7 +1,7 @@
 <template>
   <j-tray-plugin
     :config="config"
-    plugin_key="Spectral Extraction"
+    :plugin_key="plugin_key || Spectral Extraction"
     :api_hints_enabled.sync="api_hints_enabled"
     :description="docs_description || 'Extract a '+resulting_product_name+' from a spectral cube.'"
     :link="docs_link || 'https://jdaviz.readthedocs.io/en/'+vdocs+'/'+config+'/plugins.html#spectral-extraction'"

jdaviz/configs/default/plugins/plot_options/plot_options.vue

@@ -185,6 +185,7 @@
           <plugin-action-button
             :spinner="apply_RGB_presets_spinner"
             :results_isolated_to_plugin="false"
+            :class="api_hints_enabled ? 'api-hint' : null"
             @click="apply_RGB_presets"
           >
             {{ api_hints_enabled ?

jdaviz/configs/imviz/plugins/orientation/orientation.vue

@@ -68,7 +68,7 @@
             <v-radio
               v-for="item in align_by_items"
               :key="item.label"
-              :label="item.label == 'WCS' ? 'WCS (Sky)' : item.label"
+              :label="item.label == 'WCS' && !api_hints_enabled ? 'WCS (Sky)' : item.label"
               :value="item.label"
             ></v-radio>
           </v-radio-group>

jdaviz/core/template_mixin.py

@@ -394,6 +394,7 @@ class PluginTemplateMixin(TemplateMixin):
     _plugin_name = None  # noqa overwritten by the registry - won't be populated by plugins instantiated directly
     disabled_msg = Unicode("").tag(sync=True)  # noqa if non-empty, will show this message in place of plugin content
     irrelevant_msg = Unicode("").tag(sync=True)  # noqa if non-empty, will exclude from the tray, and show this message in place of any content in other instances
+    plugin_key = Unicode("").tag(sync=True)  # noqa set to non-empty to override value in vue file (when supported by vue file)
     docs_link = Unicode("").tag(sync=True)  # set to non-empty to override value in vue file
     docs_description = Unicode("").tag(sync=True)  # set to non-empty to override value in vue file
     plugin_opened = Bool(False).tag(sync=True)  # noqa any instance of the plugin is open (recently sent an "alive" ping)