plotly.py-docs/generated/plotly.graph_objects.Contour.html at gh-pages · plotly/plotly.py-docs

History

2584 lines (2458 loc) · 191 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

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

<!DOCTYPE html>

<html>

<head>

<title>plotly.graph_objects.Contour — 6.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>.Contour</a></li>

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

</ul>

</li>

<li>

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

</a>

</li>

<li>

<a href="plotly.graph_objects.Table.html" title="Next Chapter: plotly.graph_objects.Table">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>.Contour<a class="headerlink" href="#plotly-graph-objs-contour" title="Permalink to this headline">¶</a></h1>

class <code class="sig-prename descclassname">plotly.graph_objects.</code><code class="sig-name descname">Contour</code>(arg=None, autocolorscale=None, autocontour=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, texttemplatefallback=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, **kwargs)<a class="headerlink" href="#plotly.graph_objects.Contour" title="Permalink to this definition">¶</a></dt>

<code class="sig-name descname">__init__</code>(arg=None, autocolorscale=None, autocontour=None, coloraxis=None, colorbar=None, colorscale=None, connectgaps=None, contours=None, customdata=None, customdatasrc=None, dx=None, dy=None, fillcolor=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoverongaps=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, line=None, meta=None, metasrc=None, name=None, ncontours=None, opacity=None, reversescale=None, showlegend=None, showscale=None, stream=None, text=None, textfont=None, textsrc=None, texttemplate=None, texttemplatefallback=None, transpose=None, uid=None, uirevision=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xhoverformat=None, xperiod=None, xperiod0=None, xperiodalignment=None, xsrc=None, xtype=None, y=None, y0=None, yaxis=None, ycalendar=None, yhoverformat=None, yperiod=None, yperiod0=None, yperiodalignment=None, ysrc=None, ytype=None, z=None, zauto=None, zhoverformat=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, **kwargs)<a class="headerlink" href="#plotly.graph_objects.Contour.__init__" title="Permalink to this definition">¶</a></dt>

<dd>Construct a new Contour object

The data from which contour lines are computed is set in <code class="docutils literal notranslate">z</code>.

Data in <code class="docutils literal notranslate">z</code> must be a 2D list of numbers. Say that <code class="docutils literal notranslate">z</code> has N

rows and M columns, then by default, these N rows correspond to

N y coordinates (set in <code class="docutils literal notranslate">y</code> or auto-generated) and the M

columns correspond to M x coordinates (set in <code class="docutils literal notranslate">x</code> or auto-

generated). By setting <code class="docutils literal notranslate">transpose</code> to True, the above behavior

is flipped.

<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.Contour" title="plotly.graph_objects.Contour"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.Contour</code></a></li>

<li>autocolorscale – Determines whether the colorscale is a default palette

(<code class="docutils literal notranslate">autocolorscale: true</code>) or the palette determined by

<code class="docutils literal notranslate">colorscale</code>. In case <code class="docutils literal notranslate">colorscale</code> is unspecified or

<code class="docutils literal notranslate">autocolorscale</code> is true, the default palette will be

chosen according to whether numbers in the <code class="docutils literal notranslate">color</code>

array are all positive, all negative or mixed.</li>

<li>autocontour – Determines whether or not the contour level attributes

are picked by an algorithm. If True, the number of

contour levels can be set in <code class="docutils literal notranslate">ncontours</code>. If False, set

the contour level attributes in <code class="docutils literal notranslate">contours</code>.</li>

<li>coloraxis – Sets a reference to a shared color axis. References to

these shared color axes are “coloraxis”, “coloraxis2”,

“coloraxis3”, etc. Settings for these shared color axes

are set in the layout, under <code class="docutils literal notranslate">layout.coloraxis</code>,

<code class="docutils literal notranslate">layout.coloraxis2</code>, etc. Note that multiple color

scales can be linked to the same color axis.</li>

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

or dict with compatible properties</li>

<li>colorscale – Sets the colorscale. The colorscale must be an array

containing arrays mapping a normalized value to an rgb,

rgba, hex, hsl, hsv, or named color string. At minimum,

a mapping for the lowest (0) and highest (1) values are

required. For example, <code class="docutils literal notranslate">[[0, 'rgb(0,0,255)'], [1,

'rgb(255,0,0)']]</code>. To control the bounds of the

colorscale in color space, use <code class="docutils literal notranslate">zmin</code> and <code class="docutils literal notranslate">zmax</code>.

Alternatively, <code class="docutils literal notranslate">colorscale</code> may be a palette name

string of the following list: Blackbody,Bluered,Blues,C

ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl

