plotly.py-docs/generated/plotly.express.box.html at debug · plotly/plotly.py-docs

History

262 lines (231 loc) · 24.2 KB

Raw

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

251

252

253

254

255

256

257

258

259

260

261

262

<!DOCTYPE html>

<head>

<title>plotly.express.box — 4.6.0 documentation</title>

</head><body>

</button>

</a>

</div>

<a role="button"

id="dLabelGlobalToc"

data-toggle="dropdown"

data-target="#"

href="../index.html">Site </a>

<ul class="dropdown-menu globaltoc"

role="menu"

aria-labelledby="dLabelGlobalToc"><ul class="current">

<li class="toctree-l1 current"><a class="reference internal" href="../plotly.express.html"><code class="docutils literal notranslate">plotly.express</code>: high-level interface for data visualization</a></li>

<li class="toctree-l1"><a class="reference internal" href="../plotly.graph_objects.html"><code class="docutils literal notranslate">plotly.graph_objects</code>: low-level interface to figures, traces and layout</a></li>

<li class="toctree-l1"><a class="reference internal" href="../plotly.subplots.html"><code class="docutils literal notranslate">plotly.subplots</code>: helper function for laying out multi-plot figures</a></li>

<li class="toctree-l1"><a class="reference internal" href="../plotly.figure_factory.html"><code class="docutils literal notranslate">plotly.figure_factory</code>: helper methods for building specific complex charts</a></li>

<li class="toctree-l1"><a class="reference internal" href="../plotly.io.html"><code class="docutils literal notranslate">plotly.io</code>: low-level interface for displaying, reading and writing figures</a></li>

</ul>

</li>

<a role="button"

id="dLabelLocalToc"

data-toggle="dropdown"

data-target="#"

href="#">Page </a>

<ul class="dropdown-menu localtoc"

role="menu"

aria-labelledby="dLabelLocalToc"><ul>

<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">plotly.express</code>.box</a></li>

</ul>

</li>

<li>

<a href="plotly.express.violin.html" title="Previous Chapter: plotly.express.violin">« plotly.express.violin

</a>

</li>

<li>

<a href="plotly.express.strip.html" title="Next Chapter: plotly.express.strip">plotly.express.strip »

</a>

</li>

</ul>

</div>

</form>

</div>

<h1><a class="reference internal" href="plotly.express.html#module-plotly.express" title="plotly.express"><code class="xref py py-mod docutils literal notranslate">plotly.express</code></a>.box<a class="headerlink" href="#plotly-express-box" title="Permalink to this headline">¶</a></h1>

<code class="sig-prename descclassname">plotly.express.</code><code class="sig-name descname">box</code>(data_frame=None, x=None, y=None, color=None, facet_row=None, facet_col=None, facet_col_wrap=0, hover_name=None, hover_data=None, custom_data=None, animation_frame=None, animation_group=None, category_orders={}, labels={}, color_discrete_sequence=None, color_discrete_map={}, orientation='v', boxmode='group', log_x=False, log_y=False, range_x=None, range_y=None, points=None, notched=False, title=None, template=None, width=None, height=None)<a class="headerlink" href="#plotly.express.box" title="Permalink to this definition">¶</a></dt>

<div>In a box plot, rows of <code class="docutils literal notranslate">data_frame</code> are grouped together into a

box-and-whisker mark to visualize their distribution.

Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The second

quartile (Q2) is marked by a line inside the box. By default, the

whiskers correspond to the box’ edges +/- 1.5 times the interquartile

range (IQR: Q3-Q1), see “points” for other options.

</div></blockquote>

<dt class="field-odd">Parameters</dt>

<li>data_frame (DataFrame or array-like or <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.8)">dict</a>) – This argument needs to be passed for column names (and not keyword

names) to be used. Array-like and dict are tranformed internally to a

pandas DataFrame. Optional: if missing, a DataFrame gets constructed

under the hood using the other arguments.</li>

<li>x (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)">str</a> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)">int</a> or Series or array-like) – Either a name of a column in <code class="docutils literal notranslate">data_frame</code>, or a pandas Series or

array_like object. Values from this column or array_like are used to

position marks along the x axis in cartesian coordinates. For

horizontal histograms, these values are used as inputs to <code class="docutils literal notranslate">histfunc</code>.</li>

<li>y (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)">str</a> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)">int</a> or Series or array-like) – Either a name of a column in <code class="docutils literal notranslate">data_frame</code>, or a pandas Series or

