polar.pyi 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197
  1. import matplotlib.axis as maxis
  2. import matplotlib.ticker as mticker
  3. import matplotlib.transforms as mtransforms
  4. from matplotlib.axes import Axes
  5. from matplotlib.lines import Line2D
  6. from matplotlib.text import Text
  7. import numpy as np
  8. from numpy.typing import ArrayLike
  9. from collections.abc import Sequence
  10. from typing import Any, ClassVar, Literal, overload
  11. class PolarTransform(mtransforms.Transform):
  12. input_dims: int
  13. output_dims: int
  14. def __init__(
  15. self,
  16. axis: PolarAxes | None = ...,
  17. use_rmin: bool = ...,
  18. *,
  19. apply_theta_transforms: bool = ...,
  20. scale_transform: mtransforms.Transform | None = ...,
  21. ) -> None: ...
  22. def inverted(self) -> InvertedPolarTransform: ...
  23. class PolarAffine(mtransforms.Affine2DBase):
  24. def __init__(
  25. self, scale_transform: mtransforms.Transform, limits: mtransforms.BboxBase
  26. ) -> None: ...
  27. class InvertedPolarTransform(mtransforms.Transform):
  28. input_dims: int
  29. output_dims: int
  30. def __init__(
  31. self,
  32. axis: PolarAxes | None = ...,
  33. use_rmin: bool = ...,
  34. *,
  35. apply_theta_transforms: bool = ...,
  36. ) -> None: ...
  37. def inverted(self) -> PolarTransform: ...
  38. class ThetaFormatter(mticker.Formatter): ...
  39. class _AxisWrapper:
  40. def __init__(self, axis: maxis.Axis) -> None: ...
  41. def get_view_interval(self) -> np.ndarray: ...
  42. def set_view_interval(self, vmin: float, vmax: float) -> None: ...
  43. def get_minpos(self) -> float: ...
  44. def get_data_interval(self) -> np.ndarray: ...
  45. def set_data_interval(self, vmin: float, vmax: float) -> None: ...
  46. def get_tick_space(self) -> int: ...
  47. class ThetaLocator(mticker.Locator):
  48. base: mticker.Locator
  49. axis: _AxisWrapper | None
  50. def __init__(self, base: mticker.Locator) -> None: ...
  51. class ThetaTick(maxis.XTick):
  52. def __init__(self, axes: PolarAxes, *args, **kwargs) -> None: ...
  53. class ThetaAxis(maxis.XAxis):
  54. axis_name: str
  55. class RadialLocator(mticker.Locator):
  56. base: mticker.Locator
  57. def __init__(self, base, axes: PolarAxes | None = ...) -> None: ...
  58. class RadialTick(maxis.YTick): ...
  59. class RadialAxis(maxis.YAxis):
  60. axis_name: str
  61. class _WedgeBbox(mtransforms.Bbox):
  62. def __init__(
  63. self,
  64. center: tuple[float, float],
  65. viewLim: mtransforms.Bbox,
  66. originLim: mtransforms.Bbox,
  67. **kwargs,
  68. ) -> None: ...
  69. class PolarAxes(Axes):
  70. PolarTransform: ClassVar[type] = PolarTransform
  71. PolarAffine: ClassVar[type] = PolarAffine
  72. InvertedPolarTransform: ClassVar[type] = InvertedPolarTransform
  73. ThetaFormatter: ClassVar[type] = ThetaFormatter
  74. RadialLocator: ClassVar[type] = RadialLocator
  75. ThetaLocator: ClassVar[type] = ThetaLocator
  76. name: str
  77. use_sticky_edges: bool
  78. def __init__(
  79. self,
  80. *args,
  81. theta_offset: float = ...,
  82. theta_direction: float = ...,
  83. rlabel_position: float = ...,
  84. **kwargs,
  85. ) -> None: ...
  86. def get_xaxis_transform(
  87. self, which: Literal["tick1", "tick2", "grid"] = ...
  88. ) -> mtransforms.Transform: ...
  89. def get_xaxis_text1_transform(
  90. self, pad: float
  91. ) -> tuple[
  92. mtransforms.Transform,
  93. Literal["center", "top", "bottom", "baseline", "center_baseline"],
  94. Literal["center", "left", "right"],
  95. ]: ...
  96. def get_xaxis_text2_transform(
  97. self, pad: float
  98. ) -> tuple[
  99. mtransforms.Transform,
  100. Literal["center", "top", "bottom", "baseline", "center_baseline"],
  101. Literal["center", "left", "right"],
  102. ]: ...
  103. def get_yaxis_transform(
  104. self, which: Literal["tick1", "tick2", "grid"] = ...
  105. ) -> mtransforms.Transform: ...
  106. def get_yaxis_text1_transform(
  107. self, pad: float
  108. ) -> tuple[
  109. mtransforms.Transform,
  110. Literal["center", "top", "bottom", "baseline", "center_baseline"],
  111. Literal["center", "left", "right"],
  112. ]: ...
  113. def get_yaxis_text2_transform(
  114. self, pad: float
  115. ) -> tuple[
  116. mtransforms.Transform,
  117. Literal["center", "top", "bottom", "baseline", "center_baseline"],
  118. Literal["center", "left", "right"],
  119. ]: ...
  120. def set_thetamax(self, thetamax: float) -> None: ...
  121. def get_thetamax(self) -> float: ...
  122. def set_thetamin(self, thetamin: float) -> None: ...
  123. def get_thetamin(self) -> float: ...
  124. @overload
  125. def set_thetalim(self, minval: float, maxval: float, /) -> tuple[float, float]: ...
  126. @overload
  127. def set_thetalim(self, *, thetamin: float, thetamax: float) -> tuple[float, float]: ...
  128. def set_theta_offset(self, offset: float) -> None: ...
  129. def get_theta_offset(self) -> float: ...
  130. def set_theta_zero_location(
  131. self,
  132. loc: Literal["N", "NW", "W", "SW", "S", "SE", "E", "NE"],
  133. offset: float = ...,
  134. ) -> None: ...
  135. def set_theta_direction(
  136. self,
  137. direction: Literal[-1, 1, "clockwise", "counterclockwise", "anticlockwise"],
  138. ) -> None: ...
  139. def get_theta_direction(self) -> Literal[-1, 1]: ...
  140. def set_rmax(self, rmax: float) -> None: ...
  141. def get_rmax(self) -> float: ...
  142. def set_rmin(self, rmin: float) -> None: ...
  143. def get_rmin(self) -> float: ...
  144. def set_rorigin(self, rorigin: float | None) -> None: ...
  145. def get_rorigin(self) -> float: ...
  146. def get_rsign(self) -> float: ...
  147. def set_rlim(
  148. self,
  149. bottom: float | tuple[float, float] | None = ...,
  150. top: float | None = ...,
  151. *,
  152. emit: bool = ...,
  153. auto: bool = ...,
  154. **kwargs,
  155. ) -> tuple[float, float]: ...
  156. def get_rlabel_position(self) -> float: ...
  157. def set_rlabel_position(self, value: float) -> None: ...
  158. def set_rscale(self, *args, **kwargs) -> None: ...
  159. def set_rticks(self, *args, **kwargs) -> None: ...
  160. def set_thetagrids(
  161. self,
  162. angles: ArrayLike,
  163. labels: Sequence[str | Text] | None = ...,
  164. fmt: str | None = ...,
  165. **kwargs,
  166. ) -> tuple[list[Line2D], list[Text]]: ...
  167. def set_rgrids(
  168. self,
  169. radii: ArrayLike,
  170. labels: Sequence[str | Text] | None = ...,
  171. angle: float | None = ...,
  172. fmt: str | None = ...,
  173. **kwargs,
  174. ) -> tuple[list[Line2D], list[Text]]: ...
  175. def format_coord(self, theta: float, r: float) -> str: ...
  176. def get_data_ratio(self) -> float: ...
  177. def can_zoom(self) -> bool: ...
  178. def can_pan(self) -> bool: ...
  179. def start_pan(self, x: float, y: float, button: int) -> None: ...
  180. def end_pan(self) -> None: ...
  181. def drag_pan(self, button: Any, key: Any, x: float, y: float) -> None: ...