Commit098b865

authored and

committed

Document legend best slowness (#12203)

* Mention legend slowness in performance section* Mention legend slowness in legend docs

1 parent1437772 commit098b865Copy full SHA for 098b865

File tree

+12

-0

lines changed

+12

-0

lines changed

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -135,6 +135,10 @@ def _update_bbox_to_anchor(self, loc_in_canvas):`
`135`	`135`	`corner of the legend in axes coordinates (in which case`
`136`	`136`	``bbox_to_anchor`` will be ignored).
`137`	`137`
	`138`	`+ The 'best' option can be quite slow for plots with large amounts`
	`139`	`+ of data. Your plotting speed may benefit from providing a specific`
	`140`	`+ location.`
	`141`	`+`
`138`	`142`	bbox_to_anchor : `.BboxBase`, 2-tuple, or 4-tuple of floats
`139`	`143`	`Box that is used to position the legend in conjunction with loc.`
`140`	`144`	Defaults to `axes.bbox` (if called as a method to `.Axes.legend`) or

Lines changed: 8 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -760,6 +760,14 @@ def my_plotter(ax, data1, data2, param_dict):`
`760`	`760`	`# plt.plot(y)`
`761`	`761`	`# plt.show()`
`762`	`762`	`#`
	`763`	`+# Legends`
	`764`	`+# -------`
	`765`	`+#`
	`766`	`+# The default legend behavior for axes attempts to find the location`
	`767`	+# that covers the fewest data points (`loc='best'`). This can be a
	`768`	`+# very expensive computation if there are lots of data points. In`
	`769`	`+# this case, you may want to provide a specific location.`
	`770`	`+#`
`763`	`771`	`# Using the fast style`
`764`	`772`	`# ----------------------`
`765`	`773`	`#`

Comments

(0)