and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.</li>

<li>connectgaps – Determines whether or not gaps (i.e. {nan} or missing

values) in the <code class="docutils literal notranslate">z</code> data are filled in. It is defaulted

to true if <code class="docutils literal notranslate">z</code> is a one dimensional array otherwise it

is defaulted to false.</li>

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

or dict with compatible properties</li>

<li>customdata – Assigns extra data each datum. This may be useful when

listening to hover, click and selection events. Note

that, “scatter” traces also appends customdata items in

the markers DOM elements</li>

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

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

<li>dx – Sets the x coordinate step. See <code class="docutils literal notranslate">x0</code> for more info.</li>

<li>dy – Sets the y coordinate step. See <code class="docutils literal notranslate">y0</code> for more info.</li>

<li>fillcolor – Sets the fill color if <code class="docutils literal notranslate">contours.type</code> is “constraint”.

Defaults to a half-transparent variant of the line

color, marker color, or marker line color, whichever is

available.</li>

<li>hoverinfo – Determines which trace information appear on hover. If

<code class="docutils literal notranslate">none</code> or <code class="docutils literal notranslate">skip</code> are set, no information is displayed

upon hovering. But, if <code class="docutils literal notranslate">none</code> is set, click and hover

events are still fired.</li>

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

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

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

instance or dict with compatible properties</li>

<li>hoverongaps – Determines whether or not gaps (i.e. {nan} or missing

values) in the <code class="docutils literal notranslate">z</code> data have hover labels associated

with them.</li>

<li>hovertemplate – Template string used for rendering the information that

appear on hover box. Note that this will override

<code class="docutils literal notranslate">hoverinfo</code>. Variables are inserted using %{variable},

for example “y: %{y}” as well as %{xother}, {%_xother},

{%_xother_}, {%xother_}. When showing info for several

points, “xother” will be added to those with different

x positions from the first point. An underscore before

or after “(x|y)other” will add a space on that side,

only when this field is shown. Numbers are formatted

using d3-format’s syntax %{variable:d3-format}, for

example “Price: %{y:$.2f}”.

https://github.com/d3/d3-format/tree/v1.4.5#d3-format

for details on the formatting syntax. Dates are

formatted using d3-time-format’s syntax

%{variable|d3-time-format}, for example “Day:

%{2019-01-01|%A}”. https://github.com/d3/d3-time-

format/tree/v2.2.3#locale_format for details on the

date formatting syntax. Variables that can’t be found

will be replaced with the specifier. For example, a

template of “data: %{x}, %{y}” will result in a value

of “data: 1, %{y}” if x is 1 and y is missing.

Variables with an undefined value will be replaced with

the fallback value. The variables available in

<code class="docutils literal notranslate">hovertemplate</code> are the ones emitted as event data

described at this link

<a class="reference external" href="https://plotly.com/javascript/plotlyjs-events/#event">https://plotly.com/javascript/plotlyjs-events/#event</a>-

data. Additionally, all attributes that can be

specified per-point (the ones that are <code class="docutils literal notranslate">arrayOk: true</code>)

are available. Anything contained in tag <code class="docutils literal notranslate"><extra></code> is

displayed in the secondary box, for example

<code class="docutils literal notranslate"><extra>%{fullData.name}</extra></code>. To hide the

secondary box completely, use an empty tag

<li>hovertemplatefallback – Fallback string that’s displayed when a variable

referenced in a template is missing. If the boolean

value ‘false’ is passed in, the specifier with the

missing variable will be displayed.</li>

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

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

<li>hovertext – Same as <code class="docutils literal notranslate">text</code>.</li>

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

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

<li>ids – Assigns id labels to each datum. These ids for object

constancy of data points during animation. Should be an

array of strings, not numbers or any other type.</li>

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

<li>legend – Sets the reference to a legend to show this trace in.

References to these legends are “legend”, “legend2”,

“legend3”, etc. Settings for these legends are set in

the layout, under <code class="docutils literal notranslate">layout.legend</code>, <code class="docutils literal notranslate">layout.legend2</code>,

etc.</li>

<li>legendgroup – Sets the legend group for this trace. Traces and shapes

part of the same legend group hide/show at the same

time when toggling legend items.</li>

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

instance or dict with compatible properties</li>

<li>legendrank – Sets the legend rank for this trace. Items and groups

with smaller ranks are presented on top/left side while

with “reversed” <code class="docutils literal notranslate">legend.traceorder</code> they are on

bottom/right side. The default legendrank is 1000, so

that you can use ranks less than 1000 to place certain

items before all unranked items, and ranks greater than

