Contents Menu Expand Light mode Dark mode Auto light/dark mode
PyMuPDF 1.25.4 文档
Light Logo Dark Logo
PyMuPDF 1.25.4 文档

关于/About

  • 功能比较
  • 性能
  • 许可和版权
  • PyMuPDF4LLM
  • PyMuPDF Pro

用户指南/User Guide

  • 安装
  • 基础用法
  • 教程
  • PyMuPDF、LLM 和 RAG
  • 资源

教程/How to Guide

  • 打开文件
  • 文本
  • 图片
  • 注释
  • 绘图和图形
  • 故事
  • 日记
  • 多进程
  • OCR - 光学字符识别
  • 可选内容支持
  • 低级接口
  • 常见问题及其解决方案

API参考/API Reference

  • 命令行界面
  • 类
    • Annot
    • Archive
    • Colorspace
    • DisplayList
    • Document
    • DocumentWriter
    • Font
    • Identity
    • IRect
    • Link
    • linkDest
    • Matrix
    • Outline
    • Page
    • Pixmap
    • Point
    • Quad
    • Rect
    • Shape
    • Story
    • TextPage
    • TextWriter
    • Tools
    • Widget
    • Xml
  • 几何对象的运算符代数
  • 低级函数和类
    • 函数
    • 设备
    • 协同工作: DisplayList 和 TextPage
  • 术语
  • 常量和枚举
  • 颜色数据库

其他/Other

  • 附录 1:文本提取详细信息
  • 附录 2:嵌入式文件的注意事项
  • 附录 3:各类技术信息
  • 附录 4:性能比较方法
  • 更新日志
  • 已废弃名称
Back to top
Find #pymupdf on Discord

Link#

表示指向某处的指针(本文档、其他文档、互联网)。链接存在于每个文档页面上,并且是前向链接的,从初始链接开始,可以通过 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 条目的编号

Class API

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

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

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

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

  • width (float) – 如上所述。

  • style (str) – 如上所述。

  • dashes (sequence) – 如上所述。

set_colors(colors=None, stroke=None)#

仅限 PDF:更改 “stroke” 颜色。

备注

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

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

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

  • stroke (sequence) – 如上所述。

set_flags(flags)#

自版本 1.18.16 起新功能

设置链接注释的 PDF /F 属性。有关详细信息,请参见 Annot.set_flags()。如果不是 PDF,调用此方法将不起作用。

flags#

自版本 1.18.16 起新功能

返回链接注释标志,一个整数(有关详细信息,请参见 Annot.flags)。如果不是 PDF,则返回零。

colors#

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

返回类型:

dict

border#

仅限 PDF:包含边框特征的字典。如果不是 PDF,则为 None,如果没有边框信息,则为空字典。可能出现以下键:

  • width – 一个浮点数,表示边框的厚度(单位为点)。如果未指定宽度,值为 -1.0。

  • dashes – 一个整数序列,指定线条的虚线模式。[] 表示没有虚线,[n] 表示等长的开关长度为 n 点,较长的列表将被解释为交替开关的长度值。有关详细信息,请参见 Adobe PDF 参考 第 126 页。

  • style – 1 字节边框样式: S (实线)= 围绕注释的实心矩形,D (虚线)= 围绕链接的虚线矩形,虚线模式由 dashes 条目指定, B (斜角)= 模拟的浮雕矩形,似乎在页面表面上方, I (内嵌)= 模拟的刻槽矩形,似乎在页面表面下方,U (下划线)= 注释矩形底部的单线。

返回类型:

dict

rect#

可以点击的区域,采用未经变换的坐标表示。

Type:

Rect

is_external#

一个布尔值,指定链接目标是否在当前文档外部。

Type:

bool

uri#

一个字符串,指定链接目标。此属性的含义应与 is_external 属性结合使用进行评估:

  • 如果 is_external 为真: uri 指向当前 PDF 文档外的某个目标,可能是互联网资源( uri 以 http:// 或类似的开头)、另一个文件( uri 以 “file:” 或 “file://” 开头)或其他服务,如电子邮件地址( uri 以 mailto: 开头)。

  • 如果 is_external 为假:uri 将为 None 或指向内部位置。对于 PDF 文档,这应为 #nnnn,表示 1 基数的页面号 nnnn,或者是一个命名位置。对于其他文档类型,格式可能不同,例如 XPS 文档中的 “../FixedDoc.fdoc#PG_2_LNK_1” 表示第 2 页(1 基数)。

Type:

str

xref#

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

Type:

int

next#

下一个链接或 None。

Type:

Link

dest#

链接目标详细信息对象。

Type:

linkDest

Represents a pointer to somewhere (this document, other documents, the internet). Links exist per document page, and they are forward-chained to each other, starting from an initial link which is accessible by the Page.first_link property.

There is a parent-child relationship between a link and its page. If the page object becomes unusable (closed document, any document structure change, etc.), then so does every of its existing link objects – an exception is raised saying that the object is “orphaned”, whenever a link property or method is accessed.

Attribute

Short Description

Link.set_border()

modify border properties

Link.set_colors()

modify color properties

Link.set_flags()

modify link flags

Link.border

border characteristics

Link.colors

border line color

Link.dest

points to destination details

Link.is_external

checks if the link is an external destination

Link.flags

link annotation flags

Link.next

points to next link

Link.rect

clickable area in untransformed coordinates

Link.uri

link destination

Link.xref

xref number of the entry

Class API

您对此页面有任何反馈吗?

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

This documentation covers all versions up to 1.25.4.

Next
linkDest
Previous
IRect
Copyright © 2015-2025, Artifex
Made with Furo
Last updated on 19. 3月 2025
On this page
  • Link
    • Link
      • Link.set_border()
      • Link.set_colors()
      • Link.set_flags()
      • Link.flags
      • Link.colors
      • Link.border
      • Link.rect
      • Link.is_external
      • Link.uri
      • Link.xref
      • Link.next
      • Link.dest