plotly.py-docs/generated/plotly.graph_objects.Layout.html at debug · plotly/plotly.py-docs

History

534 lines (502 loc) · 48.5 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

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

<!DOCTYPE html>

<head>

<title>plotly.graph_objects.Layout — 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 current"><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.graph_objects</code>.Layout</a></li>

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

</ul>

</li>

<li>

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

</a>

</li>

<li>

<a href="plotly.graph_objects.Scatter.html" title="Next Chapter: plotly.graph_objects.Scatter">plotly.graph_... »

</a>

</li>

</ul>

</div>

</form>

</div>

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

class <code class="sig-prename descclassname">plotly.graph_objects.</code><code class="sig-name descname">Layout</code>(arg=None, angularaxis=None, annotations=None, annotationdefaults=None, autosize=None, bargap=None, bargroupgap=None, barmode=None, barnorm=None, boxgap=None, boxgroupgap=None, boxmode=None, calendar=None, clickmode=None, coloraxis=None, colorscale=None, colorway=None, datarevision=None, direction=None, dragmode=None, editrevision=None, extendfunnelareacolors=None, extendpiecolors=None, extendsunburstcolors=None, extendtreemapcolors=None, font=None, funnelareacolorway=None, funnelgap=None, funnelgroupgap=None, funnelmode=None, geo=None, grid=None, height=None, hiddenlabels=None, hiddenlabelssrc=None, hidesources=None, hoverdistance=None, hoverlabel=None, hovermode=None, images=None, imagedefaults=None, legend=None, mapbox=None, margin=None, meta=None, metasrc=None, modebar=None, orientation=None, paper_bgcolor=None, piecolorway=None, plot_bgcolor=None, polar=None, radialaxis=None, scene=None, selectdirection=None, selectionrevision=None, separators=None, shapes=None, shapedefaults=None, showlegend=None, sliders=None, sliderdefaults=None, spikedistance=None, sunburstcolorway=None, template=None, ternary=None, title=None, titlefont=None, transition=None, treemapcolorway=None, uirevision=None, uniformtext=None, updatemenus=None, updatemenudefaults=None, violingap=None, violingroupgap=None, violinmode=None, waterfallgap=None, waterfallgroupgap=None, waterfallmode=None, width=None, xaxis=None, yaxis=None, **kwargs)<a class="headerlink" href="#plotly.graph_objects.Layout" title="Permalink to this definition">¶</a></dt>

<code class="sig-name descname">__init__</code>(arg=None, angularaxis=None, annotations=None, annotationdefaults=None, autosize=None, bargap=None, bargroupgap=None, barmode=None, barnorm=None, boxgap=None, boxgroupgap=None, boxmode=None, calendar=None, clickmode=None, coloraxis=None, colorscale=None, colorway=None, datarevision=None, direction=None, dragmode=None, editrevision=None, extendfunnelareacolors=None, extendpiecolors=None, extendsunburstcolors=None, extendtreemapcolors=None, font=None, funnelareacolorway=None, funnelgap=None, funnelgroupgap=None, funnelmode=None, geo=None, grid=None, height=None, hiddenlabels=None, hiddenlabelssrc=None, hidesources=None, hoverdistance=None, hoverlabel=None, hovermode=None, images=None, imagedefaults=None, legend=None, mapbox=None, margin=None, meta=None, metasrc=None, modebar=None, orientation=None, paper_bgcolor=None, piecolorway=None, plot_bgcolor=None, polar=None, radialaxis=None, scene=None, selectdirection=None, selectionrevision=None, separators=None, shapes=None, shapedefaults=None, showlegend=None, sliders=None, sliderdefaults=None, spikedistance=None, sunburstcolorway=None, template=None, ternary=None, title=None, titlefont=None, transition=None, treemapcolorway=None, uirevision=None, uniformtext=None, updatemenus=None, updatemenudefaults=None, violingap=None, violingroupgap=None, violinmode=None, waterfallgap=None, waterfallgroupgap=None, waterfallmode=None, width=None, xaxis=None, yaxis=None, **kwargs)<a class="headerlink" href="#plotly.graph_objects.Layout.__init__" title="Permalink to this definition">¶</a></dt>

<dd>Construct a new Layout object

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

<li>arg – dict of properties compatible with this constructor or

an instance of <a class="reference internal" href="#plotly.graph_objects.Layout" title="plotly.graph_objects.Layout"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.Layout</code></a></li>

