Skip to content

Clarify default anchor alignment #7600

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
radarhere merged 1 commit into from
Dec 12, 2023
Merged

Clarify default anchor alignment #7600

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions docs/reference/ImageDraw.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,9 +362,10 @@ Methods
:param fill: Color to use for the text.
:param font: An :py:class:`~PIL.ImageFont.ImageFont` instance.
:param anchor: The text anchor alignment. Determines the relative location of
the anchor to the text. The default alignment is top left.
See :ref:`text-anchors` for valid values. This parameter is
ignored for non-TrueType fonts.
the anchor to the text. The default alignment is top left,
specifically ``la`` for horizontal text and ``lt`` for
vertical text. See :ref:`text-anchors` for details.
This parameter is ignored for non-TrueType fonts.

.. note:: This parameter was present in earlier versions
of Pillow, but implemented only in version 8.0.0.
Expand Down Expand Up @@ -433,9 +434,10 @@ Methods
:param font: An :py:class:`~PIL.ImageFont.ImageFont` instance.

:param anchor: The text anchor alignment. Determines the relative location of
the anchor to the text. The default alignment is top left.
See :ref:`text-anchors` for valid values. This parameter is
ignored for non-TrueType fonts.
the anchor to the text. The default alignment is top left,
specifically ``la`` for horizontal text and ``lt`` for
vertical text. See :ref:`text-anchors` for details.
This parameter is ignored for non-TrueType fonts.

.. note:: This parameter was present in earlier versions
of Pillow, but implemented only in version 8.0.0.
Expand Down Expand Up @@ -576,9 +578,10 @@ Methods
:py:meth:`~PIL.ImageDraw.ImageDraw.multiline_textbbox`.
:param font: A :py:class:`~PIL.ImageFont.FreeTypeFont` instance.
:param anchor: The text anchor alignment. Determines the relative location of
the anchor to the text. The default alignment is top left.
See :ref:`text-anchors` for valid values. This parameter is
ignored for non-TrueType fonts.
the anchor to the text. The default alignment is top left,
specifically ``la`` for horizontal text and ``lt`` for
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
:py:meth:`~PIL.ImageDraw.ImageDraw.multiline_textbbox`,
the number of pixels between lines.
Expand Down Expand Up @@ -630,9 +633,10 @@ Methods
:param text: Text to be measured.
:param font: A :py:class:`~PIL.ImageFont.FreeTypeFont` instance.
:param anchor: The text anchor alignment. Determines the relative location of
the anchor to the text. The default alignment is top left.
See :ref:`text-anchors` for valid values. This parameter is
ignored for non-TrueType fonts.
the anchor to the text. The default alignment is top left,
specifically ``la`` for horizontal text and ``lt`` for
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 align: ``"left"``, ``"center"`` or ``"right"``. Determines the relative alignment of lines.
Use the ``anchor`` parameter to specify the alignment to ``xy``.
Expand Down
15 changes: 9 additions & 6 deletions src/PIL/ImageFont.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,8 +375,9 @@ def getbbox(
:param stroke_width: The width of the text stroke.

:param anchor: The text anchor alignment. Determines the relative location of
the anchor to the text. The default alignment is top left.
See :ref:`text-anchors` for valid values.
the anchor to the text. The default alignment is top left,
specifically ``la`` for horizontal text and ``lt`` for
vertical text. See :ref:`text-anchors` for details.

:return: ``(left, top, right, bottom)`` bounding box
"""
Expand Down Expand Up @@ -449,8 +450,9 @@ def getmask(
.. versionadded:: 6.2.0

:param anchor: The text anchor alignment. Determines the relative location of
the anchor to the text. The default alignment is top left.
See :ref:`text-anchors` for valid values.
the anchor to the text. The default alignment is top left,
specifically ``la`` for horizontal text and ``lt`` for
vertical text. See :ref:`text-anchors` for details.

.. versionadded:: 8.0.0

Expand Down Expand Up @@ -541,8 +543,9 @@ def getmask2(
.. versionadded:: 6.2.0

:param anchor: The text anchor alignment. Determines the relative location of
the anchor to the text. The default alignment is top left.
See :ref:`text-anchors` for valid values.
the anchor to the text. The default alignment is top left,
specifically ``la`` for horizontal text and ``lt`` for
vertical text. See :ref:`text-anchors` for details.

.. versionadded:: 8.0.0

Expand Down