Set the 3D z-axis view limits. Parameters ---------- bottom : float, optional The bottom zlim in data coordinates. Passing *None* leaves the limit unchanged. The bottom and top zlims may also be passed as the tuple (*
(self, bottom=None, top=None, *, emit=True, auto=False,
view_margin=None, zmin=None, zmax=None)
| 1020 | minpos=self.xy_dataLim.minposy) |
| 1021 | |
| 1022 | def set_zlim(self, bottom=None, top=None, *, emit=True, auto=False, |
| 1023 | view_margin=None, zmin=None, zmax=None): |
| 1024 | """ |
| 1025 | Set the 3D z-axis view limits. |
| 1026 | |
| 1027 | Parameters |
| 1028 | ---------- |
| 1029 | bottom : float, optional |
| 1030 | The bottom zlim in data coordinates. Passing *None* leaves the |
| 1031 | limit unchanged. |
| 1032 | |
| 1033 | The bottom and top zlims may also be passed as the tuple |
| 1034 | (*bottom*, *top*) as the first positional argument (or as |
| 1035 | the *bottom* keyword argument). |
| 1036 | |
| 1037 | .. ACCEPTS: (bottom: float, top: float) |
| 1038 | |
| 1039 | top : float, optional |
| 1040 | The top zlim in data coordinates. Passing *None* leaves the |
| 1041 | limit unchanged. |
| 1042 | |
| 1043 | emit : bool, default: True |
| 1044 | Whether to notify observers of limit change. |
| 1045 | |
| 1046 | auto : bool or None, default: False |
| 1047 | Whether to turn on autoscaling of the z-axis. *True* turns on, |
| 1048 | *False* turns off, *None* leaves unchanged. |
| 1049 | |
| 1050 | view_margin : float, optional |
| 1051 | The additional margin to apply to the limits. |
| 1052 | |
| 1053 | zmin, zmax : float, optional |
| 1054 | They are equivalent to bottom and top respectively, and it is an |
| 1055 | error to pass both *zmin* and *bottom* or *zmax* and *top*. |
| 1056 | |
| 1057 | Returns |
| 1058 | ------- |
| 1059 | bottom, top : (float, float) |
| 1060 | The new z-axis limits in data coordinates. |
| 1061 | |
| 1062 | See Also |
| 1063 | -------- |
| 1064 | get_zlim |
| 1065 | set_zbound, get_zbound |
| 1066 | invert_zaxis, zaxis_inverted |
| 1067 | |
| 1068 | Notes |
| 1069 | ----- |
| 1070 | The *bottom* value may be greater than the *top* value, in which |
| 1071 | case the z-axis values will decrease from *bottom* to *top*. |
| 1072 | |
| 1073 | Examples |
| 1074 | -------- |
| 1075 | >>> set_zlim(bottom, top) |
| 1076 | >>> set_zlim((bottom, top)) |
| 1077 | >>> bottom, top = set_zlim(bottom, top) |
| 1078 | |
| 1079 | One limit may be left unchanged. |