1000 to go after all unranked items. When having

unranked or equal rank items shapes would be displayed

after traces i.e. according to their order in data and

layout.</li>

<li>legendwidth – Sets the width (in px or fraction) of the legend for

this trace.</li>

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

dict with compatible properties</li>

<li>meta – Assigns extra meta information associated with this

trace that can be used in various text attributes.

Attributes such as trace <code class="docutils literal notranslate">name</code>, 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">rangeselector</code>, <code class="docutils literal notranslate">updatemenues</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>. To access the trace <code class="docutils literal notranslate">meta</code>

values in an attribute in the same trace, simply use

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

<code class="docutils literal notranslate">meta</code> item in question. To access trace <code class="docutils literal notranslate">meta</code> in

layout attributes, use <code class="docutils literal notranslate">%{data[n[.meta[i]}</code> where <code class="docutils literal notranslate">i</code>

is the index or key of the <code class="docutils literal notranslate">meta</code> and <code class="docutils literal notranslate">n</code> is the trace

index.</li>

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

<li>name – Sets the trace name. The trace name appears as the

legend item and on hover.</li>

<li>ncontours – Sets the maximum number of contour levels. The actual

number of contours will be chosen automatically to be

less than or equal to the value of <code class="docutils literal notranslate">ncontours</code>. Has an

effect only if <code class="docutils literal notranslate">autocontour</code> is True or if

<code class="docutils literal notranslate">contours.size</code> is missing.</li>

<li>opacity – Sets the opacity of the trace.</li>

<li>reversescale – Reverses the color mapping if true. If true, <code class="docutils literal notranslate">zmin</code>

will correspond to the last color in the array and

<code class="docutils literal notranslate">zmax</code> will correspond to the first color.</li>

<li>showlegend – Determines whether or not an item corresponding to this

trace is shown in the legend.</li>

<li>showscale – Determines whether or not a colorbar is displayed for

this trace.</li>

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

or dict with compatible properties</li>

<li>text – Sets the text elements associated with each z value.</li>

<li>textfont – For this trace it only has an effect if <code class="docutils literal notranslate">coloring</code> is

set to “heatmap”. Sets the text font.</li>

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

<li>texttemplate – For this trace it only has an effect if <code class="docutils literal notranslate">coloring</code> is

set to “heatmap”. Template string used for rendering

the information text that appears on points. Note that

this will override <code class="docutils literal notranslate">textinfo</code>. Variables are inserted

using %{variable}, for example “y: %{y}”. Numbers are

formatted using d3-format’s syntax

%{variable:d3-format}, for example “Price: %{y:$.2f}”.

https://github.com/d3/d3-format/tree/v1.4.5#d3-format

for details on the formatting syntax. Dates are

formatted using d3-time-format’s syntax

%{variable|d3-time-format}, for example “Day:

%{2019-01-01|%A}”. https://github.com/d3/d3-time-

format/tree/v2.2.3#locale_format for details on the

date formatting syntax. Variables that can’t be found

will be replaced with the specifier. For example, a

template of “data: %{x}, %{y}” will result in a value

of “data: 1, %{y}” if x is 1 and y is missing.

Variables with an undefined value will be replaced with

the fallback value. All attributes that can be

specified per-point (the ones that are <code class="docutils literal notranslate">arrayOk: true</code>)

are available. Finally, the template string has access

to variables <code class="docutils literal notranslate">x</code>, <code class="docutils literal notranslate">y</code>, <code class="docutils literal notranslate">z</code> and <code class="docutils literal notranslate">text</code>.</li>

<li>texttemplatefallback – Fallback string that’s displayed when a variable

referenced in a template is missing. If the boolean

value ‘false’ is passed in, the specifier with the

missing variable will be displayed.</li>

<li>transpose – Transposes the z data.</li>

<li>uid – Assign an id to this trace, Use this to provide object

constancy between traces during animations and

transitions.</li>

<li>uirevision – Controls persistence of some user-driven changes to the

trace: <code class="docutils literal notranslate">constraintrange</code> in <code class="docutils literal notranslate">parcoords</code> traces, as well

as some <code class="docutils literal notranslate">editable: true</code> modifications such as <code class="docutils literal notranslate">name</code>

and <code class="docutils literal notranslate">colorbar.title</code>. Defaults to <code class="docutils literal notranslate">layout.uirevision</code>.

Note that other user-driven trace attribute changes are

controlled by <code class="docutils literal notranslate">layout</code> attributes: <code class="docutils literal notranslate">trace.visible</code> is

controlled by <code class="docutils literal notranslate">layout.legend.uirevision</code>,

<code class="docutils literal notranslate">selectedpoints</code> is controlled by

<code class="docutils literal notranslate">layout.selectionrevision</code>, and <code class="docutils literal notranslate">colorbar.(x|y)</code>

(accessible with <code class="docutils literal notranslate">config: {editable: true}</code>) is

controlled by <code class="docutils literal notranslate">layout.editrevision</code>. Trace changes are

tracked by <code class="docutils literal notranslate">uid</code>, which only falls back on trace index

if no <code class="docutils literal notranslate">uid</code> is provided. So if your app can add/remove

traces before the end of the <code class="docutils literal notranslate">data</code> array, such that

the same trace has a different index, you can still

preserve user-driven changes if you give each trace a

<code class="docutils literal notranslate">uid</code> that stays with it as it moves.</li>

<li>visible – Determines whether or not this trace is visible. If

“legendonly”, the trace is not drawn, but can appear as

a legend item (provided that the legend itself is

visible).</li>

<li>x – Sets the x coordinates.</li>

<li>x0 – Alternate to <code class="docutils literal notranslate">x</code>. Builds a linear space of x

coordinates. Use with <code class="docutils literal notranslate">dx</code> where <code class="docutils literal notranslate">x0</code> is the starting

coordinate and <code class="docutils literal notranslate">dx</code> the step.</li>

<li>xaxis – Sets a reference between this trace’s x coordinates and

a 2D cartesian x axis. If “x” (the default value), the

x coordinates refer to <code class="docutils literal notranslate">layout.xaxis</code>. If “x2”, the x

coordinates refer to <code class="docutils literal notranslate">layout.xaxis2</code>, and so on.</li>

<li>xcalendar – Sets the calendar system to use with <code class="docutils literal notranslate">x</code> date data.</li>

<li>xhoverformat – Sets the hover text formatting rulefor <code class="docutils literal notranslate">x</code> using d3

formatting mini-languages which are very similar to

those in Python. For numbers, see:

<a class="reference external" href="https://github.com/d3/d3-format/tree/v1.4.5#d3-format">https://github.com/d3/d3-format/tree/v1.4.5#d3-format</a>.

And for dates see: <a class="reference external" href="https://github.com/d3/d3-time">https://github.com/d3/d3-time</a>-

format/tree/v2.2.3#locale_format. We add two items to

d3’s date formatter: “%h” for half of the year as a

decimal number as well as “%{n}f” for fractional

seconds with n digits. For example, 2016-10-13

09:15:23.456 with tickformat “%H~%M~%S.%2f” would

display <a href="#id1">*</a>09~15~23.46*By default the values are

formatted using <code class="docutils literal notranslate">xaxis.hoverformat</code>.</li>

<li>xperiod – Only relevant when the axis <code class="docutils literal notranslate">type</code> is “date”. Sets the

period positioning in milliseconds or “M<n>” on the x

axis. Special values in the form of “M<n>” could be

used to declare the number of months. In this case <code class="docutils literal notranslate">n</code>

must be a positive integer.</li>

<li>xperiod0 – Only relevant when the axis <code class="docutils literal notranslate">type</code> is “date”. Sets the

base for period positioning in milliseconds or date

string on the x0 axis. When <code class="docutils literal notranslate">x0period</code> is round number

of weeks, the <code class="docutils literal notranslate">x0period0</code> by default would be on a

Sunday i.e. 2000-01-02, otherwise it would be at

2000-01-01.</li>

<li>xperiodalignment – Only relevant when the axis <code class="docutils literal notranslate">type</code> is “date”. Sets the

alignment of data points on the x axis.</li>

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

<li>xtype – If “array”, the heatmap’s x coordinates are given by

“x” (the default behavior when <code class="docutils literal notranslate">x</code> is provided). If

“scaled”, the heatmap’s x coordinates are given by “x0”

and “dx” (the default behavior when <code class="docutils literal notranslate">x</code> is not

provided).</li>

<li>y – Sets the y coordinates.</li>

<li>y0 – Alternate to <code class="docutils literal notranslate">y</code>. Builds a linear space of y

coordinates. Use with <code class="docutils literal notranslate">dy</code> where <code class="docutils literal notranslate">y0</code> is the starting

coordinate and <code class="docutils literal notranslate">dy</code> the step.</li>

<li>yaxis – Sets a reference between this trace’s y coordinates and

a 2D cartesian y axis. If “y” (the default value), the

y coordinates refer to <code class="docutils literal notranslate">layout.yaxis</code>. If “y2”, the y

coordinates refer to <code class="docutils literal notranslate">layout.yaxis2</code>, and so on.</li>

<li>ycalendar – Sets the calendar system to use with <code class="docutils literal notranslate">y</code> date data.</li>

<li>yhoverformat – Sets the hover text formatting rulefor <code class="docutils literal notranslate">y</code> using d3

formatting mini-languages which are very similar to

those in Python. For numbers, see:

<a class="reference external" href="https://github.com/d3/d3-format/tree/v1.4.5#d3-format">https://github.com/d3/d3-format/tree/v1.4.5#d3-format</a>.

And for dates see: <a class="reference external" href="https://github.com/d3/d3-time">https://github.com/d3/d3-time</a>-

format/tree/v2.2.3#locale_format. We add two items to

d3’s date formatter: “%h” for half of the year as a

decimal number as well as “%{n}f” for fractional

seconds with n digits. For example, 2016-10-13

09:15:23.456 with tickformat “%H~%M~%S.%2f” would

display <a href="#id3">*</a>09~15~23.46*By default the values are

formatted using <code class="docutils literal notranslate">yaxis.hoverformat</code>.</li>

<li>yperiod – Only relevant when the axis <code class="docutils literal notranslate">type</code> is “date”. Sets the

period positioning in milliseconds or “M<n>” on the y

axis. Special values in the form of “M<n>” could be

used to declare the number of months. In this case <code class="docutils literal notranslate">n</code>

must be a positive integer.</li>

<li>yperiod0 – Only relevant when the axis <code class="docutils literal notranslate">type</code> is “date”. Sets the

base for period positioning in milliseconds or date

string on the y0 axis. When <code class="docutils literal notranslate">y0period</code> is round number

of weeks, the <code class="docutils literal notranslate">y0period0</code> by default would be on a

Sunday i.e. 2000-01-02, otherwise it would be at

2000-01-01.</li>

<li>yperiodalignment – Only relevant when the axis <code class="docutils literal notranslate">type</code> is “date”. Sets the

alignment of data points on the y axis.</li>

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

<li>ytype – If “array”, the heatmap’s y coordinates are given by

“y” (the default behavior when <code class="docutils literal notranslate">y</code> is provided) If

“scaled”, the heatmap’s y coordinates are given by “y0”

and “dy” (the default behavior when <code class="docutils literal notranslate">y</code> is not

provided)</li>

<li>zauto – Determines whether or not the color domain is computed

with respect to the input data (here in <code class="docutils literal notranslate">z</code>) or the

bounds set in <code class="docutils literal notranslate">zmin</code> and <code class="docutils literal notranslate">zmax</code> Defaults to <code class="docutils literal notranslate">false</code>

when <code class="docutils literal notranslate">zmin</code> and <code class="docutils literal notranslate">zmax</code> are set by the user.</li>

<li>zhoverformat – Sets the hover text formatting rulefor <code class="docutils literal notranslate">z</code> using d3

formatting mini-languages which are very similar to

those in Python. For numbers, see: <a class="reference external" href="https://github.com/d">https://github.com/d</a>

3/d3-format/tree/v1.4.5#d3-format.By default the values

are formatted using generic number format.</li>

<li>zmax – Sets the upper bound of the color domain. Value should

have the same units as in <code class="docutils literal notranslate">z</code> and if set, <code class="docutils literal notranslate">zmin</code> must

be set as well.</li>

<li>zmid – Sets the mid-point of the color domain by scaling

<code class="docutils literal notranslate">zmin</code> and/or <code class="docutils literal notranslate">zmax</code> to be equidistant to this point.

Value should have the same units as in <code class="docutils literal notranslate">z</code>. Has no

effect when <code class="docutils literal notranslate">zauto</code> is <code class="docutils literal notranslate">false</code>.</li>

<li>zmin – Sets the lower bound of the color domain. Value should

have the same units as in <code class="docutils literal notranslate">z</code> and if set, <code class="docutils literal notranslate">zmax</code> must

be set as well.</li>

<li>zorder – Sets the layer on which this trace is displayed,

relative to other SVG traces on the same subplot. SVG

traces with higher <code class="docutils literal notranslate">zorder</code> appear in front of those

with lower <code class="docutils literal notranslate">zorder</code>.</li>

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

</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.Contour" title="plotly.graph_objects.Contour">Contour</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>.contour<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h1>

</colgroup>

<tbody>

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

</tr>

</tbody>

</table>

class <code class="sig-prename descclassname">plotly.graph_objects.contour.</code><code class="sig-name descname">ColorBar</code>(arg=None, bgcolor=None, bordercolor=None, borderwidth=None, dtick=None, exponentformat=None, labelalias=None, len=None, lenmode=None, minexponent=None, nticks=None, orientation=None, outlinecolor=None, outlinewidth=None, separatethousands=None, showexponent=None, showticklabels=None, showtickprefix=None, showticksuffix=None, thickness=None, thicknessmode=None, tick0=None, tickangle=None, tickcolor=None, tickfont=None, tickformat=None, tickformatstops=None, tickformatstopdefaults=None, ticklabeloverflow=None, ticklabelposition=None, ticklabelstep=None, ticklen=None, tickmode=None, tickprefix=None, ticks=None, ticksuffix=None, ticktext=None, ticktextsrc=None, tickvals=None, tickvalssrc=None, tickwidth=None, title=None, x=None, xanchor=None, xpad=None, xref=None, y=None, yanchor=None, ypad=None, yref=None, **kwargs)<a class="headerlink" href="#plotly.graph_objects.contour.ColorBar" title="Permalink to this definition">¶</a></dt>

property <code class="sig-name descname">bgcolor</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.bgcolor" title="Permalink to this definition">¶</a></dt>

<dd>Sets the color of padded area.

<dt>The ‘bgcolor’ property is a color and may be specified as:</dt><dd><ul class="simple">

<li>A hex string (e.g. ‘#ff0000’)</li>

<li>An rgb/rgba string (e.g. ‘rgb(255,0,0)’)</li>

<li>An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)</li>

<li>An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)</li>

<li>A named CSS color: see <a class="reference external" href="https://plotly.com/python/css-colors/">https://plotly.com/python/css-colors/</a> for a list</li>

</ul>

</dd>

</dl>

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

</dd>

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

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">bordercolor</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.bordercolor" title="Permalink to this definition">¶</a></dt>

<dd>Sets the axis line color.

<dt>The ‘bordercolor’ property is a color and may be specified as:</dt><dd><ul class="simple">

<li>A hex string (e.g. ‘#ff0000’)</li>

<li>An rgb/rgba string (e.g. ‘rgb(255,0,0)’)</li>

<li>An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)</li>

<li>An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)</li>

