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

History

2122 lines (2002 loc) · 153 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.Pie — 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>.Pie</a></li>

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

</ul>

</li>

<li>

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

</a>

</li>

<li>

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

class <code class="sig-prename descclassname">plotly.graph_objects.</code><code class="sig-name descname">Pie</code>(arg=None, automargin=None, customdata=None, customdatasrc=None, direction=None, dlabel=None, domain=None, hole=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendsrc=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, pull=None, pullsrc=None, rotation=None, scalegroup=None, showlegend=None, showlegendsrc=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)<a class="headerlink" href="#plotly.graph_objects.Pie" title="Permalink to this definition">¶</a></dt>

<code class="sig-name descname">__init__</code>(arg=None, automargin=None, customdata=None, customdatasrc=None, direction=None, dlabel=None, domain=None, hole=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, insidetextorientation=None, label0=None, labels=None, labelssrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendsrc=None, legendwidth=None, marker=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, pull=None, pullsrc=None, rotation=None, scalegroup=None, showlegend=None, showlegendsrc=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatefallback=None, texttemplatesrc=None, title=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)<a class="headerlink" href="#plotly.graph_objects.Pie.__init__" title="Permalink to this definition">¶</a></dt>

<dd>Construct a new Pie object

A data visualized by the sectors of the pie is set in <code class="docutils literal notranslate">values</code>.

The sector labels are set in <code class="docutils literal notranslate">labels</code>. The sector colors are

set in <code class="docutils literal notranslate">marker.colors</code>

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

<li>automargin – Determines whether outside text labels can push the

margins.</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>direction – Specifies the direction at which succeeding sectors

follow one another.</li>

<li>dlabel – Sets the label step. See <code class="docutils literal notranslate">label0</code> for more info.</li>

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

dict with compatible properties</li>

<li>hole – Sets the fraction of the radius to cut out of the pie.

Use this to make a donut chart.</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.pie.html#plotly.graph_objects.pie.Hoverlabel" title="plotly.graph_objects.pie.Hoverlabel"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.pie.Hoverlabel</code></a> instance

or dict with compatible properties</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. Finally, the template string has access

to variables <code class="docutils literal notranslate">label</code>, <code class="docutils literal notranslate">color</code>, <code class="docutils literal notranslate">value</code>, <code class="docutils literal notranslate">percent</code> and

<code class="docutils literal notranslate">text</code>. 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 – Sets hover text elements associated with each sector.

If a single string, the same string appears for all

data points. If an array of string, the items are

mapped in order of this trace’s sectors. To be seen,

trace <code class="docutils literal notranslate">hoverinfo</code> must contain a “text” flag.</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>insidetextfont – Sets the font used for <code class="docutils literal notranslate">textinfo</code> lying inside the

sector.</li>

<li>insidetextorientation – Controls the orientation of the text inside chart

sectors. When set to “auto”, text may be oriented in

any direction in order to be as big as possible in the

middle of a sector. The “horizontal” option orients

text to be parallel with the bottom of the chart, and

may make text smaller in order to achieve that goal.

The “radial” option orients text along the radius of

the sector. The “tangential” option orients text

perpendicular to the radius of the sector.</li>

<li>label0 – Alternate to <code class="docutils literal notranslate">labels</code>. Builds a numeric set of labels.

Use with <code class="docutils literal notranslate">dlabel</code> where <code class="docutils literal notranslate">label0</code> is the starting label

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

<li>labels – Sets the sector labels. If <code class="docutils literal notranslate">labels</code> entries are

duplicated, we sum associated <code class="docutils literal notranslate">values</code> or simply count

occurrences if <code class="docutils literal notranslate">values</code> is not provided. For other

array attributes (including color) we use the first

non-empty entry among all occurrences of the label.</li>

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

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

<li>legend – Sets the reference to a legend to show the pie slices

in. Can be an array if <code class="docutils literal notranslate">values</code> is set. In that case,

each entry specifies the legend reference for one

