-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.html
3881 lines (3877 loc) · 277 KB
/
api.html
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
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 data-content_root="./" lang="en">
<head>
<meta charset="utf-8"/>
<meta content="width=device-width, initial-scale=1.0" name="viewport"/><meta content="width=device-width, initial-scale=1" name="viewport"/>
<title>API — Datashader v0.16.3</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet"/>
<link href="_static/styles/bootstrap.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet"/>
<link href="_static/styles/pydata-sphinx-theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet"/>
<link href="_static/vendor/fontawesome/6.5.2/css/all.min.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet"/>
<link as="font" crossorigin="" href="_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2" rel="preload" type="font/woff2"/>
<link as="font" crossorigin="" href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" rel="preload" type="font/woff2"/>
<link as="font" crossorigin="" href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" rel="preload" type="font/woff2"/>
<link href="_static/pygments.css?v=fa44fd50" rel="stylesheet" type="text/css"/>
<link href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" rel="stylesheet" type="text/css"/>
<link href="_static/graphviz.css?v=fd3f3429" rel="stylesheet" type="text/css"/>
<link href="_static/copybutton.css?v=76b2166b" rel="stylesheet" type="text/css"/>
<link href="_static/sphinx-design.min.css?v=87e54e7c" rel="stylesheet" type="text/css"/>
<link href="_static/nbsite.css?v=d9d93254" rel="stylesheet" type="text/css"/>
<link href="_static/notebook.css?v=19946987" rel="stylesheet" type="text/css"/>
<link href="_static/gallery.css?v=0a3248cd" rel="stylesheet" type="text/css"/>
<link href="_static/alert.css?v=c26666be" rel="stylesheet" type="text/css"/>
<link href="_static/dataframe.css?v=a0f274c1" rel="stylesheet" type="text/css"/>
<link href="_static/scroller.css?v=2dcde208" rel="stylesheet" type="text/css"/>
<link href="_static/css/custom.css?v=471973f3" rel="stylesheet" type="text/css"/>
<!-- Pre-loaded scripts that we'll load fully later -->
<link as="script" href="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" rel="preload"/>
<link as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" rel="preload"/>
<script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
<script src="_static/documentation_options.js?v=4a1014be"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=f281be69"></script>
<script src="_static/design-tabs.js?v=f930bc37"></script>
<script>
window.goatcounter = {
path: function(p) { return location.host + p }
}
</script>
<script async="async" data-goatcounter="https://holoviz.goatcounter.com/count" src="_static/js/goatcounter.js?v=f53f84b8"></script>
<script>
window.goatcounter = {
path: function(p) { return location.host + p }
}
</script>
<script>DOCUMENTATION_OPTIONS.pagename = 'api';</script>
<link href="_static/favicon.ico" rel="icon"/>
<link href="about.html" rel="author" title="About these documents"/>
<link href="genindex.html" rel="index" title="Index"/>
<link href="search.html" rel="search" title="Search"/>
<link href="FAQ.html" rel="next" title="FAQ"/>
<link href="releases.html" rel="prev" title="Releases"/>
<meta content="width=device-width, initial-scale=1" name="viewport"/>
<meta content="en" name="docsearch:language"/>
<meta content="2024-08-01" name="docbuild:last-update"/>
</head>
<body data-bs-root-margin="0px 0px -60%" data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-default-mode="" data-offset="180">
<div class="skip-link d-print-none" id="pst-skip-link"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button class="btn rounded-pill" id="pst-back-to-top" type="button">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<input class="sidebar-toggle" id="pst-primary-sidebar-checkbox" type="checkbox"/>
<label class="overlay overlay-primary" for="pst-primary-sidebar-checkbox"></label>
<input class="sidebar-toggle" id="pst-secondary-sidebar-checkbox" type="checkbox"/>
<label class="overlay overlay-secondary" for="pst-secondary-sidebar-checkbox"></label>
<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<form action="search.html" class="bd-search d-flex align-items-center" method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input aria-label="Search the docs ..." autocapitalize="off" autocomplete="off" autocorrect="off" class="form-control" id="search-input" name="q" placeholder="Search the docs ..." spellcheck="false" type="search"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>
<div class="pst-async-banner-revealer d-none">
<aside aria-label="Version warning" class="d-none d-print-none" id="bd-header-version-warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button aria-label="Site navigation" class="pst-navbar-icon sidebar-toggle primary-toggle">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="index.html">
<img alt="Datashader v0.16.3 - Home" class="logo__image only-light" src="_static/logo_horizontal.svg"/>
<script>document.write(`<img src="_static/logo_horizontal.svg" class="logo__image only-dark" alt="Datashader v0.16.3 - Home"/>`);</script>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item">
<a class="nav-link nav-internal" href="index.html">
Introduction
</a>
</li>
<li class="nav-item">
<a class="nav-link nav-internal" href="getting_started/index.html">
Getting Started
</a>
</li>
<li class="nav-item">
<a class="nav-link nav-internal" href="user_guide/index.html">
User Guide
</a>
</li>
<li class="nav-item">
<a class="nav-link nav-internal" href="topics/index.html">
Topics
</a>
</li>
<li class="nav-item">
<a class="nav-link nav-internal" href="releases.html">
Releases
</a>
</li>
<li class="nav-item dropdown">
<button aria-controls="pst-nav-more-links" aria-expanded="false" class="btn dropdown-toggle nav-item" data-bs-toggle="dropdown" type="button">
More
</button>
<ul class="dropdown-menu" id="pst-nav-more-links">
<li class="current active">
<a class="nav-link dropdown-item nav-internal" href="#">
API
</a>
</li>
<li class="">
<a class="nav-link dropdown-item nav-internal" href="FAQ.html">
FAQ
</a>
</li>
<li class="">
<a class="nav-link dropdown-item nav-internal" href="about.html">
About
</a>
</li>
</ul>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<script>
document.write(`
<button class="btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
`);
</script>
</div>
<div class="navbar-item">
<script>
document.write(`
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
</button>
`);
</script></div>
<div class="navbar-item"><ul aria-label="Icon Links" class="navbar-icon-links">
<li class="nav-item">
<a class="nav-link pst-navbar-icon" data-bs-placement="bottom" data-bs-toggle="tooltip" href="https://github.com/holoviz/datashader" rel="noopener" target="_blank" title="GitHub"><i aria-hidden="true" class="fa-brands fa-square-github fa-lg"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a class="nav-link pst-navbar-icon" data-bs-placement="bottom" data-bs-toggle="tooltip" href="https://twitter.com/datashader" rel="noopener" target="_blank" title="Twitter"><i aria-hidden="true" class="fa-brands fa-twitter-square fa-lg"></i>
<span class="sr-only">Twitter</span></a>
</li>
<li class="nav-item">
<a class="nav-link pst-navbar-icon" data-bs-placement="bottom" data-bs-toggle="tooltip" href="https://discourse.holoviz.org/c/datashader/" rel="noopener" target="_blank" title="Discourse"><i aria-hidden="true" class="fa-brands fa-discourse fa-lg"></i>
<span class="sr-only">Discourse</span></a>
</li>
<li class="nav-item">
<a class="nav-link pst-navbar-icon" data-bs-placement="bottom" data-bs-toggle="tooltip" href="https://holoviz.org/" rel="noopener" target="_blank" title="HoloViz"><img alt="HoloViz" class="icon-link-image" src="_static/holoviz-icon-white.svg"/></a>
</li>
<li class="nav-item">
<a class="nav-link pst-navbar-icon" data-bs-placement="bottom" data-bs-toggle="tooltip" href="https://discord.gg/AXRHnJU6sP" rel="noopener" target="_blank" title="Discord"><i aria-hidden="true" class="fa-brands fa-discord fa-lg"></i>
<span class="sr-only">Discord</span></a>
</li>
</ul></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<script>
document.write(`
<button class="btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
`);
</script>
</div>
<button aria-label="On this page" class="pst-navbar-icon sidebar-toggle secondary-toggle">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<div class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item">
<a class="nav-link nav-internal" href="index.html">
Introduction
</a>
</li>
<li class="nav-item">
<a class="nav-link nav-internal" href="getting_started/index.html">
Getting Started
</a>
</li>
<li class="nav-item">
<a class="nav-link nav-internal" href="user_guide/index.html">
User Guide
</a>
</li>
<li class="nav-item">
<a class="nav-link nav-internal" href="topics/index.html">
Topics
</a>
</li>
<li class="nav-item">
<a class="nav-link nav-internal" href="releases.html">
Releases
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="#">
API
</a>
</li>
<li class="nav-item">
<a class="nav-link nav-internal" href="FAQ.html">
FAQ
</a>
</li>
<li class="nav-item">
<a class="nav-link nav-internal" href="about.html">
About
</a>
</li>
</ul>
</nav></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<script>
document.write(`
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
</button>
`);
</script></div>
<div class="navbar-item"><ul aria-label="Icon Links" class="navbar-icon-links">
<li class="nav-item">
<a class="nav-link pst-navbar-icon" data-bs-placement="bottom" data-bs-toggle="tooltip" href="https://github.com/holoviz/datashader" rel="noopener" target="_blank" title="GitHub"><i aria-hidden="true" class="fa-brands fa-square-github fa-lg"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a class="nav-link pst-navbar-icon" data-bs-placement="bottom" data-bs-toggle="tooltip" href="https://twitter.com/datashader" rel="noopener" target="_blank" title="Twitter"><i aria-hidden="true" class="fa-brands fa-twitter-square fa-lg"></i>
<span class="sr-only">Twitter</span></a>
</li>
<li class="nav-item">
<a class="nav-link pst-navbar-icon" data-bs-placement="bottom" data-bs-toggle="tooltip" href="https://discourse.holoviz.org/c/datashader/" rel="noopener" target="_blank" title="Discourse"><i aria-hidden="true" class="fa-brands fa-discourse fa-lg"></i>
<span class="sr-only">Discourse</span></a>
</li>
<li class="nav-item">
<a class="nav-link pst-navbar-icon" data-bs-placement="bottom" data-bs-toggle="tooltip" href="https://holoviz.org/" rel="noopener" target="_blank" title="HoloViz"><img alt="HoloViz" class="icon-link-image" src="_static/holoviz-icon-white.svg"/></a>
</li>
<li class="nav-item">
<a class="nav-link pst-navbar-icon" data-bs-placement="bottom" data-bs-toggle="tooltip" href="https://discord.gg/AXRHnJU6sP" rel="noopener" target="_blank" title="Discord"><i aria-hidden="true" class="fa-brands fa-discord fa-lg"></i>
<span class="sr-only">Discord</span></a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item"><!-- Adapted from sidebar-nav-bs.html (1.15.2) with the following changes
- Commented out the tag that adds the "Section Navigation" title
- Call generate_toctree_html with startdepth=0
Please update this file when required when bumping the max pin of pydata-sphinx-theme.
-->
<nav aria-label="Section Navigation" class="bd-docs-nav bd-links">
<!-- <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p> -->
<div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="index.html">Introduction</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="getting_started/index.html">Getting Started</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="getting_started/Introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started/Pipeline.html">Pipeline</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started/Interactivity.html">Interactivity</a></li>
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="user_guide/index.html">User Guide</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="user_guide/Plotting_Pitfalls.html">Plotting Pitfalls</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/Points.html">Points</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/Timeseries.html">Timeseries</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/Trajectories.html">Trajectories</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/Grids.html">Grids</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/Trimesh.html">Trimesh</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/Networks.html">Networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/Polygons.html">Polygons</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/Extending.html">Extending</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/Performance.html">Performance</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/Geography.html">Geography</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/Inspection_Reductions.html">Inspection Reductions</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/Geopandas.html">GeoPandas</a></li>
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="topics/index.html">Topics</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference external" href="https://examples.pyviz.org/census/census.html">Census</a></li>
<li class="toctree-l2"><a class="reference external" href="https://examples.pyviz.org/gerrymandering/gerrymandering.html">Gerrymandering</a></li>
<li class="toctree-l2"><a class="reference external" href="https://examples.pyviz.org/landsat/landsat.html">Landsat</a></li>
<li class="toctree-l2"><a class="reference external" href="https://examples.pyviz.org/network_packets/network_packets.html">Network Packets</a></li>
<li class="toctree-l2"><a class="reference external" href="https://examples.pyviz.org/nyc_taxi/nyc_taxi-nongeo.html">NYC Taxi</a></li>
<li class="toctree-l2"><a class="reference external" href="https://examples.pyviz.org/opensky/opensky.html">OpenSky</a></li>
<li class="toctree-l2"><a class="reference external" href="https://examples.pyviz.org/osm/osm-1billion.html">OSM 1 Billion</a></li>
<li class="toctree-l2"><a class="reference external" href="https://examples.pyviz.org/osm/osm-3billion.html">OSM</a></li>
<li class="toctree-l2"><a class="reference external" href="https://examples.pyviz.org/datashader_dashboard/dashboard.html">Dashboard</a></li>
<li class="toctree-l2"><a class="reference external" href="https://examples.pyviz.org/attractors/attractors.html">Strange attractors</a></li>
<li class="toctree-l2"><a class="reference external" href="https://examples.pyviz.org/bay_trimesh/bay_trimesh.html">Bay Trimesh</a></li>
<li class="toctree-l2"><a class="reference external" href="https://anaconda.org/defusco/amz_centers/notebook">Amazon.com center distance</a></li>
<li class="toctree-l2"><a class="reference external" href="https://examples.pyviz.org/uk_researchers/uk_researchers.html">UK Researchers</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="FAQ.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
<div id="rtd-footer-container"></div>
</div>
<main class="bd-main" id="main-content" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a aria-label="Home" class="nav-link" href="index.html">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li aria-current="page" class="breadcrumb-item active">API</li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="api">
<h1>API<a class="headerlink" href="#api" title="Link to this heading">#</a></h1>
<section id="entry-points">
<h2>Entry Points<a class="headerlink" href="#entry-points" title="Link to this heading">#</a></h2>
<p><strong>Canvas</strong></p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.Canvas" title="datashader.Canvas"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Canvas</span></code></a>([plot_width, plot_height, x_range, ...])</p></td>
<td><p>An abstract canvas representing the space in which to bin.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Canvas.line</span></code>(source[, x, y, agg, axis, ...])</p></td>
<td><p>Compute a reduction by pixel, mapping data to pixels as one or more lines.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Canvas.points</span></code>(source[, x, y, agg, geometry])</p></td>
<td><p>Compute a reduction by pixel, mapping data to pixels as points.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Canvas.raster</span></code>(source[, layer, ...])</p></td>
<td><p>Sample a raster dataset by canvas size and bounds.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Canvas.trimesh</span></code>(vertices, simplices[, mesh, ...])</p></td>
<td><p>Compute a reduction by pixel, mapping data to pixels as a triangle.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Canvas.validate</span></code>()</p></td>
<td><p>Check that parameter settings are valid for this object</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Canvas.area</span></code>(source, x, y[, agg, axis, y_stack])</p></td>
<td><p>Compute a reduction by pixel, mapping data to pixels as a filled area region</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Canvas.polygons</span></code>(source, geometry[, agg])</p></td>
<td><p>Compute a reduction by pixel, mapping data to pixels as one or more filled polygons.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Canvas.quadmesh</span></code>(source[, x, y, agg])</p></td>
<td><p>Samples a recti- or curvi-linear quadmesh by canvas size and bounds.</p></td>
</tr>
</tbody>
</table>
</div>
<p><strong>Pipeline</strong></p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.Pipeline" title="datashader.Pipeline"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Pipeline</span></code></a>(df, glyph[, agg, transform_fn, ...])</p></td>
<td><p>A datashading pipeline callback.</p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="edge-bundling">
<h2>Edge Bundling<a class="headerlink" href="#edge-bundling" title="Link to this heading">#</a></h2>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.bundling.directly_connect_edges" title="datashader.bundling.directly_connect_edges"><code class="xref py py-obj docutils literal notranslate"><span class="pre">directly_connect_edges</span></code></a></p></td>
<td><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">connect_edges</span></code></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.bundling.hammer_bundle" title="datashader.bundling.hammer_bundle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hammer_bundle</span></code></a>(*, accuracy, ...)</p></td>
<td><p>Iteratively group edges and return as paths suitable for datashading.</p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="glyphs">
<h2>Glyphs<a class="headerlink" href="#glyphs" title="Link to this heading">#</a></h2>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.glyphs.Point" title="datashader.glyphs.Point"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Point</span></code></a>(x, y)</p></td>
<td><p>A point, with center at <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.glyphs.Triangles" title="datashader.glyphs.Triangles"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Triangles</span></code></a>(x, y[, z, weight_type, interp])</p></td>
<td><p>An unstructured mesh of triangles, with vertices defined by <code class="docutils literal notranslate"><span class="pre">xs</span></code> and <code class="docutils literal notranslate"><span class="pre">ys</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.glyphs.PolygonGeom" title="datashader.glyphs.PolygonGeom"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PolygonGeom</span></code></a>(geometry)</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.glyphs.QuadMeshRaster" title="datashader.glyphs.QuadMeshRaster"><code class="xref py py-obj docutils literal notranslate"><span class="pre">QuadMeshRaster</span></code></a>(x, y, name)</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.glyphs.QuadMeshRectilinear" title="datashader.glyphs.QuadMeshRectilinear"><code class="xref py py-obj docutils literal notranslate"><span class="pre">QuadMeshRectilinear</span></code></a>(x, y, name)</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.glyphs.QuadMeshCurvilinear" title="datashader.glyphs.QuadMeshCurvilinear"><code class="xref py py-obj docutils literal notranslate"><span class="pre">QuadMeshCurvilinear</span></code></a>(x, y, name)</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.glyphs.LineAxis0" title="datashader.glyphs.LineAxis0"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LineAxis0</span></code></a>(x, y)</p></td>
<td><p>A line, with vertices defined by <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.glyphs.LineAxis0Multi" title="datashader.glyphs.LineAxis0Multi"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LineAxis0Multi</span></code></a>(x, y)</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.glyphs.LinesAxis1" title="datashader.glyphs.LinesAxis1"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LinesAxis1</span></code></a>(x, y)</p></td>
<td><p>A collection of lines (on line per row) with vertices defined by the lists of columns in <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.glyphs.LinesAxis1XConstant" title="datashader.glyphs.LinesAxis1XConstant"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LinesAxis1XConstant</span></code></a>(x, y)</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.glyphs.LinesAxis1YConstant" title="datashader.glyphs.LinesAxis1YConstant"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LinesAxis1YConstant</span></code></a>(x, y)</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.glyphs.LinesAxis1Ragged" title="datashader.glyphs.LinesAxis1Ragged"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LinesAxis1Ragged</span></code></a>(x, y)</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.glyphs.LineAxis1Geometry" title="datashader.glyphs.LineAxis1Geometry"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LineAxis1Geometry</span></code></a>(geometry)</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.glyphs.AreaToZeroAxis0" title="datashader.glyphs.AreaToZeroAxis0"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AreaToZeroAxis0</span></code></a>(x, y)</p></td>
<td><p>A filled area glyph.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.glyphs.AreaToZeroAxis0Multi" title="datashader.glyphs.AreaToZeroAxis0Multi"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AreaToZeroAxis0Multi</span></code></a>(x, y)</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.glyphs.AreaToZeroAxis1" title="datashader.glyphs.AreaToZeroAxis1"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AreaToZeroAxis1</span></code></a>(x, y)</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.glyphs.AreaToZeroAxis1XConstant" title="datashader.glyphs.AreaToZeroAxis1XConstant"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AreaToZeroAxis1XConstant</span></code></a>(x, y)</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.glyphs.AreaToZeroAxis1YConstant" title="datashader.glyphs.AreaToZeroAxis1YConstant"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AreaToZeroAxis1YConstant</span></code></a>(x, y)</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.glyphs.AreaToZeroAxis1Ragged" title="datashader.glyphs.AreaToZeroAxis1Ragged"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AreaToZeroAxis1Ragged</span></code></a>(x, y)</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.glyphs.AreaToLineAxis0" title="datashader.glyphs.AreaToLineAxis0"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AreaToLineAxis0</span></code></a>(x, y, y_stack)</p></td>
<td><p>A filled area glyph The area to be filled is the region from the line defined by <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y[0]</span></code> and the line defined by <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y[1]</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.glyphs.AreaToLineAxis0Multi" title="datashader.glyphs.AreaToLineAxis0Multi"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AreaToLineAxis0Multi</span></code></a>(x, y, y_stack)</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.glyphs.AreaToLineAxis1" title="datashader.glyphs.AreaToLineAxis1"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AreaToLineAxis1</span></code></a>(x, y, y_stack)</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.glyphs.AreaToLineAxis1XConstant" title="datashader.glyphs.AreaToLineAxis1XConstant"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AreaToLineAxis1XConstant</span></code></a>(x, y, y_stack)</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.glyphs.AreaToLineAxis1YConstant" title="datashader.glyphs.AreaToLineAxis1YConstant"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AreaToLineAxis1YConstant</span></code></a>(x, y, y_stack)</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.glyphs.AreaToLineAxis1Ragged" title="datashader.glyphs.AreaToLineAxis1Ragged"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AreaToLineAxis1Ragged</span></code></a>(x, y, y_stack)</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="reductions">
<h2>Reductions<a class="headerlink" href="#reductions" title="Link to this heading">#</a></h2>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.reductions.any" title="datashader.reductions.any"><code class="xref py py-obj docutils literal notranslate"><span class="pre">any</span></code></a>([column])</p></td>
<td><p>Whether any elements in <code class="docutils literal notranslate"><span class="pre">column</span></code> map to each bin.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.reductions.count" title="datashader.reductions.count"><code class="xref py py-obj docutils literal notranslate"><span class="pre">count</span></code></a>([column, self_intersect])</p></td>
<td><p>Count elements in each bin, returning the result as a uint32, or a float32 if using antialiasing.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">by</span></code>(cat_column[, reduction])</p></td>
<td><p>Apply the provided reduction separately per category.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.reductions.first" title="datashader.reductions.first"><code class="xref py py-obj docutils literal notranslate"><span class="pre">first</span></code></a>([column])</p></td>
<td><p>First value encountered in <code class="docutils literal notranslate"><span class="pre">column</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.reductions.last" title="datashader.reductions.last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">last</span></code></a>([column])</p></td>
<td><p>Last value encountered in <code class="docutils literal notranslate"><span class="pre">column</span></code>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.reductions.m2" title="datashader.reductions.m2"><code class="xref py py-obj docutils literal notranslate"><span class="pre">m2</span></code></a>([column])</p></td>
<td><p>Sum of square differences from the mean of all elements in <code class="docutils literal notranslate"><span class="pre">column</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.reductions.max" title="datashader.reductions.max"><code class="xref py py-obj docutils literal notranslate"><span class="pre">max</span></code></a>([column])</p></td>
<td><p>Maximum value of all elements in <code class="docutils literal notranslate"><span class="pre">column</span></code>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.reductions.mean" title="datashader.reductions.mean"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mean</span></code></a>([column])</p></td>
<td><p>Mean of all elements in <code class="docutils literal notranslate"><span class="pre">column</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.reductions.min" title="datashader.reductions.min"><code class="xref py py-obj docutils literal notranslate"><span class="pre">min</span></code></a>([column])</p></td>
<td><p>Minimum value of all elements in <code class="docutils literal notranslate"><span class="pre">column</span></code>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.reductions.mode" title="datashader.reductions.mode"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mode</span></code></a>([column])</p></td>
<td><p>Mode (most common value) of all the values encountered in <code class="docutils literal notranslate"><span class="pre">column</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.reductions.std" title="datashader.reductions.std"><code class="xref py py-obj docutils literal notranslate"><span class="pre">std</span></code></a>([column])</p></td>
<td><p>Standard Deviation of all elements in <code class="docutils literal notranslate"><span class="pre">column</span></code>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.reductions.sum" title="datashader.reductions.sum"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sum</span></code></a>([column, self_intersect])</p></td>
<td><p>Sum of all elements in <code class="docutils literal notranslate"><span class="pre">column</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.reductions.summary" title="datashader.reductions.summary"><code class="xref py py-obj docutils literal notranslate"><span class="pre">summary</span></code></a>(**kwargs)</p></td>
<td><p>A collection of named reductions.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.reductions.var" title="datashader.reductions.var"><code class="xref py py-obj docutils literal notranslate"><span class="pre">var</span></code></a>([column])</p></td>
<td><p>Variance of all elements in <code class="docutils literal notranslate"><span class="pre">column</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.reductions.where" title="datashader.reductions.where"><code class="xref py py-obj docutils literal notranslate"><span class="pre">where</span></code></a>(selector[, lookup_column])</p></td>
<td><p>Returns values from a <code class="docutils literal notranslate"><span class="pre">lookup_column</span></code> corresponding to a <code class="docutils literal notranslate"><span class="pre">selector</span></code> reduction that is applied to some other column.</p></td>
</tr>
</tbody>
</table>
</div>
<p>The table below indicates which <code class="docutils literal notranslate"><span class="pre">Reduction</span></code> classes are supported on the CPU (e.g. using
<code class="docutils literal notranslate"><span class="pre">pandas</span></code>), on CPU with Dask (e.g. using <code class="docutils literal notranslate"><span class="pre">dask.dataframe</span></code>), on the GPU (e.g. using <code class="docutils literal notranslate"><span class="pre">cudf</span></code>),
and on the GPU with Dask (e.g. using <code class="docutils literal notranslate"><span class="pre">dask-cudf</span></code>). The final two columns indicate which reductions
support antialiased lines and which can be used as the <code class="docutils literal notranslate"><span class="pre">selector</span></code> in a
<a class="reference internal" href="#datashader.reductions.where" title="datashader.reductions.where"><code class="xref py py-class docutils literal notranslate"><span class="pre">where</span></code></a> reduction.</p>
<div class="pst-scrollable-table-container"><table class="table">
<thead>
<tr class="row-odd"><th class="head"></th>
<th class="head"><p>CPU</p></th>
<th class="head"><p>CPU + Dask</p></th>
<th class="head"><p>GPU</p></th>
<th class="head"><p>GPU + Dask</p></th>
<th class="head"><p>Antialiasing</p></th>
<th class="head"><p>Within <a class="reference internal" href="#datashader.reductions.where" title="datashader.reductions.where"><code class="xref py py-class docutils literal notranslate"><span class="pre">where</span></code></a></p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.reductions.any" title="datashader.reductions.any"><code class="xref py py-class docutils literal notranslate"><span class="pre">any</span></code></a></p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-class docutils literal notranslate"><span class="pre">by</span></code></p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.reductions.count" title="datashader.reductions.count"><code class="xref py py-class docutils literal notranslate"><span class="pre">count</span></code></a></p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.reductions.first" title="datashader.reductions.first"><code class="xref py py-class docutils literal notranslate"><span class="pre">first</span></code></a></p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-class docutils literal notranslate"><span class="pre">first_n</span></code></p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.reductions.last" title="datashader.reductions.last"><code class="xref py py-class docutils literal notranslate"><span class="pre">last</span></code></a></p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-class docutils literal notranslate"><span class="pre">last_n</span></code></p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.reductions.max" title="datashader.reductions.max"><code class="xref py py-class docutils literal notranslate"><span class="pre">max</span></code></a></p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-class docutils literal notranslate"><span class="pre">max_n</span></code></p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.reductions.mean" title="datashader.reductions.mean"><code class="xref py py-class docutils literal notranslate"><span class="pre">mean</span></code></a></p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.reductions.min" title="datashader.reductions.min"><code class="xref py py-class docutils literal notranslate"><span class="pre">min</span></code></a></p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-class docutils literal notranslate"><span class="pre">min_n</span></code></p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.reductions.std" title="datashader.reductions.std"><code class="xref py py-class docutils literal notranslate"><span class="pre">std</span></code></a></p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.reductions.sum" title="datashader.reductions.sum"><code class="xref py py-class docutils literal notranslate"><span class="pre">sum</span></code></a></p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.reductions.var" title="datashader.reductions.var"><code class="xref py py-class docutils literal notranslate"><span class="pre">var</span></code></a></p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<p>The <a class="reference internal" href="#datashader.reductions.mode" title="datashader.reductions.mode"><code class="xref py py-class docutils literal notranslate"><span class="pre">mode</span></code></a> reduction is not listed in the table and can only be used
with <code class="docutils literal notranslate"><span class="pre">Canvas.raster</span></code>. A <code class="xref py py-class docutils literal notranslate"><span class="pre">by</span></code> reduction supports anything that its
contained reduction (that is applied separately to each category) supports.</p>
<p><strong>Categorizers</strong></p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">category_binning</span></code>(column, lower, upper, nbins)</p></td>
<td><p>A variation on category_codes that assigns categories by binning a continuous-valued column.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">category_modulo</span></code>(column, modulo[, offset])</p></td>
<td><p>A variation on category_codes that assigns categories using an integer column, modulo a base.</p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="transfer-functions">
<h2>Transfer Functions<a class="headerlink" href="#transfer-functions" title="Link to this heading">#</a></h2>
<p><strong>Image</strong></p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.transfer_functions.Image" title="datashader.transfer_functions.Image"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Image</span></code></a>(data, coords, dims, name, attrs, ...)</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Image.to_bytesio</span></code>([format, origin])</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Image.to_pil</span></code>([origin])</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
</div>
<p><strong>Images</strong></p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Images</span></code>(*images)</p></td>
<td><p>A list of HTML-representable objects to display in a table.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Images.cols</span></code>(n)</p></td>
<td><p>Set the number of columns to use in the HTML table.</p></td>
</tr>
</tbody>
</table>
</div>
<p><strong>Other</strong></p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.transfer_functions.dynspread" title="datashader.transfer_functions.dynspread"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dynspread</span></code></a>(img[, threshold, max_px, shape, ...])</p></td>
<td><p>Spread pixels in an image dynamically based on the image density.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.transfer_functions.set_background" title="datashader.transfer_functions.set_background"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_background</span></code></a>(img[, color, name])</p></td>
<td><p>Return a new image, with the background set to <cite>color</cite>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.transfer_functions.shade" title="datashader.transfer_functions.shade"><code class="xref py py-obj docutils literal notranslate"><span class="pre">shade</span></code></a>(agg[, cmap, color_key, how, alpha, ...])</p></td>
<td><p>Convert a DataArray to an image by choosing an RGBA pixel color for each value.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datashader.transfer_functions.spread" title="datashader.transfer_functions.spread"><code class="xref py py-obj docutils literal notranslate"><span class="pre">spread</span></code></a>(img[, px, shape, how, mask, name])</p></td>
<td><p>Spread pixels in an image.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datashader.transfer_functions.stack" title="datashader.transfer_functions.stack"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stack</span></code></a>(*imgs, **kwargs)</p></td>
<td><p>Combine images together, overlaying later images onto earlier ones.</p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="definitions">
<h2>Definitions<a class="headerlink" href="#definitions" title="Link to this heading">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="datashader.Canvas">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datashader.</span></span><span class="sig-name descname"><span class="pre">Canvas</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plot_width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">600</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plot_height</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">600</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_range</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">y_range</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">x_axis_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'linear'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_axis_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'linear'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/holoviz/datashader/blob/main/datashader/core.py#L155-L1312"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datashader.Canvas" title="Link to this definition">#</a></dt>
<dd><p>An abstract canvas representing the space in which to bin.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>plot_width, plot_height</strong><span class="classifier">int, optional</span></dt><dd><p>Width and height of the output aggregate in pixels.</p>
</dd>
<dt><strong>x_range, y_range</strong><span class="classifier">tuple, optional</span></dt><dd><p>A tuple representing the bounds inclusive space <code class="docutils literal notranslate"><span class="pre">[min,</span> <span class="pre">max]</span></code> along
the axis.</p>
</dd>
<dt><strong>x_axis_type, y_axis_type</strong><span class="classifier">str, optional</span></dt><dd><p>The type of the axis. Valid options are <code class="docutils literal notranslate"><span class="pre">'linear'</span></code> [default], and
<code class="docutils literal notranslate"><span class="pre">'log'</span></code>.</p>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Methods</p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">area</span></code>(source, x, y[, agg, axis, y_stack])</p></td>
<td><p>Compute a reduction by pixel, mapping data to pixels as a filled area region</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">line</span></code>(source[, x, y, agg, axis, geometry, ...])</p></td>
<td><p>Compute a reduction by pixel, mapping data to pixels as one or more lines.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">points</span></code>(source[, x, y, agg, geometry])</p></td>
<td><p>Compute a reduction by pixel, mapping data to pixels as points.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">polygons</span></code>(source, geometry[, agg])</p></td>
<td><p>Compute a reduction by pixel, mapping data to pixels as one or more filled polygons.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">quadmesh</span></code>(source[, x, y, agg])</p></td>
<td><p>Samples a recti- or curvi-linear quadmesh by canvas size and bounds.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">raster</span></code>(source[, layer, upsample_method, ...])</p></td>
<td><p>Sample a raster dataset by canvas size and bounds.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">trimesh</span></code>(vertices, simplices[, mesh, agg, ...])</p></td>
<td><p>Compute a reduction by pixel, mapping data to pixels as a triangle.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">validate</span></code>()</p></td>
<td><p>Check that parameter settings are valid for this object</p></td>
</tr>
</tbody>
</table>
</div>
<div class="pst-scrollable-table-container"><table class="table">
<tbody>
<tr class="row-odd"><td><p><strong>validate_ranges</strong></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><strong>validate_size</strong></p></td>
<td></td>
</tr>
</tbody>
</table>
</div>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="datashader.Pipeline">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datashader.</span></span><span class="sig-name descname"><span class="pre">Pipeline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">df</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">glyph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">agg=<datashader.reductions.count</span> <span class="pre">object></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transform_fn=<function</span> <span class="pre">identity></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color_fn=<function</span> <span class="pre">shade></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spread_fn=<function</span> <span class="pre">dynspread></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width_scale=1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height_scale=1.0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/holoviz/datashader/blob/main/datashader/pipeline.py#L10-L72"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datashader.Pipeline" title="Link to this definition">#</a></dt>
<dd><p>A datashading pipeline callback.</p>
<p>Given a declarative specification, creates a callable with the following
signature:</p>
<p><code class="docutils literal notranslate"><span class="pre">callback(x_range,</span> <span class="pre">y_range,</span> <span class="pre">width,</span> <span class="pre">height)</span></code></p>
<p>where <code class="docutils literal notranslate"><span class="pre">x_range</span></code> and <code class="docutils literal notranslate"><span class="pre">y_range</span></code> form the bounding box on the viewport,
and <code class="docutils literal notranslate"><span class="pre">width</span></code> and <code class="docutils literal notranslate"><span class="pre">height</span></code> specify the output image dimensions.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>df</strong><span class="classifier">pandas.DataFrame, dask.DataFrame</span></dt><dd></dd>
<dt><strong>glyph</strong><span class="classifier">Glyph</span></dt><dd><p>The glyph to bin by.</p>
</dd>
<dt><strong>agg</strong><span class="classifier">Reduction, optional</span></dt><dd><p>The reduction to compute per-pixel. Default is <code class="docutils literal notranslate"><span class="pre">count()</span></code>.</p>
</dd>
<dt><strong>transform_fn</strong><span class="classifier">callable, optional</span></dt><dd><p>A callable that takes the computed aggregate as an argument, and
returns another aggregate. This can be used to do preprocessing before
passing to the <code class="docutils literal notranslate"><span class="pre">color_fn</span></code> function.</p>
</dd>
<dt><strong>color_fn</strong><span class="classifier">callable, optional</span></dt><dd><p>A callable that takes the output of <code class="docutils literal notranslate"><span class="pre">tranform_fn</span></code>, and returns an
<code class="docutils literal notranslate"><span class="pre">Image</span></code> object. Default is <code class="docutils literal notranslate"><span class="pre">shade</span></code>.</p>
</dd>
<dt><strong>spread_fn</strong><span class="classifier">callable, optional</span></dt><dd><p>A callable that takes the output of <code class="docutils literal notranslate"><span class="pre">color_fn</span></code>, and returns another
<code class="docutils literal notranslate"><span class="pre">Image</span></code> object. Default is <code class="docutils literal notranslate"><span class="pre">dynspread</span></code>.</p>
</dd>
<dt><strong>height_scale: float, optional</strong></dt><dd><p>Factor by which to scale the provided height</p>
</dd>
<dt><strong>width_scale: float, optional</strong></dt><dd><p>Factor by which to scale the provided width</p>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Methods</p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">__call__</span></code>([x_range, y_range, width, height])</p></td>
<td><p>Compute an image from the specified pipeline.</p></td>
</tr>
</tbody>
</table>
</div>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="datashader.bundling.directly_connect_edges">
<span class="sig-prename descclassname"><span class="pre">datashader.bundling.</span></span><span class="sig-name descname"><span class="pre">directly_connect_edges</span></span><a class="reference external" href="https://github.com/holoviz/datashader/blob/main/datashader/bundling.py#L367-L408"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datashader.bundling.directly_connect_edges" title="Link to this definition">#</a></dt>
<dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">connect_edges</span></code></p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="datashader.bundling.hammer_bundle">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datashader.bundling.</span></span><span class="sig-name descname"><span class="pre">hammer_bundle</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">accuracy</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">advect_iterations</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">batch_size</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decay</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">initial_bandwidth</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iterations</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_segment_length</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_segment_length</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tension</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_edge_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">weight</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/holoviz/datashader/blob/main/datashader/bundling.py#L421-L533"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datashader.bundling.hammer_bundle" title="Link to this definition">#</a></dt>
<dd><p>Iteratively group edges and return as paths suitable for datashading.</p>
<p>Breaks each edge into a path with multiple line segments, and
iteratively curves this path to bundle edges into groups.</p>
<p class="rubric">Methods</p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">__call__</span></code>(nodes, edges, **params)</p></td>
<td><p>Convert a graph data structure into a path structure for plotting</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">instance</span></code>(**params)</p></td>
<td><p>Return an instance of this class, copying parameters from any existing instance provided.</p></td>
</tr>
</tbody>
</table>
</div>
<p>Parameters inherited from:</p>
<blockquote>
<div><p><code class="xref py py-class docutils literal notranslate"><span class="pre">datashader.bundling.connect_edges</span></code>: x, y, source, target, include_edge_id</p>
</div></blockquote>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">weight</span></code> = param.String(allow_None=True, allow_refs=False, default=’weight’, label=’Weight’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x13a95f990>)</dt><dd><p>Column name for each edge weight. If None, weights are ignored.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">initial_bandwidth</span></code> = param.Number(allow_refs=False, bounds=(0.0, None), default=0.05, inclusive_bounds=(True, True), label=’Initial bandwidth’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x13b9dc0d0>)</dt><dd><p>Initial value of the bandwidth….</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">decay</span></code> = param.Number(allow_refs=False, bounds=(0.0, 1.0), default=0.7, inclusive_bounds=(True, True), label=’Decay’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x13b904e90>)</dt><dd><p>Rate of decay in the bandwidth value, with 1.0 indicating no decay.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">iterations</span></code> = param.Integer(allow_refs=False, bounds=(1, None), default=4, inclusive_bounds=(True, True), label=’Iterations’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x13b7f2250>)</dt><dd><p>Number of passes for the smoothing algorithm</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">batch_size</span></code> = param.Integer(allow_refs=False, bounds=(1, None), default=20000, inclusive_bounds=(True, True), label=’Batch size’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x13b8ddd50>)</dt><dd><p>Number of edges to process together</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">tension</span></code> = param.Number(allow_refs=False, bounds=(0, None), default=0.3, inclusive_bounds=(True, True), label=’Tension’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x13bc05750>)</dt><dd><p>Exponential smoothing factor to use when smoothing</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">accuracy</span></code> = param.Integer(allow_refs=False, bounds=(1, None), default=500, inclusive_bounds=(True, True), label=’Accuracy’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x13b8ddd50>)</dt><dd><p>Number of entries in table for…</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">advect_iterations</span></code> = param.Integer(allow_refs=False, bounds=(0, None), default=50, inclusive_bounds=(True, True), label=’Advect iterations’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x13b942250>)</dt><dd><p>Number of iterations to move edges along gradients</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">min_segment_length</span></code> = param.Number(allow_refs=False, bounds=(0, None), default=0.008, inclusive_bounds=(True, True), label=’Min segment length’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x13b8b2190>)</dt><dd><p>Minimum length (in data space?) for an edge segment</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">max_segment_length</span></code> = param.Number(allow_refs=False, bounds=(0, None), default=0.016, inclusive_bounds=(True, True), label=’Max segment length’, nested_refs=False, rx=<param.reactive.reactive_ops object at 0x13b942250>)</dt><dd><p>Maximum length (in data space?) for an edge segment</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="datashader.glyphs.Point">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datashader.glyphs.</span></span><span class="sig-name descname"><span class="pre">Point</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/holoviz/datashader/blob/main/datashader/glyphs/points.py#L170-L242"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#datashader.glyphs.Point" title="Link to this definition">#</a></dt>
<dd><p>A point, with center at <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code>.</p>
<p>Points map each record to a single bin.
Points falling exactly on the upper bounds are treated as a special case,
mapping into the previous bin rather than being cropped off.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>x, y</strong><span class="classifier">str</span></dt><dd><p>Column names for the x and y coordinates of each point.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Attributes<span class="colon">:</span></dt>
<dd class="field-even"><dl class="simple">
<dt><strong>inputs</strong></dt><dd></dd>
<dt><code class="xref py py-obj docutils literal notranslate"><span class="pre">ndims</span></code></dt><dd><p>The number of dimensions required in the data structure this Glyph is constructed from.</p>
</dd>
<dt><strong>x_label</strong></dt><dd></dd>
<dt><strong>y_label</strong></dt><dd></dd>
</dl>
</dd>
</dl>
<p class="rubric">Methods</p>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">expand_aggs_and_cols</span></code>(append)</p></td>
<td><p>Create a decorator that can be used on functions that accept <a href="#id1"><span class="problematic" id="id2">*</span></a>aggs_and_cols as a variable length argument. The decorator will replace <a href="#id3"><span class="problematic" id="id4">*</span></a>aggs_and_cols with a fixed number of arguments.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="pst-scrollable-table-container"><table class="table">
<tbody>
<tr class="row-odd"><td><p><strong>compute_bounds_dask</strong></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><strong>compute_x_bounds</strong></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><strong>compute_y_bounds</strong></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><strong>maybe_expand_bounds</strong></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><strong>required_columns</strong></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><strong>to_cupy_array</strong></p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><strong>validate</strong></p></td>
<td></td>
</tr>
</tbody>
</table>