<li>angularaxis – <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.AngularAxis" title="plotly.graph_objects.layout.AngularAxis"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.AngularAxis</code></a>

instance or dict with compatible properties</li>

<li>annotations – A tuple of

<a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.Annotation" title="plotly.graph_objects.layout.Annotation"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.Annotation</code></a>

instances or dicts with compatible properties</li>

<li>annotationdefaults – When used in a template (as

layout.template.layout.annotationdefaults), sets the

default property values to use for elements of

layout.annotations</li>

<li>autosize – Determines whether or not a layout width or height that

has been left undefined by the user is initialized on

each relayout. Note that, regardless of this attribute,

an undefined layout width or height is always

initialized on the first call to plot.</li>

<li>bargap – Sets the gap (in plot fraction) between bars of

adjacent location coordinates.</li>

<li>bargroupgap – Sets the gap (in plot fraction) between bars of the

same location coordinate.</li>

<li>barmode – Determines how bars at the same location coordinate are

displayed on the graph. With “stack”, the bars are

stacked on top of one another With “relative”, the bars

are stacked on top of one another, with negative values

below the axis, positive values above With “group”, the

bars are plotted next to one another centered around

the shared location. With “overlay”, the bars are

plotted over one another, you might need to an

“opacity” to see multiple bars.</li>

<li>barnorm – Sets the normalization for bar traces on the graph.

With “fraction”, the value of each bar is divided by

the sum of all values at that location coordinate.

“percent” is the same but multiplied by 100 to show

percentages.</li>

<li>boxgap – Sets the gap (in plot fraction) between boxes of

adjacent location coordinates. Has no effect on traces

that have “width” set.</li>

<li>boxgroupgap – Sets the gap (in plot fraction) between boxes of the

same location coordinate. Has no effect on traces that

have “width” set.</li>

<li>boxmode – Determines how boxes at the same location coordinate

are displayed on the graph. If “group”, the boxes are

plotted next to one another centered around the shared

location. If “overlay”, the boxes are plotted over one

another, you might need to set “opacity” to see them

multiple boxes. Has no effect on traces that have

“width” set.</li>

<li>calendar – Sets the default calendar system to use for

interpreting and displaying dates throughout the plot.</li>

<li>clickmode – Determines the mode of single click interactions.

“event” is the default value and emits the

<code class="docutils literal notranslate">plotly_click</code> event. In addition this mode emits the

<code class="docutils literal notranslate">plotly_selected</code> event in drag modes “lasso” and

“select”, but with no event data attached (kept for

compatibility reasons). The “select” flag enables

selecting single data points via click. This mode also

supports persistent selections, meaning that pressing

Shift while clicking, adds to / subtracts from an

existing selection. “select” with <code class="docutils literal notranslate">hovermode</code>: “x” can

be confusing, consider explicitly setting <code class="docutils literal notranslate">hovermode</code>:

“closest” when using this feature. Selection events are

sent accordingly as long as “event” flag is set as

well. When the “event” flag is missing, <code class="docutils literal notranslate">plotly_click</code>

and <code class="docutils literal notranslate">plotly_selected</code> events are not fired.</li>

<li>coloraxis – <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.Coloraxis" title="plotly.graph_objects.layout.Coloraxis"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.Coloraxis</code></a> instance

or dict with compatible properties</li>

<li>colorscale – <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.Colorscale" title="plotly.graph_objects.layout.Colorscale"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.Colorscale</code></a>

instance or dict with compatible properties</li>

<li>colorway – Sets the default trace colors.</li>

<li>datarevision – If provided, a changed value tells <code class="docutils literal notranslate">Plotly.react</code> that

one or more data arrays has changed. This way you can

modify arrays in-place rather than making a complete

new copy for an incremental change. If NOT provided,

<code class="docutils literal notranslate">Plotly.react</code> assumes that data arrays are being

treated as immutable, thus any data array with a

different identity from its predecessor contains new

data.</li>

<li>direction – Legacy polar charts are deprecated! Please switch to

“polar” subplots. Sets the direction corresponding to

positive angles in legacy polar charts.</li>

<li>dragmode – Determines the mode of drag interactions. “select” and

“lasso” apply only to scatter traces with markers or

text. “orbit” and “turntable” apply only to 3D scenes.</li>

<li>editrevision – Controls persistence of user-driven changes in

