plotly.py-docs/plotly.subplots.html at debug · plotly/plotly.py-docs

History

448 lines (417 loc) · 38.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

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

<!DOCTYPE html>

<head>

<title>plotly.subplots: helper function for laying out multi-plot figures — 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"><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 current"><a class="current reference internal" href="#"><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="docutils literal notranslate">plotly.subplots</code>: helper function for laying out multi-plot figures</a></li>

</ul>

</li>

<li>

<a href="generated/plotly.graph_objects.Contourcarpet.html" title="Previous Chapter: plotly.graph_objects.Contourcarpet">« plotly.graph_...

</a>

</li>

<li>

<a href="generated/plotly.subplots.make_subplots.html" title="Next Chapter: plotly.subplots.make_subplots">plotly.subplo... »

</a>

</li>

</ul>

</div>

</form>

</div>

<h1><code class="docutils literal notranslate">plotly.subplots</code>: helper function for laying out multi-plot figures<a class="headerlink" href="#plotly-subplots-helper-function-for-laying-out-multi-plot-figures" title="Permalink to this headline">¶</a></h1>

</colgroup>

<tbody>

<tr class="row-odd"><td><a class="reference internal" href="#plotly.subplots.make_subplots" title="plotly.subplots.make_subplots"><code class="xref py py-obj docutils literal notranslate">make_subplots</code></a>([rows, cols, shared_xaxes, …])</td>

<td>Return an instance of plotly.graph_objects.Figure with predefined subplots configured in ‘layout’.</td>

</tr>

</tbody>

</table>

<code class="sig-prename descclassname">plotly.subplots.</code><code class="sig-name descname">make_subplots</code>(rows=1, cols=1, shared_xaxes=False, shared_yaxes=False, start_cell='top-left', print_grid=False, horizontal_spacing=None, vertical_spacing=None, subplot_titles=None, column_widths=None, row_heights=None, specs=None, insets=None, column_titles=None, row_titles=None, x_title=None, y_title=None, **kwargs)<a class="headerlink" href="#plotly.subplots.make_subplots" title="Permalink to this definition">¶</a></dt>

<dd>Return an instance of plotly.graph_objects.Figure with predefined subplots

configured in ‘layout’.

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

<li>rows (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)">int</a> (default 1)) – Number of rows in the subplot grid. Must be greater than zero.</li>

<li>cols (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)">int</a> (default 1)) – Number of columns in the subplot grid. Must be greater than zero.</li>

<li>shared_xaxes (boolean or <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)">str</a> (default False)) – Assign shared (linked) x-axes for 2D cartesian subplots

<li>True or ‘columns’: Share axes among subplots in the same column</li>

<li>’rows’: Share axes among subplots in the same row</li>

<li>’all’: Share axes across all subplots in the grid.</li>

</ul>

</div></blockquote>

</li>

<li>shared_yaxes (boolean or <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)">str</a> (default False)) – Assign shared (linked) y-axes for 2D cartesian subplots

<li>’columns’: Share axes among subplots in the same column</li>

<li>True or ‘rows’: Share axes among subplots in the same row</li>

<li>’all’: Share axes across all subplots in the grid.</li>

</ul>

</div></blockquote>

</li>

<li>start_cell ('bottom-left' or 'top-left' (default 'top-left')) – Choose the starting cell in the subplot grid used to set the

domains_grid of the subplots.

<dt>’top-left’: Subplots are numbered with (1, 1) in the top</dt><dd>left corner

</dd>

</dl>

</li>

<dt>’bottom-left’: Subplots are numbererd with (1, 1) in the bottom</dt><dd>left corner

</dd>

</dl>

</li>

</ul>

</div></blockquote>

</li>

<li>print_grid (boolean (default True):) – If True, prints a string representation of the plot grid. Grid may

also be printed using the <code class="docutils literal notranslate">Figure.print_grid()</code> method on the

resulting figure.</li>

<li>horizontal_spacing (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.8)">float</a> (default 0.2 / cols)) – Space between subplot columns in normalized plot coordinates. Must be

a float between 0 and 1.

Applies to all columns (use ‘specs’ subplot-dependents spacing)

</li>

<li>vertical_spacing (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.8)">float</a> (default 0.3 / rows)) – Space between subplot rows in normalized plot coordinates. Must be

a float between 0 and 1.

Applies to all rows (use ‘specs’ subplot-dependents spacing)

</li>

<li>subplot_titles (list of str or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.8)">None</a> (default None)) – Title of each subplot as a list in row-major ordering.

Empty strings (“”) can be included in the list if no subplot title

is desired in that space so that the titles are properly indexed.

</li>

<li>specs (list of lists of dict or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.8)">None</a> (default None)) – Per subplot specifications of subplot type, row/column spanning, and

spacing.

ex1: specs=[[{}, {}], [{‘colspan’: 2}, None]]

