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

History

673 lines (628 loc) · 40.8 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

<!DOCTYPE html>

<head>

<title>plotly.graph_objects.Image — 4.6.0 documentation</title>

</head><body>

</button>

</a>

</div>

<a role="button"

id="dLabelGlobalToc"

data-toggle="dropdown"

data-target="#"

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

<ul class="dropdown-menu globaltoc"

role="menu"

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

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

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

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

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

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

</ul>

</li>

<a role="button"

id="dLabelLocalToc"

data-toggle="dropdown"

data-target="#"

href="#">Page </a>

<ul class="dropdown-menu localtoc"

role="menu"

aria-labelledby="dLabelLocalToc"><ul>

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

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

</ul>

</li>

<li>

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

</a>

</li>

<li>

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

class <code class="sig-prename descclassname">plotly.graph_objects.</code><code class="sig-name descname">Image</code>(arg=None, colormodel=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, meta=None, metasrc=None, name=None, opacity=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x0=None, xaxis=None, y0=None, yaxis=None, z=None, zmax=None, zmin=None, zsrc=None, **kwargs)<a class="headerlink" href="#plotly.graph_objects.Image" title="Permalink to this definition">¶</a></dt>

<code class="sig-name descname">__init__</code>(arg=None, colormodel=None, customdata=None, customdatasrc=None, dx=None, dy=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, meta=None, metasrc=None, name=None, opacity=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, visible=None, x0=None, xaxis=None, y0=None, yaxis=None, z=None, zmax=None, zmin=None, zsrc=None, **kwargs)<a class="headerlink" href="#plotly.graph_objects.Image.__init__" title="Permalink to this definition">¶</a></dt>

<dd>Construct a new Image object

Display an image, i.e. data on a 2D regular raster. By default,

when an image is displayed in a subplot, its y axis will be

reversed (ie. <code class="docutils literal notranslate">autorange: 'reversed'</code>), constrained to the

domain (ie. <code class="docutils literal notranslate">constrain: 'domain'</code>) and it will have the same

scale as its x axis (ie. <code class="docutils literal notranslate">scaleanchor: 'x,</code>) in order for

pixels to be rendered as squares.

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

<li>colormodel – Color model used to map the numerical color components

described in <code class="docutils literal notranslate">z</code> into colors.</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

customdata .</li>

<li>dx – Set the pixel’s horizontal size.</li>

<li>dy – Set the pixel’s vertical size</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

hoverinfo .</li>

<li>hoverlabel – <a class="reference internal" href="plotly.graph_objects.image.html#plotly.graph_objects.image.Hoverlabel" title="plotly.graph_objects.image.Hoverlabel"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.image.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}”. Numbers are formatted using

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

“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api-

reference/blob/master/Formatting.md#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-3.x-api-

reference/blob/master/Time-Formatting.md#format for

details on the date formatting syntax. 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, every attributes that can be

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

are available. variables <code class="docutils literal notranslate">z</code>, <code class="docutils literal notranslate">color</code> and <code class="docutils literal notranslate">colormodel</code>.

Anything contained in tag <code class="docutils literal notranslate"><extra></code> is displayed in the

secondary box, for example

“<extra>{fullData.name}</extra>”. To hide the secondary

box completely, use an empty tag <code class="docutils literal notranslate"><extra></extra></code>.</li>

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

hovertemplate .</li>

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

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

hovertext .</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

ids .</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

meta .</li>

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

legend item and on hover.</li>

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

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

dict with compatible properties</li>

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

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

text .</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>x0 – Set the image’s x position.</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>y0 – Set the image’s y position.</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>z – A 2-dimensional array in which each element is an array

of 3 or 4 numbers representing a color.</li>

<li>zmax – Array defining the higher bound for each color

component. Note that the default value will depend on

the colormodel. For the <code class="docutils literal notranslate">rgb</code> colormodel, it is [255,

255, 255]. For the <code class="docutils literal notranslate">rgba</code> colormodel, it is [255, 255,

255, 1]. For the <code class="docutils literal notranslate">hsl</code> colormodel, it is [360, 100,

100]. For the <code class="docutils literal notranslate">hsla</code> colormodel, it is [360, 100, 100,

1].</li>

<li>zmin – Array defining the lower bound for each color