slice. 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.pie.html#plotly.graph_objects.pie.Legendgrouptitle" title="plotly.graph_objects.pie.Legendgrouptitle"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.pie.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>legendsrc – Sets the source reference on Chart Studio Cloud for

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

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

this trace.</li>

<li>marker – <a class="reference internal" href="plotly.graph_objects.pie.html#plotly.graph_objects.pie.Marker" title="plotly.graph_objects.pie.Marker"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.pie.Marker</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>opacity – Sets the opacity of the trace.</li>

<li>outsidetextfont – Sets the font used for <code class="docutils literal notranslate">textinfo</code> lying outside the

sector.</li>

<li>pull – Sets the fraction of larger radius to pull the sectors

out from the center. This can be a constant to pull all

slices apart from each other equally or an array to

highlight one or more slices.</li>

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

<li>rotation – Instead of the first slice starting at 12 o’clock,

rotate to some other angle.</li>

<li>scalegroup – If there are multiple pie charts that should be sized

according to their totals, link them by providing a

non-empty group id here shared by every trace in the

same group.</li>

<li>showlegend – Determines whether or not items corresponding to the

pie slices are shown in the legend. Can be an array if

<code class="docutils literal notranslate">values</code> is set. In that case, each entry specifies

appearance in the legend for one slice.</li>

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

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

<li>sort – Determines whether or not the sectors are reordered

from largest to smallest.</li>

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

dict with compatible properties</li>

<li>text – Sets text elements associated with each sector. If

trace <code class="docutils literal notranslate">textinfo</code> contains a “text” flag, these elements

will be seen on the chart. If trace <code class="docutils literal notranslate">hoverinfo</code>

contains a “text” flag and “hovertext” is not set,

these elements will be seen in the hover labels.</li>

<li>textfont – Sets the font used for <code class="docutils literal notranslate">textinfo</code>.</li>

<li>textinfo – Determines which trace information appear on the graph.</li>

<li>textposition – Specifies the location of the <code class="docutils literal notranslate">textinfo</code>.</li>

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

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

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

<li>texttemplate – 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

<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>texttemplatesrc – Sets the source reference on Chart Studio Cloud for

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

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

dict with compatible properties</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>values – Sets the values of the sectors. If omitted, we count

occurrences of each label.</li>

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

<code class="docutils literal notranslate">values</code>.</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>

</ul>

</dd>

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

</dd>

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

</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>.pie<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h1>

</colgroup>

<tbody>

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

</tr>

</tbody>

</table>

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

<dd>If there is a layout grid, use the domain for this column in

the grid for this pie trace .

<dt>The ‘column’ 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">row</code><a class="headerlink" href="#plotly.graph_objects.pie.Domain.row" title="Permalink to this definition">¶</a></dt>

<dd>If there is a layout grid, use the domain for this row in the

grid for this pie trace .

<dt>The ‘row’ 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">x</code><a class="headerlink" href="#plotly.graph_objects.pie.Domain.x" title="Permalink to this definition">¶</a></dt>

<dt>Sets the horizontal domain of this pie trace (in plot</dt><dd>fraction).

The ‘x’ property is an info array that may be specified as:

<li>a list or tuple of 2 elements where:</li>

</ul>

</dd>

</dl>

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

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

</ul>

</dd>

</dl>

</li>

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

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

</ul>

</dd>

</dl>

list

</li>

</ol>

</dd></dl>

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

<dd>Sets the vertical domain of this pie trace (in plot fraction).

<div>The ‘y’ property is an info array that may be specified as:

<li>a list or tuple of 2 elements where:</li>

</ul>

</div></blockquote>

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

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

</ul>

</dd>

</dl>

</li>

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

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

</ul>

</dd>

</dl>

list

</li>

</ol>

</dd></dl>

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

<dd>Sets the horizontal alignment of the text content within hover

label box. Has an effect only if the hover label text spans

more two or more lines

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

<dt>One of the following enumeration values:</dt><dd>[‘left’, ‘right’, ‘auto’]

</dd>

</dl>

</li>