<li>A named CSS color: see <a class="reference external" href="https://plotly.com/python/css-colors/">https://plotly.com/python/css-colors/</a> for a list</li>

</ul>

</dd>

</dl>

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

</dd>

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

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">borderwidth</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.borderwidth" title="Permalink to this definition">¶</a></dt>

<dd>Sets the width (in px) or the border enclosing this color bar.

<dt>The ‘borderwidth’ property is a number and may be specified as:</dt><dd><ul class="simple">

<li>An int or float in the interval [0, inf]</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">int|float

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">dtick</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.dtick" title="Permalink to this definition">¶</a></dt>

<dd>Sets the step in-between ticks on this axis. Use with <code class="docutils literal notranslate">tick0</code>.

Must be a positive number, or special strings available to

“log” and “date” axes. If the axis <code class="docutils literal notranslate">type</code> is “log”, then ticks

are set every 10^(n*dtick) where n is the tick number. For

example, to set a tick mark at 1, 10, 100, 1000, … set dtick

to 1. To set tick marks at 1, 100, 10000, … set dtick to 2.

To set tick marks at 1, 5, 25, 125, 625, 3125, … set dtick to

log_10(5), or 0.69897000433. “log” has several special values;

“L<f>”, where <code class="docutils literal notranslate">f</code> is a positive number, gives ticks linearly

