链接#

表示一个指向某个地方的指针（这个文档、其他文档、互联网）。链接在每个文档页面存在，并且相互前向链接，从一个可以通过Page.first_link属性访问的初始链接开始。

链接与其页面之间存在父子关系。如果页面对象变得无法使用（关闭文档、任何文档结构变化等），那么其所有现有的链接对象也会变得不可用 - 每当访问链接属性或方法时，都会引发一个异常，提示对象是“孤儿”。

属性	简短描述
`Link.set_border()`	修改边框属性
`Link.set_colors()`	修改颜色属性
`Link.set_flags()`	修改链接标志
`Link.border`	边框特性
`Link.colors`	边框线颜色
`Link.dest`	指向目的地详细信息
`Link.is_external`	检查链接是否为外部目的地
`Link.flags`	链接注释标志
`Link.next`	指向下一个链接
`Link.rect`	未变换坐标中的可点击区域
`Link.uri`	链接目标
`Link.xref`	`xref` 条目的编号

类 API

class Link#

set_border(border=None, width=0, style=None, dashes=None)#

仅限PDF：更改边框宽度和虚线属性。

(在版本 1.16.9 中更改) 允许在不使用字典的情况下进行指定。如果border 不是字典，则使用直接参数。

Parameters:

border (dict) – 一个由 border 属性返回的字典，包含键 “width” (float), “style” (str) 和 “dashes” (sequence)。省略的键将使相应的属性保持不变。例如，要移除虚线使用: “dashes”: []。如果 dashes 不是一个空序列，“style” 将自动设置为 “D” (虚线)。
宽度 (浮点数) – 见上文。
样式 (str) – 请参见上文。
破折号 (序列) – 见上文。

set_colors(colors=None, stroke=None)#

仅限PDF：改变“描边”颜色。

注意

在PDF中，链接在技术上是注释的一个子类型，并且不支持填充颜色。然而，为了保持一致的API，我们确实允许像所有注释一样指定一个fill=参数，这个参数将会被忽略并发出警告。

(在版本 1.16.9 中更改) 允许直接设置颜色。如果 colors 不是字典，则使用这些参数。

Parameters:

colors (dict) – 一个包含色彩规范的字典。有关接受的字典键和值，请参见下方。最实用的方法应该是先复制 colors 属性，然后根据需要修改此字典。
stroke (sequence) – 请参见上文。

set_flags(flags)#

在v1.18.16中的新功能

设置链接注释的 PDF /F 属性。详情请参见 Annot.set_flags()。如果不是 PDF，则此方法无效。

flags#

v1.18.16中的新功能

返回链接注释标志，一个整数（详见 Annot.flags）。如果不是 PDF，则为零。

colors#

仅对PDF有意义：一个包含两个元组的字典，元组内的浮点数范围为 0 <= float <= 1，指定描边和内部（填充）颜色。如果不是PDF，则返回None。如上所述，链接的填充颜色始终为 None。描边颜色用于链接矩形的边框。元组的长度隐含决定了颜色空间：1 = 灰度，3 = RGB，4 = CMYK。因此 (1.0, 0.0, 0.0) 代表RGB颜色红色。每个浮点数 f 的值通过计算 f = i / 255 被映射到范围从0到255的整数值 i。

Return type:: 字典

border#

仅对 PDF 有意义：包含边框特征的字典。对于非 PDF 将为 None，如果没有边框信息则为一个空字典。可以出现以下键：

width – 一个浮点数，表示边框的厚度，单位为点。如果未指定宽度，则值为 -1.0。
破折号 – 一系列整数，指定线条的破折号模式。[] 表示没有破折号，[n] 表示n 点的相等开关长度，较长的列表将被解释为指定交替的开关长度值。请参见Adobe PDF References 第126页获取更多详细信息。
style – 1字节边框样式：S (实线) = 围绕注释的实心矩形，D (虚线) = 围绕链接的虚线矩形，虚线模式由dashes条目指定，B (斜面) = 一种模拟的浮雕矩形，似乎高于页面表面，I (嵌入) = 一种模拟的雕刻矩形，似乎凹入于页面表面，U (下划线) = 注释矩形底部的单行线。

Return type:: 字典

rect#

可以在未转换坐标中点击的区域。

Type:: 矩形

is_external#

一个布尔值，指示链接目标是否在当前文档之外。

Type:: 布尔值

uri#

一个指定链接目标的字符串。该属性的含义应与属性 is_external 一起评估：

is_external 为真：uri 指向当前PDF之外的某个目标，这可能是一个互联网资源（uri 以 http:// 或类似内容开头），另一个文件（uri 以 “file:” 或 “file://” 开头）或其他服务，如电子邮件地址（uri 以 mailto: 开头）。
is_external 是 false: uri 将是 None 或指向一个内部位置。在PDF文档的情况下，这应该是 #nnnn以指示一个从1开始的 (!) 页码 nnnn，或一个命名位置。其他文档类型的格式各不相同，例如在XPS文档中，页码2（从1开始）为“../FixedDoc.fdoc#PG_2_LNK_1”。

Type:: 字符串

xref#

一个整数，指定PDF xref。如果不是PDF，则为零。

Type:: 整型

next#

下一个链接或无。

Type:: 链接

dest#

链接目标详细信息对象。

Type:: linkDest

Do you have any feedback on this page?

本软件按原样提供，不作任何明示或暗示的担保。该软件根据许可证分发，除非按照该许可证的条款明确授权，否则不得复制、修改或分发。有关许可信息，请参阅artifex.com或联系Artifex Software Inc.，地址：39 Mesa Street, Suite 108A, San Francisco CA 94129, United States以获取更多信息。