mplutils.dashed

mplutils.dashed(ratio=1.5, n_dashes=3, linewidth=None, fontsize=None, legend_handlelength=None, **aliases)

Return a tuple to create a dashed line that fits perfectly into a legend. For that to work properly you may need to provide the linewidth of the graph and the fontsize of the legend.

Parameters:

ratiofloat, default: 1.5

Ratio between dash-length and gap-length

n_dashesint, default: 3

Number of dashes drawn

linewidth (or lw)float, optional, default: rcParams[“lines.linewidth”]

fontsizefloat or str, Optional, default: rcParams[“legend.fontsize”]

The fontsize used in the legend

• float: fontsize in pts

• str: "xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large", "larger", or "smaller"

legend_handlelength (or lh)float, default rcParams["legend.handlelength"]

Length of the legend handles (the dotted line, in this case) in font units

Returns:

(float, (float, float, float, float))

tuple to be used as linetype in plotting

See also

dotted()

Create dotted-line linestyle.

dash_dotted()

Create dash-dotted-line linestyle.

Examples

import matplotlib.pyplot as plt
import mplutils as mplu

_, (ax0, ax1) = plt.subplots(1, 2, layout=mplu.FixedLayoutEngine())

ax0.plot([0, 1], ls="dashed", label="incorrect width")
ax0.plot([1, 2], ls="-", label="reference width")
ax1.plot([0, 1], ls=mplu.dashed(), label="correct width")
ax1.plot([1, 2], ls="-", label="reference width")

for ax in (ax0, ax1):
    mplu.set_axes_size(2.5, ax=ax)
    ax.legend()

(Source code, png, hires.png, pdf)