1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
.. include:: header.rst
.. _DisplayList:
================
DisplayList
================
DisplayList is a list containing drawing commands (text, images, etc.). The intent is two-fold:
1. as a caching-mechanism to reduce parsing of a page
2. as a data structure in multi-threading setups, where one thread parses the page and another one renders pages. This aspect is currently not supported by PyMuPDF.
A display list is populated with objects from a page, usually by executing :meth:`Page.get_displaylist`. There also exists an independent constructor.
"Replay" the list (once or many times) by invoking one of its methods :meth:`~DisplayList.run`, :meth:`~DisplayList.get_pixmap` or :meth:`~DisplayList.get_textpage`.
================================= ============================================
**Method** **Short Description**
================================= ============================================
:meth:`~DisplayList.run` Run a display list through a device.
:meth:`~DisplayList.get_pixmap` generate a pixmap
:meth:`~DisplayList.get_textpage` generate a text page
:attr:`~DisplayList.rect` mediabox of the display list
================================= ============================================
**Class API**
.. class:: DisplayList
.. method:: __init__(self, mediabox)
Create a new display list.
:arg mediabox: The page's rectangle.
:type mediabox: :ref:`Rect`
:rtype: *DisplayList*
.. method:: run(device, matrix, area)
Run the display list through a device. The device will populate the display list with its "commands" (i.e. text extraction or image creation). The display list can later be used to "read" a page many times without having to re-interpret it from the document file.
You will most probably instead use one of the specialized run methods below -- :meth:`get_pixmap` or :meth:`get_textpage`.
:arg device: Device
:type device: :ref:`Device`
:arg matrix: Transformation matrix to apply to the display list contents.
:type matrix: :ref:`Matrix`
:arg area: Only the part visible within this area will be considered when the list is run through the device.
:type area: :ref:`Rect`
.. index::
pair: matrix; DisplayList.get_pixmap
pair: colorspace; DisplayList.get_pixmap
pair: clip; DisplayList.get_pixmap
pair: alpha; DisplayList.get_pixmap
.. method:: get_pixmap(matrix=pymupdf.Identity, colorspace=pymupdf.csRGB, alpha=0, clip=None)
Run the display list through a draw device and return a pixmap.
:arg matrix: matrix to use. Default is the identity matrix.
:type matrix: :ref:`Matrix`
:arg colorspace: the desired colorspace. Default is RGB.
:type colorspace: :ref:`Colorspace`
:arg int alpha: determine whether or not (0, default) to include a transparency channel.
:arg irect_like clip: restrict rendering to the intersection of this area with :attr:`DisplayList.rect`.
:rtype: :ref:`Pixmap`
:returns: pixmap of the display list.
.. method:: get_textpage(flags)
Run the display list through a text device and return a text page.
:arg int flags: control which information is parsed into a text page. Default value in PyMuPDF is `3 = TEXT_PRESERVE_LIGATURES | TEXT_PRESERVE_WHITESPACE`, i.e. :data:`ligatures` are **passed through**, white spaces are **passed through** (not translated to spaces), and images are **not included**. See :ref:`TextPreserve`.
:rtype: :ref:`TextPage`
:returns: text page of the display list.
.. attribute:: rect
Contains the display list's mediabox. This will equal the page's rectangle if it was created via :meth:`Page.get_displaylist`.
:type: :ref:`Rect`
.. include:: footer.rst
|
