Module wxmpl :: Class PlotPanel
[show private | hide private]
[frames | no frames]

Class PlotPanel

           FigureCanvasBase --+        
                              |        
                FigureCanvasAgg --+    
                                  |    
           FigureCanvasBase --+   |    
                              |   |    
wxObjectPtr --+               |   |    
              |               |   |    
wxEvtHandlerPtr --+           |   |    
                  |           |   |    
        wxWindowPtr --+       |   |    
                      |       |   |    
             wxPanelPtr --+   |   |    
                          |   |   |    
                    wxPanel --+   |    
                              |   |    
                 FigureCanvasWx --+    
                                  |    
                  FigureCanvasWxAgg --+
                                      |
                                     PlotPanel


A matplotlib canvas suitable for embedding in wxPython applications.
Method Summary
  __init__(self, parent, id, size, dpi, cursor, location, crosshairs, selection, zoom)
Creates a new PlotPanel window that is the child of the wxPython window parent with the wxPython identifier id.
  draw(self, repaint)
Draw the associated Figure onto the screen.
  get_figure(self)
Returns the figure associated with this canvas.
  notify_point(self, axes, x, y)
Called by the associated PlotPanelDirector to emit a PointEvent.
  notify_selection(self, axes, x1, y1, x2, y2)
Called by the associated PlotPanelDirector to emit a SelectionEvent.
  OnActivate(self, evt)
Handles the wxPython window activation event.
  OnDestroy(self, evt)
Handles the wxPython window destruction event.
  OnEraseBackground(self, evt)
Overrides the wxPython backround repainting event to reduce flicker.
  set_crosshairs(self, state)
Enable or disable drawing crosshairs through the mouse cursor when it is inside a matplotlib axes.
  set_cursor(self, state)
Enable or disable the changing mouse cursor.
  set_location(self, state)
Enable or disable the display of the matplotlib axes coordinates of the mouse in the lower left corner of the canvas.
  set_selection(self, state)
Enable or disable area selections, where user selects a rectangular area of the canvas by left-clicking and dragging the mouse.
  set_zoom(self, state)
Enable or disable zooming in when the user makes an area selection and zooming out again when the user right-clicks.
  zoomed(self, axes)
