Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/release/v6.16.0/Workbench/Bugfixes/38044.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- The documentation of :ref:`Superplot <WorkbenchSuperplot>` is launched when the help button is clicked instead of the Basic 1D and Tiled Plots documentation.
4 changes: 4 additions & 0 deletions qt/applications/workbench/workbench/plotting/figuremanager.py
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,7 @@ def __init__(self, canvas, num):
self.toolbar.sig_copy_to_clipboard_triggered.connect(self.copy_to_clipboard)
self.toolbar.sig_plot_options_triggered.connect(self.launch_plot_options)
self.toolbar.sig_plot_help_triggered.connect(self.launch_plot_help)
self.toolbar.super_plot_help_triggered.connect(self.launch_superplot_help)
self.toolbar.sig_generate_plot_script_clipboard_triggered.connect(self.generate_plot_script_clipboard)
self.toolbar.sig_generate_plot_script_file_triggered.connect(self.generate_plot_script_file)
self.toolbar.sig_home_clicked.connect(self.set_figure_zoom_to_display_all)
Expand Down Expand Up @@ -374,6 +375,9 @@ def launch_plot_options_on_curves_tab(self, axes, curve):
def launch_plot_help(self):
PlotHelpPages.show_help_page_for_figure(self.canvas.figure)

def launch_superplot_help(self):
PlotHelpPages.show_help_page_for_figure(None, superplot=True)

def hide_plot(self):
self.window.hide()

Expand Down
9 changes: 7 additions & 2 deletions qt/applications/workbench/workbench/plotting/plothelppages.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
PLOT3D_PAGE = "3DPlotsHelp.html"
COLORFILL_PAGE = "ColorfillPlotsHelp.html"
MESH_PAGE = "MeshPlotHelp.html"
SUPERPLOT_PAGE = "superplot.html"

# Create a plot page for each enumeration in FigureType
# The values can be edited if there is a more relevant documentation page
Expand All @@ -29,12 +30,16 @@
FigureType.Image: BASE_PATH + COLORFILL_PAGE,
FigureType.Contour: BASE_PATH + COLORFILL_PAGE,
FigureType.Mesh: BASE_PATH + MESH_PAGE,
FigureType.Superplot: "workbench/" + SUPERPLOT_PAGE,
}


class PlotHelpPages(object):
@classmethod
def show_help_page_for_figure(cls, figure):
fig_type = figure_type(figure)
def show_help_page_for_figure(cls, figure, superplot=False):
if superplot:
fig_type = FigureType.Superplot
else:
fig_type = figure_type(figure)
doc_url = HELP_PAGES[fig_type]
InterfaceManager().showHelpPage(doc_url)
8 changes: 7 additions & 1 deletion qt/applications/workbench/workbench/plotting/toolbar.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ class WorkbenchNavigationToolbar(MantidNavigationToolbar):
sig_waterfall_conversion = QtCore.Signal(bool)
sig_change_line_collection_colour_triggered = QtCore.Signal(QtGui.QColor)
sig_hide_plot_triggered = QtCore.Signal()
super_plot_help_triggered = QtCore.Signal()

toolitems = (
MantidNavigationTool("Home", "Reset axes limits", "mdi.home", "on_home_clicked", None),
Expand Down Expand Up @@ -145,7 +146,12 @@ def trigger_fit_toggle_action(self):
self._actions["toggle_fit"].trigger()

def launch_plot_help(self):
self.sig_plot_help_triggered.emit()
superplot_action = self._actions["toggle_superplot"]
is_checked = superplot_action.isChecked()
if is_checked:
self.super_plot_help_triggered.emit()
else:
self.sig_plot_help_triggered.emit()

def print_figure(self):
printer = QtPrintSupport.QPrinter(QtPrintSupport.QPrinter.HighResolution)
Expand Down
2 changes: 2 additions & 0 deletions qt/python/mantidqt/mantidqt/plotting/figuretype.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ class FigureType(Enum):
Contour = 7
# A 3D Mesh plot
Mesh = 8
# A super plot
Superplot = 9
# Any other type of plot
Other = 100

Expand Down
Loading