Reportlab生成PDF文件

前一个帖子我们做了一个带动态标签的面积曲线图: 

这个帖子里我们再加一个动态标签,在图表上把最后一个数据标出来。另外就是x轴上记录在案的最后两个刻度,如果相差大于一年加上子刻度。图表上显示的x轴刻度并没有全部记录在案,第1、3、5被记录下来了,所以比较的是图表上显示出来的第三和第五个刻度: 

跟上一个帖子比起来,这里的动态标签类DynamicLabel把一些对标签属性的设置放进方法函数asAnnotation()里了。在类AreaChart_DynamicLabelConditionalSubTicks里,就算在

self.chart.annotations.append(self.label1.asAnnotation)

之后,对这些属性进行修改,在最终的图表上也看不到效果的。具体原因我不清楚,可能跟图表的annotation的执行时机有关系。有可能annotation的执行顺序比较靠后,往画布上画时才执行,所以在它用到的asAnnotation()里对属性的定义变成是最后的定义了。

 

生成的两个动态标签,一个是跟上一个帖子相同的label1,另一个是这个帖子里独有的label。注意生成label对象时的参数皆为空,它的内容和坐标位置都是在方法函数getContents()里完成的,虽然并没有在代码中看见哪里有调用这个函数,还有这个方法函数的返回值Drawing.getContents(self),又是个啥玩意呢?

getContents()在源代码里的解释是:

Return the list of things to be rendered override to get more complicated behaviour

我的理解就是可以完成一些复杂的“动作”,放在列表里往画布上渲染。不用调用,往画布上渲染时自动会去把getContents()里定义的动作做一遍。

在方法函数getContents()里,第一条语句调用函数addConditionalSubTicks(),这个函数是这样实现的:

def addConditionalSubTicks(chart):
    chart.xValueAxis.configure([chart.data])
    if int(str(chart.xValueAxis._tickValues[-1])[:4])-int(str(chart.xValueAxis._tickValues[-2])[:4])>1:
        chart.xValueAxis.subTickNum = 1
        chart.xValueAxis.visibleSubTicks = True
        chart.xValueAxis.subTickLo = chart.xValueAxis.tickDown

第一句是坐标轴基于图表数据配置configute()刻度和范围,如果有定义刻度的最大最小值和步长,则按照这些值来;如果没有定义,按照源代码的注释说是会“聪明”地选择定义刻度和范围。

怎么个聪明法没讲,但在这里configure()完后,在档的刻度值chart.xValueAxis._tickValues的内容是:

[20031231, 20051230, 20071231]

跟本帖贴出来最后生成的图表x轴上的刻度标签并不相符,原因不明。如果对y轴进行配置:

chart.yValueAxis.configure([chart.data])

y轴在档的刻度chart.yValueAxis._tickValues为:

[0.0, 5000.0, 10000.0, 15000.0]

跟最后生成的图表基本一致,至于为什么图表上y轴最大刻度值是20000.0一会儿解释。

 

接下来的if判断是chart.xValueAxis._tickValues,所以它的值

[20031231, 20051230, 20071231]很重要。

int(str(chart.xValueAxis._tickValues[-1])[:4])

把这个列表最后一个元素20071231取出来转换成字符"20071231"后切片[:4]得“2007”,最后用int()转成整数2007。一句话概括就是把年份取出来,if语句判断在档的刻度值列表最后两个元素年份差是否大于1,如果大于1就加1个子刻度

chart.xValueAxis.subTickNum = 1)

目前的情况2007-2005=2>1,条件成立,所以图表上x轴有加子刻度。

 

如果在类AreaChart_DynamicLabelConditionalSubTicks里设置x轴显示最后一个日期标签:

self.chart.xValueAxis.forceEndDate        = 1

则chart.xValueAxis._tickValues里的内容由

[20031231, 20051230, 20071231]

变为

[20031231, 20051230, 20080331],

为了显示最后一个日期标签,20071231被拿掉了。此时的图表是这样,注意x轴上的刻度变化: 

还记得属性specialTickClear么?在前一个帖子的注释里我们解释过,这时候如果类AreaChart_DynamicLabelConditionalSubTicks里的初始化函数__init__()中:

self.chart.xValueAxis.specialTickClear        = 1

则刚才被拿掉的20071231会被放回来,此时chart.xValueAxis._tickValues里的内容是这样:

[20031231, 20051230, 20071231, 20080331]

20071231被放回来了,但是最后的两个元素年份之间的差异也不再大于1了,函数函数addConditionalSubTicks()里的if语句的判断条件不成立了,所以现在图表长这样: 

