|
136 | 136 | #
|
137 | 137 | # The 1D :class:`~ultraplot.axes.PlotAxes` commands recognize `pandas`_
|
138 | 138 | # and `xarray`_ data structures. If you omit dependent variable coordinates,
|
139 |
| -# the commands try to infer them from the `pandas.Series`, `pandas.DataFrame`, |
140 |
| -# or `xarray.DataArray`. If you did not explicitly set the *x* or *y* axis label |
| 139 | +# the commands try to infer them from the :class:`pandas.Series`, :class:`pandas.DataFrame`, |
| 140 | +# or :class:`xarray.DataArray`. If you did not explicitly set the *x* or *y* axis label |
141 | 141 | # or :ref:`legend or colorbar <ug_guides_loc>` label(s), the commands
|
142 |
| -# try to retrieve them from the `pandas.DataFrame` or `xarray.DataArray`. |
143 |
| -# The commands also recognize `pint.Quantity` structures and apply |
| 142 | +# try to retrieve them from the :class:`pandas.DataFrame` or :class:`xarray.DataArray`. |
| 143 | +# The commands also recognize :class:`pint.Quantity` structures and apply |
144 | 144 | # unit string labels with formatting specified by :rc:`unitformat`.
|
145 | 145 | #
|
146 | 146 | # These features restore some of the convenience you get with the builtin
|
|
151 | 151 | #
|
152 | 152 | # .. note::
|
153 | 153 | #
|
154 |
| -# For every plotting command, you can pass a `~xarray.Dataset`, :class:`~pandas.DataFrame`, |
| 154 | +# For every plotting command, you can pass a :class:`~xarray.Dataset`, :class:`~pandas.DataFrame`, |
155 | 155 | # or `dict` to the `data` keyword with strings as data arguments instead of arrays
|
156 | 156 | # -- just like matplotlib. For example, ``ax.plot('y', data=dataset)`` and
|
157 | 157 | # ``ax.plot(y='y', data=dataset)`` are translated to ``ax.plot(dataset['y'])``.
|
158 | 158 | # This is the preferred input style for most `seaborn`_ plotting commands.
|
159 |
| -# Also, if you pass a `pint.Quantity` or :class:`~xarray.DataArray` |
160 |
| -# containing a `pint.Quantity`, UltraPlot will automatically call |
161 |
| -# `~pint.UnitRegistry.setup_matplotlib` so that the axes become unit-aware. |
| 159 | +# Also, if you pass a :class:`pint.Quantity` or :class:`~xarray.DataArray` |
| 160 | +# containing a :class:`pint.Quantity`, UltraPlot will automatically call |
| 161 | +# :func:`~pint.UnitRegistry.setup_matplotlib` so that the axes become unit-aware. |
162 | 162 |
|
163 | 163 | # %%
|
164 | 164 | import xarray as xr
|
|
354 | 354 | # has the area :rcraw:`lines.markersize` squared. These minimum and maximum marker
|
355 | 355 | # sizes can also be specified manually with the `smin` and `smax` keywords,
|
356 | 356 | # analogous to `vmin` and `vmax` used to scale the color array `c`. This feature
|
357 |
| -# can be disabled by passing ``absolute_size=True`` to :func:`~ultraplot.axes.Axes.scatter` |
358 |
| -# or :func:`~ultraplot.axes.Axes.scatterx`. This is done automatically when `seaborn`_ |
359 |
| -# calls :func:`~ultraplot.axes.Axes.scatter` internally. |
| 357 | +# can be disabled by passing ``absolute_size=True`` to :func:`~ultraplot.axes.PlotAxes.scatter` |
| 358 | +# or :func:`~ultraplot.axes.PlotAxes.scatterx`. This is done automatically when `seaborn`_ |
| 359 | +# calls :func:`~ultraplot.axes.PlotAxes.scatter` internally. |
360 | 360 |
|
361 | 361 | # %%
|
362 | 362 | import ultraplot as uplt
|
|
513 | 513 | # while UltraPlot bar widths are expressed in step size-relative units by
|
514 | 514 | # default. For example, ``width=1`` with a dependent coordinate step
|
515 | 515 | # size of ``2`` fills 100% of the space between each bar rather than 50%. This
|
516 |
| -# can be disabled by passing ``absolute_width=True`` to :func:`~ultraplot.axes.Axes.bar` |
517 |
| -# or :func:`~ultraplot.axes.Axes.barh`. This is done automatically when `seaborn`_ calls |
518 |
| -# :func:`~ultraplot.axes.Axes.bar` or :func:`~ultraplot.axes.Axes.barh` internally. |
| 516 | +# can be disabled by passing ``absolute_width=True`` to :func:`~ultraplot.axes.PlotAxes.bar` |
| 517 | +# or :func:`~ultraplot.axes.PlotAxes.barh`. This is done automatically when `seaborn`_ calls |
| 518 | +# :func:`~ultraplot.axes.PlotAxes.bar` or :func:`~ultraplot.axes.PlotAxes.barh` internally. |
519 | 519 |
|
520 | 520 | # %%
|
521 | 521 | import ultraplot as uplt
|
|
0 commit comments