.. include:: headings.inc

.. currentmodule:: lib.plot

.. highlight:: python



.. _lib.plot.PlotGraphics:

==========================================================================================================================================
|phoenix_title|  **PlotGraphics**
==========================================================================================================================================

Container to hold PolyXXX objects and graph labels
- All methods except __init__ are private.



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **PlotGraphics**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.plot.PlotGraphics_inheritance.png" alt="Inheritance diagram of PlotGraphics" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.plot.PlotGraphics.html" title="Container to hold PolyXXX objects and graph labels" alt="" coords="7,5,151,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~lib.plot.PlotGraphics.__init__`                                          Creates PlotGraphics object
:meth:`~lib.plot.PlotGraphics.boundingBox`                                       
:meth:`~lib.plot.PlotGraphics.draw`                                              
:meth:`~lib.plot.PlotGraphics.getLegendNames`                                    Returns list of legend names
:meth:`~lib.plot.PlotGraphics.getSymExtent`                                      Get max width and height of lines and markers symbols for legend
:meth:`~lib.plot.PlotGraphics.getTitle`                                          Get the title at the top of graph
:meth:`~lib.plot.PlotGraphics.getXLabel`                                         Get x axis label string
:meth:`~lib.plot.PlotGraphics.getYLabel`                                         Get y axis label string
:meth:`~lib.plot.PlotGraphics.scaleAndShift`                                     
:meth:`~lib.plot.PlotGraphics.setLogScale`                                       
:meth:`~lib.plot.PlotGraphics.setPrinterScale`                                   Thickens up lines and markers only for printing
:meth:`~lib.plot.PlotGraphics.setTitle`                                          Set the title at the top of graph
:meth:`~lib.plot.PlotGraphics.setXLabel`                                         Set the X axis label on the graph
:meth:`~lib.plot.PlotGraphics.setYLabel`                                         Set the Y axis label on the graph
================================================================================ ================================================================================


|


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

.. class:: PlotGraphics

   Container to hold PolyXXX objects and graph labels
   - All methods except __init__ are private.

   .. method:: __init__(self, objects, title='', xLabel='', yLabel= '')

      Creates PlotGraphics object
      objects - list of PolyXXX objects to make graph
      title - title shown at top of graph
      xLabel - label shown on x-axis
      yLabel - label shown on y-axis


   .. method:: boundingBox(self)


   .. method:: draw(self, dc)


   .. method:: getLegendNames(self)

      Returns list of legend names


   .. method:: getSymExtent(self, printerScale)

      Get max width and height of lines and markers symbols for legend


   .. method:: getTitle(self, title= '')

      Get the title at the top of graph


   .. method:: getXLabel(self)

      Get x axis label string


   .. method:: getYLabel(self)

      Get y axis label string


   .. method:: scaleAndShift(self, scale=(1,1), shift=(0,0))


   .. method:: setLogScale(self, logscale)


   .. method:: setPrinterScale(self, scale)

      Thickens up lines and markers only for printing


   .. method:: setTitle(self, title= '')

      Set the title at the top of graph


   .. method:: setXLabel(self, xLabel= '')

      Set the X axis label on the graph


   .. method:: setYLabel(self, yLabel= '')

      Set the Y axis label on the graph