spaced in value (but not position). For example <code class="docutils literal notranslate">tick0</code> = 0.1,

<code class="docutils literal notranslate">dtick</code> = “L0.5” will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To

show powers of 10 plus small digits between, use “D1” (all

digits) or “D2” (only 2 and 5). <code class="docutils literal notranslate">tick0</code> is ignored for “D1” and

“D2”. If the axis <code class="docutils literal notranslate">type</code> is “date”, then you must convert the

time to milliseconds. For example, to set the interval between

ticks to one day, set <code class="docutils literal notranslate">dtick</code> to 86400000.0. “date” also has

special values “M<n>” gives ticks spaced by a number of months.

<code class="docutils literal notranslate">n</code> must be a positive integer. To set ticks on the 15th of

every third month, set <code class="docutils literal notranslate">tick0</code> to “2000-01-15” and <code class="docutils literal notranslate">dtick</code> to

“M3”. To set ticks every 4 years, set <code class="docutils literal notranslate">dtick</code> to “M48”

The ‘dtick’ property accepts values of any type

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

</dd>

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

<dd class="field-even">Any

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">exponentformat</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.exponentformat" title="Permalink to this definition">¶</a></dt>

<dd>Determines a formatting rule for the tick exponents. For

example, consider the number 1,000,000,000. If “none”, it