ex2: specs=[[{‘rowspan’: 2}, {}], [None, {}]]

<ul>

<li>Indices of the outer list correspond to subplot grid rows

starting from the top, if start_cell=’top-left’,

or bottom, if start_cell=’bottom-left’.

The number of rows in ‘specs’ must be equal to ‘rows’.</li>

<li>Indices of the inner lists correspond to subplot grid columns

starting from the left. The number of columns in ‘specs’

must be equal to ‘cols’.</li>

<li>Each item in the ‘specs’ list corresponds to one subplot

in a subplot grid. (N.B. The subplot grid has exactly ‘rows’

times ‘cols’ cells.)</li>

<li>Use None for a blank a subplot cell (or to move past a col/row span).</li>

<li>Note that specs[0][0] has the specs of the ‘start_cell’ subplot.</li>

<dt>Each item in ‘specs’ is a dictionary.</dt><dd>The available keys are:

* type (string, default ‘xy’): Subplot type. One of

<li>’xy’: 2D Cartesian subplot type for scatter, bar, etc.</li>

<li>’scene’: 3D Cartesian subplot for scatter3d, cone, etc.</li>

<li>’polar’: Polar subplot for scatterpolar, barpolar, etc.</li>

<li>’ternary’: Ternary subplot for scatterternary</li>

<li>’mapbox’: Mapbox subplot for scattermapbox</li>

<dt>’domain’: Subplot type for traces that are individually</dt><dd>positioned. pie, parcoords, parcats, etc.

</dd>

</dl>

</li>

<dt>trace type: A trace type which will be used to determine</dt><dd>the appropriate subplot type for that trace

</dd>

</dl>

</li>

</ul>

</div></blockquote>

<dt>secondary_y (bool, default False): If True, create a secondary</dt><dd>y-axis positioned on the right side of the subplot. Only valid

if type=’xy’.

</dd>

</dl>

</li>

<dt>colspan (int, default 1): number of subplot columns</dt><dd>for this subplot to span.

</dd>

</dl>

</li>

<dt>rowspan (int, default 1): number of subplot rows</dt><dd>for this subplot to span.

</dd>

</dl>

</li>

<li>l (float, default 0.0): padding left of cell</li>

<li>r (float, default 0.0): padding right of cell</li>

<li>t (float, default 0.0): padding right of cell</li>

<li>b (float, default 0.0): padding bottom of cell</li>

</ul>

</dd>

</dl>

</li>

<li>Note: Use ‘horizontal_spacing’ and ‘vertical_spacing’ to adjust

the spacing in between the subplots.</li>

</ul>

</li>

<li>insets (list of dict or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.8)">None</a> (default None):) – Inset specifications. Insets are subplots that overlay grid subplots

<ul>

<dt>Each item in ‘insets’ is a dictionary.</dt><dd>The available keys are:

<ul>

<dt>cell (tuple, default=(1,1)): (row, col) index of the</dt><dd>subplot cell to overlay inset axes onto.

</dd>

</dl>

</li>

<li>type (string, default ‘xy’): Subplot type</li>

<dt>l (float, default=0.0): padding left of inset</dt><dd>in fraction of cell width

</dd>

</dl>

</li>

<dt>w (float or ‘to_end’, default=’to_end’) inset width</dt><dd>in fraction of cell width (‘to_end’: to cell right edge)

</dd>

</dl>

</li>

<dt>b (float, default=0.0): padding bottom of inset</dt><dd>in fraction of cell height

</dd>

</dl>

</li>

<dt>h (float or ‘to_end’, default=’to_end’) inset height</dt><dd>in fraction of cell height (‘to_end’: to cell top edge)

</dd>

</dl>

</li>

</ul>

</dd>

</dl>

</li>

</ul>

</li>

<li>column_widths (list of numbers or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.8)">None</a> (default None)) – list of length <code class="docutils literal notranslate">cols</code> of the relative widths of each column of suplots.

Values are normalized internally and used to distribute overall width

of the figure (excluding padding) among the columns.

For backward compatibility, may also be specified using the

<code class="docutils literal notranslate">column_width</code> keyword argument.

</li>

<li>row_heights (list of numbers or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.8)">None</a> (default None)) – list of length <code class="docutils literal notranslate">rows</code> of the relative heights of each row of subplots.

If start_cell=’top-left’ then row heights are applied top to bottom.

Otherwise, if start_cell=’bottom-left’ then row heights are applied

bottom to top.

For backward compatibility, may also be specified using the

<code class="docutils literal notranslate">row_width</code> kwarg. If specified as <code class="docutils literal notranslate">row_width</code>, then the width values

are applied from bottom to top regardless of the value of start_cell.

This matches the legacy behavior of the <code class="docutils literal notranslate">row_width</code> argument.

</li>

