first commit

.venv/Lib/site-packages/plotly/graph_objs/volume/slices/__init__.py

@@ -0,0 +1,13 @@
+import sys
+from typing import TYPE_CHECKING
+
+if sys.version_info < (3, 7) or TYPE_CHECKING:
+    from ._x import X
+    from ._y import Y
+    from ._z import Z
+else:
+    from _plotly_utils.importers import relative_import
+
+    __all__, __getattr__, __dir__ = relative_import(
+        __name__, [], ["._x.X", "._y.Y", "._z.Z"]
+    )

.venv/Lib/site-packages/plotly/graph_objs/volume/slices/_x.py

@@ -0,0 +1,214 @@
+from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
+import copy as _copy
+
+
+class X(_BaseTraceHierarchyType):
+
+    # class properties
+    # --------------------
+    _parent_path_str = "volume.slices"
+    _path_str = "volume.slices.x"
+    _valid_props = {"fill", "locations", "locationssrc", "show"}
+
+    # fill
+    # ----
+    @property
+    def fill(self):
+        """
+        Sets the fill ratio of the `slices`. The default fill value of
+        the `slices` is 1 meaning that they are entirely shaded. On the
+        other hand Applying a `fill` ratio less than one would allow
+        the creation of openings parallel to the edges.
+
+        The 'fill' property is a number and may be specified as:
+          - An int or float in the interval [0, 1]
+
+        Returns
+        -------
+        int|float
+        """
+        return self["fill"]
+
+    @fill.setter
+    def fill(self, val):
+        self["fill"] = val
+
+    # locations
+    # ---------
+    @property
+    def locations(self):
+        """
+        Specifies the location(s) of slices on the axis. When not
+        specified slices would be created for all points of the axis x
+        except start and end.
+
+        The 'locations' property is an array that may be specified as a tuple,
+        list, numpy array, or pandas Series
+
+        Returns
+        -------
+        numpy.ndarray
+        """
+        return self["locations"]
+
+    @locations.setter
+    def locations(self, val):
+        self["locations"] = val
+
+    # locationssrc
+    # ------------
+    @property
+    def locationssrc(self):
+        """
+        Sets the source reference on Chart Studio Cloud for
+        `locations`.
+
+        The 'locationssrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
+
+        Returns
+        -------
+        str
+        """
+        return self["locationssrc"]
+
+    @locationssrc.setter
+    def locationssrc(self, val):
+        self["locationssrc"] = val
+
+    # show
+    # ----
+    @property
+    def show(self):
+        """
+        Determines whether or not slice planes about the x dimension
+        are drawn.
+
+        The 'show' property must be specified as a bool
+        (either True, or False)
+
+        Returns
+        -------
+        bool
+        """
+        return self["show"]
+
+    @show.setter
+    def show(self, val):
+        self["show"] = val
+
+    # Self properties description
+    # ---------------------------
+    @property
+    def _prop_descriptions(self):
+        return """\
+        fill
+            Sets the fill ratio of the `slices`. The default fill
+            value of the `slices` is 1 meaning that they are
+            entirely shaded. On the other hand Applying a `fill`
+            ratio less than one would allow the creation of
+            openings parallel to the edges.
+        locations
+            Specifies the location(s) of slices on the axis. When
+            not specified slices would be created for all points of
+            the axis x except start and end.
+        locationssrc
+            Sets the source reference on Chart Studio Cloud for
+            `locations`.
+        show
+            Determines whether or not slice planes about the x
+            dimension are drawn.
+        """
+
+    def __init__(
+        self,
+        arg=None,
+        fill=None,
+        locations=None,
+        locationssrc=None,
+        show=None,
+        **kwargs,
+    ):
+        """
+        Construct a new X object
+
+        Parameters
+        ----------
+        arg
+            dict of properties compatible with this constructor or
+            an instance of
+            :class:`plotly.graph_objs.volume.slices.X`
+        fill
+            Sets the fill ratio of the `slices`. The default fill
+            value of the `slices` is 1 meaning that they are
+            entirely shaded. On the other hand Applying a `fill`
+            ratio less than one would allow the creation of
+            openings parallel to the edges.
+        locations
+            Specifies the location(s) of slices on the axis. When
+            not specified slices would be created for all points of
+            the axis x except start and end.
+        locationssrc
+            Sets the source reference on Chart Studio Cloud for
+            `locations`.
+        show
+            Determines whether or not slice planes about the x
+            dimension are drawn.
+
+        Returns
+        -------
+        X
+        """
+        super(X, self).__init__("x")
+
+        if "_parent" in kwargs:
+            self._parent = kwargs["_parent"]
+            return
+
+        # Validate arg
+        # ------------
+        if arg is None:
+            arg = {}
+        elif isinstance(arg, self.__class__):
+            arg = arg.to_plotly_json()
+        elif isinstance(arg, dict):
+            arg = _copy.copy(arg)
+        else:
+            raise ValueError(
+                """\
+The first argument to the plotly.graph_objs.volume.slices.X
+constructor must be a dict or
+an instance of :class:`plotly.graph_objs.volume.slices.X`"""
+            )
+
+        # Handle skip_invalid
+        # -------------------
+        self._skip_invalid = kwargs.pop("skip_invalid", False)
+        self._validate = kwargs.pop("_validate", True)
+
+        # Populate data dict with properties
+        # ----------------------------------
+        _v = arg.pop("fill", None)
+        _v = fill if fill is not None else _v
+        if _v is not None:
+            self["fill"] = _v
+        _v = arg.pop("locations", None)
+        _v = locations if locations is not None else _v
+        if _v is not None:
+            self["locations"] = _v
+        _v = arg.pop("locationssrc", None)
+        _v = locationssrc if locationssrc is not None else _v
+        if _v is not None:
+            self["locationssrc"] = _v
+        _v = arg.pop("show", None)
+        _v = show if show is not None else _v
+        if _v is not None:
+            self["show"] = _v
+
+        # Process unknown kwargs
+        # ----------------------
+        self._process_kwargs(**dict(arg, **kwargs))
+
+        # Reset skip_invalid
+        # ------------------
+        self._skip_invalid = False