appears as 1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If

“power”, 1x10^9 (with 9 in a super script). If “SI”, 1G. If

“B”, 1B. “SI” uses prefixes from “femto” f (10^-15) to “tera” T

(10^12). SI extended covers instead the full SI range from

“quecto” q (10^-30) to “quetta” Q (10^30). If “SI” or SI

extended is used and the exponent is beyond the above ranges,

the formatting rule will automatically be switched to the power

notation.

<dt>The ‘exponentformat’ property is an enumeration that may be specified as:</dt><dd><ul class="simple">

<dt>One of the following enumeration values:</dt><dd>[‘none’, ‘e’, ‘E’, ‘power’, ‘SI’, ‘B’, ‘SI extended’]

</dd>

</dl>

</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">Any

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">labelalias</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.labelalias" title="Permalink to this definition">¶</a></dt>

<dd>Replacement text for specific tick or hover labels. For example

using {US: ‘USA’, CA: ‘Canada’} changes US to USA and CA to

Canada. The labels we would have shown must match the keys

exactly, after adding any tickprefix or ticksuffix. For

negative numbers the minus sign symbol used (U+2212) is wider

than the regular ascii dash. That means you need to use −1

instead of -1. labelalias can be used with any axis type, and

both keys (if needed) and values (if desired) can include html-

