.. include:: headings.inc

.. currentmodule:: lib.plot

.. highlight:: python



.. _lib.plot.PolyLine:

==========================================================================================================================================
|phoenix_title|  **PolyLine**
==========================================================================================================================================

Class to define line type and style
- All methods except __init__ are private.



|

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

Inheritance diagram for class **PolyLine**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.plot.PolyLine_inheritance.png" alt="Inheritance diagram of PolyLine" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.plot.PolyLine.html" title="Class to define line type and style" alt="" coords="184,5,299,35"/> <area shape="rect" id="node2" href="lib.plot.PolyPoints.html" title="Base Class for lines and markers" alt="" coords="7,5,135,35"/> </map> 
   </p>

|


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

:class:`lib.plot.PolyPoints`

|


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

================================================================================ ================================================================================
:meth:`~lib.plot.PolyLine.__init__`                                              Creates PolyLine object
:meth:`~lib.plot.PolyLine.draw`                                                  
:meth:`~lib.plot.PolyLine.getSymExtent`                                          Width and Height of Marker
================================================================================ ================================================================================


|


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

.. class:: PolyLine(PolyPoints)

   Class to define line type and style
   - All methods except __init__ are private.

   .. method:: __init__(self, points, \*\*attr)

      Creates PolyLine object
      
      :param `points`: sequence (array, tuple or list) of (x,y) points making up line
      :keyword `attr`: keyword attributes, default to:
      
       ==========================  ================================  
       'colour'= 'black'           wx.Pen Colour any wx.NamedColour
       'width'= 1                  Pen width
       'style'= wx.SOLID           wx.Pen style
       'legend'= ''                Line Legend to display
       ==========================  ================================  


   .. method:: draw(self, dc, printerScale, coord= None)


   .. method:: getSymExtent(self, printerScale)

      Width and Height of Marker