mpl_toolkits.mplot3d.axes3d.Axes3D.set_xlim

Axes3D.set_xlim(left=None, right=None, *, emit=True, auto=False, view_margin=None, xmin=None, xmax=None)

Set the 3D x-axis view limits.

Parameters:

leftfloat, optional

The left xlim in data coordinates. Passing None leaves the limit unchanged.

The left and right xlims may also be passed as the tuple (left, right) as the first positional argument (or as the left keyword argument).

rightfloat, optional

The right xlim in data coordinates. Passing None leaves the limit unchanged.

emitbool, default: True

Whether to notify observers of limit change.

autobool or None, default: False

Whether to turn on autoscaling of the x-axis. True turns on, False turns off, None leaves unchanged.

view_marginfloat, optional

The additional margin to apply to the limits.

xmin, xmaxfloat, optional

They are equivalent to left and right respectively, and it is an error to pass both xmin and left or xmax and right.

Returns:

left, right(float, float)

The new x-axis limits in data coordinates.

See also

get_xlim

set_xbound, get_xbound

invert_xaxis, xaxis_inverted

Notes

The left value may be greater than the right value, in which case the x-axis values will decrease from left to right.

Examples

>>> set_xlim(left, right)
>>> set_xlim((left, right))
>>> left, right = set_xlim(left, right)

One limit may be left unchanged.

>>> set_xlim(right=right_lim)

Limits may be passed in reverse order to flip the direction of the x-axis. For example, suppose x represents depth of the ocean in m. The x-axis limits might be set like the following so 5000 m depth is at the left of the plot and the surface, 0 m, is at the right.

>>> set_xlim(5000, 0)