.venv/Lib/site-packages/plotly/graph_objs/volume/slices/_y.py

@@ -0,0 +1,214 @@
+from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
+import copy as _copy
+
+
+class Y(_BaseTraceHierarchyType):
+
+    # class properties
+    # --------------------
+    _parent_path_str = "volume.slices"
+    _path_str = "volume.slices.y"
+    _valid_props = {"fill", "locations", "locationssrc", "show"}
+
+    # fill
+    # ----
+    @property
+    def fill(self):
+        """
+        Sets the fill ratio of the `slices`. The default fill value of
+        the `slices` is 1 meaning that they are entirely shaded. On the
+        other hand Applying a `fill` ratio less than one would allow
+        the creation of openings parallel to the edges.
+
+        The 'fill' property is a number and may be specified as:
+          - An int or float in the interval [0, 1]
+
+        Returns
+        -------
+        int|float
+        """
+        return self["fill"]
+
+    @fill.setter
+    def fill(self, val):
+        self["fill"] = val
+
+    # locations
+    # ---------
+    @property
+    def locations(self):
+        """
+        Specifies the location(s) of slices on the axis. When not
+        specified slices would be created for all points of the axis y
+        except start and end.
+
+        The 'locations' property is an array that may be specified as a tuple,
+        list, numpy array, or pandas Series
+
+        Returns
+        -------
+        numpy.ndarray
+        """
+        return self["locations"]
+
+    @locations.setter
+    def locations(self, val):
+        self["locations"] = val
+
+    # locationssrc
+    # ------------
+    @property
+    def locationssrc(self):
+        """
+        Sets the source reference on Chart Studio Cloud for
+        `locations`.
+
+        The 'locationssrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
+
+        Returns
+        -------
+        str
+        """
+        return self["locationssrc"]
+
+    @locationssrc.setter
+    def locationssrc(self, val):
+        self["locationssrc"] = val
+
+    # show
+    # ----
+    @property
+    def show(self):
+        """
+        Determines whether or not slice planes about the y dimension
+        are drawn.
+
+        The 'show' property must be specified as a bool
+        (either True, or False)
+
+        Returns
+        -------
+        bool
+        """
+        return self["show"]
+
+    @show.setter
+    def show(self, val):
+        self["show"] = val
+
+    # Self properties description
+    # ---------------------------
+    @property
+    def _prop_descriptions(self):
+        return """\
+        fill
+            Sets the fill ratio of the `slices`. The default fill
+            value of the `slices` is 1 meaning that they are
+            entirely shaded. On the other hand Applying a `fill`
+            ratio less than one would allow the creation of
+            openings parallel to the edges.
+        locations
+            Specifies the location(s) of slices on the axis. When
+            not specified slices would be created for all points of
+            the axis y except start and end.
+        locationssrc
+            Sets the source reference on Chart Studio Cloud for
+            `locations`.
+        show
+            Determines whether or not slice planes about the y
+            dimension are drawn.
+        """
+
+    def __init__(
+        self,
+        arg=None,
+        fill=None,
+        locations=None,
+        locationssrc=None,
+        show=None,
+        **kwargs,
+    ):
+        """
+        Construct a new Y object
+
+        Parameters
+        ----------
+        arg
+            dict of properties compatible with this constructor or
+            an instance of
+            :class:`plotly.graph_objs.volume.slices.Y`
+        fill
+            Sets the fill ratio of the `slices`. The default fill
+            value of the `slices` is 1 meaning that they are
+            entirely shaded. On the other hand Applying a `fill`
+            ratio less than one would allow the creation of
+            openings parallel to the edges.
+        locations
+            Specifies the location(s) of slices on the axis. When
+            not specified slices would be created for all points of
+            the axis y except start and end.
+        locationssrc
+            Sets the source reference on Chart Studio Cloud for
+            `locations`.
+        show
+            Determines whether or not slice planes about the y
+            dimension are drawn.
+
+        Returns
+        -------
+        Y
+        """
+        super(Y, self).__init__("y")
+
+        if "_parent" in kwargs:
+            self._parent = kwargs["_parent"]
+            return
+
+        # Validate arg
+        # ------------
+        if arg is None:
+            arg = {}
+        elif isinstance(arg, self.__class__):
+            arg = arg.to_plotly_json()
+        elif isinstance(arg, dict):
+            arg = _copy.copy(arg)
+        else:
+            raise ValueError(
+                """\
+The first argument to the plotly.graph_objs.volume.slices.Y
+constructor must be a dict or
+an instance of :class:`plotly.graph_objs.volume.slices.Y`"""
+            )
+
+        # Handle skip_invalid
+        # -------------------
+        self._skip_invalid = kwargs.pop("skip_invalid", False)
+        self._validate = kwargs.pop("_validate", True)
+
+        # Populate data dict with properties
+        # ----------------------------------
+        _v = arg.pop("fill", None)
+        _v = fill if fill is not None else _v
+        if _v is not None:
+            self["fill"] = _v
+        _v = arg.pop("locations", None)
+        _v = locations if locations is not None else _v
+        if _v is not None:
+            self["locations"] = _v
+        _v = arg.pop("locationssrc", None)
+        _v = locationssrc if locationssrc is not None else _v
+        if _v is not None:
+            self["locationssrc"] = _v
+        _v = arg.pop("show", None)
+        _v = show if show is not None else _v
+        if _v is not None:
+            self["show"] = _v
+
+        # Process unknown kwargs
+        # ----------------------
+        self._process_kwargs(**dict(arg, **kwargs))
+
+        # Reset skip_invalid
+        # ------------------
+        self._skip_invalid = False

