Skip to content

[Doc]: Improve legend loc and bbox_to_anchor documentation #26620

Open
@timhoffm

Description

@timhoffm

Documentation Link

https://matplotlib.org/devdocs/api/_as_gen/matplotlib.axes.Axes.legend.html#matplotlib.axes.Axes.legend

Problem

Inspired by #26612

  1. Legends: Replace confusing terminology like bbox_to_anchor etc, and make the legend positioning simpler

Suggested improvement

Parameter loc

  • Explicitly state that the locations are positions within a given box (configurable via bbox_to_anchor, default: Axes box)

  • Replace

    The strings 'upper left', 'upper right', 'lower left', 'lower right' place the legend at the corresponding corner of the axes.
    The strings 'upper center', 'lower center', 'center left', 'center right' place the legend at the center of the corresponding edge of the axes.
    The string 'center' places the legend at the center of the axes.

    By Add a visual similar to the cheat sheet
    grafik
    but with the string names in the respective positions.

Parameter bbox_to_anchor

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions