-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathplotly.graph_objects.Image.html
More file actions
568 lines (526 loc) · 50.9 KB
/
Copy pathplotly.graph_objects.Image.html
File metadata and controls
568 lines (526 loc) · 50.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>plotly.graph_objects.Image — 7.0.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/plotly-style.css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="plotly.graph_objects.Contour" href="plotly.graph_objects.Contour.html" />
<link rel="prev" title="plotly.graph_objects.Heatmap" href="plotly.graph_objects.Heatmap.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<script type="text/javascript" src="../_static/js/jquery-1.12.4.min.js"></script>
<script type="text/javascript" src="../_static/js/jquery-fix.js"></script>
<script type="text/javascript" src="../_static/bootstrap-3.4.1/js/bootstrap.min.js"></script>
<script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
</head><body>
<div id="navbar" class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html"><span><img src="../_static/logo.png"></span>
</a>
<span class="navbar-text navbar-version pull-left"><b></b></span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li class="dropdown globaltoc-container">
<a role="button"
id="dLabelGlobalToc"
data-toggle="dropdown"
data-target="#"
href="../index.html">Site <b class="caret"></b></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"><span class="pre">plotly.express</span></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"><span class="pre">plotly.graph_objects</span></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"><span class="pre">plotly.subplots</span></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"><span class="pre">plotly.figure_factory</span></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"><span class="pre">plotly.io</span></code>: low-level interface for displaying, reading and writing figures</a></li>
</ul>
</ul>
</li>
<li class="dropdown">
<a role="button"
id="dLabelLocalToc"
data-toggle="dropdown"
data-target="#"
href="#">Page <b class="caret"></b></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"><span class="pre">plotly.graph_objects</span></code>.Image</a></li>
<li><a class="reference internal" href="#id1"><code class="xref py py-mod docutils literal notranslate"><span class="pre">plotly.graph_objects</span></code>.image</a></li>
</ul>
</ul>
</li>
<li>
<a href="plotly.graph_objects.Heatmap.html" title="Previous Chapter: plotly.graph_objects.Heatmap"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« plotly.graph_...</span>
</a>
</li>
<li>
<a href="plotly.graph_objects.Contour.html" title="Next Chapter: plotly.graph_objects.Contour"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">plotly.graph_... »</span>
</a>
</li>
</ul>
<form class="navbar-form navbar-right" action="../search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="body col-md-12 content" role="main">
<div class="section" id="plotly-graph-objs-image">
<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"><span class="pre">plotly.graph_objects</span></code></a>.Image<a class="headerlink" href="#plotly-graph-objs-image" title="Permalink to this headline">¶</a></h1>
<dl class="py class">
<dt id="plotly.graph_objects.Image">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">plotly.graph_objects.</span></code><code class="sig-name descname"><span class="pre">Image</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colormodel</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customdata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hoverinfo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hoverlabel</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hovertemplate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hovertemplatefallback</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hovertext</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ids</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">legend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">legendgrouptitle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">legendrank</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">legendwidth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">meta</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">opacity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uirevision</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visible</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xaxis</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yaxis</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">z</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">zmax</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">zmin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">zorder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">zsmooth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#plotly.graph_objects.Image" title="Permalink to this definition">¶</a></dt>
<dd><dl class="py method">
<dt id="plotly.graph_objects.Image.__init__">
<code class="sig-name descname"><span class="pre">__init__</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colormodel</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">customdata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hoverinfo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hoverlabel</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hovertemplate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hovertemplatefallback</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hovertext</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ids</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">legend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">legendgrouptitle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">legendrank</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">legendwidth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">meta</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">opacity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uirevision</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visible</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xaxis</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yaxis</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">z</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">zmax</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">zmin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">zorder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">zsmooth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#plotly.graph_objects.Image.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Construct a new Image object</p>
<p>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"><span class="pre">autorange:</span> <span class="pre">'reversed'</span></code>), constrained to the
domain (ie. <code class="docutils literal notranslate"><span class="pre">constrain:</span> <span class="pre">'domain'</span></code>) and it will have the same
scale as its x axis (ie. <code class="docutils literal notranslate"><span class="pre">scaleanchor:</span> <span class="pre">'x,</span></code>) in order for
pixels to be rendered as squares.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>arg</strong> – 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"><span class="pre">plotly.graph_objects.Image</span></code></a></p></li>
<li><p><strong>colormodel</strong> – Color model used to map the numerical color components
described in <code class="docutils literal notranslate"><span class="pre">z</span></code> into colors. If <code class="docutils literal notranslate"><span class="pre">source</span></code> is specified,
this attribute will be set to <code class="docutils literal notranslate"><span class="pre">rgba256</span></code> otherwise it
defaults to <code class="docutils literal notranslate"><span class="pre">rgb</span></code>.</p></li>
<li><p><strong>customdata</strong> – 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</p></li>
<li><p><strong>dx</strong> – Set the pixel’s horizontal size.</p></li>
<li><p><strong>dy</strong> – Set the pixel’s vertical size</p></li>
<li><p><strong>hoverinfo</strong> – Determines what trace information appears on hover. If
<code class="docutils literal notranslate"><span class="pre">none</span></code> or <code class="docutils literal notranslate"><span class="pre">skip</span></code> are set, no information is displayed
upon hovering. But, if <code class="docutils literal notranslate"><span class="pre">none</span></code> is set, click and hover
events are still fired.</p></li>
<li><p><strong>hoverlabel</strong> – <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"><span class="pre">plotly.graph_objects.image.Hoverlabel</span></code></a> instance
or dict with compatible properties</p></li>
<li><p><strong>hovertemplate</strong> – Template string used for rendering the information that
appear on hover box. Note that this will override
<code class="docutils literal notranslate"><span class="pre">hoverinfo</span></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"><span class="pre">hovertemplate</span></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"><span class="pre">arrayOk:</span> <span class="pre">true</span></code>)
are available. Finally, the template string has access
to variables <code class="docutils literal notranslate"><span class="pre">z</span></code>, <code class="docutils literal notranslate"><span class="pre">color</span></code> and <code class="docutils literal notranslate"><span class="pre">colormodel</span></code>. Anything
contained in tag <code class="docutils literal notranslate"><span class="pre"><extra></span></code> is displayed in the
secondary box, for example
<code class="docutils literal notranslate"><span class="pre"><extra>%{fullData.name}</extra></span></code>. To hide the
secondary box completely, use an empty tag
<code class="docutils literal notranslate"><span class="pre"><extra></extra></span></code>.</p></li>
<li><p><strong>hovertemplatefallback</strong> – 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.</p></li>
<li><p><strong>hovertext</strong> – Same as <code class="docutils literal notranslate"><span class="pre">text</span></code>.</p></li>
<li><p><strong>ids</strong> – 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.</p></li>
<li><p><strong>legend</strong> – 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"><span class="pre">layout.legend</span></code>, <code class="docutils literal notranslate"><span class="pre">layout.legend2</span></code>,
etc.</p></li>
<li><p><strong>legendgrouptitle</strong> – <a class="reference internal" href="plotly.graph_objects.image.html#plotly.graph_objects.image.Legendgrouptitle" title="plotly.graph_objects.image.Legendgrouptitle"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.image.Legendgrouptitle</span></code></a>
instance or dict with compatible properties</p></li>
<li><p><strong>legendrank</strong> – 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"><span class="pre">legend.traceorder</span></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.</p></li>
<li><p><strong>legendwidth</strong> – Sets the width (in px or fraction) of the legend for
this trace.</p></li>
<li><p><strong>meta</strong> – 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"><span class="pre">name</span></code>, graph, axis and
colorbar <code class="docutils literal notranslate"><span class="pre">title.text</span></code>, annotation <code class="docutils literal notranslate"><span class="pre">text</span></code>
<code class="docutils literal notranslate"><span class="pre">rangeselector</span></code>, <code class="docutils literal notranslate"><span class="pre">updatemenues</span></code> and <code class="docutils literal notranslate"><span class="pre">sliders</span></code> <code class="docutils literal notranslate"><span class="pre">label</span></code>
text all support <code class="docutils literal notranslate"><span class="pre">meta</span></code>. To access the trace <code class="docutils literal notranslate"><span class="pre">meta</span></code>
values in an attribute in the same trace, simply use
<code class="docutils literal notranslate"><span class="pre">%{meta[i]}</span></code> where <code class="docutils literal notranslate"><span class="pre">i</span></code> is the index or key of the
<code class="docutils literal notranslate"><span class="pre">meta</span></code> item in question. To access trace <code class="docutils literal notranslate"><span class="pre">meta</span></code> in
layout attributes, use <code class="docutils literal notranslate"><span class="pre">%{data[n[.meta[i]}</span></code> where <code class="docutils literal notranslate"><span class="pre">i</span></code>
is the index or key of the <code class="docutils literal notranslate"><span class="pre">meta</span></code> and <code class="docutils literal notranslate"><span class="pre">n</span></code> is the trace
index.</p></li>
<li><p><strong>name</strong> – Sets the trace name. The trace name appears as the
legend item and on hover.</p></li>
<li><p><strong>opacity</strong> – Sets the opacity of the trace.</p></li>
<li><p><strong>source</strong> – Specifies the data URI of the image to be visualized.
The URI consists of “<a class="reference external" href="data:image">data:image</a>/[<media
subtype>][;base64],<data>”</p></li>
<li><p><strong>text</strong> – Sets the text elements associated with each z value.</p></li>
<li><p><strong>uid</strong> – Assign an id to this trace, Use this to provide object
constancy between traces during animations and
transitions.</p></li>
<li><p><strong>uirevision</strong> – Controls persistence of some user-driven changes to the
trace: <code class="docutils literal notranslate"><span class="pre">constraintrange</span></code> in <code class="docutils literal notranslate"><span class="pre">parcoords</span></code> traces, as well
as some <code class="docutils literal notranslate"><span class="pre">editable:</span> <span class="pre">true</span></code> modifications such as <code class="docutils literal notranslate"><span class="pre">name</span></code>
and <code class="docutils literal notranslate"><span class="pre">colorbar.title</span></code>. Defaults to <code class="docutils literal notranslate"><span class="pre">layout.uirevision</span></code>.
Note that other user-driven trace attribute changes are
controlled by <code class="docutils literal notranslate"><span class="pre">layout</span></code> attributes: <code class="docutils literal notranslate"><span class="pre">trace.visible</span></code> is
controlled by <code class="docutils literal notranslate"><span class="pre">layout.legend.uirevision</span></code>,
<code class="docutils literal notranslate"><span class="pre">selectedpoints</span></code> is controlled by
<code class="docutils literal notranslate"><span class="pre">layout.selectionrevision</span></code>, and <code class="docutils literal notranslate"><span class="pre">colorbar.(x|y)</span></code>
(accessible with <code class="docutils literal notranslate"><span class="pre">config:</span> <span class="pre">{editable:</span> <span class="pre">true}</span></code>) is
controlled by <code class="docutils literal notranslate"><span class="pre">layout.editrevision</span></code>. Trace changes are
tracked by <code class="docutils literal notranslate"><span class="pre">uid</span></code>, which only falls back on trace index
if no <code class="docutils literal notranslate"><span class="pre">uid</span></code> is provided. So if your app can add/remove
traces before the end of the <code class="docutils literal notranslate"><span class="pre">data</span></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"><span class="pre">uid</span></code> that stays with it as it moves.</p></li>
<li><p><strong>visible</strong> – 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).</p></li>
<li><p><strong>x0</strong> – Set the image’s x position. The left edge of the image
(or the right edge if the x axis is reversed or dx is
negative) will be found at xmin=x0-dx/2</p></li>
<li><p><strong>xaxis</strong> – 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"><span class="pre">layout.xaxis</span></code>. If “x2”, the x
coordinates refer to <code class="docutils literal notranslate"><span class="pre">layout.xaxis2</span></code>, and so on.</p></li>
<li><p><strong>y0</strong> – Set the image’s y position. The top edge of the image
(or the bottom edge if the y axis is NOT reversed or if
dy is negative) will be found at ymin=y0-dy/2. By
default when an image trace is included, the y axis
will be reversed so that the image is right-side-up,
but you can disable this by setting
yaxis.autorange=true or by providing an explicit y axis
range.</p></li>
<li><p><strong>yaxis</strong> – 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"><span class="pre">layout.yaxis</span></code>. If “y2”, the y
coordinates refer to <code class="docutils literal notranslate"><span class="pre">layout.yaxis2</span></code>, and so on.</p></li>
<li><p><strong>z</strong> – A 2-dimensional array in which each element is an array
of 3 or 4 numbers representing a color.</p></li>
<li><p><strong>zmax</strong> – 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"><span class="pre">rgb</span></code> colormodel, it is [255,
255, 255]. For the <code class="docutils literal notranslate"><span class="pre">rgba</span></code> colormodel, it is [255, 255,
255, 1]. For the <code class="docutils literal notranslate"><span class="pre">rgba256</span></code> colormodel, it is [255, 255,
255, 255]. For the <code class="docutils literal notranslate"><span class="pre">hsl</span></code> colormodel, it is [360, 100,
100]. For the <code class="docutils literal notranslate"><span class="pre">hsla</span></code> colormodel, it is [360, 100, 100,
1].</p></li>
<li><p><strong>zmin</strong> – 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"><span class="pre">rgb</span></code> colormodel, it is [0, 0,
0]. For the <code class="docutils literal notranslate"><span class="pre">rgba</span></code> colormodel, it is [0, 0, 0, 0]. For
the <code class="docutils literal notranslate"><span class="pre">rgba256</span></code> colormodel, it is [0, 0, 0, 0]. For the
<code class="docutils literal notranslate"><span class="pre">hsl</span></code> colormodel, it is [0, 0, 0]. For the <code class="docutils literal notranslate"><span class="pre">hsla</span></code>
colormodel, it is [0, 0, 0, 0].</p></li>
<li><p><strong>zorder</strong> – 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"><span class="pre">zorder</span></code> appear in front of those
with lower <code class="docutils literal notranslate"><span class="pre">zorder</span></code>.</p></li>
<li><p><strong>zsmooth</strong> – Picks a smoothing algorithm used to smooth <code class="docutils literal notranslate"><span class="pre">z</span></code> data.
This only applies for image traces that use the
<code class="docutils literal notranslate"><span class="pre">source</span></code> attribute.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p></p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#plotly.graph_objects.Image" title="plotly.graph_objects.Image">Image</a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="id1">
<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"><span class="pre">plotly.graph_objects</span></code></a>.image<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h1>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="plotly.graph_objects.image.html#module-plotly.graph_objects.image" title="plotly.graph_objects.image"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plotly.graph_objects.image</span></code></a></p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
<span class="target" id="module-plotly.graph_objects.image"></span><dl class="py class">
<dt id="plotly.graph_objects.image.Hoverlabel">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">plotly.graph_objects.image.</span></code><code class="sig-name descname"><span class="pre">Hoverlabel</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">align</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bgcolor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bordercolor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">font</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">namelength</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">showarrow</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#plotly.graph_objects.image.Hoverlabel" title="Permalink to this definition">¶</a></dt>
<dd><dl class="py method">
<dt id="plotly.graph_objects.image.Hoverlabel.align">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">align</span></code><a class="headerlink" href="#plotly.graph_objects.image.Hoverlabel.align" title="Permalink to this definition">¶</a></dt>
<dd><p>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</p>
<dl class="simple">
<dt>The ‘align’ property is an enumeration that may be specified as:</dt><dd><ul class="simple">
<li><dl class="simple">
<dt>One of the following enumeration values:</dt><dd><p>[‘left’, ‘right’, ‘auto’]</p>
</dd>
</dl>
</li>
<li><p>A tuple, list, or one-dimensional numpy array of the above</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Any|numpy.ndarray</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.image.Hoverlabel.bgcolor">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">bgcolor</span></code><a class="headerlink" href="#plotly.graph_objects.image.Hoverlabel.bgcolor" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the background color of the hover labels for this trace</p>
<dl class="simple">
<dt>The ‘bgcolor’ property is a color and may be specified as a string in the following formats:</dt><dd><ul class="simple">
<li><p>hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)</p></li>
<li><p>hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)</p></li>
<li><p>rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)</p></li>
<li><p>rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)</p></li>
<li><p>hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)</p></li>
<li><p>hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)</p></li>
<li><p>hwb (e.g. ‘hwb(0 0% 100%)’)</p></li>
<li><p>lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)</p></li>
<li><p>color (e.g. ‘color(display-p3 1 0 0)’)</p></li>
<li><p>named colors (full list: <a class="reference external" href="https://www.w3.org/TR/css-color-4/#named-color">https://www.w3.org/TR/css-color-4/#named-color</a>)</p></li>
<li><p>Any other supported CSS 4 color format: <a class="reference external" href="https://www.w3.org/TR/css-color-4/">https://www.w3.org/TR/css-color-4/</a></p></li>
<li><p>A list or array of any of the above</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>str|numpy.ndarray</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.image.Hoverlabel.bordercolor">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">bordercolor</span></code><a class="headerlink" href="#plotly.graph_objects.image.Hoverlabel.bordercolor" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the border color of the hover labels for this trace.</p>
<dl class="simple">
<dt>The ‘bordercolor’ property is a color and may be specified as a string in the following formats:</dt><dd><ul class="simple">
<li><p>hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’)</p></li>
<li><p>hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’)</p></li>
<li><p>rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’)</p></li>
<li><p>rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’)</p></li>
<li><p>hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’)</p></li>
<li><p>hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’)</p></li>
<li><p>hwb (e.g. ‘hwb(0 0% 100%)’)</p></li>
<li><p>lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’)</p></li>
<li><p>color (e.g. ‘color(display-p3 1 0 0)’)</p></li>
<li><p>named colors (full list: <a class="reference external" href="https://www.w3.org/TR/css-color-4/#named-color">https://www.w3.org/TR/css-color-4/#named-color</a>)</p></li>
<li><p>Any other supported CSS 4 color format: <a class="reference external" href="https://www.w3.org/TR/css-color-4/">https://www.w3.org/TR/css-color-4/</a></p></li>
<li><p>A list or array of any of the above</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>str|numpy.ndarray</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.image.Hoverlabel.font">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">font</span></code><a class="headerlink" href="#plotly.graph_objects.image.Hoverlabel.font" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the font used in hover labels.</p>
<p>The ‘font’ property is an instance of Font
that may be specified as:</p>
<blockquote>
<div><ul class="simple">
<li><p>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"><span class="pre">plotly.graph_objects.image.hoverlabel.Font</span></code></a></p></li>
<li><p>A dict of string/value properties that will be passed
to the Font constructor</p></li>
</ul>
</div></blockquote>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.image.Hoverlabel.namelength">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">namelength</span></code><a class="headerlink" href="#plotly.graph_objects.image.Hoverlabel.namelength" title="Permalink to this definition">¶</a></dt>
<dd><p>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"><span class="pre">namelength</span> <span class="pre">-</span> <span class="pre">3</span></code> characters and add an ellipsis.</p>
<dl class="simple">
<dt>The ‘namelength’ property is an integer and may be specified as:</dt><dd><ul class="simple">
<li><p>An int (or float that will be cast to an int)
in the interval [-1, 9223372036854775807]</p></li>
<li><p>A tuple, list, or one-dimensional numpy array of the above</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>int|numpy.ndarray</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.image.Hoverlabel.showarrow">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">showarrow</span></code><a class="headerlink" href="#plotly.graph_objects.image.Hoverlabel.showarrow" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets whether or not to show the hover label arrow/triangle
pointing to the data point.</p>
<dl class="simple">
<dt>The ‘showarrow’ property is a boolean and must be specified as:</dt><dd><ul class="simple">
<li><p>A boolean value: True or False</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)">bool</a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="plotly.graph_objects.image.Legendgrouptitle">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">plotly.graph_objects.image.</span></code><code class="sig-name descname"><span class="pre">Legendgrouptitle</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">font</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#plotly.graph_objects.image.Legendgrouptitle" title="Permalink to this definition">¶</a></dt>
<dd><dl class="py method">
<dt id="plotly.graph_objects.image.Legendgrouptitle.font">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">font</span></code><a class="headerlink" href="#plotly.graph_objects.image.Legendgrouptitle.font" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets this legend group’s title font.</p>
<p>The ‘font’ property is an instance of Font
that may be specified as:</p>
<blockquote>
<div><ul class="simple">
<li><p>An instance of <a class="reference internal" href="plotly.graph_objects.image.legendgrouptitle.html#plotly.graph_objects.image.legendgrouptitle.Font" title="plotly.graph_objects.image.legendgrouptitle.Font"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotly.graph_objects.image.legendgrouptitle.Font</span></code></a></p></li>
<li><p>A dict of string/value properties that will be passed
to the Font constructor</p></li>
</ul>
</div></blockquote>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="plotly.graph_objects.image.legendgrouptitle.html#plotly.graph_objects.image.legendgrouptitle.Font" title="plotly.graph_objects.image.legendgrouptitle.Font">plotly.graph_objects.image.legendgrouptitle.Font</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="plotly.graph_objects.image.Legendgrouptitle.text">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">text</span></code><a class="headerlink" href="#plotly.graph_objects.image.Legendgrouptitle.text" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the title of the legend group.</p>
<dl class="simple">
<dt>The ‘text’ property is a string and must be specified as:</dt><dd><ul class="simple">
<li><p>A string</p></li>
<li><p>A number that will be converted to a string</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">str</a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<div class="clearer"></div></div>
</div>
</div>
</div>
<script type="text/javascript">
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>