python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2025-06-24 15:03:22 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #7600 from nulano/anchor-clarify-docs

Browse Source 
Clarify default anchor alignment
This commit is contained in:
Andrew Murray 2023-12-13 07:36:00 +11:00 committed by GitHub
commit 4c7eeec4fc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 25 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/reference/ImageDraw.rst
View File

@ -362,9 +362,10 @@ Methods
:param fill: Color to use for the text. :param fill: Color to use for the text.
:param font: An :py:class:`~PIL.ImageFont.ImageFont` instance. :param font: An :py:class:`~PIL.ImageFont.ImageFont` instance.
:param anchor: The text anchor alignment. Determines the relative location of :param anchor: The text anchor alignment. Determines the relative location of
the anchor to the text. The default alignment is top left. the anchor to the text. The default alignment is top left,
See :ref:`text-anchors` for valid values. This parameter is specifically ``la`` for horizontal text and ``lt`` for
ignored for non-TrueType fonts. vertical text. See :ref:`text-anchors` for details.
This parameter is ignored for non-TrueType fonts.
.. note:: This parameter was present in earlier versions .. note:: This parameter was present in earlier versions
of Pillow, but implemented only in version 8.0.0. of Pillow, but implemented only in version 8.0.0.
@ -433,9 +434,10 @@ Methods
:param font: An :py:class:`~PIL.ImageFont.ImageFont` instance. :param font: An :py:class:`~PIL.ImageFont.ImageFont` instance.
:param anchor: The text anchor alignment. Determines the relative location of :param anchor: The text anchor alignment. Determines the relative location of
the anchor to the text. The default alignment is top left. the anchor to the text. The default alignment is top left,
See :ref:`text-anchors` for valid values. This parameter is specifically ``la`` for horizontal text and ``lt`` for
ignored for non-TrueType fonts. vertical text. See :ref:`text-anchors` for details.
This parameter is ignored for non-TrueType fonts.
.. note:: This parameter was present in earlier versions .. note:: This parameter was present in earlier versions
of Pillow, but implemented only in version 8.0.0. of Pillow, but implemented only in version 8.0.0.
@ -576,9 +578,10 @@ Methods
:py:meth:`~PIL.ImageDraw.ImageDraw.multiline_textbbox`. :py:meth:`~PIL.ImageDraw.ImageDraw.multiline_textbbox`.
:param font: A :py:class:`~PIL.ImageFont.FreeTypeFont` instance. :param font: A :py:class:`~PIL.ImageFont.FreeTypeFont` instance.
:param anchor: The text anchor alignment. Determines the relative location of :param anchor: The text anchor alignment. Determines the relative location of
the anchor to the text. The default alignment is top left. the anchor to the text. The default alignment is top left,
See :ref:`text-anchors` for valid values. This parameter is specifically ``la`` for horizontal text and ``lt`` for
ignored for non-TrueType fonts. vertical text. See :ref:`text-anchors` for details.
This parameter is ignored for non-TrueType fonts.
:param spacing: If the text is passed on to :param spacing: If the text is passed on to
:py:meth:`~PIL.ImageDraw.ImageDraw.multiline_textbbox`, :py:meth:`~PIL.ImageDraw.ImageDraw.multiline_textbbox`,
the number of pixels between lines. the number of pixels between lines.
@ -630,9 +633,10 @@ Methods
:param text: Text to be measured. :param text: Text to be measured.
:param font: A :py:class:`~PIL.ImageFont.FreeTypeFont` instance. :param font: A :py:class:`~PIL.ImageFont.FreeTypeFont` instance.
:param anchor: The text anchor alignment. Determines the relative location of :param anchor: The text anchor alignment. Determines the relative location of
the anchor to the text. The default alignment is top left. the anchor to the text. The default alignment is top left,
See :ref:`text-anchors` for valid values. This parameter is specifically ``la`` for horizontal text and ``lt`` for
ignored for non-TrueType fonts. vertical text. See :ref:`text-anchors` for details.
This parameter is ignored for non-TrueType fonts.
:param spacing: The number of pixels between lines. :param spacing: The number of pixels between lines.
:param align: ``"left"``, ``"center"`` or ``"right"``. Determines the relative alignment of lines. :param align: ``"left"``, ``"center"`` or ``"right"``. Determines the relative alignment of lines.
Use the ``anchor`` parameter to specify the alignment to ``xy``. Use the ``anchor`` parameter to specify the alignment to ``xy``.

15
src/PIL/ImageFont.py
View File

@ -392,8 +392,9 @@ class FreeTypeFont:
:param stroke_width: The width of the text stroke. :param stroke_width: The width of the text stroke.
:param anchor: The text anchor alignment. Determines the relative location of :param anchor: The text anchor alignment. Determines the relative location of
the anchor to the text. The default alignment is top left. the anchor to the text. The default alignment is top left,
See :ref:`text-anchors` for valid values. specifically ``la`` for horizontal text and ``lt`` for
vertical text. See :ref:`text-anchors` for details.
:return: ``(left, top, right, bottom)`` bounding box :return: ``(left, top, right, bottom)`` bounding box
""" """
@ -466,8 +467,9 @@ class FreeTypeFont:
.. versionadded:: 6.2.0 .. versionadded:: 6.2.0
:param anchor: The text anchor alignment. Determines the relative location of :param anchor: The text anchor alignment. Determines the relative location of
the anchor to the text. The default alignment is top left. the anchor to the text. The default alignment is top left,
See :ref:`text-anchors` for valid values. specifically ``la`` for horizontal text and ``lt`` for
vertical text. See :ref:`text-anchors` for details.
.. versionadded:: 8.0.0 .. versionadded:: 8.0.0
@ -558,8 +560,9 @@ class FreeTypeFont:
.. versionadded:: 6.2.0 .. versionadded:: 6.2.0
:param anchor: The text anchor alignment. Determines the relative location of :param anchor: The text anchor alignment. Determines the relative location of
the anchor to the text. The default alignment is top left. the anchor to the text. The default alignment is top left,
See :ref:`text-anchors` for valid values. specifically ``la`` for horizontal text and ``lt`` for
vertical text. See :ref:`text-anchors` for details.
.. versionadded:: 8.0.0 .. versionadded:: 8.0.0