array_like object. Values from this column or array_like are used to

position marks along the y axis in cartesian coordinates. For vertical

histograms, these values are used as inputs to <code class="docutils literal notranslate">histfunc</code>.</li>

<li>color (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)">str</a> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)">int</a> or Series or array-like) – Either a name of a column in <code class="docutils literal notranslate">data_frame</code>, or a pandas Series or

array_like object. Values from this column or array_like are used to

assign color to marks.</li>

<li>facet_row (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)">str</a> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)">int</a> or Series or array-like) – Either a name of a column in <code class="docutils literal notranslate">data_frame</code>, or a pandas Series or

array_like object. Values from this column or array_like are used to

assign marks to facetted subplots in the vertical direction.</li>

<li>facet_col (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)">str</a> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)">int</a> or Series or array-like) – Either a name of a column in <code class="docutils literal notranslate">data_frame</code>, or a pandas Series or

array_like object. Values from this column or array_like are used to

assign marks to facetted subplots in the horizontal direction.</li>

<li>facet_col_wrap (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)">int</a>) – Maximum number of facet columns. Wraps the column variable at this

width, so that the column facets span multiple rows. Ignored if 0, and

forced to 0 if <code class="docutils literal notranslate">facet_row</code> or a <code class="docutils literal notranslate">marginal</code> is set.</li>

<li>hover_name (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)">str</a> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)">int</a> or Series or array-like) – Either a name of a column in <code class="docutils literal notranslate">data_frame</code>, or a pandas Series or

array_like object. Values from this column or array_like appear in bold

in the hover tooltip.</li>

<li>hover_data (list of str or <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)">int</a>, or Series or array-like, or <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.8)">dict</a>) – Either a list of names of columns in <code class="docutils literal notranslate">data_frame</code>, or pandas Series, or

array_like objects or a dict with column names as keys, with values

True (for default formatting) False (in order to remove this column

from hover information), or a formatting string, for example ‘:.3f’ or

‘<a href="#id1">|</a>%a’ or list-like data to appear in the hover tooltip or tuples with a

bool or formatting string as first element, and list-like data to

appear in hover as second element Values from these columns appear as

extra data in the hover tooltip.</li>

<li>custom_data (list of str or <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)">int</a>, or Series or array-like) – Either names of columns in <code class="docutils literal notranslate">data_frame</code>, or pandas Series, or

array_like objects Values from these columns are extra data, to be used

in widgets or Dash callbacks for example. This data is not user-visible

but is included in events emitted by the figure (lasso selection etc.)</li>

<li>animation_frame (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)">str</a> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)">int</a> or Series or array-like) – Either a name of a column in <code class="docutils literal notranslate">data_frame</code>, or a pandas Series or

array_like object. Values from this column or array_like are used to

assign marks to animation frames.</li>

<li>animation_group (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)">str</a> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)">int</a> or Series or array-like) – Either a name of a column in <code class="docutils literal notranslate">data_frame</code>, or a pandas Series or

array_like object. Values from this column or array_like are used to

provide object-constancy across animation frames: rows with matching

<a href="#id3">`</a>animation_group`s will be treated as if they describe the same object

in each frame.</li>

<li>category_orders (dict with str keys and list of str values (default <code class="docutils literal notranslate">{}</code>)) – By default, in Python 3.6+, the order of categorical values in axes,

legends and facets depends on the order in which these values are first

encountered in <code class="docutils literal notranslate">data_frame</code> (and no order is guaranteed by default in

Python below 3.6). This parameter is used to force a specific ordering

of values per column. The keys of this dict should correspond to column

names, and the values should be lists of strings corresponding to the

specific display order desired.</li>

<li>labels (dict with str keys and str values (default <code class="docutils literal notranslate">{}</code>)) – By default, column names are used in the figure for axis titles, legend

entries and hovers. This parameter allows this to be overridden. The

keys of this dict should correspond to column names, and the values

should correspond to the desired label to be displayed.</li>

<li>color_discrete_sequence (list of str) – Strings should define valid CSS-colors. When <code class="docutils literal notranslate">color</code> is set and the

values in the corresponding column are not numeric, values in that

column are assigned colors by cycling through <code class="docutils literal notranslate">color_discrete_sequence</code>

in the order described in <code class="docutils literal notranslate">category_orders</code>, unless the value of

