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
|
# --- 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 Tiling(_BaseTraceHierarchyType):
_parent_path_str = "treemap"
_path_str = "treemap.tiling"
_valid_props = {"flip", "packing", "pad", "squarifyratio"}
@property
def flip(self):
"""
Determines if the positions obtained from solver are flipped on
each axis.
The 'flip' property is a flaglist and may be specified
as a string containing:
- Any combination of ['x', 'y'] joined with '+' characters
(e.g. 'x+y')
Returns
-------
Any
"""
return self["flip"]
@flip.setter
def flip(self, val):
self["flip"] = val
@property
def packing(self):
"""
Determines d3 treemap solver. For more info please refer to
https://github.com/d3/d3-hierarchy#treemap-tiling
The 'packing' property is an enumeration that may be specified as:
- One of the following enumeration values:
['squarify', 'binary', 'dice', 'slice', 'slice-dice',
'dice-slice']
Returns
-------
Any
"""
return self["packing"]
@packing.setter
def packing(self, val):
self["packing"] = val
@property
def pad(self):
"""
Sets the inner padding (in px).
The 'pad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
"""
return self["pad"]
@pad.setter
def pad(self, val):
self["pad"] = val
@property
def squarifyratio(self):
"""
When using "squarify" `packing` algorithm, according to https:/
/github.com/d3/d3-
hierarchy/blob/v3.1.1/README.md#squarify_ratio this option
specifies the desired aspect ratio of the generated rectangles.
The ratio must be specified as a number greater than or equal
to one. Note that the orientation of the generated rectangles
(tall or wide) is not implied by the ratio; for example, a
ratio of two will attempt to produce a mixture of rectangles
whose width:height ratio is either 2:1 or 1:2. When using
"squarify", unlike d3 which uses the Golden Ratio i.e.
1.618034, Plotly applies 1 to increase squares in treemap
layouts.
The 'squarifyratio' property is a number and may be specified as:
- An int or float in the interval [1, inf]
Returns
-------
int|float
"""
return self["squarifyratio"]
@squarifyratio.setter
def squarifyratio(self, val):
self["squarifyratio"] = val
@property
def _prop_descriptions(self):
return """\
flip
Determines if the positions obtained from solver are
flipped on each axis.
packing
Determines d3 treemap solver. For more info please
refer to https://github.com/d3/d3-hierarchy#treemap-
tiling
pad
Sets the inner padding (in px).
squarifyratio
When using "squarify" `packing` algorithm, according to
https://github.com/d3/d3-
hierarchy/blob/v3.1.1/README.md#squarify_ratio this
option specifies the desired aspect ratio of the
generated rectangles. The ratio must be specified as a
number greater than or equal to one. Note that the
orientation of the generated rectangles (tall or wide)
is not implied by the ratio; for example, a ratio of
two will attempt to produce a mixture of rectangles
whose width:height ratio is either 2:1 or 1:2. When
using "squarify", unlike d3 which uses the Golden Ratio
i.e. 1.618034, Plotly applies 1 to increase squares in
treemap layouts.
"""
def __init__(
self, arg=None, flip=None, packing=None, pad=None, squarifyratio=None, **kwargs
):
"""
Construct a new Tiling object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
:class:`plotly.graph_objs.treemap.Tiling`
flip
Determines if the positions obtained from solver are
flipped on each axis.
packing
Determines d3 treemap solver. For more info please
refer to https://github.com/d3/d3-hierarchy#treemap-
tiling
pad
Sets the inner padding (in px).
squarifyratio
When using "squarify" `packing` algorithm, according to
https://github.com/d3/d3-
hierarchy/blob/v3.1.1/README.md#squarify_ratio this
option specifies the desired aspect ratio of the
generated rectangles. The ratio must be specified as a
number greater than or equal to one. Note that the
orientation of the generated rectangles (tall or wide)
is not implied by the ratio; for example, a ratio of
two will attempt to produce a mixture of rectangles
whose width:height ratio is either 2:1 or 1:2. When
using "squarify", unlike d3 which uses the Golden Ratio
i.e. 1.618034, Plotly applies 1 to increase squares in
treemap layouts.
Returns
-------
Tiling
"""
super().__init__("tiling")
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.treemap.Tiling
constructor must be a dict or
an instance of :class:`plotly.graph_objs.treemap.Tiling`""")
self._skip_invalid = kwargs.pop("skip_invalid", False)
self._validate = kwargs.pop("_validate", True)
self._set_property("flip", arg, flip)
self._set_property("packing", arg, packing)
self._set_property("pad", arg, pad)
self._set_property("squarifyratio", arg, squarifyratio)
self._process_kwargs(**dict(arg, **kwargs))
self._skip_invalid = False
|
