done

lib/python3.11/site-packages/plotly/graph_objs/ohlc/_line.py

@@ -0,0 +1,123 @@
+#                   --- THIS FILE IS AUTO-GENERATED ---
+# Modifications will be overwitten the next time code generation run.
+
+from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
+import copy as _copy
+
+
+class Line(_BaseTraceHierarchyType):
+    _parent_path_str = "ohlc"
+    _path_str = "ohlc.line"
+    _valid_props = {"dash", "width"}
+
+    @property
+    def dash(self):
+        """
+        Sets the dash style of lines. Set to a dash type string
+        ("solid", "dot", "dash", "longdash", "dashdot", or
+        "longdashdot") or a dash length list in px (eg
+        "5px,10px,2px,2px"). Note that this style setting can also be
+        set per direction via `increasing.line.dash` and
+        `decreasing.line.dash`.
+
+        The 'dash' property is an enumeration that may be specified as:
+          - One of the following dash styles:
+                ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot']
+          - A string containing a dash length list in pixels or percentages
+                (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.)
+
+        Returns
+        -------
+        str
+        """
+        return self["dash"]
+
+    @dash.setter
+    def dash(self, val):
+        self["dash"] = val
+
+    @property
+    def width(self):
+        """
+        [object Object] Note that this style setting can also be set
+        per direction via `increasing.line.width` and
+        `decreasing.line.width`.
+
+        The 'width' property is a number and may be specified as:
+          - An int or float in the interval [0, inf]
+
+        Returns
+        -------
+        int|float
+        """
+        return self["width"]
+
+    @width.setter
+    def width(self, val):
+        self["width"] = val
+
+    @property
+    def _prop_descriptions(self):
+        return """\
+        dash
+            Sets the dash style of lines. Set to a dash type string
+            ("solid", "dot", "dash", "longdash", "dashdot", or
+            "longdashdot") or a dash length list in px (eg
+            "5px,10px,2px,2px"). Note that this style setting can
+            also be set per direction via `increasing.line.dash`
+            and `decreasing.line.dash`.
+        width
+            [object Object] Note that this style setting can also
+            be set per direction via `increasing.line.width` and
+            `decreasing.line.width`.
+        """
+
+    def __init__(self, arg=None, dash=None, width=None, **kwargs):
+        """
+        Construct a new Line object
+
+        Parameters
+        ----------
+        arg
+            dict of properties compatible with this constructor or
+            an instance of :class:`plotly.graph_objs.ohlc.Line`
+        dash
+            Sets the dash style of lines. Set to a dash type string
+            ("solid", "dot", "dash", "longdash", "dashdot", or
+            "longdashdot") or a dash length list in px (eg
+            "5px,10px,2px,2px"). Note that this style setting can
+            also be set per direction via `increasing.line.dash`
+            and `decreasing.line.dash`.
+        width
+            [object Object] Note that this style setting can also
+            be set per direction via `increasing.line.width` and
+            `decreasing.line.width`.
+
+        Returns
+        -------
+        Line
+        """
+        super().__init__("line")
+        if "_parent" in kwargs:
+            self._parent = kwargs["_parent"]
+            return
+
+        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.ohlc.Line
+constructor must be a dict or
+an instance of :class:`plotly.graph_objs.ohlc.Line`""")
+
+        self._skip_invalid = kwargs.pop("skip_invalid", False)
+        self._validate = kwargs.pop("_validate", True)
+
+        self._set_property("dash", arg, dash)
+        self._set_property("width", arg, width)
+        self._process_kwargs(**dict(arg, **kwargs))
+        self._skip_invalid = False