<li>column_titles (list of str or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.8)">None</a> (default None)) – list of length <code class="docutils literal notranslate">cols</code> of titles to place above the top subplot in

each column.</li>

<li>row_titles (list of str or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.8)">None</a> (default None)) – list of length <code class="docutils literal notranslate">rows</code> of titles to place on the right side of each

row of subplots. If start_cell=’top-left’ then row titles are

applied top to bottom. Otherwise, if start_cell=’bottom-left’ then

row titles are applied bottom to top.</li>

<li>x_title (<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/constants.html#None" title="(in Python v3.8)">None</a> (default None)) – Title to place below the bottom row of subplots,

centered horizontally</li>

<li>y_title (<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/constants.html#None" title="(in Python v3.8)">None</a> (default None)) – Title to place to the left of the left column of subplots,

centered vertically</li>

</ul>

</dd>

</dl>

Examples

Example 1:

<div class="highlight-default notranslate"><div class="highlight"><pre>>>> # Stack two subplots vertically, and add a scatter trace to each

>>> from plotly.subplots import make_subplots

>>> import plotly.graph_objects as go

</pre></div>

</div>

This is the format of your plot grid:

[ (1,1) xaxis1,yaxis1 ]

[ (2,1) xaxis2,yaxis2 ]

Figure(...)

>>> fig.add_scatter(y=[1, 3, 2], row=2, col=1)

Figure(...)

</pre></div>

</div>

or see Figure.append_trace

Example 2:

<div class="highlight-default notranslate"><div class="highlight"><pre>>>> # Stack a scatter plot

>>> fig = make_subplots(rows=2, shared_xaxes=True)

</pre></div>

</div>

This is the format of your plot grid:

[ (1,1) xaxis1,yaxis1 ]

[ (2,1) xaxis2,yaxis2 ]

Figure(...)

</pre></div>

</div>

Example 3:

<div class="highlight-default notranslate"><div class="highlight"><pre>>>> # irregular subplot layout (more examples below under 'specs')

>>> fig = make_subplots(rows=2, cols=2,

... specs=[[{}, {}],

... [{'colspan': 2}, None]])

</pre></div>

</div>

This is the format of your plot grid:

[ (1,1) xaxis1,yaxis1 ] [ (1,2) xaxis2,yaxis2 ]

[ (2,1) xaxis3,yaxis3 - ]

<div class="highlight-default notranslate"><div class="highlight"><pre>>>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=1, col=1)

Figure(...)

>>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=1, col=2)

Figure(...)

>>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=2, col=1)

Figure(...)

</pre></div>

</div>

Example 4:

<div class="highlight-default notranslate"><div class="highlight"><pre>>>> # insets

>>> fig = make_subplots(insets=[{'cell': (1,1), 'l': 0.7, 'b': 0.3}])

</pre></div>

</div>

This is the format of your plot grid:

[ (1,1) xaxis1,yaxis1 ]

With insets:

[ xaxis2,yaxis2 ] over [ (1,1) xaxis1,yaxis1 ]

Figure(...)

>>> fig.add_scatter(x=[1,2,3], y=[2,1,2], xaxis='x2', yaxis='y2')

Figure(...)

</pre></div>

</div>

Example 5:

<div class="highlight-default notranslate"><div class="highlight"><pre>>>> # include subplot titles

>>> fig = make_subplots(rows=2, subplot_titles=('Plot 1','Plot 2'))

</pre></div>

</div>

This is the format of your plot grid:

[ (1,1) x1,y1 ]

[ (2,1) x2,y2 ]

<div class="highlight-default notranslate"><div class="highlight"><pre>>>> fig.add_scatter(x=[1,2,3], y=[2,1,2], row=1, col=1)

Figure(...)

>>> fig.add_bar(x=[1,2,3], y=[2,1,2], row=2, col=1)

Figure(...)

</pre></div>

</div>

Example 6:

Subplot with mixed subplot types

<div class="highlight-default notranslate"><div class="highlight"><pre>>>> fig = make_subplots(rows=2, cols=2,

... specs=[[{'type': 'xy'}, {'type': 'polar'}],

... [{'type': 'scene'}, {'type': 'ternary'}]])

</pre></div>

</div>

... [go.Scatter(y=[2, 3, 1]),

... go.Scatterpolar(r=[1, 3, 2], theta=[0, 45, 90]),

... go.Scatter3d(x=[1, 2, 1], y=[2, 3, 1], z=[0, 3, 5]),

... go.Scatterternary(a=[0.1, 0.2, 0.1],

... b=[0.2, 0.3, 0.1],

... c=[0.7, 0.5, 0.8])],

... rows=[1, 1, 2, 2],

... cols=[1, 2, 1, 2])

Figure(...)

</pre></div>

</div>

</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.subplots.html

Latest commit

History

plotly.subplots.html

File metadata and controls