like tags or MathJax.

The ‘labelalias’ property accepts values of any type

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

</dd>

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

<dd class="field-even">Any

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">len</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.len" title="Permalink to this definition">¶</a></dt>

<dd>Sets the length of the color bar This measure excludes the

padding of both ends. That is, the color bar length is this

length minus the padding on both ends.

<dt>The ‘len’ property is a number and may be specified as:</dt><dd><ul class="simple">

<li>An int or float in the interval [0, inf]</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">int|float

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">lenmode</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.lenmode" title="Permalink to this definition">¶</a></dt>

<dd>Determines whether this color bar’s length (i.e. the measure in

the color variation direction) is set in units of plot

“fraction” or in <a href="#id6">*</a>pixels. Use <code class="docutils literal notranslate">len</code> to set the value.

<dt>The ‘lenmode’ property is an enumeration that may be specified as:</dt><dd><ul class="simple">

<dt>One of the following enumeration values:</dt><dd>[‘fraction’, ‘pixels’]

</dd>

</dl>

</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">Any

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">minexponent</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.minexponent" title="Permalink to this definition">¶</a></dt>

<dd>Hide SI prefix for 10^n if <a href="#id8">|n|</a> is below this number. This only

has an effect when <code class="docutils literal notranslate">tickformat</code> is “SI” or “B”.

<dt>The ‘minexponent’ property is a number and may be specified as:</dt><dd><ul class="simple">

<li>An int or float in the interval [0, inf]</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">int|float

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">nticks</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.nticks" title="Permalink to this definition">¶</a></dt>

<dd>Specifies the maximum number of ticks for the particular axis.

The actual number of ticks will be chosen automatically to be

less than or equal to <code class="docutils literal notranslate">nticks</code>. Has an effect only if

<code class="docutils literal notranslate">tickmode</code> is set to “auto”.

<dt>The ‘nticks’ property is a integer and may be specified as:</dt><dd><ul class="simple">

<li>An int (or float that will be cast to an int)

in the interval [0, 9223372036854775807]</li>

</ul>

</dd>

</dl>

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

</dd>

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

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">orientation</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.orientation" title="Permalink to this definition">¶</a></dt>

<dd>Sets the orientation of the colorbar.

<dt>The ‘orientation’ property is an enumeration that may be specified as:</dt><dd><ul class="simple">

<dt>One of the following enumeration values:</dt><dd>[‘h’, ‘v’]

</dd>

</dl>

</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">Any

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">outlinecolor</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.outlinecolor" title="Permalink to this definition">¶</a></dt>

<dd>Sets the axis line color.

<dt>The ‘outlinecolor’ property is a color and may be specified as:</dt><dd><ul class="simple">

<li>A hex string (e.g. ‘#ff0000’)</li>

<li>An rgb/rgba string (e.g. ‘rgb(255,0,0)’)</li>

<li>An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)</li>

<li>An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)</li>

<li>A named CSS color: see <a class="reference external" href="https://plotly.com/python/css-colors/">https://plotly.com/python/css-colors/</a> for a list</li>

</ul>

</dd>

</dl>

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