<code class="docutils literal notranslate">color</code> is a key in <code class="docutils literal notranslate">color_discrete_map</code>. Various useful color

sequences are available in the <code class="docutils literal notranslate">plotly.express.colors</code> submodules,

specifically <code class="docutils literal notranslate">plotly.express.colors.qualitative</code>.</li>

<li>color_discrete_map (dict with str keys and str values (default <code class="docutils literal notranslate">{}</code>)) – String values should define valid CSS-colors Used to override

<code class="docutils literal notranslate">color_discrete_sequence</code> to assign a specific colors to marks

corresponding with specific values. Keys in <code class="docutils literal notranslate">color_discrete_map</code> should

be values in the column denoted by <code class="docutils literal notranslate">color</code>.</li>

<li>orientation (str (default <code class="docutils literal notranslate">'v'</code>)) – One of <code class="docutils literal notranslate">'h'</code> for horizontal or <code class="docutils literal notranslate">'v'</code> for vertical)</li>

<li>boxmode (str (default <code class="docutils literal notranslate">'group'</code>)) – One of <code class="docutils literal notranslate">'group'</code> or <code class="docutils literal notranslate">'overlay'</code> In <code class="docutils literal notranslate">'overlay'</code> mode, boxes are on drawn

top of one another. In <code class="docutils literal notranslate">'group'</code> mode, baxes are placed beside each

other.</li>

<li>log_x (boolean (default <code class="docutils literal notranslate">False</code>)) – If <code class="docutils literal notranslate">True</code>, the x-axis is log-scaled in cartesian coordinates.</li>

<li>log_y (boolean (default <code class="docutils literal notranslate">False</code>)) – If <code class="docutils literal notranslate">True</code>, the y-axis is log-scaled in cartesian coordinates.</li>

<li>range_x (list of two numbers) – If provided, overrides auto-scaling on the x-axis in cartesian

coordinates.</li>

<li>range_y (list of two numbers) – If provided, overrides auto-scaling on the y-axis in cartesian

coordinates.</li>

<li>points (str or boolean (default <code class="docutils literal notranslate">'outliers'</code>)) – One of <code class="docutils literal notranslate">'outliers'</code>, <code class="docutils literal notranslate">'suspectedoutliers'</code>, <code class="docutils literal notranslate">'all'</code>, or <code class="docutils literal notranslate">False</code>. If

<code class="docutils literal notranslate">'outliers'</code>, only the sample points lying outside the whiskers are

shown. If <code class="docutils literal notranslate">'suspectedoutliers'</code>, all outlier points are shown and those

less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted with the

marker’s <code class="docutils literal notranslate">'outliercolor'</code>. If <code class="docutils literal notranslate">'outliers'</code>, only the sample points

lying outside the whiskers are shown. If <code class="docutils literal notranslate">'all'</code>, all sample points are

shown. If <code class="docutils literal notranslate">False</code>, no sample points are shown and the whiskers extend

to the full range of the sample.</li>

<li>notched (boolean (default <code class="docutils literal notranslate">False</code>)) – If <code class="docutils literal notranslate">True</code>, boxes are drawn with notches.</li>

<li>title (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)">str</a>) – The figure title.</li>

<li>template (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)">str</a> or <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.8)">dict</a> or plotly.graph_objects.layout.Template instance) – The figure template name (must be a key in plotly.io.templates) or

definition.</li>

<li>width (int (default <code class="docutils literal notranslate">None</code>)) – The figure width in pixels.</li>

<li>height (int (default <code class="docutils literal notranslate">None</code>)) – The figure height in pixels.</li>

</ul>

</dd>

<dt class="field-even">Returns</dt>

</dd>

<dt class="field-odd">Return type</dt>

<dd class="field-odd"><a class="reference internal" href="plotly.graph_objects.html#plotly.graph_objects.Figure" title="plotly.graph_objects.Figure">plotly.graph_objects.Figure</a>

</dd>

</dl>

</dd></dl>

</div>

var _gaq = _gaq || [];

_gaq.push(['_setAccount', 'UA-39373211-1']);

_gaq.push(['_setDomainName', 'none']);

_gaq.push(['_setAllowLinker', true]);

_gaq.push(['_trackPageview']);

(function() {

var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;

ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';

var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);

})();

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

plotly.express.box.html

Latest commit

History

plotly.express.box.html

File metadata and controls