_frame.py

fromplotly.basedatatypesimportBaseFrameHierarchyTypeas_BaseFrameHierarchyType
importcopyas_copy


classFrame(_BaseFrameHierarchyType):

# class properties
# --------------------
_parent_path_str=""
_path_str="frame"
_valid_props= {"baseframe", "data", "group", "layout", "name", "traces"}

# baseframe
# ---------
@property
defbaseframe(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
 """
returnself["baseframe"]

@baseframe.setter
defbaseframe(self, val):
self["baseframe"] =val

# data
# ----
@property
defdata(self):
"""
 A list of traces this frame modifies. The format is identical
 to the normal trace definition.

 Returns
 -------
 Any
 """
returnself["data"]

@data.setter
defdata(self, val):
self["data"] =val

# group
# -----
@property
defgroup(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
 """
returnself["group"]

@group.setter
defgroup(self, val):
self["group"] =val

# layout
# ------
@property
deflayout(self):
"""
 Layout properties which this frame modifies. The format is
 identical to the normal layout definition.

 Returns
 -------
 Any
 """
returnself["layout"]

@layout.setter
deflayout(self, val):
self["layout"] =val

# name
# ----
@property
defname(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
 """
returnself["name"]

@name.setter
defname(self, val):
self["name"] =val

# traces
# ------
@property
deftraces(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
 """
returnself["traces"]

@traces.setter
deftraces(self, val):
self["traces"] =val

# Self properties description
# ---------------------------
@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(Frame, self).__init__("frames")

if"_parent"inkwargs:
self._parent=kwargs["_parent"]
return

# Validate arg
# ------------
ifargisNone:
arg= {}
elifisinstance(arg, self.__class__):
arg=arg.to_plotly_json()
elifisinstance(arg, dict):
arg=_copy.copy(arg)
else:
raiseValueError(
"""\
The first argument to the plotly.graph_objs.Frame
constructor must be a dict or
an instance of :class:`plotly.graph_objs.Frame`"""
 )

# 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("baseframe", None)
_v=baseframeifbaseframeisnotNoneelse_v
if_visnotNone:
self["baseframe"] =_v
_v=arg.pop("data", None)
_v=dataifdataisnotNoneelse_v
if_visnotNone:
self["data"] =_v
_v=arg.pop("group", None)
_v=groupifgroupisnotNoneelse_v
if_visnotNone:
self["group"] =_v
_v=arg.pop("layout", None)
_v=layoutiflayoutisnotNoneelse_v
if_visnotNone:
self["layout"] =_v
_v=arg.pop("name", None)
_v=nameifnameisnotNoneelse_v
if_visnotNone:
self["name"] =_v
_v=arg.pop("traces", None)
_v=tracesiftracesisnotNoneelse_v
if_visnotNone:
self["traces"] =_v

# Process unknown kwargs
# ----------------------
self._process_kwargs(**dict(arg, **kwargs))

# Reset skip_invalid
# ------------------
self._skip_invalid=False