</dd>

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

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">outlinewidth</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.outlinewidth" title="Permalink to this definition">¶</a></dt>

<dd>Sets the width (in px) of the axis line.

<dt>The ‘outlinewidth’ property is a number and may be specified as:</dt><dd><ul class="simple">

<li>An int or float in the interval [0, inf]</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">int|float

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">separatethousands</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.separatethousands" title="Permalink to this definition">¶</a></dt>

<dd>If “true”, even 4-digit integers are separated

<dt>The ‘separatethousands’ property is a boolean and must be specified as:</dt><dd><ul class="simple">

<li>A boolean value: True or False</li>

</ul>

</dd>

</dl>

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

</dd>

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

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">showexponent</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.showexponent" title="Permalink to this definition">¶</a></dt>

<dd>If “all”, all exponents are shown besides their significands.

If “first”, only the exponent of the first tick is shown. If

“last”, only the exponent of the last tick is shown. If “none”,

no exponents appear.

<dt>The ‘showexponent’ property is an enumeration that may be specified as:</dt><dd><ul class="simple">

<dt>One of the following enumeration values:</dt><dd>[‘all’, ‘first’, ‘last’, ‘none’]

</dd>

</dl>

</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">Any

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">showticklabels</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.showticklabels" title="Permalink to this definition">¶</a></dt>

<dd>Determines whether or not the tick labels are drawn.

<dt>The ‘showticklabels’ property is a boolean and must be specified as:</dt><dd><ul class="simple">

<li>A boolean value: True or False</li>

</ul>

</dd>

</dl>

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

</dd>

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

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">showtickprefix</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.showtickprefix" title="Permalink to this definition">¶</a></dt>

<dd>If “all”, all tick labels are displayed with a prefix. If

“first”, only the first tick is displayed with a prefix. If

“last”, only the last tick is displayed with a suffix. If

“none”, tick prefixes are hidden.

<dt>The ‘showtickprefix’ property is an enumeration that may be specified as:</dt><dd><ul class="simple">

<dt>One of the following enumeration values:</dt><dd>[‘all’, ‘first’, ‘last’, ‘none’]

</dd>

</dl>

</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">Any

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">showticksuffix</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.showticksuffix" title="Permalink to this definition">¶</a></dt>

<dd>Same as <code class="docutils literal notranslate">showtickprefix</code> but for tick suffixes.

<dt>The ‘showticksuffix’ property is an enumeration that may be specified as:</dt><dd><ul class="simple">

<dt>One of the following enumeration values:</dt><dd>[‘all’, ‘first’, ‘last’, ‘none’]

</dd>

</dl>

</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">Any

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">thickness</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.thickness" title="Permalink to this definition">¶</a></dt>

<dd>Sets the thickness of the color bar This measure excludes the

size of the padding, ticks and labels.

<dt>The ‘thickness’ property is a number and may be specified as:</dt><dd><ul class="simple">

<li>An int or float in the interval [0, inf]</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">int|float

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">thicknessmode</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.thicknessmode" title="Permalink to this definition">¶</a></dt>

<dd>Determines whether this color bar’s thickness (i.e. the measure

in the constant color direction) is set in units of plot

“fraction” or in “pixels”. Use <code class="docutils literal notranslate">thickness</code> to set the value.

<dt>The ‘thicknessmode’ property is an enumeration that may be specified as:</dt><dd><ul class="simple">

<dt>One of the following enumeration values:</dt><dd>[‘fraction’, ‘pixels’]

</dd>

</dl>

</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">Any

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">tick0</code><a class="headerlink" href="#plotly.graph_objects.contour.ColorBar.tick0" title="Permalink to this definition">¶</a></dt>

<dd>Sets the placement of the first tick on this axis. Use with

<code class="docutils literal notranslate">dtick</code>. If the axis <code class="docutils literal notranslate">type</code> is “log”, then you must take the

log of your starting tick (e.g. to set the starting tick to

100, set the <code class="docutils literal notranslate">tick0</code> to 2) except when <code class="docutils literal notranslate">dtick`=*L<f>* (see

`dtick</code> for more info). If the axis <code class="docutils literal notranslate">type</code> is “date”, it should

be a date string, like date data. If the axis <code class="docutils literal notranslate">type</code> is

“category”, it should be a number, using the scale where each

category is assigned a serial number from zero in the order it

appears.

The ‘tick0’ property accepts values of any type

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

</dd>

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

<dd class="field-even">Any

</dd>

</dl>

</dd></dl>

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

plotly.graph_objects.Contour.html

Latest commit

History

plotly.graph_objects.Contour.html

File metadata and controls