Commit91f986a

committed

DOC: document fmt_xdata, fmt_ydata, and fmt_ydata

1 parent5bd9b9d commit91f986aCopy full SHA for 91f986a

File tree

+52

-0

lines changed

+52

-0

lines changed

Lines changed: 2 additions & 0 deletions

Lines changed: 23 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -312,6 +312,29 @@ Preserve aspect ratio hold CONTROL when panning/zooming with mo`
`312`	`312`	`================================== ===============================`
`313`	`313`
`314`	`314`
	`315`	`+Position Format`
	`316`	`+---------------`
	`317`	`+`
	`318`	`+The location of the cursor is shown in the UI and generated via the`
	`319`	+`~axes.Axes.format_coord` method which in turn calls the
	`320`	+`~axes.Axes.format_xdata` and `~axes.Axes.format_ydata` methods. The hard
	`321`	+coded format in `~axes.Axes.format_coord` is ``f'x={formatted_x}
	`322`	+y={formatted_y}'``.
	`323`	`+`
	`324`	`+To easily customize how the x and y values are formatted, you can set the`
	`325`	+`.axes.Axes.fmt_xdata` and `.axes.Axes.fmt_ydata` attributes on the
	`326`	+`~axes.Axes` instance. The values are expected to be functions that
	`327`	`+take a float and return a string. For example ::`
	`328`	`+`
	`329`	`+ fig, ax = plt.subplots()`
	`330`	`+ ax.set_ylim(-5, 5)`
	`331`	`+ ax.fmt_ydata = lambda v: f'{v:.3g}' if v > 0 else f'({-v:.3g})'`
	`332`	`+`
	`333`	`+will format negative y-values with parenthesis rather than a negative sign. If`
	`334`	+these attributes are set to `None`, then the `.Formatter.format_data_short`
	`335`	`+method on the major formatter of the respective axes will be used instead.`
	`336`	`+`
	`337`	`+`
`315`	`338`	`.. _other-shells:`
`316`	`339`
`317`	`340`	`Other Python prompts`

Lines changed: 20 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -594,6 +594,26 @@ class _AxesBase(martist.Artist):`
`594`	`594`	- :doc:`Axis API </api/axis_api>`
`595`	`595`	`"""`
`596`	`596`
	`597`	`+#: Callable to format the x-data in an interactive window.`
	`598`	`+#:`
	`599`	`+#: The expected signature is ::`
	`600`	`+#:`
	`601`	`+#: def fmt(val: float, /) -> str: ...`
	`602`	`+fmt_xdata=None`
	`603`	`+`
	`604`	`+#: Callable to format the y-data in an interactive window`
	`605`	`+#:`
	`606`	`+#: The expected signature is ::`
	`607`	`+#:`
	`608`	`+#: def fmt(val: float, /) -> str: ...`
	`609`	`+fmt_ydata=None`
	`610`	`+`
	`611`	`+@property`
	`612`	`+def_axis_map(self):`
	`613`	+"""A mapping of axis names, e.g. 'x', to `Axis` instances."""
	`614`	`+return {name:getattr(self,f"{name}axis")`
	`615`	`+fornameinself._axis_names}`
	`616`	`+`
`597`	`617`	`def__str__(self):`
`598`	`618`	`return"{0}({1[0]:g},{1[1]:g};{1[2]:g}x{1[3]:g})".format(`
`599`	`619`	`type(self).__name__,self._position.bounds)`

Lines changed: 7 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,13 @@ class Axes3D(Axes):`
`57`	`57`	`Axes._shared_axes["z"]=cbook.Grouper()`
`58`	`58`	`Axes._shared_axes["view"]=cbook.Grouper()`
`59`	`59`
	`60`	`+#: Callable to format the z-data in an interactive window`
	`61`	`+#:`
	`62`	`+#: The expected signature is ::`
	`63`	`+#:`
	`64`	`+#: def fmt(val: float, /) -> str: ...`
	`65`	`+fmt_zdata=None`
	`66`	`+`
`60`	`67`	`def__init__(`
`61`	`68`	`self,fig,rect=None,*args,`
`62`	`69`	`elev=30,azim=-60,roll=0,shareview=None,sharez=None,`

Comments

(0)