ReportLab API 参考指南

5星 · 超过95%的资源需积分: 46 26 浏览量更新于2024-07-24 收藏 157KB PDF 举报

"reportlab-doc" **ReportLab API 参考** ReportLab 是一个强大的 Python 库，用于生成 PDF 文档。官方文档提供了该库所有公开的类、函数和方法的详细参考信息。虽然大部分参考文本自动生成自每个类、方法和函数的文档字符串，因此格式可能不那么美观，但它仍然是理解和使用 ReportLab 的重要资源。 **关键点说明** 1. **私有与实验性项目** - 前面有一个下划线（_）的项目被认为是模块内的私有，不在文档中公开，且维护承诺有限。这意味着不应依赖这些私有项目进行长期开发。 - 结尾带数字（通常为零）的项目是实验性的。它们是为了广泛测试而发布，但未来可能会发生变化或被废弃。你可以尝试使用并提供反馈，但不适合在生产环境中依赖这些实验性功能。 2. **包架构** - `reportlab` 包由多个子包组成，这使得代码结构清晰，便于管理和扩展。 - `reportlab.pdfgen` - 这是与 PDF 文件格式交互的编程接口。`Canvas` 类是核心，它提供了创建 PDF 输出所需的所有工具。`TextObject` 和 `PathObject` 作为辅助类，帮助处理文本和路径操作。 **报告实验室包的主要组件** - **reportlab.pdfgen** - `Canvas` 类：这是创建 PDF 页面的基本对象，可以理解为画布，允许你在上面添加图形、文本和其他元素。 - `TextObject`：处理 PDF 文本的类，用于在画布上添加和格式化文本。 - `PathObject`：处理图形路径，如线条、曲线和形状，支持复杂的绘图操作。 **使用 ReportLab 创建 PDF** 使用 ReportLab 创建 PDF 时，通常会首先创建一个 `Canvas` 实例，然后在其上绘制元素。例如，你可以通过 `Canvas.create_text()` 添加文本，通过 `Canvas.line()` 绘制直线，或者使用 `Canvas.draw_image()` 插入图片。每个方法都有丰富的参数供你定制输出样式和位置。 **其他子包** - `reportlab.platypus`：提供了一组高级布局对象，如段落、表格和列表，简化了复杂页面设计的工作。 - `reportlab.lib`：包含各种实用工具和常量，如颜色定义、字体管理等。 - `reportlab.graphics`：用于创建矢量图形，可以生成 PDF 图形或导出为其他格式。 - `reportlab.rl_config`：配置选项，允许用户自定义 ReportLab 的行为。 ReportLab 提供了一个全面的框架，让 Python 开发者能够轻松地生成高质量的 PDF 文档，无论是简单的文本输出还是复杂的多页报告，都能够胜任。通过深入理解其 API 参考文档，开发者可以充分利用 ReportLab 的强大功能，实现各种定制化的 PDF 生成需求。

def setEncrypt(self, encrypt):

Set the encryption used for the pdf generated by this canvas.

If encrypt is a string object, it is used as the user password for the pdf.

If encrypt is an instance of reportlab.lib.pdfencrypt.StandardEncryption, this object is

used to encrypt the pdf. This allows more finegrained control over the encryption settings.

def setFont(self, psfontname, size, leading = None):

Sets the font. If leading not specified, defaults to 1.2 x

font size. Raises a readable exception if an illegal font

is supplied. Font names are case-sensitive! Keeps track

of font name and size for metrics.

def setFontSize(self, size=None, leading=None):

Sets font size or leading without knowing the font face

def setKeywords(self, keywords):

write a list of keywords into the PDF file which shows in document properties.

Either submit a single string or a list/tuple

def setLineCap(self, mode):

0=butt,1=round,2=square

def setLineJoin(self, mode):

0=mitre, 1=round, 2=bevel

def setLineWidth(self, width):

(no documentation string)

def setMiterLimit(self, limit):

(no documentation string)

def setPageCallBack(self, func):

func(pageNum) will be called on each page end.

This is mainly a hook for progress monitoring.