component. Note that the default value will depend on

the colormodel. For the <code class="docutils literal notranslate">rgb</code> colormodel, it is [0, 0,

0]. For the <code class="docutils literal notranslate">rgba</code> colormodel, it is [0, 0, 0, 0]. For

the <code class="docutils literal notranslate">hsl</code> colormodel, it is [0, 0, 0]. For the <code class="docutils literal notranslate">hsla</code>

colormodel, it is [0, 0, 0, 0].</li>

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

.</li>

</ul>

</dd>

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

</dd>

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

<dd class="field-odd"><a class="reference internal" href="plotly.graph_objects.html#plotly.graph_objects.Image" title="plotly.graph_objects.Image">Image</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>.image<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h1>

</colgroup>

<tbody>

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

</tr>

</tbody>

</table>

class <code class="sig-prename descclassname">plotly.graph_objects.image.</code><code class="sig-name descname">Stream</code>(arg=None, maxpoints=None, token=None, **kwargs)<a class="headerlink" href="#plotly.graph_objects.image.Stream" title="Permalink to this definition">¶</a></dt>

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

<dd>Sets the maximum number of points to keep on the plots from an

incoming stream. If <code class="docutils literal notranslate">maxpoints</code> is set to 50, only the newest

50 points will be displayed on the plot.

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

<li>An int or float in the interval [0, 10000]</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">token</code><a class="headerlink" href="#plotly.graph_objects.image.Stream.token" title="Permalink to this definition">¶</a></dt>

<dd>The stream id number links a data trace on a plot with a

stream. See <a class="reference external" href="https://chart-studio.plotly.com/settings">https://chart-studio.plotly.com/settings</a> for more

details.

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

<li>A non-empty string</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.image.</code><code class="sig-name descname">Hoverlabel</code>(arg=None, align=None, alignsrc=None, bgcolor=None, bgcolorsrc=None, bordercolor=None, bordercolorsrc=None, font=None, namelength=None, namelengthsrc=None, **kwargs)<a class="headerlink" href="#plotly.graph_objects.image.Hoverlabel" title="Permalink to this definition">¶</a></dt>

property <code class="sig-name descname">align</code><a class="headerlink" href="#plotly.graph_objects.image.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.image.Hoverlabel.alignsrc" title="Permalink to this definition">¶</a></dt>

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

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

<dt>A named CSS color:</dt><dd>aliceblue, antiquewhite, aqua, aquamarine, azure,

beige, bisque, black, blanchedalmond, blue,

blueviolet, brown, burlywood, cadetblue,

chartreuse, chocolate, coral, cornflowerblue,

cornsilk, crimson, cyan, darkblue, darkcyan,

darkgoldenrod, darkgray, darkgrey, darkgreen,

darkkhaki, darkmagenta, darkolivegreen, darkorange,

darkorchid, darkred, darksalmon, darkseagreen,

darkslateblue, darkslategray, darkslategrey,

darkturquoise, darkviolet, deeppink, deepskyblue,

dimgray, dimgrey, dodgerblue, firebrick,

floralwhite, forestgreen, fuchsia, gainsboro,

ghostwhite, gold, goldenrod, gray, grey, green,

greenyellow, honeydew, hotpink, indianred, indigo,

ivory, khaki, lavender, lavenderblush, lawngreen,

lemonchiffon, lightblue, lightcoral, lightcyan,

lightgoldenrodyellow, lightgray, lightgrey,

lightgreen, lightpink, lightsalmon, lightseagreen,

lightskyblue, lightslategray, lightslategrey,

lightsteelblue, lightyellow, lime, limegreen,

linen, magenta, maroon, mediumaquamarine,

mediumblue, mediumorchid, mediumpurple,

mediumseagreen, mediumslateblue, mediumspringgreen,

mediumturquoise, mediumvioletred, midnightblue,

mintcream, mistyrose, moccasin, navajowhite, navy,

oldlace, olive, olivedrab, orange, orangered,

orchid, palegoldenrod, palegreen, paleturquoise,

palevioletred, papayawhip, peachpuff, peru, pink,

plum, powderblue, purple, red, rosybrown,

royalblue, rebeccapurple, saddlebrown, salmon,

sandybrown, seagreen, seashell, sienna, silver,

skyblue, slateblue, slategray, slategrey, snow,

