128 lines
3.4 KiB
Python
128 lines
3.4 KiB
Python
# --- 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 Contour(_BaseTraceHierarchyType):
|
|
_parent_path_str = "mesh3d"
|
|
_path_str = "mesh3d.contour"
|
|
_valid_props = {"color", "show", "width"}
|
|
|
|
@property
|
|
def color(self):
|
|
"""
|
|
Sets the color of the contour lines.
|
|
|
|
The 'color' property is a color and may be specified as:
|
|
- A hex string (e.g. '#ff0000')
|
|
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
|
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
|
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
|
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["color"]
|
|
|
|
@color.setter
|
|
def color(self, val):
|
|
self["color"] = val
|
|
|
|
@property
|
|
def show(self):
|
|
"""
|
|
Sets whether or not dynamic contours are shown on hover
|
|
|
|
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
|
|
|
|
@property
|
|
def width(self):
|
|
"""
|
|
Sets the width of the contour lines.
|
|
|
|
The 'width' property is a number and may be specified as:
|
|
- An int or float in the interval [1, 16]
|
|
|
|
Returns
|
|
-------
|
|
int|float
|
|
"""
|
|
return self["width"]
|
|
|
|
@width.setter
|
|
def width(self, val):
|
|
self["width"] = val
|
|
|
|
@property
|
|
def _prop_descriptions(self):
|
|
return """\
|
|
color
|
|
Sets the color of the contour lines.
|
|
show
|
|
Sets whether or not dynamic contours are shown on hover
|
|
width
|
|
Sets the width of the contour lines.
|
|
"""
|
|
|
|
def __init__(self, arg=None, color=None, show=None, width=None, **kwargs):
|
|
"""
|
|
Construct a new Contour object
|
|
|
|
Parameters
|
|
----------
|
|
arg
|
|
dict of properties compatible with this constructor or
|
|
an instance of
|
|
:class:`plotly.graph_objs.mesh3d.Contour`
|
|
color
|
|
Sets the color of the contour lines.
|
|
show
|
|
Sets whether or not dynamic contours are shown on hover
|
|
width
|
|
Sets the width of the contour lines.
|
|
|
|
Returns
|
|
-------
|
|
Contour
|
|
"""
|
|
super().__init__("contour")
|
|
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.mesh3d.Contour
|
|
constructor must be a dict or
|
|
an instance of :class:`plotly.graph_objs.mesh3d.Contour`""")
|
|
|
|
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
|
self._validate = kwargs.pop("_validate", True)
|
|
|
|
self._set_property("color", arg, color)
|
|
self._set_property("show", arg, show)
|
|
self._set_property("width", arg, width)
|
|
self._process_kwargs(**dict(arg, **kwargs))
|
|
self._skip_invalid = False
|