<code class="docutils literal notranslate">editable: true</code> configuration, other than trace names

and axis titles. Defaults to <code class="docutils literal notranslate">layout.uirevision</code>.</li>

<li>extendfunnelareacolors – If <code class="docutils literal notranslate">true</code>, the funnelarea slice colors (whether given

by <code class="docutils literal notranslate">funnelareacolorway</code> or inherited from <code class="docutils literal notranslate">colorway</code>)

will be extended to three times its original length by

first repeating every color 20% lighter then each color

20% darker. This is intended to reduce the likelihood

of reusing the same color when you have many slices,

but you can set <code class="docutils literal notranslate">false</code> to disable. Colors provided in

the trace, using <code class="docutils literal notranslate">marker.colors</code>, are never extended.</li>

<li>extendpiecolors – If <code class="docutils literal notranslate">true</code>, the pie slice colors (whether given by

<code class="docutils literal notranslate">piecolorway</code> or inherited from <code class="docutils literal notranslate">colorway</code>) will be

extended to three times its original length by first

repeating every color 20% lighter then each color 20%

darker. This is intended to reduce the likelihood of

reusing the same color when you have many slices, but

you can set <code class="docutils literal notranslate">false</code> to disable. Colors provided in the

trace, using <code class="docutils literal notranslate">marker.colors</code>, are never extended.</li>

<li>extendsunburstcolors – If <code class="docutils literal notranslate">true</code>, the sunburst slice colors (whether given by

<code class="docutils literal notranslate">sunburstcolorway</code> or inherited from <code class="docutils literal notranslate">colorway</code>) will

be extended to three times its original length by first

repeating every color 20% lighter then each color 20%

darker. This is intended to reduce the likelihood of

reusing the same color when you have many slices, but

you can set <code class="docutils literal notranslate">false</code> to disable. Colors provided in the

trace, using <code class="docutils literal notranslate">marker.colors</code>, are never extended.</li>

<li>extendtreemapcolors – If <code class="docutils literal notranslate">true</code>, the treemap slice colors (whether given by

<code class="docutils literal notranslate">treemapcolorway</code> or inherited from <code class="docutils literal notranslate">colorway</code>) will be

extended to three times its original length by first

repeating every color 20% lighter then each color 20%

darker. This is intended to reduce the likelihood of

reusing the same color when you have many slices, but

you can set <code class="docutils literal notranslate">false</code> to disable. Colors provided in the

trace, using <code class="docutils literal notranslate">marker.colors</code>, are never extended.</li>

<li>font – Sets the global font. Note that fonts used in traces

and other layout components inherit from the global

font.</li>

<li>funnelareacolorway – Sets the default funnelarea slice colors. Defaults to

the main <code class="docutils literal notranslate">colorway</code> used for trace colors. If you

specify a new list here it can still be extended with

lighter and darker colors, see

<code class="docutils literal notranslate">extendfunnelareacolors</code>.</li>

<li>funnelgap – Sets the gap (in plot fraction) between bars of

adjacent location coordinates.</li>

<li>funnelgroupgap – Sets the gap (in plot fraction) between bars of the

same location coordinate.</li>

<li>funnelmode – Determines how bars at the same location coordinate are

displayed on the graph. With “stack”, the bars are

stacked on top of one another With “group”, the bars

are plotted next to one another centered around the

shared location. With “overlay”, the bars are plotted

over one another, you might need to an “opacity” to see

multiple bars.</li>

<li>geo – <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.Geo" title="plotly.graph_objects.layout.Geo"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.Geo</code></a> instance or

dict with compatible properties</li>

<li>grid – <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.Grid" title="plotly.graph_objects.layout.Grid"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.Grid</code></a> instance or

dict with compatible properties</li>

<li>height – Sets the plot’s height (in px).</li>

<li>hiddenlabels – hiddenlabels is the funnelarea & pie chart analog of

visible:’legendonly’ but it can contain many labels,

and can simultaneously hide slices from several

pies/funnelarea charts</li>

<li>hiddenlabelssrc – Sets the source reference on Chart Studio Cloud for

hiddenlabels .</li>

<li>hidesources – Determines whether or not a text link citing the data

source is placed at the bottom-right cored of the

figure. Has only an effect only on graphs that have

been generated via forked graphs from the Chart Studio

Cloud (at <a class="reference external" href="https://chart-studio.plotly.com">https://chart-studio.plotly.com</a> or on-

premise).</li>

