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

Class FigurePrintout

wxObjectPtr --+        
              |        
  wxPrintoutPtr --+    
                  |    
         wxPrintout --+
                      |
                     FigurePrintout


Render a matplotlib Figure to a page or file using wxPython's printing framework.
Method Summary
  __init__(self, figure, title, size, aspectRatio)
Create a printout for the matplotlib chart figure.
  GetPageInfo(self)
Overrides wx.Printout.GetPageInfo() to provide the printing framework with the number of pages in this print job.
  OnPrintPage(self, pageNumber)
Overrides wx.Printout.OnPrintPage to render the matplotlib figure to a printing device context.
  render_figure_as_image(self, wFig, hFig, dpi)
Renders a matplotlib figure using the Agg backend and stores the result in a wx.Image.
    Inherited from wxPrintoutPtr
  __repr__(self)
  base_GetPageInfo(self, *_args, **_kwargs)
  base_HasPage(self, *_args, **_kwargs)
  base_OnBeginDocument(self, *_args, **_kwargs)
  base_OnBeginPrinting(self, *_args, **_kwargs)
  base_OnEndDocument(self, *_args, **_kwargs)
  base_OnEndPrinting(self, *_args, **_kwargs)
  base_OnPreparePrinting(self, *_args, **_kwargs)
  Destroy(self, *_args, **_kwargs)
  GetDC(self, *_args, **_kwargs)
  GetPageSizeMM(self, *_args, **_kwargs)
  GetPageSizePixels(self, *_args, **_kwargs)
  GetPPIPrinter(self, *_args, **_kwargs)
  GetPPIScreen(self, *_args, **_kwargs)
  IsPreview(self, *_args, **_kwargs)
  _setCallbackInfo(self, *_args, **_kwargs)
    Inherited from wxObjectPtr
  GetClassName(self, *_args, **_kwargs)

Class Variable Summary
int ASPECT_RECTANGULAR = 1                                                                     
int ASPECT_SQUARE = 2                                                                     

Method Details

__init__(self, figure, title=None, size=None, aspectRatio=None)
(Constructor)

Create a printout for the matplotlib chart figure. The keyword argument title provides the printing framework with a title for the print job. The keyword argument size specifies how to scale the figure, from 1 to 100 percent. The keyword argument aspectRatio determines whether the printed figure will be rectangular or square.
Overrides:
wxPython.printfw.wxPrintout.__init__

GetPageInfo(self)

Overrides wx.Printout.GetPageInfo() to provide the printing framework with the number of pages in this print job.

OnPrintPage(self, pageNumber)

Overrides wx.Printout.OnPrintPage to render the matplotlib figure to a printing device context.

render_figure_as_image(self, wFig, hFig, dpi)

Renders a matplotlib figure using the Agg backend and stores the result in a wx.Image. The arguments wFig and {hFig} are the width and height of the figure, and dpi is the dots-per-inch to render at.

Class Variable Details

ASPECT_RECTANGULAR

Type:
int
Value:
1                                                                     

ASPECT_SQUARE

Type:
int
Value:
2                                                                     

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