Returns a boolean indicating whether or not the axes is zoomed in.
    Inherited from wxPanelPtr
  __repr__(self)
  Create(self, *_args, **_kwargs)
  InitDialog(self, *_args, **_kwargs)
    Inherited from wxWindowPtr
  AcceptsFocus(self, *_args, **_kwargs)
  AddChild(self, *_args, **_kwargs)
  CaptureMouse(self, *_args, **_kwargs)
  Center(self, *_args, **_kwargs)
  CenterOnParent(self, *_args, **_kwargs)
  CenterOnScreen(self, *_args, **_kwargs)
  Centre(self, *_args, **_kwargs)
  CentreOnParent(self, *_args, **_kwargs)
  CentreOnScreen(self, *_args, **_kwargs)
  Clear(self, *_args, **_kwargs)
  ClientToScreen(self, *_args, **_kwargs)
  ClientToScreenXY(self, *_args, **_kwargs)
  Close(self, *_args, **_kwargs)
  ConvertDialogPointToPixels(self, *_args, **_kwargs)
  ConvertDialogSizeToPixels(self, *_args, **_kwargs)
  ConvertPixelPointToDialog(self, *_args, **_kwargs)
  ConvertPixelSizeToDialog(self, *_args, **_kwargs)
  DestroyChildren(self, *_args, **_kwargs)
  Disable(self, *_args, **_kwargs)
  DLG_PNT(self, *_args, **_kwargs)
  DLG_SZE(self, *_args, **_kwargs)
  Enable(self, *_args, **_kwargs)
  FindWindowById(self, *_args, **_kwargs)
  FindWindowByName(self, *_args, **_kwargs)
  Fit(self, *_args, **_kwargs)
  FitInside(self, *_args, **_kwargs)
  Freeze(self, *_args, **_kwargs)
  GetAcceleratorTable(self, *_args, **_kwargs)
  GetAdjustedBestSize(self, *_args, **_kwargs)
  GetAutoLayout(self, *_args, **_kwargs)
  GetBackgroundColour(self, *_args, **_kwargs)
  GetBestSize(self, *_args, **_kwargs)
  GetBestVirtualSize(self, *_args, **_kwargs)
  GetBorder(self, *_args, **_kwargs)
  GetCaret(self, *_args, **_kwargs)
  GetCharHeight(self, *_args, **_kwargs)
  GetCharWidth(self, *_args, **_kwargs)
  GetChildren(self, *_args, **_kwargs)
  GetClientAreaOrigin(self, *_args, **_kwargs)
  GetClientRect(self, *_args, **_kwargs)
  GetClientSize(self, *_args, **_kwargs)
  GetClientSizeTuple(self, *_args, **_kwargs)
  GetConstraints(self, *_args, **_kwargs)
  GetContainingSizer(self, *_args, **_kwargs)
  GetCursor(self, *_args, **_kwargs)
  GetDefaultItem(self, *_args, **_kwargs)
  GetDropTarget(self, *_args, **_kwargs)
  GetEventHandler(self, *_args, **_kwargs)
  GetFont(self, *_args, **_kwargs)
  GetForegroundColour(self, *_args, **_kwargs)
  GetFullTextExtent(self, *_args, **_kwargs)
  GetGrandParent(self, *_args, **_kwargs)
  GetHandle(self, *_args, **_kwargs)
  GetHelpText(self, *_args, **_kwargs)
  GetId(self, *_args, **_kwargs)
  GetLabel(self, *_args, **_kwargs)
  GetMaxSize(self, *_args, **_kwargs)
  GetName(self, *_args, **_kwargs)
  GetParent(self, *_args, **_kwargs)
  GetPosition(self, *_args, **_kwargs)
  GetPositionTuple(self, *_args, **_kwargs)
  GetRect(self, *_args, **_kwargs)
  GetScrollPos(self, *_args, **_kwargs)
  GetScrollRange(self, *_args, **_kwargs)
  GetScrollThumb(self, *_args, **_kwargs)
  GetSize(self, *_args, **_kwargs)
  GetSizer(self, *_args, **_kwargs)
  GetSizeTuple(self, *_args, **_kwargs)
  GetTextExtent(self, *_args, **_kwargs)
  GetThemeEnabled(self, *_args, **_kwargs)
  GetTitle(self, *_args, **_kwargs)
  GetToolTip(self, *_args, **_kwargs)
  GetUpdateRegion(self, *_args, **_kwargs)
  GetValidator(self, *_args, **_kwargs)
  GetVirtualSize(self, *_args, **_kwargs)
  GetVirtualSizeTuple(self, *_args, **_kwargs)
  GetWindowStyleFlag(self, *_args, **_kwargs)
  HasCapture(self, *_args, **_kwargs)
  HasScrollbar(self, *_args, **_kwargs)
  Hide(self, *_args, **_kwargs)
  HitTest(self, *_args, **_kwargs)
  IsBeingDeleted(self, *_args, **_kwargs)
  IsEnabled(self, *_args, **_kwargs)
  IsExposed(self, *_args, **_kwargs)
  IsExposedPoint(self, *_args, **_kwargs)
  IsExposedRect(self, *_args, **_kwargs)
  IsRetained(self, *_args, **_kwargs)
  IsShown(self, *_args, **_kwargs)
  IsTopLevel(self, *_args, **_kwargs)
  Layout(self, *_args, **_kwargs)
  LineDown(self, *_args, **_kwargs)
  LineUp(self, *_args, **_kwargs)
  Lower(self, *_args, **_kwargs)
  MakeModal(self, *_args, **_kwargs)
  Move(self, *_args, **_kwargs)
  MoveXY(self, *_args, **_kwargs)
  PageDown(self, *_args, **_kwargs)
  PageUp(self, *_args, **_kwargs)
  PopEventHandler(self, *_args, **_kwargs)
  PopupMenu(self, *_args, **_kwargs)
  PopupMenuXY(self, *_args, **_kwargs)
  PushEventHandler(self, *_args, **_kwargs)
  Raise(self, *_args, **_kwargs)
  Refresh(self, *_args, **_kwargs)
  RefreshRect(self, *_args, **_kwargs)
  ReleaseMouse(self, *_args, **_kwargs)
  RemoveChild(self, *_args, **_kwargs)
  RemoveEventHandler(self, *_args, **_kwargs)
  Reparent(self, *_args, **_kwargs)
  ScreenToClient(self, *_args, **_kwargs)
  ScreenToClientXY(self, *_args, **_kwargs)
  ScrollLines(self, *_args, **_kwargs)
  ScrollPages(self, *_args, **_kwargs)
  ScrollWindow(self, *_args, **_kwargs)
  SetAcceleratorTable(self, *_args, **_kwargs)
  SetAutoLayout(self, *_args, **_kwargs)
  SetBackgroundColour(self, *_args, **_kwargs)
  SetCaret(self, *_args, **_kwargs)
  SetClientSize(self, *_args, **_kwargs)
  SetClientSizeWH(self, *_args, **_kwargs)
  SetConstraints(self, *_args, **_kwargs)
  SetContainingSizer(self, *_args, **_kwargs)
  SetCursor(self, *_args, **_kwargs)
  SetDefaultItem(self, *_args, **_kwargs)
  SetDimensions(self, *_args, **_kwargs)
  SetDropTarget(self, *_args, **_kwargs)
  SetEventHandler(self, *_args, **_kwargs)
  SetExtraStyle(self, *_args, **_kwargs)
  SetFocus(self, *_args, **_kwargs)
  SetFocusFromKbd(self, *_args, **_kwargs)
  SetFont(self, *_args, **_kwargs)
  SetForegroundColour(self, *_args, **_kwargs)
  SetHelpText(self, *_args, **_kwargs)
  SetHelpTextForId(self, *_args, **_kwargs)
  SetId(self, *_args, **_kwargs)
  SetLabel(self, *_args, **_kwargs)
  SetName(self, *_args, **_kwargs)
  SetPosition(self, *_args, **_kwargs)
  SetRect(self, *_args, **_kwargs)
  SetScrollbar(self, *_args, **_kwargs)
  SetScrollPos(self, *_args, **_kwargs)
  SetSize(self, *_args, **_kwargs)
  SetSizeHints(self, *_args, **_kwargs)
  SetSizer(self, *_args, **_kwargs)
  SetSizerAndFit(self, *_args, **_kwargs)
  SetThemeEnabled(self, *_args, **_kwargs)
  SetTitle(self, *_args, **_kwargs)
  SetTmpDefaultItem(self, *_args, **_kwargs)
  SetToolTip(self, *_args, **_kwargs)
  SetToolTipString(self, *_args, **_kwargs)
  SetValidator(self, *_args, **_kwargs)
  SetVirtualSize(self, *_args, **_kwargs)
  SetVirtualSizeHints(self, *_args, **_kwargs)
  SetVirtualSizeWH(self, *_args, **_kwargs)
  SetWindowStyle(self, *_args, **_kwargs)
  SetWindowStyleFlag(self, *_args, **_kwargs)
  Show(self, *_args, **_kwargs)
  Thaw(self, *_args, **_kwargs)
  TransferDataFromWindow(self, *_args, **_kwargs)
  TransferDataToWindow(self, *_args, **_kwargs)
  UnsetConstraints(self, *_args, **_kwargs)
  Update(self, *_args, **_kwargs)
  UpdateWindowUI(self, *_args, **_kwargs)
  Validate(self, *_args, **_kwargs)
  WarpPointer(self, *_args, **_kwargs)
    Inherited from wxEvtHandlerPtr
  AddPendingEvent(self, *_args, **_kwargs)
  Connect(self, *_args, **_kwargs)
  Disconnect(self, *_args, **_kwargs)
  GetEvtHandlerEnabled(self, *_args, **_kwargs)
  GetNextHandler(self, *_args, **_kwargs)
  GetPreviousHandler(self, *_args, **_kwargs)
  ProcessEvent(self, *_args, **_kwargs)
  SetEvtHandlerEnabled(self, *_args, **_kwargs)
  SetNextHandler(self, *_args, **_kwargs)
  SetPreviousHandler(self, *_args, **_kwargs)
    Inherited from wxObjectPtr
  GetClassName(self, *_args, **_kwargs)
    Inherited from FigureCanvasBase
  blit(self, bbox)
