.. _imreportlabrst:

=========
reportlab
=========


.. only:: html

    **Links:** :download:`notebook <im_reportlab.ipynb>`, :downloadlink:`html <im_reportlab2html.html>`, :download:`PDF <im_reportlab.pdf>`, :download:`python <im_reportlab.py>`, :downloadlink:`slides <im_reportlab.slides.html>`, :githublink:`GitHub|_doc/notebooks/2016/pydata/im_reportlab.ipynb|*`


`reportlab <http://www.reportlab.com/>`__ is the best option if you want
to draw graph directly in PDF. Otherwise, code is usually longer with
this module compare to *matpotlib* for example.

`documentation <http://www.reportlab.com/documentation/>`__
`source <https://bitbucket.org/rptlab/>`__
`installation <https://pypi.python.org/pypi/reportlab>`__
`tutorial <http://www.reportlab.com/documentation/tutorial/>`__

.. code:: ipython3

    from jyquickhelper import add_notebook_menu
    add_notebook_menu()






.. contents::
    :local:





example
-------

.. code:: ipython3

    from reportlab.graphics.charts.legends import Legend
    from reportlab.graphics.charts.lineplots import ScatterPlot
    from reportlab.graphics.shapes import Drawing, _DrawingEditorMixin, String
    from reportlab.graphics.charts.textlabels import Label
    from reportlab.graphics.samples.excelcolors import *
    
    class Scatter(_DrawingEditorMixin,Drawing):
        def __init__(self,width=200,height=150,*args,**kw):
            Drawing.__init__(self,width,height,*args,**kw)
            self._add(self,ScatterPlot(),name='chart',validate=None,desc="The main chart")
            self.chart.width      = 115
            self.chart.height     = 80
            self.chart.x          = 30
            self.chart.y          = 40
            self.chart.lines[0].strokeColor = color01
            self.chart.lines[1].strokeColor = color02
            self.chart.lines[2].strokeColor = color03
            self.chart.lines[3].strokeColor = color04
            self.chart.lines[4].strokeColor = color05
            self.chart.lines[5].strokeColor = color06
            self.chart.lines[6].strokeColor = color07
            self.chart.lines[7].strokeColor = color08
            self.chart.lines[8].strokeColor = color09
            self.chart.lines[9].strokeColor = color10
            self.chart.fillColor         = backgroundGrey
            self.chart.lineLabels.fontName              = 'Helvetica'
            self.chart.xValueAxis.labels.fontName       = 'Helvetica'
            self.chart.xValueAxis.labels.fontSize       = 7
            self.chart.xValueAxis.forceZero             = 0
            self.chart.data             = [((100,100), (200,200), (250,210), (300,300), (400,500)), ((100,200), (200,300), (250,200), (300,400), (400, 600))]
            self.chart.xValueAxis.avoidBoundFrac           = 1
            self.chart.xValueAxis.gridEnd                  = 115
            self.chart.xValueAxis.tickDown                 = 3
            self.chart.xValueAxis.visibleGrid              = 1
            self.chart.yValueAxis.tickLeft              = 3
            self.chart.yValueAxis.labels.fontName       = 'Helvetica'
            self.chart.yValueAxis.labels.fontSize       = 7
            self._add(self,Label(),name='Title',validate=None,desc="The title at the top of the chart")
            self.Title.fontName   = 'Helvetica-Bold'
            self.Title.fontSize   = 7
            self.Title.x          = 100
            self.Title.y          = 135
            self.Title._text      = 'Chart Title'
            self.Title.maxWidth   = 180
            self.Title.height     = 20
            self.Title.textAnchor ='middle'
            self._add(self,Legend(),name='Legend',validate=None,desc="The legend or key for the chart")
            self.Legend.colorNamePairs = [(color01, 'Widgets'), (color02, 'Sprockets')]
            self.Legend.fontName       = 'Helvetica'
            self.Legend.fontSize       = 7
            self.Legend.x              = 153
            self.Legend.y              = 85
            self.Legend.dxTextSpace    = 5
            self.Legend.dy             = 5
            self.Legend.dx             = 5
            self.Legend.deltay         = 5
            self.Legend.alignment      ='right'
            self.chart.lineLabelFormat  = None
            self.chart.xLabel           = 'X Axis'
            self.chart.y                = 30
            self.chart.yLabel           = 'Y Axis'
            self.chart.yValueAxis.labelTextFormat     = '%d'
            self.chart.yValueAxis.forceZero           = 1
            self.chart.xValueAxis.forceZero           = 1
    
    
            self._add(self,0,name='preview',validate=None,desc=None)
    
    import os
    filename = Scatter().save(formats=['pdf'], outDir=os.path.abspath("."), fnRoot='scatter')
    print(os.path.split(filename)[-1])


.. parsed-literal::
    scatter.pdf


.. code:: ipython3

    filename = Scatter().save(formats=['svg'], outDir=os.path.abspath("."), fnRoot='scatter')
    from IPython.display import SVG
    SVG(filename)




.. image:: im_reportlab_5_0.svg