# !/usr/bin/env python
#
# chartpanel.py
"""
A canvas for displaying a chart within a wxPython window
"""
#
# Copyright (c) 2019-2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>
#
# Method ``constrain_zoom`` based on https://stackoverflow.com/a/16709952/3092681
# Copyright 2013 simonb
# https://stackoverflow.com/users/456805/simonb
#
# Method ``setup_scrollwheel_zooming`` based on https://stackoverflow.com/a/11562898/3092681
# Copyright 2012 Thomas A Caswell
# https://stackoverflow.com/users/380231/tacaswell
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
# MA 02110-1301, USA.
#
# stdlib
import types
from typing import Optional
# 3rd party
import matplotlib # type: ignore
import matplotlib.projections # type: ignore[import]
import numpy
import wx.html2 # type: ignore
from matplotlib.axes import Axes # type: ignore
from matplotlib.backends.backend_wxagg import FigureCanvasWxAgg as FigureCanvas # type: ignore
from matplotlib.backends.backend_wxagg import NavigationToolbar2WxAgg as NavigationToolbar
from matplotlib.figure import Figure # type: ignore
# this package
from domdf_wxpython_tools.border_config import border_config
from domdf_wxpython_tools.projections import XPanAxes
__all__ = ["ChartPanelBase"]
# Constrain zoom to X axis
matplotlib.projections.register_projection(XPanAxes)
[docs]class ChartPanelBase(wx.Panel):
"""
Panel that contains a matplotlib plotting window, used for displaying an image.
The image can be right clicked to bring up a context menu allowing copying, pasting and saving of the image.
The image can be panned by holding the left mouse button and moving the mouse,
and zoomed in and out using the scrollwheel on the mouse.
:param parent: The parent window.
:param fig:
:param ax:
:param id: An identifier for the panel. wx.ID_ANY is taken to mean a default.
:param pos: The panel position. The value ``wx.DefaultPosition`` indicates a default position,
chosen by either the windowing system or wxWidgets, depending on platform.
:param size: The panel size. The value ::wxDefaultSize indicates a default size, chosen by
either the windowing system or wxWidgets, depending on platform.
:param style: The window style. See wxPanel.
:param name: Window name.
"""
def __init__(
self,
parent: wx.Window,
fig: Figure,
ax: Axes,
id: int = wx.ID_ANY, # noqa: A002 # pylint: disable=redefined-builtin
pos: wx.Point = wx.DefaultPosition,
size: wx.Size = wx.DefaultSize,
style: int = 0,
name: str = wx.PanelNameStr
):
wx.Panel.__init__(self, parent, id, pos, size, style | wx.TAB_TRAVERSAL, name)
self.fig = fig
self.ax = ax
self.canvas = FigureCanvas(self, wx.ID_ANY, self.fig)
self._do_layout()
self.toolbar = NavigationToolbar(self.canvas)
self.toolbar.Hide()
self.Bind(wx.EVT_SIZE, self.on_size_change, self)
self.Bind(wx.EVT_MAXIMIZE, self.on_size_change)
[docs] def setup_ylim_refresher(self, y_data, x_data):
"""
Setup the function for updating the ylim whenever the xlim changes.
:param y_data:
:param x_data:
"""
def update_ylim(*args):
# print(str(*args).startswith("MPL MouseEvent")) # Pan
# Zoom, Pan
if ((str(*args).startswith("XPanAxesSubplot") and self.canvas.toolbar._active != "PAN")
or (str(*args).startswith("MPL MouseEvent") and self.canvas.toolbar._active != "ZOOM")):
# print("updated xlims: ", axes.get_xlim())
min_x_index = (numpy.abs(x_data - self.ax.get_xlim()[0])).argmin()
max_x_index = (numpy.abs(x_data - self.ax.get_xlim()[1])).argmin()
# print(min_x_index, max_x_index)
y_vals_for_range = numpy.take(y_data, [idx for idx in range(min_x_index, max_x_index)])
# print(max(y_vals_for_range))
self.ax.set_ylim(bottom=0, top=max(y_vals_for_range) * 1.1)
self.fig.canvas.draw()
# print("x-val: {}, y-val:{}
self.size_change()
self.ax.callbacks.connect("xlim_changed", update_ylim)
self.fig.canvas.callbacks.connect("button_release_event", update_ylim)
def _do_layout(self) -> None:
# begin wxGlade: ChromatogramPanel.__do_layout
sizer = wx.FlexGridSizer(1, 2, 0, 0)
sizer.Add(self.canvas, 1, wx.EXPAND, 0)
self.SetSizer(sizer)
sizer.Fit(self)
self.Layout()
[docs] def reset_view(self, *_) -> None:
"""
Reset the view of the chart.
"""
self.canvas.toolbar.home()
self.canvas.draw_idle()
[docs] def previous_view(self, *_) -> None:
"""
Go to the previous view of the chart.
"""
self.canvas.toolbar.back()
[docs] def zoom(self, enable: bool = True) -> None:
"""
Enable the Zoom tool.
"""
if enable or (not enable and self.canvas.toolbar._active == "ZOOM"):
self.canvas.toolbar.zoom()
self.canvas.Refresh()
[docs] def pan(self, enable: bool = True) -> None:
"""
Enable the Pan tool.
"""
if enable or (not enable and self.canvas.toolbar._active == "PAN"):
self.canvas.toolbar.pan()
self.canvas.Refresh()
[docs] def constrain_zoom(self, key: str = 'x') -> None:
"""
Constrain zoom to the x axis only.
:param key:
"""
def press_zoom(self, event):
event.key = key
NavigationToolbar.press_zoom(self, event)
self.fig.canvas.toolbar.press_zoom = types.MethodType(press_zoom, self.fig.canvas.toolbar)
# Other Toolbar Options
# Save chromatogram as image: save_figure(self, *args)
# set_cursor(self, cursor)
# Set the current cursor to one of the :class:`Cursors` enums values.
# If required by the backend, this method should trigger an update in
# the backend event loop after the cursor is set, as this method may be
# called e.g. before a long-running task during which the GUI is not
# updated.
# set_history_buttons(self)
# Enable or disable the back/forward button.
# forward(self, *args)
# move forward in the view lim stack.
# print(axes.get_ylim())
# end of class ChromatogramPanel
[docs] def size_change(self) -> None:
"""
Internal function that runs whenever the window is resized.
"""
# self.canvas.SetMinSize(self.GetSize())
self.canvas.SetSize(self.GetSize())
self.Refresh()
self.canvas.draw()
self.canvas.Refresh()
# if event.ClassName == "wxSizeEvent":
# event.Skip()
[docs] def on_size_change(self, _) -> None:
"""
Event handler for size change events
"""
self.size_change()
# event.Skip()