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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
|
# --- THIS FILE IS AUTO-GENERATED ---
# Modifications will be overwitten the next time code generation run.
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
import copy as _copy
class Ternary(_BaseLayoutHierarchyType):
_parent_path_str = "layout"
_path_str = "layout.ternary"
_valid_props = {"aaxis", "baxis", "bgcolor", "caxis", "domain", "sum", "uirevision"}
@property
def aaxis(self):
"""
The 'aaxis' property is an instance of Aaxis
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.ternary.Aaxis`
- A dict of string/value properties that will be passed
to the Aaxis constructor
Returns
-------
plotly.graph_objs.layout.ternary.Aaxis
"""
return self["aaxis"]
@aaxis.setter
def aaxis(self, val):
self["aaxis"] = val
@property
def baxis(self):
"""
The 'baxis' property is an instance of Baxis
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.ternary.Baxis`
- A dict of string/value properties that will be passed
to the Baxis constructor
Returns
-------
plotly.graph_objs.layout.ternary.Baxis
"""
return self["baxis"]
@baxis.setter
def baxis(self, val):
self["baxis"] = val
@property
def bgcolor(self):
"""
Set the background color of the subplot
The 'bgcolor' 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["bgcolor"]
@bgcolor.setter
def bgcolor(self, val):
self["bgcolor"] = val
@property
def caxis(self):
"""
The 'caxis' property is an instance of Caxis
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.ternary.Caxis`
- A dict of string/value properties that will be passed
to the Caxis constructor
Returns
-------
plotly.graph_objs.layout.ternary.Caxis
"""
return self["caxis"]
@caxis.setter
def caxis(self, val):
self["caxis"] = val
@property
def domain(self):
"""
The 'domain' property is an instance of Domain
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.ternary.Domain`
- A dict of string/value properties that will be passed
to the Domain constructor
Returns
-------
plotly.graph_objs.layout.ternary.Domain
"""
return self["domain"]
@domain.setter
def domain(self, val):
self["domain"] = val
@property
def sum(self):
"""
The number each triplet should sum to, and the maximum range of
each axis
The 'sum' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
"""
return self["sum"]
@sum.setter
def sum(self, val):
self["sum"] = val
@property
def uirevision(self):
"""
Controls persistence of user-driven changes in axis `min` and
`title`, if not overridden in the individual axes. Defaults to
`layout.uirevision`.
The 'uirevision' property accepts values of any type
Returns
-------
Any
"""
return self["uirevision"]
@uirevision.setter
def uirevision(self, val):
self["uirevision"] = val
@property
def _prop_descriptions(self):
return """\
aaxis
:class:`plotly.graph_objects.layout.ternary.Aaxis`
instance or dict with compatible properties
baxis
:class:`plotly.graph_objects.layout.ternary.Baxis`
instance or dict with compatible properties
bgcolor
Set the background color of the subplot
caxis
:class:`plotly.graph_objects.layout.ternary.Caxis`
instance or dict with compatible properties
domain
:class:`plotly.graph_objects.layout.ternary.Domain`
instance or dict with compatible properties
sum
The number each triplet should sum to, and the maximum
range of each axis
uirevision
Controls persistence of user-driven changes in axis
`min` and `title`, if not overridden in the individual
axes. Defaults to `layout.uirevision`.
"""
def __init__(
self,
arg=None,
aaxis=None,
baxis=None,
bgcolor=None,
caxis=None,
domain=None,
sum=None,
uirevision=None,
**kwargs,
):
"""
Construct a new Ternary object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
:class:`plotly.graph_objs.layout.Ternary`
aaxis
:class:`plotly.graph_objects.layout.ternary.Aaxis`
instance or dict with compatible properties
baxis
:class:`plotly.graph_objects.layout.ternary.Baxis`
instance or dict with compatible properties
bgcolor
Set the background color of the subplot
caxis
:class:`plotly.graph_objects.layout.ternary.Caxis`
instance or dict with compatible properties
domain
:class:`plotly.graph_objects.layout.ternary.Domain`
instance or dict with compatible properties
sum
The number each triplet should sum to, and the maximum
range of each axis
uirevision
Controls persistence of user-driven changes in axis
`min` and `title`, if not overridden in the individual
axes. Defaults to `layout.uirevision`.
Returns
-------
Ternary
"""
super().__init__("ternary")
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.layout.Ternary
constructor must be a dict or
an instance of :class:`plotly.graph_objs.layout.Ternary`""")
self._skip_invalid = kwargs.pop("skip_invalid", False)
self._validate = kwargs.pop("_validate", True)
self._set_property("aaxis", arg, aaxis)
self._set_property("baxis", arg, baxis)
self._set_property("bgcolor", arg, bgcolor)
self._set_property("caxis", arg, caxis)
self._set_property("domain", arg, domain)
self._set_property("sum", arg, sum)
self._set_property("uirevision", arg, uirevision)
self._process_kwargs(**dict(arg, **kwargs))
self._skip_invalid = False
|