<li>hoverdistance – Sets the default distance (in pixels) to look for data

to add hover labels (-1 means no cutoff, 0 means no

looking for data). This is only a real distance for

hovering on point-like objects, like scatter points.

For area-like objects (bars, scatter fills, etc)

hovering is on inside the area and off outside, but

these objects will not supersede hover on point-like

objects in case of conflict.</li>

<li>hoverlabel – <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.Hoverlabel" title="plotly.graph_objects.layout.Hoverlabel"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.Hoverlabel</code></a>

instance or dict with compatible properties</li>

<li>hovermode – Determines the mode of hover interactions. If

“closest”, a single hoverlabel will appear for the

“closest” point within the <code class="docutils literal notranslate">hoverdistance</code>. If “x” (or

“y”), multiple hoverlabels will appear for multiple

points at the “closest” x- (or y-) coordinate within

the <code class="docutils literal notranslate">hoverdistance</code>, with the caveat that no more than

one hoverlabel will appear per trace. If x unified

(or y unified), a single hoverlabel will appear

multiple points at the closest x- (or y-) coordinate

within the <code class="docutils literal notranslate">hoverdistance</code> with the caveat that no more

than one hoverlabel will appear per trace. In this

mode, spikelines are enabled by default perpendicular

to the specified axis. If false, hover interactions are

disabled. If <code class="docutils literal notranslate">clickmode</code> includes the “select” flag,

<code class="docutils literal notranslate">hovermode</code> defaults to “closest”. If <code class="docutils literal notranslate">clickmode</code> lacks

the “select” flag, it defaults to “x” or “y” (depending

on the trace’s <code class="docutils literal notranslate">orientation</code> value) for plots based on

cartesian coordinates. For anything else the default

value is “closest”.</li>

<li>images – A tuple of <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.Image" title="plotly.graph_objects.layout.Image"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.Image</code></a>

instances or dicts with compatible properties</li>

<li>imagedefaults – When used in a template (as

layout.template.layout.imagedefaults), sets the default

property values to use for elements of layout.images</li>

<li>legend – <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.Legend" title="plotly.graph_objects.layout.Legend"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.Legend</code></a> instance or

dict with compatible properties</li>

<li>mapbox – <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.Mapbox" title="plotly.graph_objects.layout.Mapbox"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.Mapbox</code></a> instance or

dict with compatible properties</li>

<li>margin – <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.Margin" title="plotly.graph_objects.layout.Margin"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.Margin</code></a> instance or

dict with compatible properties</li>

<li>meta – Assigns extra meta information that can be used in

various <code class="docutils literal notranslate">text</code> attributes. Attributes such as the

graph, axis and colorbar <code class="docutils literal notranslate">title.text</code>, annotation

<code class="docutils literal notranslate">text</code> <code class="docutils literal notranslate">trace.name</code> in legend items, <code class="docutils literal notranslate">rangeselector</code>,

<code class="docutils literal notranslate">updatemenus</code> and <code class="docutils literal notranslate">sliders</code> <code class="docutils literal notranslate">label</code> text all support

<code class="docutils literal notranslate">meta</code>. One can access <code class="docutils literal notranslate">meta</code> fields using template

strings: <code class="docutils literal notranslate">%{meta[i]}</code> where <code class="docutils literal notranslate">i</code> is the index of the

<code class="docutils literal notranslate">meta</code> item in question. <code class="docutils literal notranslate">meta</code> can also be an object

for example <code class="docutils literal notranslate">{key: value}</code> which can be accessed

%{meta[key]}.</li>

<li>metasrc – Sets the source reference on Chart Studio Cloud for

meta .</li>

<li>modebar – <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.Modebar" title="plotly.graph_objects.layout.Modebar"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.Modebar</code></a> instance

or dict with compatible properties</li>

<li>orientation – Legacy polar charts are deprecated! Please switch to

“polar” subplots. Rotates the entire polar by the given

angle in legacy polar charts.</li>

<li>paper_bgcolor – Sets the background color of the paper where the graph

is drawn.</li>

<li>piecolorway – Sets the default pie slice colors. Defaults to the main

<code class="docutils literal notranslate">colorway</code> used for trace colors. If you specify a new

list here it can still be extended with lighter and

darker colors, see <code class="docutils literal notranslate">extendpiecolors</code>.</li>