springgreen, steelblue, tan, teal, thistle, tomato,

turquoise, violet, wheat, white, whitesmoke,

yellow, yellowgreen

</dd>

</dl>

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

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

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

<dt>A named CSS color:</dt><dd>aliceblue, antiquewhite, aqua, aquamarine, azure,

beige, bisque, black, blanchedalmond, blue,

blueviolet, brown, burlywood, cadetblue,

chartreuse, chocolate, coral, cornflowerblue,

cornsilk, crimson, cyan, darkblue, darkcyan,

darkgoldenrod, darkgray, darkgrey, darkgreen,

darkkhaki, darkmagenta, darkolivegreen, darkorange,

darkorchid, darkred, darksalmon, darkseagreen,

darkslateblue, darkslategray, darkslategrey,

darkturquoise, darkviolet, deeppink, deepskyblue,

dimgray, dimgrey, dodgerblue, firebrick,

floralwhite, forestgreen, fuchsia, gainsboro,

ghostwhite, gold, goldenrod, gray, grey, green,

greenyellow, honeydew, hotpink, indianred, indigo,

ivory, khaki, lavender, lavenderblush, lawngreen,

lemonchiffon, lightblue, lightcoral, lightcyan,

lightgoldenrodyellow, lightgray, lightgrey,

lightgreen, lightpink, lightsalmon, lightseagreen,

lightskyblue, lightslategray, lightslategrey,

lightsteelblue, lightyellow, lime, limegreen,

linen, magenta, maroon, mediumaquamarine,

mediumblue, mediumorchid, mediumpurple,

mediumseagreen, mediumslateblue, mediumspringgreen,

mediumturquoise, mediumvioletred, midnightblue,

mintcream, mistyrose, moccasin, navajowhite, navy,

oldlace, olive, olivedrab, orange, orangered,

orchid, palegoldenrod, palegreen, paleturquoise,

palevioletred, papayawhip, peachpuff, peru, pink,

plum, powderblue, purple, red, rosybrown,

royalblue, rebeccapurple, saddlebrown, salmon,

sandybrown, seagreen, seashell, sienna, silver,

skyblue, slateblue, slategray, slategrey, snow,

springgreen, steelblue, tan, teal, thistle, tomato,

turquoise, violet, wheat, white, whitesmoke,

yellow, yellowgreen

</dd>

</dl>

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

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

bordercolor .

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

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

to the Font constructor

Supported dict properties:

<div>color

<dt>colorsrc</dt><dd>Sets the source reference on Chart Studio Cloud

for color .

</dd>

<dt>family</dt><dd>HTML font family - the typeface that will be

applied by the web browser. The web browser

will only be able to apply a font if it is

available on the system which it operates.

Provide multiple font families, separated by

commas, to indicate the preference in which to

apply fonts if they aren’t available on the

system. The Chart Studio Cloud (at

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

generates images on a server, where only a

select number of fonts are installed and

supported. These include “Arial”, “Balto”,

“Courier New”, “Droid Sans”,, “Droid Serif”,

“Droid Sans Mono”, “Gravitas One”, “Old

Standard TT”, “Open Sans”, “Overpass”, “PT Sans

Narrow”, “Raleway”, “Times New Roman”.

</dd>

<dt>familysrc</dt><dd>Sets the source reference on Chart Studio Cloud

for family .

</dd>

</dl>

size

<dt>sizesrc</dt><dd>Sets the source reference on Chart Studio Cloud

for size .

</dd>

</dl>

</div></blockquote>

</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.image.hoverlabel.html#plotly.graph_objects.image.hoverlabel.Font" title="plotly.graph_objects.image.hoverlabel.Font">plotly.graph_objects.image.hoverlabel.Font</a>

</dd>

</dl>

</dd></dl>

property <code class="sig-name descname">namelength</code><a class="headerlink" href="#plotly.graph_objects.image.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.image.Hoverlabel.namelengthsrc" title="Permalink to this definition">¶</a></dt>

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

.

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>

</div>

var _gaq = _gaq || [];

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

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

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

_gaq.push(['_trackPageview']);

(function() {

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

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

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

})();

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

plotly.graph_objects.Image.html

Latest commit

History

plotly.graph_objects.Image.html

File metadata and controls