<li>A tuple, list, or one-dimensional numpy array of the above</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">Any|numpy.ndarray

</dd>

</dl>

</dd></dl>

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

<dd>Sets the source reference on Chart Studio Cloud for <code class="docutils literal notranslate">align</code>.

The ‘alignsrc’ property must be specified as a string or

as a plotly.grid_objs.Column object

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

</dd>

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

</dd>

</dl>

</dd></dl>

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

<dd>Sets the background color of the hover labels for this trace

<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>

<li>A list or array of any of the above</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">str|numpy.ndarray

</dd>

</dl>

</dd></dl>

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

<dd>Sets the source reference on Chart Studio Cloud for <code class="docutils literal notranslate">bgcolor</code>.

The ‘bgcolorsrc’ property must be specified as a string or

as a plotly.grid_objs.Column object

<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.pie.Hoverlabel.bordercolor" title="Permalink to this definition">¶</a></dt>

<dd>Sets the border color of the hover labels for this trace.

<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>

<li>A list or array of any of the above</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">str|numpy.ndarray

</dd>

</dl>

</dd></dl>

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

<dd>Sets the source reference on Chart Studio Cloud for

<code class="docutils literal notranslate">bordercolor</code>.

The ‘bordercolorsrc’ property must be specified as a string or

as a plotly.grid_objs.Column object

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

</dd>

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

</dd>

</dl>

</dd></dl>

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

<dd>Sets the font used in hover labels.

The ‘font’ property is an instance of Font

that may be specified as:

<li>An instance of <a class="reference internal" href="plotly.graph_objects.pie.hoverlabel.html#plotly.graph_objects.pie.hoverlabel.Font" title="plotly.graph_objects.pie.hoverlabel.Font"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.pie.hoverlabel.Font</code></a></li>

<li>A dict of string/value properties that will be passed

to the Font constructor</li>

</ul>

</div></blockquote>

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

</dd>

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

<dd class="field-even"><a class="reference internal" href="plotly.graph_objects.pie.hoverlabel.html#plotly.graph_objects.pie.hoverlabel.Font" title="plotly.graph_objects.pie.hoverlabel.Font">plotly.graph_objects.pie.hoverlabel.Font</a>

</dd>

</dl>

</dd></dl>

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

<dd>Sets the default length (in number of characters) of the trace

name in the hover labels for all traces. -1 shows the whole

name regardless of length. 0-3 shows the first 0-3 characters,

and an integer >3 will show the whole name if it is less than

that many characters, but if it is longer, will truncate to

<code class="docutils literal notranslate">namelength - 3</code> characters and add an ellipsis.

<dt>The ‘namelength’ 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 [-1, 9223372036854775807]</li>

<li>A tuple, list, or one-dimensional numpy array of the above</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">int|numpy.ndarray

</dd>

</dl>

</dd></dl>

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

<dd>Sets the source reference on Chart Studio Cloud for

<code class="docutils literal notranslate">namelength</code>.

The ‘namelengthsrc’ property must be specified as a string or

as a plotly.grid_objs.Column object

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

</dd>

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

</dd>

</dl>

</dd></dl>

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

<dd>Sets whether or not to show the hover label arrow/triangle

pointing to the data point.

<dt>The ‘showarrow’ 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>

class <code class="sig-prename descclassname">plotly.graph_objects.pie.</code><code class="sig-name descname">Insidetextfont</code>(arg=None, color=None, colorsrc=None, family=None, familysrc=None, lineposition=None, linepositionsrc=None, shadow=None, shadowsrc=None, size=None, sizesrc=None, style=None, stylesrc=None, textcase=None, textcasesrc=None, variant=None, variantsrc=None, weight=None, weightsrc=None, **kwargs)<a class="headerlink" href="#plotly.graph_objects.pie.Insidetextfont" title="Permalink to this definition">¶</a></dt>

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

<dt>The ‘color’ 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>

<li>A list or array of any of the above</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">str|numpy.ndarray

</dd>

</dl>

</dd></dl>

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

