Link (リンク)#

リンクは、どこかへのポインタを表します（この文書、他の文書、インターネットなど）。リンクは文書のページごとに存在し、最初のリンクは Page.first_link プロパティでアクセスできます。リンクはお互いにフォワードチェーンされ、最初のリンクから始まります。

リンクとそのページとの親子関係があります。ページオブジェクトが使用できなくなると（ドキュメントがクローズされた場合、ドキュメント構造が変更された場合など）、そのページに存在するリンクオブジェクトも使用できなくなります。リンクのプロパティまたはメソッドにアクセスしようとすると、「オーファン」というオブジェクトが発生し、例外が発生します。

属性	短い説明
`Link.set_border()`	境界線のプロパティを変更します
`Link.set_colors()`	色のプロパティを変更します
`Link.set_flags()`	リンクフラグを変更します
`Link.border`	境界線の特性
`Link.colors`	境界線の色
`Link.dest`	宛先の詳細を指します
`Link.is_external`	checks if the link is an external destination
`Link.flags`	リンク注釈のフラグ
`Link.next`	次のリンクを指します
`Link.rect`	clickable area in untransformed coordinates
`Link.uri`	リンクの宛先
`Link.xref`	エントリの `xref` 番号

クラスAPI

class Link#

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

PDFのみ：境界線の幅と破線プロパティを変更します。

（バージョン1.16.9で変更） 辞書を使用せずに仕様を許可します。border が辞書でない場合、直接のパラメータが使用されます。

パラメータ:

border (dict) -- border プロパティによって返される辞書で、キー "width"*（*浮動小数点）、"style"*（*str）、"dashes"*（*シーケンス）を持っています。省略されたキーは、対応するプロパティを変更しません。例えば点線を削除するには、「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 の2つの浮動小数点数のタプルを含む辞書。PDFでない場合、None が返されます。上記のように、リンクの塗りつぶしの色は常に None です。ストロークの色はリンクの境界のために使用されます。タプルの長さは暗黙的に色空間を決定します: 1 = GRAY、3 = RGB、4 = CMYK。したがって、 (1.0、0.0、0.0) はRGBカラーの赤を表します。各浮動小数点数 f の値は、f = i / 255 の計算を介して範囲0から255の整数値 i にマップされます。

戻り値の型:: 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 true: uri points to some target outside the current PDF, which may be an internet resource (uri starts with http:// or similar), another file (uri starts with "file:" or "file://") or some other service like an e-mail address (uri starts with mailto:).
⚠️

Type:: str

xref#

PDF xref を指定する整数。PDFでない場合はゼロ。

Type:: int

next#

次のリンクまたは None。

Type:: Link （リンク）

dest#

リンクの対象の詳細オブジェクト。

Type:: linkDest

This software is provided AS-IS with no warranty, either express or implied. This software is distributed under license and may not be copied, modified or distributed except as expressly authorized under the terms of that license. Refer to licensing information at artifex.com or contact Artifex Software Inc., 39 Mesa Street, Suite 108A, San Francisco CA 94129, United States for further information.