blit the canvas in bbox (default entire canvas)
  button_press_event(self, x, y, button, guiEvent)
Backend derived classes should call this function on any mouse button press.
  button_release_event(self, x, y, button, guiEvent)
Backend derived classes should call this function on any mouse button release.
  draw_cursor(self, event)
Draw a cursor in the event.axes if inaxes is not None.
  draw_event(self, renderer)
  draw_idle(self, *args, **kwargs)
draw only if idle; defaults to draw but backends can overrride
  get_width_height(self)
return the figure width and height in points or pixels (depending on the backend), truncated to integers
  key_press_event(self, key, guiEvent)
  key_release_event(self, key, guiEvent)
  motion_notify_event(self, x, y, guiEvent)
Backend derived classes should call this function on any motion-notify-event.
  mpl_connect(self, s, func)
Connect event with string s to func.
  mpl_disconnect(self, cid)
Connect s to func.
  switch_backends(self, FigureCanvasClass)
instantiate an instance of FigureCanvasClass

Class Variable Summary
    Inherited from FigureCanvasBase
tuple events = ('key_press_event', 'key_release_event', 'butto...

Method Details

__init__(self, parent, id, size=(6.0, 3.7000000000000002), dpi=96, cursor=True, location=True, crosshairs=True, selection=True, zoom=True)
(Constructor)

Creates a new PlotPanel window that is the child of the wxPython window parent with the wxPython identifier id.

The keyword arguments size and {dpi} are used to create the matplotlib Figure associated with this canvas. size is the desired width and height of the figure, in inches, as the 2-tuple (width, height). dpi is the dots-per-inch of the figure.

The keyword arguments cursor, location, crosshairs, selection, and zoom enable or disable various user interaction features that are descibed in their associated set() methods.
Overrides:
matplotlib.backends.backend_wx.FigureCanvasWx.__init__

draw(self, repaint=True)

Draw the associated Figure onto the screen.
Overrides:
matplotlib.backends.backend_wxagg.FigureCanvasWxAgg.draw

get_figure(self)

Returns the figure associated with this canvas.

notify_point(self, axes, x, y)

Called by the associated PlotPanelDirector to emit a PointEvent.

notify_selection(self, axes, x1, y1, x2, y2)

Called by the associated PlotPanelDirector to emit a SelectionEvent.

OnActivate(self, evt)

Handles the wxPython window activation event.

OnDestroy(self, evt)

Handles the wxPython window destruction event.

OnEraseBackground(self, evt)

Overrides the wxPython backround repainting event to reduce flicker.

set_crosshairs(self, state)

Enable or disable drawing crosshairs through the mouse cursor when it is inside a matplotlib axes.

set_cursor(self, state)

Enable or disable the changing mouse cursor. When enabled, the cursor changes from the normal arrow to a square cross when the mouse enters a matplotlib axes on this canvas.

set_location(self, state)

Enable or disable the display of the matplotlib axes coordinates of the mouse in the lower left corner of the canvas.

set_selection(self, state)

Enable or disable area selections, where user selects a rectangular area of the canvas by left-clicking and dragging the mouse.

set_zoom(self, state)

Enable or disable zooming in when the user makes an area selection and zooming out again when the user right-clicks.

zoomed(self, axes)

Returns a boolean indicating whether or not the axes is zoomed in.

Generated by Epydoc 2.1 on Mon Aug 28 13:47:50 2006 http://epydoc.sf.net