.venv/Lib/site-packages/plotly/graph_objs/volume/slices/_z.py

@@ -0,0 +1,214 @@
+from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
+import copy as _copy
+
+
+class Z(_BaseTraceHierarchyType):
+
+    # class properties
+    # --------------------
+    _parent_path_str = "volume.slices"
+    _path_str = "volume.slices.z"
+    _valid_props = {"fill", "locations", "locationssrc", "show"}
+
+    # fill
+    # ----
+    @property
+    def fill(self):
+        """
+        Sets the fill ratio of the `slices`. The default fill value of
+        the `slices` is 1 meaning that they are entirely shaded. On the
+        other hand Applying a `fill` ratio less than one would allow
+        the creation of openings parallel to the edges.
+
+        The 'fill' property is a number and may be specified as:
+          - An int or float in the interval [0, 1]
+
+        Returns
+        -------
+        int|float
+        """
+        return self["fill"]
+
+    @fill.setter
+    def fill(self, val):
+        self["fill"] = val
+
+    # locations
+    # ---------
+    @property
+    def locations(self):
+        """
+        Specifies the location(s) of slices on the axis. When not
+        specified slices would be created for all points of the axis z
+        except start and end.
+
+        The 'locations' property is an array that may be specified as a tuple,
+        list, numpy array, or pandas Series
+
+        Returns
+        -------
+        numpy.ndarray
+        """
+        return self["locations"]
+
+    @locations.setter
+    def locations(self, val):
+        self["locations"] = val
+
+    # locationssrc
+    # ------------
+    @property
+    def locationssrc(self):
+        """
+        Sets the source reference on Chart Studio Cloud for
+        `locations`.
+
+        The 'locationssrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
+
+        Returns
+        -------
+        str
+        """
+        return self["locationssrc"]
+
+    @locationssrc.setter
+    def locationssrc(self, val):
+        self["locationssrc"] = val
+
+    # show
+    # ----
+    @property
+    def show(self):
+        """
+        Determines whether or not slice planes about the z dimension
+        are drawn.
+
+        The 'show' property must be specified as a bool
+        (either True, or False)
+
+        Returns
+        -------
+        bool
+        """
+        return self["show"]
+
+    @show.setter
+    def show(self, val):
+        self["show"] = val
+
+    # Self properties description
+    # ---------------------------
+    @property
+    def _prop_descriptions(self):
+        return """\
+        fill
+            Sets the fill ratio of the `slices`. The default fill
+            value of the `slices` is 1 meaning that they are
+            entirely shaded. On the other hand Applying a `fill`
+            ratio less than one would allow the creation of
+            openings parallel to the edges.
+        locations
+            Specifies the location(s) of slices on the axis. When
+            not specified slices would be created for all points of
+            the axis z except start and end.
+        locationssrc
+            Sets the source reference on Chart Studio Cloud for
+            `locations`.
+        show
+            Determines whether or not slice planes about the z
+            dimension are drawn.
+        """
+
+    def __init__(
+        self,
+        arg=None,
+        fill=None,
+        locations=None,
+        locationssrc=None,
+        show=None,
+        **kwargs,
+    ):
+        """
+        Construct a new Z object
+
+        Parameters
+        ----------
+        arg
+            dict of properties compatible with this constructor or
+            an instance of
+            :class:`plotly.graph_objs.volume.slices.Z`
+        fill
+            Sets the fill ratio of the `slices`. The default fill
+            value of the `slices` is 1 meaning that they are
+            entirely shaded. On the other hand Applying a `fill`
+            ratio less than one would allow the creation of
+            openings parallel to the edges.
+        locations
+            Specifies the location(s) of slices on the axis. When
+            not specified slices would be created for all points of
+            the axis z except start and end.
+        locationssrc
+            Sets the source reference on Chart Studio Cloud for
+            `locations`.
+        show
+            Determines whether or not slice planes about the z
+            dimension are drawn.
+
+        Returns
+        -------
+        Z
+        """
+        super(Z, self).__init__("z")
+
+        if "_parent" in kwargs:
+            self._parent = kwargs["_parent"]
+            return
+
+        # Validate arg
+        # ------------
+        if arg is None:
+            arg = {}
+        elif isinstance(arg, self.__class__):
+            arg = arg.to_plotly_json()
+        elif isinstance(arg, dict):
+            arg = _copy.copy(arg)
+        else:
+            raise ValueError(
+                """\
+The first argument to the plotly.graph_objs.volume.slices.Z
+constructor must be a dict or
+an instance of :class:`plotly.graph_objs.volume.slices.Z`"""
+            )
+
+        # Handle skip_invalid
+        # -------------------
+        self._skip_invalid = kwargs.pop("skip_invalid", False)
+        self._validate = kwargs.pop("_validate", True)
+
+        # Populate data dict with properties
+        # ----------------------------------
+        _v = arg.pop("fill", None)
+        _v = fill if fill is not None else _v
+        if _v is not None:
+            self["fill"] = _v
+        _v = arg.pop("locations", None)
+        _v = locations if locations is not None else _v
+        if _v is not None:
+            self["locations"] = _v
+        _v = arg.pop("locationssrc", None)
+        _v = locationssrc if locationssrc is not None else _v
+        if _v is not None:
+            self["locationssrc"] = _v
+        _v = arg.pop("show", None)
+        _v = show if show is not None else _v
+        if _v is not None:
+            self["show"] = _v
+
+        # Process unknown kwargs
+        # ----------------------
+        self._process_kwargs(**dict(arg, **kwargs))
+
+        # Reset skip_invalid
+        # ------------------
+        self._skip_invalid = False