20071231对应的那个刻度虽然回来了,子刻度却不见了。所以是有条件的子刻度,函数addConditionalSubTicks()名副其实!

 

继续看方法函数getContents()里这句:

self.chart.yValueAxis.valueMax = max(maxValue, lastQuarterMax)

maxValue是图表数据的最大值(y值);lastQuarterMax后四分之一数据中的最大值又加大了一些。self.chart.yValueAxis.valueMax得到的值是17164.1985。

回去类AreaChart_DynamicLabelConditionalSubTicks里的初始化函数__init__()中,注意看:

self.chart.yValueAxis.rangeRound            ='both'

属性rangeRound规定坐标轴最大最小值怎么取,可以取'None'、'topping'、‘floor'和'both‘。'both‘兼顾了'topping'和'floor',最大刻度值用'topping',往大了取;最小刻度值用'floor'往小了取。这里yValueAxis.valueMax为17164.1985,往上取就是20000.0,正如y轴上显示的最大刻度是¥20000.0。如果将rangeRound设定为'floor':

self.chart.yValueAxis.rangeRound            ='floor'

则图表变成:

注意y轴上最大刻度标签的变化。

 

还有一个数值轴的origShiftIPC属性也比较少用到,这个属性决定数值轴的0刻度位置,给的值是刻度比例。比如在这个图表对应的是:

self.chart.yValueAxis.origShiftIPC          = 0

如果self.chart.yValueAxis.origShiftIPC= 0.8: 

如果self.chart.yValueAxis.origShiftIPC= 0.5:

 

如果self.chart.yValueAxis.origShiftIPC= 1: 

代码和部分注释如下:

"带动态标签的面积图"
# 面积曲线图
from reportlab.lib.normalDate import NormalDate
from reportlab.lib.formatters import DecimalFormatter
from reportlab.graphics.charts.lineplots import AreaLinePlot
from reportlab.graphics.shapes import Drawing, _DrawingEditorMixin, Line
from reportlab.lib.colors import PCMYKColor, black, blue, red, purple
from reportlab.graphics.charts.axes import NormalDateXValueAxis
from reportlab.graphics.charts.textlabels import Label
from myStyle import *
class DynamicLabel(Label):
    def __init__(self,text,ux,uy,**kw):
        """
        text: 标签内容
        ux:   标签在坐标轴上的x坐标
        uy:   标签在坐标轴上的y坐标
        """
        Label.__init__(self,**kw)
        self._text = text
        self._ux = ux
        self._uy = uy
        return None

    def asAnnotation(self,chart,xscale,yscale):
        # 见名知意,这个函数相当于annotation属性赋值经常用到的lambda表达式
        self.x = xscale(self._ux)
        self.y = yscale(self._uy)
        # 动态标签的位置
        self.fontName   = 'apple'
        self.fontSize   = 7
        self.fillColor  = red
        self.boxFillColor   = None
        # 标签字体、字体大小、颜色、无背景填充色
        self.textAnchor = 'start'     # 左对齐

def addConditionalSubTicks(chart):
    '''
        如果x轴上最后两个记录在档的刻度年份差大于一年则加上子刻度
    '''
    chart.xValueAxis.configure([chart.data])

    if int(str(chart.xValueAxis._tickValues[-1])[:4])-int(str(chart.xValueAxis._tickValues[-2])[:4])>1:
        chart.xValueAxis.subTickNum = 1
        chart.xValueAxis.visibleSubTicks = True
        chart.xValueAxis.subTickLo = chart.xValueAxis.tickDown

