Turn the axes box on or off on the current axes. Parameters ---------- on : bool or None The new `~matplotlib.axes.Axes` box state. If ``None``, toggle the state. See Also -------- :meth:`matplotlib.axes.Axes.set_frame_on` :meth:`matplotlib.axes.Axe
(on=None)
| 1383 | |
| 1384 | |
| 1385 | def box(on=None): |
| 1386 | """ |
| 1387 | Turn the axes box on or off on the current axes. |
| 1388 | |
| 1389 | Parameters |
| 1390 | ---------- |
| 1391 | on : bool or None |
| 1392 | The new `~matplotlib.axes.Axes` box state. If ``None``, toggle |
| 1393 | the state. |
| 1394 | |
| 1395 | See Also |
| 1396 | -------- |
| 1397 | :meth:`matplotlib.axes.Axes.set_frame_on` |
| 1398 | :meth:`matplotlib.axes.Axes.get_frame_on` |
| 1399 | """ |
| 1400 | ax = gca() |
| 1401 | if on is None: |
| 1402 | on = not ax.get_frame_on() |
| 1403 | on = _string_to_bool(on) |
| 1404 | ax.set_frame_on(on) |
| 1405 | |
| 1406 | ## Axis ## |
| 1407 |
nothing calls this directly
no test coverage detected