.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2020 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc

.. currentmodule:: wx.lib.plot.polyobjects

.. highlight:: python



.. _wx.lib.plot.polyobjects.PlotPrintout:

==========================================================================================================================================
|phoenix_title|  **wx.lib.plot.polyobjects.PlotPrintout**
==========================================================================================================================================

Controls how the plot is made in printing and previewing



|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>PlotPrintout</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.lib.plot.polyobjects.PlotPrintout_inheritance.svg" alt="Inheritance diagram of PlotPrintout" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.plot.polyobjects.PlotPrintout.html" title="Controls how the plot is made in printing and previewing" alt="" coords="5,159,277,188"/> <area shape="rect" id="node2" href="wx.Printout.html" title="This class encapsulates the functionality of printing out an application document." alt="" coords="87,82,195,111"/> <area shape="rect" id="node3" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="92,5,191,34"/> </map> 
   </p>
   </div>

|


|super_classes| Known Superclasses
==================================

:class:`wx.Printout`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.lib.plot.polyobjects.PlotPrintout.__init__`                           graph is instance of plotCanvas to be printed or previewed
:meth:`~wx.lib.plot.polyobjects.PlotPrintout.GetPageInfo`                        GetPageInfo() -> Tuple[int, int, int, int]
:meth:`~wx.lib.plot.polyobjects.PlotPrintout.HasPage`                            HasPage(pageNum : int) -> bool
:meth:`~wx.lib.plot.polyobjects.PlotPrintout.OnPrintPage`                        OnPrintPage(pageNum : int) -> bool
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: PlotPrintout(wx.Printout)

   Controls how the plot is made in printing and previewing

   .. method:: __init__(self, graph)

      graph is instance of plotCanvas to be printed or previewed


   .. method:: GetPageInfo(self)

      GetPageInfo() -> Tuple[int, int, int, int]
      
      Called by the framework to obtain information from the application
      about minimum and maximum page values that the user can select, and
      the required page range to be printed.


   .. method:: HasPage(self, page)

      HasPage(pageNum : int) -> bool
      
      Should be overridden to return true if the document has this page, or
      false if not.


   .. method:: OnPrintPage(self, page)

      OnPrintPage(pageNum : int) -> bool
      
      Called by the framework when a page should be printed.