DisplayList(ディスプレイリスト)#
DisplayListは、描画コマンド(テキスト、画像など)を含むリストです。その目的は二つあります:
ページのパースを削減するためのキャッシュメカニズムとして
ページをパースするスレッドとページをレンダリングする別のスレッドでのデータ構造として。この側面は現在、PyMuPDFではサポートされていません。
ディスプレイリストは通常、Page.get_displaylist()
を実行することによってページからオブジェクトで満たされます。また、独立したコンストラクタも存在します。
このリストを(一度または複数回)再生するには、そのメソッドのうちのいずれかを呼び出します。run()
、get_pixmap()
、または get_textpage()
です。
メソッド |
短い説明 |
---|---|
ディスプレイリストをデバイスを介して実行します。 |
|
ピクスマップを生成します。 |
|
テキストページを生成します。 |
|
ディスプレイリストのメディアボックス(表示領域)です。 |
Class API(クラスAPI)
- class DisplayList#
- __init__(self, mediabox)#
新しいディスプレイリストを作成します。
- パラメータ:
mediabox (Rect (矩形)) -- ページの矩形。
- 戻り値の型:
DisplayList
- run(device, matrix, area)#
デバイスを介してディスプレイリストを実行します。デバイスはディスプレイリストをその「コマンド」(つまりテキストの抽出または画像の作成)で満たします。ディスプレイリストは後で文書ファイルから再解釈することなく、ページを多くの回数「読む」ために使用できます。
おそらく、以下の専門の実行メソッドの1つを代わりに使用するでしょう -
get_pixmap()
またはget_textpage()
。- パラメータ:
device (Device (デバイス)) -- デバイス
matrix (Matrix (マトリックス)) -- ディスプレイリストのコンテンツに適用する変換行列。
area (Rect (矩形)) -- デバイスを介してリストを実行する際にこの領域内で可視部分のみが考慮されます。
- get_pixmap(matrix=pymupdf.Identity, colorspace=pymupdf.csRGB, alpha=0, clip=None)#
ディスプレイリストを描画デバイスを介して実行し、ピクスマップを返します。
- パラメータ:
matrix (Matrix (マトリックス)) -- 使用する行列。デフォルトは単位行列です。
colorspace (Colorspace (カラースペース)) -- 望ましいカラースペース。デフォルトはRGBです。
alpha (int) -- 透明チャネルを含めるかどうかを決定します(0、デフォルトは含めない)。
clip (irect_like) --
DisplayList.rect
との交差部分にレンダリングを制限します。
- 戻り値の型:
- 戻り値:
ディスプレイリストのピクスマップ。
- get_textpage(flags)#
ディスプレイリストをテキストデバイスを介して実行し、テキストページを返します。
- パラメータ:
flags (int) -- テキストページに解析される情報を制御します。PyMuPDFのデフォルト値は
3 = TEXT_PRESERVE_LIGATURES | TEXT_PRESERVE_WHITESPACE
です。つまり、ligatures
はそのまま 通過 し、空白はそのまま 通過 します(スペースに変換されません)、画像は 含まれません 。テキスト抽出フラグ を参照してください。- 戻り値の型:
- 戻り値:
ディスプレイリストのテキストページ。
- rect#
ディスプレイリストのmediaboxを含みます。これは、
Page.get_displaylist()
を介して作成された場合、ページの矩形と等しいです。- Type: