Commit8874cb0

committed

DOC: document fmt_xdata and fmt_ydata

1 parenta844eca commit8874cb0Copy full SHA for 8874cb0

File tree

+39

-0

lines changed

+39

-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
`@@ -235,6 +235,29 @@ Preserve aspect ratio hold CONTROL when panning/zooming with mo`
`235`	`235`	`================================== ===============================`
`236`	`236`
`237`	`237`
	`238`	`+Position Format`
	`239`	`+---------------`
	`240`	`+`
	`241`	`+The location of the cursor is show in the UI and generated via the`
	`242`	+`~axes.Axes.format_coord` method which in turn calls the
	`243`	+`~axes.Axes.format_xdata` and `~axes.Axes.format_ydata` methods. The hard
	`244`	+coded format in `~axes.Axes.format_coord` is ``f'x={formtated_x}
	`245`	+y={formatted_y}'``.
	`246`	`+`
	`247`	`+To easily customize how the x and y values are formatted, you can set the`
	`248`	+`.axes.Axes.fmt_xdata` and `.axes.Axes.fmt_ydata` attributes on the
	`249`	+`~axes.Axes` instance. The values are expected to be functions that
	`250`	`+take a float and return a string. For example ::`
	`251`	`+`
	`252`	`+ fig, ax = plt.subplots()`
	`253`	`+ ax.set_ylim(-5, 5)`
	`254`	`+ ax.fmt_ydata = lambda v: f'{v:.3g}' if v > 0 else f'({abs(v):.3g})'`
	`255`	`+`
	`256`	`+will format negative y-values with parenthesis rather than a negative sign. If`
	`257`	+these attributes are set to `None`, then the `.Formatter.format_data_short`
	`258`	`+method on the major formatter of the respective axes will be used instead.`
	`259`	`+`
	`260`	`+`
`238`	`261`	`.. _other-shells:`
`239`	`262`
`240`	`263`	`Other Python prompts`

Lines changed: 14 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -561,6 +561,20 @@ class _AxesBase(martist.Artist):`
`561`	`561`
`562`	`562`	`_subclass_uses_cla=False`
`563`	`563`
	`564`	`+#: Callable to format the x-data in an interactive window.`
	`565`	`+#:`
	`566`	`+#: The expected signature is ::`
	`567`	`+#:`
	`568`	`+#: def fmt(val: float,/) -> str: ...`
	`569`	`+fmt_xdata=None`
	`570`	`+`
	`571`	`+#: Callable to format the y-data in an interactive window`
	`572`	`+#:`
	`573`	`+#: The expected signature is ::`
	`574`	`+#:`
	`575`	`+#: def fmt(val: float,/) -> str: ...`
	`576`	`+fmt_ydata=None`
	`577`	`+`
`564`	`578`	`@property`
`565`	`579`	`def_axis_map(self):`
`566`	`580`	"""A mapping of axis names, e.g. 'x', to `Axis` instances."""

Comments

(0)