<li>plot_bgcolor – Sets the background color of the plotting area in-

between x and y axes.</li>

<li>polar – <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.Polar" title="plotly.graph_objects.layout.Polar"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.Polar</code></a> instance or

dict with compatible properties</li>

<li>radialaxis – <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.RadialAxis" title="plotly.graph_objects.layout.RadialAxis"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.RadialAxis</code></a>

instance or dict with compatible properties</li>

<li>scene – <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.Scene" title="plotly.graph_objects.layout.Scene"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.Scene</code></a> instance or

dict with compatible properties</li>

<li>selectdirection – When “dragmode” is set to “select”, this limits the

selection of the drag to horizontal, vertical or

diagonal. “h” only allows horizontal selection, “v”

only vertical, “d” only diagonal and “any” sets no

limit.</li>

<li>selectionrevision – Controls persistence of user-driven changes in selected

points from all traces.</li>

<li>separators – Sets the decimal and thousand separators. For example,

<a href="#id1">*</a>. * puts a ‘.’ before decimals and a space between

thousands. In English locales, dflt is “.,” but other

locales may alter this default.</li>

<li>shapes – A tuple of <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.Shape" title="plotly.graph_objects.layout.Shape"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.Shape</code></a>

instances or dicts with compatible properties</li>

<li>shapedefaults – When used in a template (as

layout.template.layout.shapedefaults), sets the default

property values to use for elements of layout.shapes</li>

<li>showlegend – Determines whether or not a legend is drawn. Default is

<code class="docutils literal notranslate">true</code> if there is a trace to show and any of these: a)

Two or more traces would by default be shown in the

legend. b) One pie trace is shown in the legend. c) One

trace is explicitly given with <code class="docutils literal notranslate">showlegend: true</code>.</li>

<li>sliders – A tuple of <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.Slider" title="plotly.graph_objects.layout.Slider"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.Slider</code></a>

instances or dicts with compatible properties</li>

<li>sliderdefaults – When used in a template (as

layout.template.layout.sliderdefaults), sets the

default property values to use for elements of

layout.sliders</li>

<li>spikedistance – Sets the default distance (in pixels) to look for data

to draw spikelines to (-1 means no cutoff, 0 means no

looking for data). As with hoverdistance, distance does

not apply to area-like objects. In addition, some

objects can be hovered on but will not generate

spikelines, such as scatter fills.</li>

<li>sunburstcolorway – Sets the default sunburst slice colors. Defaults to the

main <code class="docutils literal notranslate">colorway</code> used for trace colors. If you specify a

new list here it can still be extended with lighter and

darker colors, see <code class="docutils literal notranslate">extendsunburstcolors</code>.</li>

<li>template – Default attributes to be applied to the plot. This

should be a dict with format: <code class="docutils literal notranslate">{'layout':

layoutTemplate, 'data': {trace_type: [traceTemplate,

...], ...}}</code> where <code class="docutils literal notranslate">layoutTemplate</code> is a dict matching

the structure of <code class="docutils literal notranslate">figure.layout</code> and <code class="docutils literal notranslate">traceTemplate</code> is

a dict matching the structure of the trace with type

<code class="docutils literal notranslate">trace_type</code> (e.g. ‘scatter’). Alternatively, this may

be specified as an instance of

plotly.graph_objects.layout.Template. Trace templates are

applied cyclically to traces of each type. Container

arrays (eg <code class="docutils literal notranslate">annotations</code>) have special handling: An

object ending in <code class="docutils literal notranslate">defaults</code> (eg <code class="docutils literal notranslate">annotationdefaults</code>)

is applied to each array item. But if an item has a

<code class="docutils literal notranslate">templateitemname</code> key we look in the template array

for an item with matching <code class="docutils literal notranslate">name</code> and apply that

instead. If no matching <code class="docutils literal notranslate">name</code> is found we mark the

item invisible. Any named template item not referenced

is appended to the end of the array, so this can be

used to add a watermark annotation or a logo image, for

example. To omit one of these items on the plot, make

an item with matching <code class="docutils literal notranslate">templateitemname</code> and <code class="docutils literal notranslate">visible:

false</code>.</li>

<li>ternary – <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.Ternary" title="plotly.graph_objects.layout.Ternary"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.Ternary</code></a> instance

or dict with compatible properties</li>

<li>title – <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.Title" title="plotly.graph_objects.layout.Title"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.Title</code></a> instance or