class AreaChart_DynamicLabelConditionalSubTicks(_DrawingEditorMixin,Drawing):
    '''        
        跟类AreaChart_WithDynamicLabel相比多了
        - 动态标签类的方法函数asAnnotation()承接了对几个属性的设置
        - 动态标签表示图表最后一个数据
        - x轴上有条件地添加子刻度
        
        在方法函数getContents()完成复杂操作
        - 调用添加子刻度的程序
        - 通过valueMax干涉y轴最大刻度的选定
        - 确定新添加的动态标签的内容和位置
        
        getContents()和annotation属性赋值时的函数都是最后才调用,
        annotation比getContents()还后面执行
    '''
    def __init__(self,width=400,height=150,*args,**kw):
        Drawing.__init__(self, width, height, *args, **kw)

        fontName = 'Helvetica'
        gridStickOut = 4
        strokeDashArray = (0.4,0.4)

        # 图表
        self._add(self,AreaLinePlot(),name='chart',validate=None,desc=None)
        self.chart.x                                = 50
        self.chart.y                                = 30
        # 图表左下角坐标
        self.chart.width                            = 305
        self.chart.height                           = 100
        # 图表宽高
        self.chart.lines[0].strokeColor             = PCMYKColor(100, 0, 90, 50, alpha=40)
        # 既决定图表上数据线的颜色又决定面积图内的填充颜色

        # x轴
        self.chart.xValueAxis = NormalDateXValueAxis()
        # x轴是日期轴
        self.chart.xValueAxis.labels.boxAnchor      ='autox'
        self.chart.xValueAxis.labels.fontName       = fontName
        self.chart.xValueAxis.labels.fontSize       = 6
        self.chart.xValueAxis.labels.topPadding     = 3
        # x轴上刻度标签的锚点、字体、字体大小、上留白
        self.chart.xValueAxis.xLabelFormat          = '{dd}/{mm}/{yyyy}'
        # 刻度标签的日期格式

        self.chart.xValueAxis.strokeWidth           = 0.5
        self.chart.xValueAxis.strokeDashArray       = strokeDashArray
        # x轴线和刻度线的宽度和样式
        self.chart.xValueAxis.visibleTicks          = True
        self.chart.xValueAxis.maximumTicks          = 6
        # 属性注释上说最多六个刻度线

        # y轴
        self.chart.yValueAxis.labels.fontName       = fontName
        self.chart.yValueAxis.labels.fontSize       = 6
        self.chart.yValueAxis.labels.rightPadding   = 0
        # 刻度标签的字体、大小和右留白
        self.chart.yValueAxis.labelTextFormat       = lambda v,a=self.chart.yValueAxis: (abs(v-a._valueMax)<1e-6 and '¥{}' or '{}').format(v)
        # 刻度标签的格式是动态的,最大值的标签的格式与其他不同
        # lambda表达式首先判断刻度值是不是最大值,最大值有自己的格式
        self.chart.yValueAxis.forceZero             = 1
        self.chart.yValueAxis.strokeWidth           = 0
        self.chart.yValueAxis.strokeDashArray       = strokeDashArray
        self.chart.yValueAxis.origShiftIPC          = 0
        # y轴上0坐标的位置,单位是刻度比例
        self.chart.yValueAxis.visibleTicks          = True
        # 刻度可见
        self.chart.yValueAxis.maximumTicks          = 6
        # 最多6个刻度
        self.chart.yValueAxis.rangeRound            ='both'
        # self.chart.yValueAxis.rangeRound            ='floor'
        # 刻度上下值如何取值,None、ceiling、floor和both
        self.chart.yValueAxis.visibleGrid           = 1
        # 格子线设置
        self.chart.yValueAxis.gridStrokeColor             = blue
        self.chart.yValueAxis.gridStrokeDashArray   = strokeDashArray
        self.chart.yValueAxis.gridStart             = self.chart.x-gridStickOut
        self.chart.yValueAxis.gridEnd               = self.chart.x+self.chart.width+gridStickOut
        # 格子线可见、样式、起点和终点
        # 子格子线设置
        self.chart.yValueAxis.visibleSubTicks       = True
        # 子刻度线可见
        self.chart.yValueAxis.subTickNum            = 2
        # 格子间的子刻度和子格子线有几条,这个值如果不设,子格子线不显示
        self.chart.yValueAxis.visibleSubGrid        = True
        self.chart.yValueAxis.subGridStrokeWidth    = self.chart.yValueAxis.gridStrokeWidth
        self.chart.yValueAxis.subGridStrokeDashArray= strokeDashArray
        self.chart.yValueAxis.subGridStart              = self.chart.yValueAxis.gridStart
        self.chart.yValueAxis.subGridEnd                = self.chart.yValueAxis.gridEnd
        # 子格子线可见、宽度、颜色、样式、起点和终点

        # 图表数据
        self.chart.data = [(20030220, 10020.0), (20030331, 9910.0), (20030430, 10240.0), (20030530, 10660.0), (20030630, 10680.0), (20030731, 10690.0), (20030829, 10850.0), (20030930, 10760.0), (20031031, 11170.0), (20031128, 11280.0), (20031231, 11553.190000000001),
                           (20040130, 11635.57), (20040227, 11707.65), (20040331, 11635.57), (20040430, 11388.440000000001), (20040528, 11460.52), (20040630, 11651.870000000001), (20040730, 11233.110000000001), (20040831, 11306.4), (20040930, 11358.74), (20041029, 11536.709999999999), (20041130, 11945.0), (20041231, 12295.450000000001),
                           (20050131, 11966.209999999999), (20050228, 12102.450000000001), (20050331, 11932.15), (20050429, 11716.440000000001), (20050531, 12034.33), (20050630, 11991.209999999999), (20050729, 12426.84), (20050831, 12254.879999999999), (20050930, 12289.280000000001), (20051031, 12128.780000000001), (20051130, 12564.41), (20051230, 12584.99),
                           (20060131, 12967.76), (20060228, 12921.360000000001), (20060331, 13257.74), (20060428, 13338.93), (20060531, 12874.969999999999), (20060630, 12857.6), (20060731, 12834.35), (20060831, 12985.48), (20060929, 13171.49), (20061031, 13555.120000000001), (20061130, 13776.0), (20061229, 13886.870000000001),
                           (20070131, 14053.4), (20070228, 13848.43), (20070330, 13925.299999999999), (20070430, 14335.24), (20070531, 14655.51), (20070629, 14460.98), (20070731, 14190.08), (20070831, 14319.08), (20070928, 14770.59), (20071031, 14925.389999999999), (20071130, 14460.98), (20071231, 14494.120000000001),
                           (20080131, 13829.26), (20080229, 13637.18), (20080331, 13651.959999999999)]
        # 图表左的垂直线
        self.chart.annotations=[lambda c,cA,vA: Line(c.x,c.y-gridStickOut,c.x,c.y+c.height+gridStickOut,strokeColor=black,strokeWidth=0.5)]
        # 图表右的垂直线
        self.chart.annotations.append(lambda c,cA,vA: Line(c.x+c.width,c.y-gridStickOut,c.x+c.width,c.y+c.height+gridStickOut,strokeColor=black,strokeWidth=0.5))

        # 选一数据,显示图表上的位置和标签
        num = 28        # 索引
        pointX = self.chart.data[num][0]
        pointY = self.chart.data[num][1]
        # 索引为num的坐标
        self.chart.annotations.append(lambda c, cA, vA: Line(cA(pointX), vA(pointY), c.x, vA(pointY),strokeColor=red,strokeWidth=0.5))
        self.chart.annotations.append(lambda c, cA, vA: Line(cA(pointX), vA(pointY), cA(pointX), c.y,strokeColor=red,strokeWidth=0.5))
        # 从选定的坐标点花两条直线落在坐标轴上

        import datetime
        pointXdate = datetime.datetime.strptime('{}'.format(pointX), '%Y%m%d').strftime('%d/%m/%y')
        # 将x坐标转成指定的日期格式dd/mm/yy
        self._add(self,DynamicLabel('X坐标: {}\nY坐标: {}'.format(pointXdate, pointY), pointX,pointY),name='label1',validate=None,desc=None)
        # 添加一个动态标签,标签位置跟选中的数据点坐标有关
        self.chart.annotations.append(self.label1.asAnnotation)
        # self.label.asAnnotation设置动态标签的属性,比用lambda表达式处理更复杂的情况
        # 对标签的锚点和位置可以做个性化调整
        self.label1.dx         = -20
        self.label1.dy         = 5
        self.label1.boxAnchor  ='sw'         # 锚点左下角

        self._add(self,DynamicLabel('', 0, 0),name='label',validate=None,desc=None)
        self.chart.annotations.append(self.label.asAnnotation)
        self.label.boxAnchor = 'se'         # 锚点右下角

    def getContents(self):
        '''
            往画布上提交整个图表时调用这个函数
        '''

        addConditionalSubTicks(self.chart)
        # 判断记录在案的后两个刻度距离,如果年份差大于1则加子刻度

        # dates获取图表数据中的日期,values获取值
        dates = [d[0] for d in self.chart.data]
        values = [d[1] for d in self.chart.data]

        # 找到图表后四分之一部分的最大值,一个是为了获取y轴刻度标签的最大值;
        # 一个是获取动态标签的y坐标
        maxValue = max(values)            # 图表数据里的最大值
        sf = maxValue/self.chart.height   # 最大值/图表高度为一个单位
        lastQuarterV = max(values[int(0.75*len(values)):])+sf*5
        # 找到3/4位置到数据末的最大值,在加5个单位
        lastQuarterMax = lastQuarterV + sf*self.label.fontSize
        # m加上字体大小个单位
        self.chart.yValueAxis.valueMax = max(maxValue, lastQuarterMax)
        
        valueFormat = DecimalFormatter(0, prefix='¥', suffix=None, thousandSep=',')
        self.label._ux        = NormalDate(dates[-1])
        self.label._uy        = lastQuarterV
        self.label._text      = ' Ending Value {} '.format(valueFormat(values[-1]))

        return Drawing.getContents(self)

if __name__=="__main__":
    AreaChart_DynamicLabelConditionalSubTicks().save(formats=['pdf'],outDir='.',fnRoot=None)