Outline (アウトライン)#

The document outline (otherwise known as "bookmarks") is a property of Document (ドキュメント) (see Document.outline). If not None, it stands for the first outline item of the document. Its properties in turn define the characteristics of this item and also point to other outline items in "horizontal" or downward direction. The full tree of all outline items for e.g. a conventional table of contents (TOC) can be recovered by following these "pointers".

メソッド / 属性	短い説明
`Outline.down`	次の項目は下向き
`Outline.next`	同じレベルの次の項目
`Outline.page`	ページ番号（0から始まる）
`Outline.title`	タイトル
`Outline.uri`	アウトラインのターゲットをさらに指定する文字列
`Outline.is_external`	ドキュメントの外部のターゲットかどうか
`Outline.is_open`	サブアウトラインが開いているか折りたたまれているか
`Outline.dest`	宛先の詳細オブジェクトを指す

クラスAPI

class Outline#

down#

次の階層のアウトライン項目です。アイテムに子要素がない場合は None です。

Type:: Outline (アウトライン)

next#

このアイテムと同じレベルの次のアウトライン項目です。このアイテムがそのレベルで最後の場合、None です。

Type:: Outline (アウトライン)

page#

このブックマークが指すページ番号（0から始まる）です。

Type:: int

title#

アイテムのタイトル、または None の文字列です。

Type:: str

is_open#

サブアウトラインが展開されるべきか（True）折りたたまれるべきか（False）を示すインジケーターです。この情報はPDFリーダーソフトウェアによって解釈されます。

Type:: bool

is_external#

対象が現在のドキュメントの外部（True）かどうかを示すブール値です。

Type:: bool

uri#

リンクの対象を指定する文字列。このプロパティの意味は、プロパティ is_external と一緒に評価されるべきです。

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:).
is_external is false: uri will be None or point to an internal location. In case of PDF documents, this should either be #nnnn to indicate a 1-based (!) page number nnnn, or a named location. The format varies for other document types, for example "../FixedDoc.fdoc#PG_2_LNK_1" for page number 2 (1-based) in an XPS document.

Type:: str

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.