221 lines
6.1 KiB
Python
221 lines
6.1 KiB
Python
# --- THIS FILE IS AUTO-GENERATED ---
|
|
# Modifications will be overwitten the next time code generation run.
|
|
|
|
from plotly.basedatatypes import BaseFrameHierarchyType as _BaseFrameHierarchyType
|
|
import copy as _copy
|
|
|
|
|
|
class Frame(_BaseFrameHierarchyType):
|
|
_parent_path_str = ""
|
|
_path_str = "frame"
|
|
_valid_props = {"baseframe", "data", "group", "layout", "name", "traces"}
|
|
|
|
@property
|
|
def baseframe(self):
|
|
"""
|
|
The name of the frame into which this frame's properties are
|
|
merged before applying. This is used to unify properties and
|
|
avoid needing to specify the same values for the same
|
|
properties in multiple frames.
|
|
|
|
The 'baseframe' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["baseframe"]
|
|
|
|
@baseframe.setter
|
|
def baseframe(self, val):
|
|
self["baseframe"] = val
|
|
|
|
@property
|
|
def data(self):
|
|
"""
|
|
A list of traces this frame modifies. The format is identical
|
|
to the normal trace definition.
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["data"]
|
|
|
|
@data.setter
|
|
def data(self, val):
|
|
self["data"] = val
|
|
|
|
@property
|
|
def group(self):
|
|
"""
|
|
An identifier that specifies the group to which the frame
|
|
belongs, used by animate to select a subset of frames.
|
|
|
|
The 'group' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["group"]
|
|
|
|
@group.setter
|
|
def group(self, val):
|
|
self["group"] = val
|
|
|
|
@property
|
|
def layout(self):
|
|
"""
|
|
Layout properties which this frame modifies. The format is
|
|
identical to the normal layout definition.
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["layout"]
|
|
|
|
@layout.setter
|
|
def layout(self, val):
|
|
self["layout"] = val
|
|
|
|
@property
|
|
def name(self):
|
|
"""
|
|
A label by which to identify the frame
|
|
|
|
The 'name' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["name"]
|
|
|
|
@name.setter
|
|
def name(self, val):
|
|
self["name"] = val
|
|
|
|
@property
|
|
def traces(self):
|
|
"""
|
|
A list of trace indices that identify the respective traces in
|
|
the data attribute
|
|
|
|
The 'traces' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["traces"]
|
|
|
|
@traces.setter
|
|
def traces(self, val):
|
|
self["traces"] = val
|
|
|
|
@property
|
|
def _prop_descriptions(self):
|
|
return """\
|
|
baseframe
|
|
The name of the frame into which this frame's
|
|
properties are merged before applying. This is used to
|
|
unify properties and avoid needing to specify the same
|
|
values for the same properties in multiple frames.
|
|
data
|
|
A list of traces this frame modifies. The format is
|
|
identical to the normal trace definition.
|
|
group
|
|
An identifier that specifies the group to which the
|
|
frame belongs, used by animate to select a subset of
|
|
frames.
|
|
layout
|
|
Layout properties which this frame modifies. The format
|
|
is identical to the normal layout definition.
|
|
name
|
|
A label by which to identify the frame
|
|
traces
|
|
A list of trace indices that identify the respective
|
|
traces in the data attribute
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
arg=None,
|
|
baseframe=None,
|
|
data=None,
|
|
group=None,
|
|
layout=None,
|
|
name=None,
|
|
traces=None,
|
|
**kwargs,
|
|
):
|
|
"""
|
|
Construct a new Frame object
|
|
|
|
Parameters
|
|
----------
|
|
arg
|
|
dict of properties compatible with this constructor or
|
|
an instance of :class:`plotly.graph_objs.Frame`
|
|
baseframe
|
|
The name of the frame into which this frame's
|
|
properties are merged before applying. This is used to
|
|
unify properties and avoid needing to specify the same
|
|
values for the same properties in multiple frames.
|
|
data
|
|
A list of traces this frame modifies. The format is
|
|
identical to the normal trace definition.
|
|
group
|
|
An identifier that specifies the group to which the
|
|
frame belongs, used by animate to select a subset of
|
|
frames.
|
|
layout
|
|
Layout properties which this frame modifies. The format
|
|
is identical to the normal layout definition.
|
|
name
|
|
A label by which to identify the frame
|
|
traces
|
|
A list of trace indices that identify the respective
|
|
traces in the data attribute
|
|
|
|
Returns
|
|
-------
|
|
Frame
|
|
"""
|
|
super().__init__("frames")
|
|
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.Frame
|
|
constructor must be a dict or
|
|
an instance of :class:`plotly.graph_objs.Frame`""")
|
|
|
|
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
|
self._validate = kwargs.pop("_validate", True)
|
|
|
|
self._set_property("baseframe", arg, baseframe)
|
|
self._set_property("data", arg, data)
|
|
self._set_property("group", arg, group)
|
|
self._set_property("layout", arg, layout)
|
|
self._set_property("name", arg, name)
|
|
self._set_property("traces", arg, traces)
|
|
self._process_kwargs(**dict(arg, **kwargs))
|
|
self._skip_invalid = False
|