<dd>Sets the source reference on Chart Studio Cloud for <code class="docutils literal notranslate">color</code>.

The ‘colorsrc’ property must be specified as a string or

as a plotly.grid_objs.Column object

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

</dd>

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

</dd>

</dl>

</dd></dl>

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

<dd>HTML font family - the typeface that will be applied by the web

browser. The web browser can only apply a font if it is

available on the system where it runs. Provide multiple font

families, separated by commas, to indicate the order in which

to apply fonts if they aren’t available.

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

<li>A non-empty string</li>

<li>A tuple, list, or one-dimensional numpy array of the above</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">str|numpy.ndarray

</dd>

</dl>

</dd></dl>

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

<dd>Sets the source reference on Chart Studio Cloud for <code class="docutils literal notranslate">family</code>.

The ‘familysrc’ property must be specified as a string or

as a plotly.grid_objs.Column object

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

</dd>

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

</dd>

</dl>

</dd></dl>

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

<dd>Sets the kind of decoration line(s) with text, such as an

“under”, “over” or “through” as well as combinations e.g.

“under+over”, etc.

The ‘lineposition’ property is a flaglist and may be specified

as a string containing:

<li>Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters

(e.g. ‘under+over’)

OR exactly one of [‘none’] (e.g. ‘none’)</li>

<li>A list or array of the above</li>

</ul>

</div></blockquote>

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

</dd>

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

<dd class="field-even">Any|numpy.ndarray

</dd>

</dl>

</dd></dl>

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

<dd>Sets the source reference on Chart Studio Cloud for

<code class="docutils literal notranslate">lineposition</code>.

The ‘linepositionsrc’ property must be specified as a string or

as a plotly.grid_objs.Column object

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

</dd>

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

</dd>

</dl>

</dd></dl>

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

<dd>Sets the shape and color of the shadow behind text. “auto”

places minimal shadow and applies contrast text font color. See

<a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow">https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow</a>

for additional options.

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

<li>A string</li>

<li>A number that will be converted to a string</li>

<li>A tuple, list, or one-dimensional numpy array of the above</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">str|numpy.ndarray

</dd>

</dl>

</dd></dl>

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

<dd>Sets the source reference on Chart Studio Cloud for <code class="docutils literal notranslate">shadow</code>.

The ‘shadowsrc’ property must be specified as a string or

as a plotly.grid_objs.Column object

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

</dd>

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

</dd>

</dl>

</dd></dl>

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

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

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

<li>A tuple, list, or one-dimensional numpy array of the above</li>

</ul>

</dd>

</dl>

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

</dd>

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

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

</dd>

</dl>

</dd></dl>

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

<dd>Sets the source reference on Chart Studio Cloud for <code class="docutils literal notranslate">size</code>.

The ‘sizesrc’ property must be specified as a string or

as a plotly.grid_objs.Column object

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

</dd>

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

</dd>

</dl>

</dd></dl>

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

<dd>Sets whether a font should be styled with a normal or italic

face from its family.

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

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

</dd>

</dl>

</li>

<li>A tuple, list, or one-dimensional numpy array of the above</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">Any|numpy.ndarray

</dd>

</dl>

</dd></dl>

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

<dd>Sets the source reference on Chart Studio Cloud for <code class="docutils literal notranslate">style</code>.

The ‘stylesrc’ property must be specified as a string or

as a plotly.grid_objs.Column object

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

</dd>

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

</dd>

</dl>

</dd></dl>

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

<dd>Sets capitalization of text. It can be used to make text appear

in all-uppercase or all-lowercase, or with each word

capitalized.

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

<dt>One of the following enumeration values:</dt><dd>[‘normal’, ‘word caps’, ‘upper’, ‘lower’]

</dd>

</dl>

</li>

<li>A tuple, list, or one-dimensional numpy array of the above</li>

</ul>

</dd>

</dl>

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

</dd>

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

<dd class="field-even">Any|numpy.ndarray

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

Latest commit

History

plotly.graph_objects.Pie.html

File metadata and controls