dict with compatible properties</li>

<li>titlefont – Deprecated: Please use layout.title.font instead. Sets

the title font. Note that the title’s font used to be

customized by the now deprecated <code class="docutils literal notranslate">titlefont</code> attribute.</li>

<li>transition – Sets transition options used during Plotly.react

updates.</li>

<li>treemapcolorway – Sets the default treemap slice colors. Defaults to the

main <code class="docutils literal notranslate">colorway</code> used for trace colors. If you specify a

new list here it can still be extended with lighter and

darker colors, see <code class="docutils literal notranslate">extendtreemapcolors</code>.</li>

<li>uirevision – Used to allow user interactions with the plot to

persist after <code class="docutils literal notranslate">Plotly.react</code> calls that are unaware of

these interactions. If <code class="docutils literal notranslate">uirevision</code> is omitted, or if

it is given and it changed from the previous

<code class="docutils literal notranslate">Plotly.react</code> call, the exact new figure is used. If

<code class="docutils literal notranslate">uirevision</code> is truthy and did NOT change, any

attribute that has been affected by user interactions

and did not receive a different value in the new figure

will keep the interaction value. <code class="docutils literal notranslate">layout.uirevision</code>

attribute serves as the default for <code class="docutils literal notranslate">uirevision</code>

attributes in various sub-containers. For finer control

you can set these sub-attributes directly. For example,

if your app separately controls the data on the x and y

axes you might set <code class="docutils literal notranslate">xaxis.uirevision=*time*</code> and

<code class="docutils literal notranslate">yaxis.uirevision=*cost*</code>. Then if only the y data is

changed, you can update <code class="docutils literal notranslate">yaxis.uirevision=*quantity*</code>

and the y axis range will reset but the x axis range

will retain any user-driven zoom.</li>

<li>uniformtext – <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.Uniformtext" title="plotly.graph_objects.layout.Uniformtext"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.Uniformtext</code></a>

instance or dict with compatible properties</li>

<li>updatemenus – A tuple of

<a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.Updatemenu" title="plotly.graph_objects.layout.Updatemenu"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.Updatemenu</code></a>

instances or dicts with compatible properties</li>

<li>updatemenudefaults – When used in a template (as

layout.template.layout.updatemenudefaults), sets the

default property values to use for elements of

layout.updatemenus</li>

<li>violingap – Sets the gap (in plot fraction) between violins of

adjacent location coordinates. Has no effect on traces

that have “width” set.</li>

<li>violingroupgap – Sets the gap (in plot fraction) between violins of the

same location coordinate. Has no effect on traces that

have “width” set.</li>

<li>violinmode – Determines how violins at the same location coordinate

are displayed on the graph. If “group”, the violins are

plotted next to one another centered around the shared

location. If “overlay”, the violins are plotted over

one another, you might need to set “opacity” to see

them multiple violins. Has no effect on traces that

have “width” set.</li>

<li>waterfallgap – Sets the gap (in plot fraction) between bars of

adjacent location coordinates.</li>

<li>waterfallgroupgap – Sets the gap (in plot fraction) between bars of the

same location coordinate.</li>

<li>waterfallmode – Determines how bars at the same location coordinate are

displayed on the graph. With “group”, the bars are

plotted next to one another centered around the shared

location. With “overlay”, the bars are plotted over one

another, you might need to an “opacity” to see multiple

bars.</li>

<li>width – Sets the plot’s width (in px).</li>

<li>xaxis – <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.XAxis" title="plotly.graph_objects.layout.XAxis"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.XAxis</code></a> instance or

dict with compatible properties</li>

<li>yaxis – <a class="reference internal" href="plotly.graph_objects.layout.html#plotly.graph_objects.layout.YAxis" title="plotly.graph_objects.layout.YAxis"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.layout.YAxis</code></a> instance or

dict with compatible properties</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.Layout" title="plotly.graph_objects.Layout">Layout</a>

</dd>

</dl>

</dd></dl>

</div>

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

</colgroup>

<tbody>

<tr class="row-odd"><td><a class="reference internal" href="#module-plotly.graph_objects.layout" title="plotly.graph_objects.layout"><code class="xref py py-obj docutils literal notranslate">plotly.graph_objects.layout</code></a></td>

</tr>

</tbody>

</table>

</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.graph_objects.Layout.html

Latest commit

History

plotly.graph_objects.Layout.html

File metadata and controls