1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
# --- 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
|