Call setPageCallback(None) to clear a callback.

def setPageCompression(self, pageCompression=1):

Possible values None, 1 or 0

If None the value from rl_config will be used.

If on, the page data will be compressed, leading to much

smaller files, but takes a little longer to create the files.

This applies to all subsequent pages, or until setPageCompression()

is next called.

def setPageDuration(self, duration=None):

Allows hands-off animation of presentations :-)

If this is set to a number, in full screen mode, Acrobat Reader

will advance to the next page after this many seconds. The

duration of the transition itself (fade/flicker etc.) is controlled

by the 'duration' argument to setPageTransition; this controls

the time spent looking at the page. This is effective for all

subsequent pages.

def setPageRotation(self, rot):

Instruct display device that this page is to be rotated

def setPageSize(self, size):

accepts a 2-tuple in points for paper size for this

and subsequent pages

def setPageTransition(self, effectname=None, duration=1,

direction=0,dimension='H',motion='I'):

PDF allows page transition effects for use when giving

presentations. There are six possible effects. You can

just guive the effect name, or supply more advanced options

to refine the way it works. There are three types of extra

argument permitted, and here are the allowed values::

direction_arg = [0,90,180,270]

dimension_arg = ['H', 'V']

ReportLab API Reference reportlab.pdfgen subpackage

Page 10

reportlab.pdfgen.pathobject module

The method Canvas.beginPath allows users to construct a PDFPathObject, which is defined in

reportlab/pdfgen/pathobject.py.

Class PDFPathObject:

Represents a graphic path. There are certain 'modes' to PDF

drawing, and making a separate object to expose Path operations

ensures they are completed with no run-time overhead. Ask

the Canvas for a PDFPath with getNewPathObject(); moveto/lineto/

curveto wherever you want; add whole shapes; and then add it back

into the canvas with one of the relevant operators.

Path objects are probably not long, so we pack onto one line

the code argument allows a canvas to get the operatiosn appended directly so

avoiding the final getCode

def arc(self, x1,y1, x2,y2, startAng=0, extent=90):

Contributed to piddlePDF by Robert Kern, 28/7/99.

Draw a partial ellipse inscribed within the rectangle x1,y1,x2,y2,

starting at startAng degrees and covering extent degrees. Angles

start with 0 to the right (+x) and increase counter-clockwise.

These should have x1<x2 and y1<y2.

The algorithm is an elliptical generalization of the formulae in

Jim Fitzsimmon's TeX tutorial <URL: http://www.tinaja.com/bezarc1.pdf>.

def arcTo(self, x1,y1, x2,y2, startAng=0, extent=90):

Like arc, but draws a line from the current point to

the start if the start is not the current point.

def circle(self, x_cen, y_cen, r):

adds a circle to the path

def close(self):

draws a line back to where it started

def curveTo(self, x1, y1, x2, y2, x3, y3):

(no documentation string)

def ellipse(self, x, y, width, height):

adds an ellipse to the path

def getCode(self):

pack onto one line; used internally

def lineTo(self, x, y):

(no documentation string)

def moveTo(self, x, y):

(no documentation string)

def rect(self, x, y, width, height):

Adds a rectangle to the path

def roundRect(self, x, y, width, height, radius):

Draws a rectangle with rounded corners. The corners are

approximately quadrants of a circle, with the given radius.

ReportLab API Reference reportlab.pdfgen subpackage

Page 12

剩余58页未读，继续阅读

NavCat

粉丝: 50
资源: 15

ReportLab API 参考指南

reportlab-userguide.pdf

python使用reportlab画图示例（含中文汉字）

reportlab中文手册.pdf

reportlab分页

ReportLab自动化报表生成：数据库与ReportLab整合技巧

在reportlab中,doc和story的关系具体代码说明

在reportlab中，doc.multiBuild()如何让目录生成文档的标签

在reportlab中如何在doc.multiBuild()生成可以把目录变成标签的文档

在reportlab中，使用doc.multiBuild()方法，如何把TableOfContents() 添加到标签中

reportlab table

最新资源