-
Notifications
You must be signed in to change notification settings - Fork 15
Expand file tree
/
Copy pathpsyplot.plotter.html
More file actions
2513 lines (2367 loc) · 276 KB
/
Copy pathpsyplot.plotter.html
File metadata and controls
2513 lines (2367 loc) · 276 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
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 class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title><no title> — psyplot documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../_static/nc-table-styles.css?v=d585f46f" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=87e54e7c" />
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css" />
<link rel="shortcut icon" href="../_static/psyplot.ico"/>
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/design-tabs.js?v=f930bc37"></script>
<script src="../_static/js/theme.js"></script>
<link rel="author" title="About these documents" href="../about.html" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="<no title>" href="psyplot.project.html" />
<link rel="prev" title="<no title>" href="psyplot.gdal_store.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home">
psyplot
<img src="../_static/psyplot.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../about.html">About psyplot</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../about.html#why-psyplot">Why psyplot?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../about.html#what-it-is-and-what-it-is-not">What it is, and what it is not</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../about.html#what-it-is">What it is</a></li>
<li class="toctree-l3"><a class="reference internal" href="../about.html#what-it-is-not">What it is not</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../about.html#about-the-author">About the author</a></li>
<li class="toctree-l2"><a class="reference internal" href="../about.html#license">License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../installing.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../installing.html#how-to-install">How to install</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../installing.html#installation-using-conda">Installation using conda</a></li>
<li class="toctree-l3"><a class="reference internal" href="../installing.html#installation-using-pip">Installation using pip</a></li>
<li class="toctree-l3"><a class="reference internal" href="../installing.html#installation-from-source">Installation from source</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../installing.html#dependencies">Dependencies</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../installing.html#required-dependencies">Required dependencies</a></li>
<li class="toctree-l3"><a class="reference internal" href="../installing.html#optional-dependencies">Optional dependencies</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../installing.html#running-the-tests">Running the tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installing.html#building-the-docs">Building the docs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installing.html#uninstallation">Uninstallation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../installing.html#uninstallation-via-conda">Uninstallation via conda</a></li>
<li class="toctree-l3"><a class="reference internal" href="../installing.html#uninstallation-via-pip">Uninstallation via pip</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html#initialization-and-interactive-usage">Initialization and interactive usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html#choosing-the-dimension">Choosing the dimension</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html#configuring-the-appearance-of-the-plot">Configuring the appearance of the plot</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html#controlling-the-update">Controlling the update</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../getting_started.html#automatic-update">Automatic update</a></li>
<li class="toctree-l3"><a class="reference internal" href="../getting_started.html#direct-control-on-formatoption-update">Direct control on formatoption update</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html#creating-and-managing-multiple-plots">Creating and managing multiple plots</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../getting_started.html#creating-multiple-plots">Creating multiple plots</a></li>
<li class="toctree-l3"><a class="reference internal" href="../getting_started.html#slicing-and-filtering-the-project">Slicing and filtering the project</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html#saving-and-loading-your-project">Saving and loading your project</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html#using-presets">Using presets</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html#adding-your-own-script-the-post-formatoption">Adding your own script: The <code class="xref py py-attr docutils literal notranslate"><span class="pre">post</span></code> formatoption</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference external" href="https://psyplot.github.io/examples/">Example Gallery</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration.html">Configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../configuration.html#the-rcparams">The <code class="docutils literal notranslate"><span class="pre">rcParams</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="../configuration.html#default-formatoptions">Default formatoptions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects.html">Subprojects</a></li>
<li class="toctree-l1"><a class="reference internal" href="../accessors.html">xarray Accessors</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../accessors.html#the-datasetaccessor-dataset-accessor">The <code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetAccessor</span></code> dataset accessor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../accessors.html#the-interactivearray-dataarray-accessor">The <code class="xref py py-class docutils literal notranslate"><span class="pre">InteractiveArray</span></code> dataarray accessor</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../accessors.html#creating-plots-with-the-dataarray-accessor">Creating plots with the dataarray accessor</a></li>
<li class="toctree-l3"><a class="reference internal" href="../accessors.html#updating-plots-and-arrays-with-the-dataarray-accessor">Updating plots and arrays with the dataarray accessor</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../plugins.html">Psyplot plugins</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../plugins.html#existing-plugins">Existing plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugins.html#how-to-exclude-plugins">How to exclude plugins</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../plugins.html#the-psyplot-plugins-environment-variable">The <code class="docutils literal notranslate"><span class="pre">PSYPLOT_PLUGINS</span></code> environment variable</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugins.html#the-psyplot-plotmethods-environment-variable">The <code class="docutils literal notranslate"><span class="pre">PSYPLOT_PLOTMETHODS</span></code> environment variable</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../command_line.html">Command line usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../command_line.html#positional-arguments">Positional Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="../command_line.html#named-arguments">Named Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="../command_line.html#info-options">Info options</a></li>
<li class="toctree-l2"><a class="reference internal" href="../command_line.html#output-options">Output options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../develop/index.html">Developers guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../develop/framework.html">The psyplot framework</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../develop/framework.html#the-project-function">The <code class="xref py py-func docutils literal notranslate"><span class="pre">project()</span></code> function</a></li>
<li class="toctree-l3"><a class="reference internal" href="../develop/framework.html#the-interactivebase-and-the-plotter-classes">The <code class="xref py py-class docutils literal notranslate"><span class="pre">InteractiveBase</span></code> and the <code class="xref py py-class docutils literal notranslate"><span class="pre">Plotter</span></code> classes</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../develop/framework.html#interactive-data-objects">Interactive data objects</a></li>
<li class="toctree-l4"><a class="reference internal" href="../develop/framework.html#visualization-objects">Visualization objects</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../develop/framework.html#formatoptions">Formatoptions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../develop/plugins_guide.html">How to implement your own plotters and plugins</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../develop/plugins_guide.html#creating-plotters">Creating plotters</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../develop/plugins_guide.html#interface-for-the-plotter">Interface for the plotter</a></li>
<li class="toctree-l4"><a class="reference internal" href="../develop/plugins_guide.html#interface-to-the-data">Interface to the data</a></li>
<li class="toctree-l4"><a class="reference internal" href="../develop/plugins_guide.html#interfacing-to-other-formatoptions">Interfacing to other formatoptions</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../develop/plugins_guide.html#creating-new-plugins">Creating new plugins</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../develop/plugins_guide.html#creating-a-package-with-the-psyplot-plugin-template">Creating a package with the psyplot-plugin-template</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../develop/plugins_guide.html#rcparams-handling-in-plugins"><code class="docutils literal notranslate"><span class="pre">rcParams</span></code> handling in plugins</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contribution and development hints</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../contributing.html#code-of-conduct">Code of Conduct</a></li>
<li class="toctree-l2"><a class="reference internal" href="../contributing.html#what-should-i-know-before-i-get-started">What should I know before I get started?</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../contributing.html#the-psyplot-framework">The psyplot framework</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../contributing.html#contributing-in-the-development">Contributing in the development</a></li>
<li class="toctree-l2"><a class="reference internal" href="../contributing.html#helpers">Helpers</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../contributing.html#shortcuts-with-make">Shortcuts with make</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing.html#annotating-licenses">Annotating licenses</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../contributing.html#fixing-the-docs">Fixing the docs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../contributing.html#contributing-to-the-code">Contributing to the code</a></li>
<li class="toctree-l2"><a class="reference internal" href="../contributing.html#updating-the-skeleton-for-this-package">Updating the skeleton for this package</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="psyplot.html">psyplot package</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="psyplot.html#psyplot.get_versions"><code class="docutils literal notranslate"><span class="pre">get_versions()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="psyplot.html#psyplot.with_gui"><code class="docutils literal notranslate"><span class="pre">with_gui</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="psyplot.html#subpackages">Subpackages</a><ul>
<li class="toctree-l4"><a class="reference internal" href="psyplot.config.html">psyplot.config package</a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.sphinxext.html">psyplot.sphinxext package</a></li>
</ul>
</li>
<li class="toctree-l3 current"><a class="reference internal" href="psyplot.html#submodules">Submodules</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html"><code class="docutils literal notranslate"><span class="pre">AbsoluteTimeDecoder</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.AbsoluteTimeEncoder"><code class="docutils literal notranslate"><span class="pre">AbsoluteTimeEncoder</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.ArrayList"><code class="docutils literal notranslate"><span class="pre">ArrayList</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.CFDecoder"><code class="docutils literal notranslate"><span class="pre">CFDecoder</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.DatasetAccessor"><code class="docutils literal notranslate"><span class="pre">DatasetAccessor</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.InteractiveArray"><code class="docutils literal notranslate"><span class="pre">InteractiveArray</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.InteractiveBase"><code class="docutils literal notranslate"><span class="pre">InteractiveBase</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.InteractiveList"><code class="docutils literal notranslate"><span class="pre">InteractiveList</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.Signal"><code class="docutils literal notranslate"><span class="pre">Signal</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.UGridDecoder"><code class="docutils literal notranslate"><span class="pre">UGridDecoder</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.decode_absolute_time"><code class="docutils literal notranslate"><span class="pre">decode_absolute_time()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.encode_absolute_time"><code class="docutils literal notranslate"><span class="pre">encode_absolute_time()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.get_filename_ds"><code class="docutils literal notranslate"><span class="pre">get_filename_ds()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.get_fname_funcs"><code class="docutils literal notranslate"><span class="pre">get_fname_funcs</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.get_index_from_coord"><code class="docutils literal notranslate"><span class="pre">get_index_from_coord()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.get_tdata"><code class="docutils literal notranslate"><span class="pre">get_tdata()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.open_dataset"><code class="docutils literal notranslate"><span class="pre">open_dataset()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.open_mfdataset"><code class="docutils literal notranslate"><span class="pre">open_mfdataset()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.setup_coords"><code class="docutils literal notranslate"><span class="pre">setup_coords()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.t_patterns"><code class="docutils literal notranslate"><span class="pre">t_patterns</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.to_netcdf"><code class="docutils literal notranslate"><span class="pre">to_netcdf()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#psyplot.data.to_slice"><code class="docutils literal notranslate"><span class="pre">to_slice()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.docstring.html"><code class="docutils literal notranslate"><span class="pre">PsyplotDocstringProcessor</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.docstring.html#psyplot.docstring.append_original_doc"><code class="docutils literal notranslate"><span class="pre">append_original_doc()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.docstring.html#psyplot.docstring.dedent"><code class="docutils literal notranslate"><span class="pre">dedent()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.docstring.html#psyplot.docstring.docstrings"><code class="docutils literal notranslate"><span class="pre">docstrings</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.docstring.html#psyplot.docstring.indent"><code class="docutils literal notranslate"><span class="pre">indent()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.gdal_store.html"><code class="docutils literal notranslate"><span class="pre">GdalStore</span></code></a></li>
<li class="toctree-l4 current"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">BEFOREPLOTTING</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.plotter.DictFormatoption"><code class="docutils literal notranslate"><span class="pre">DictFormatoption</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.plotter.END"><code class="docutils literal notranslate"><span class="pre">END</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.plotter.Formatoption"><code class="docutils literal notranslate"><span class="pre">Formatoption</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.plotter.FormatoptionMeta"><code class="docutils literal notranslate"><span class="pre">FormatoptionMeta</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.plotter.Plotter"><code class="docutils literal notranslate"><span class="pre">Plotter</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.plotter.PostProcDependencies"><code class="docutils literal notranslate"><span class="pre">PostProcDependencies</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.plotter.PostProcessing"><code class="docutils literal notranslate"><span class="pre">PostProcessing</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.plotter.PostTiming"><code class="docutils literal notranslate"><span class="pre">PostTiming</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.plotter.START"><code class="docutils literal notranslate"><span class="pre">START</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.plotter.default_print_func"><code class="docutils literal notranslate"><span class="pre">default_print_func()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.plotter.format_time"><code class="docutils literal notranslate"><span class="pre">format_time()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.plotter.groups"><code class="docutils literal notranslate"><span class="pre">groups</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.plotter.is_data_dependent"><code class="docutils literal notranslate"><span class="pre">is_data_dependent()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html"><code class="docutils literal notranslate"><span class="pre">DataArrayPlotter</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.DataArrayPlotterInterface"><code class="docutils literal notranslate"><span class="pre">DataArrayPlotterInterface</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.DatasetPlotter"><code class="docutils literal notranslate"><span class="pre">DatasetPlotter</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.DatasetPlotterInterface"><code class="docutils literal notranslate"><span class="pre">DatasetPlotterInterface</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.PROJECT_CLS"><code class="docutils literal notranslate"><span class="pre">PROJECT_CLS</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.PlotterInterface"><code class="docutils literal notranslate"><span class="pre">PlotterInterface</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.Project"><code class="docutils literal notranslate"><span class="pre">Project</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.ProjectPlotter"><code class="docutils literal notranslate"><span class="pre">ProjectPlotter</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.close"><code class="docutils literal notranslate"><span class="pre">close()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.gcp"><code class="docutils literal notranslate"><span class="pre">gcp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.get_project_nums"><code class="docutils literal notranslate"><span class="pre">get_project_nums()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.multiple_subplots"><code class="docutils literal notranslate"><span class="pre">multiple_subplots()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.plot"><code class="docutils literal notranslate"><span class="pre">plot</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.project"><code class="docutils literal notranslate"><span class="pre">project()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.register_plotter"><code class="docutils literal notranslate"><span class="pre">register_plotter()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.scp"><code class="docutils literal notranslate"><span class="pre">scp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.unregister_plotter"><code class="docutils literal notranslate"><span class="pre">unregister_plotter()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html"><code class="docutils literal notranslate"><span class="pre">Defaultdict</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html#psyplot.utils.check_key"><code class="docutils literal notranslate"><span class="pre">check_key()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html#psyplot.utils.get_default_value"><code class="docutils literal notranslate"><span class="pre">get_default_value()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html#psyplot.utils.hashable"><code class="docutils literal notranslate"><span class="pre">hashable()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html#psyplot.utils.is_iterable"><code class="docutils literal notranslate"><span class="pre">is_iterable()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html#psyplot.utils.is_remote_url"><code class="docutils literal notranslate"><span class="pre">is_remote_url()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html#psyplot.utils.isstring"><code class="docutils literal notranslate"><span class="pre">isstring()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html#psyplot.utils.join_dicts"><code class="docutils literal notranslate"><span class="pre">join_dicts()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html#psyplot.utils.plugin_entrypoints"><code class="docutils literal notranslate"><span class="pre">plugin_entrypoints()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html#psyplot.utils.sort_kwargs"><code class="docutils literal notranslate"><span class="pre">sort_kwargs()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html#psyplot.utils.unique_everseen"><code class="docutils literal notranslate"><span class="pre">unique_everseen()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.warning.html"><code class="docutils literal notranslate"><span class="pre">PsyPlotCritical</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.warning.html#psyplot.warning.PsyPlotRuntimeWarning"><code class="docutils literal notranslate"><span class="pre">PsyPlotRuntimeWarning</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.warning.html#psyplot.warning.PsyPlotWarning"><code class="docutils literal notranslate"><span class="pre">PsyPlotWarning</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.warning.html#psyplot.warning.critical"><code class="docutils literal notranslate"><span class="pre">critical()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.warning.html#psyplot.warning.customwarn"><code class="docutils literal notranslate"><span class="pre">customwarn()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.warning.html#psyplot.warning.disable_warnings"><code class="docutils literal notranslate"><span class="pre">disable_warnings()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.warning.html#psyplot.warning.warn"><code class="docutils literal notranslate"><span class="pre">warn()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../todos.html">ToDos</a></li>
<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-5-1">v1.5.1</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#added">Added</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-5-0">v1.5.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id2">Added</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-4-3">v1.4.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-4-2">v1.4.2</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id3">Changed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-4-1">v1.4.1</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id4">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#fixed">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id5">Changed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-4-0">v1.4.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id6">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id7">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id8">Changed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-3-2">v1.3.2</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id9">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-3-1">v1.3.1</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id10">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-3-0">v1.3.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id11">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id12">Changed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-2-1">v1.2.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-2-0">v1.2.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id13">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#removed">Removed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id14">Changed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-1-0">v1.1.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id15">Added</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-0-0">v1.0.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id16">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id17">Changed</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">psyplot</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="../api.html">API Reference</a></li>
<li class="breadcrumb-item"><a href="psyplot.html">psyplot package</a></li>
<li class="breadcrumb-item active"><no title></li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/api/psyplot.plotter.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<p id="module-psyplot.plotter">Core package for interactive visualization in the psyplot package</p>
<p>This package defines the <a class="reference internal" href="#psyplot.plotter.Plotter" title="psyplot.plotter.Plotter"><code class="xref py py-class docutils literal notranslate"><span class="pre">Plotter</span></code></a> and <a class="reference internal" href="#psyplot.plotter.Formatoption" title="psyplot.plotter.Formatoption"><code class="xref py py-class docutils literal notranslate"><span class="pre">Formatoption</span></code></a> classes,
the core of the visualization in the <a class="reference internal" href="psyplot.html#module-psyplot" title="psyplot"><code class="xref py py-mod docutils literal notranslate"><span class="pre">psyplot</span></code></a> package. Each
<a class="reference internal" href="#psyplot.plotter.Plotter" title="psyplot.plotter.Plotter"><code class="xref py py-class docutils literal notranslate"><span class="pre">Plotter</span></code></a> combines a set of formatoption keys where each formatoption
key is represented by a <a class="reference internal" href="#psyplot.plotter.Formatoption" title="psyplot.plotter.Formatoption"><code class="xref py py-class docutils literal notranslate"><span class="pre">Formatoption</span></code></a> subclass.</p>
<p><strong>Data:</strong></p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.BEFOREPLOTTING" title="psyplot.plotter.BEFOREPLOTTING"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BEFOREPLOTTING</span></code></a></p></td>
<td><p>Priority value of formatoptions that are updated before the plot it made.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.END" title="psyplot.plotter.END"><code class="xref py py-obj docutils literal notranslate"><span class="pre">END</span></code></a></p></td>
<td><p>Priority value of formatoptions that are updated at the end.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.START" title="psyplot.plotter.START"><code class="xref py py-obj docutils literal notranslate"><span class="pre">START</span></code></a></p></td>
<td><p>Priority value of formatoptions that are updated before the data is loaded.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.groups" title="psyplot.plotter.groups"><code class="xref py py-obj docutils literal notranslate"><span class="pre">groups</span></code></a></p></td>
<td><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>.</p></td>
</tr>
</tbody>
</table>
<p><strong>Classes:</strong></p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.DictFormatoption" title="psyplot.plotter.DictFormatoption"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DictFormatoption</span></code></a>(key[, plotter, ...])</p></td>
<td><p>Base formatoption class defining an alternative set_value that works for dictionaries.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption" title="psyplot.plotter.Formatoption"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Formatoption</span></code></a>(key[, plotter, index_in_list, ...])</p></td>
<td><p>Abstract formatoption</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.FormatoptionMeta" title="psyplot.plotter.FormatoptionMeta"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FormatoptionMeta</span></code></a>(clsname, bases, dct)</p></td>
<td><p>Meta class for formatoptions</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Plotter" title="psyplot.plotter.Plotter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Plotter</span></code></a>([data, ax, auto_update, project, ...])</p></td>
<td><p>Interactive plotting object for one or more data arrays</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.PostProcDependencies" title="psyplot.plotter.PostProcDependencies"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PostProcDependencies</span></code></a>()</p></td>
<td><p>The dependencies of this formatoption</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.PostProcessing" title="psyplot.plotter.PostProcessing"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PostProcessing</span></code></a>(key[, plotter, ...])</p></td>
<td><p>Apply your own postprocessing script</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.PostTiming" title="psyplot.plotter.PostTiming"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PostTiming</span></code></a>(key[, plotter, index_in_list, ...])</p></td>
<td><p>Determine when to run the <code class="xref py py-attr docutils literal notranslate"><span class="pre">post</span></code> formatoption</p></td>
</tr>
</tbody>
</table>
<p><strong>Functions:</strong></p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.format_time" title="psyplot.plotter.format_time"><code class="xref py py-obj docutils literal notranslate"><span class="pre">format_time</span></code></a>(x)</p></td>
<td><p>Formats date values</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.is_data_dependent" title="psyplot.plotter.is_data_dependent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_data_dependent</span></code></a>(fmto, data)</p></td>
<td><p>Check whether a formatoption is data dependent</p></td>
</tr>
</tbody>
</table>
<dl class="py data">
<dt class="sig sig-object py" id="psyplot.plotter.BEFOREPLOTTING">
<span class="sig-prename descclassname"><span class="pre">psyplot.plotter.</span></span><span class="sig-name descname"><span class="pre">BEFOREPLOTTING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">20</span></em><a class="headerlink" href="#psyplot.plotter.BEFOREPLOTTING" title="Link to this definition"></a></dt>
<dd><p>Priority value of formatoptions that are updated before the plot it made.</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="psyplot.plotter.DictFormatoption">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">psyplot.plotter.</span></span><span class="sig-name descname"><span class="pre">DictFormatoption</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plotter</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">index_in_list</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">additional_children</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additional_dependencies</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</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="reference internal" href="../_modules/psyplot/plotter.html#DictFormatoption"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.plotter.DictFormatoption" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#psyplot.plotter.Formatoption" title="psyplot.plotter.Formatoption"><code class="xref py py-class docutils literal notranslate"><span class="pre">Formatoption</span></code></a></p>
<p>Base formatoption class defining an alternative set_value that works for
dictionaries.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>key</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – formatoption key in the <cite>plotter</cite></p></li>
<li><p><strong>plotter</strong> (<a class="reference internal" href="#psyplot.plotter.Plotter" title="psyplot.plotter.Plotter"><em>psyplot.plotter.Plotter</em></a>) – Plotter instance that holds this formatoption. If None, it is
assumed that this instance serves as a descriptor.</p></li>
<li><p><strong>index_in_list</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em> or </em><em>None</em>) – The index that shall be used if the data is a
<code class="xref py py-class docutils literal notranslate"><span class="pre">psyplot.InteractiveList</span></code></p></li>
<li><p><strong>additional_children</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Additional children to use (see the <code class="xref py py-attr docutils literal notranslate"><span class="pre">children</span></code> attribute)</p></li>
<li><p><strong>additional_dependencies</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Additional dependencies to use (see the <code class="xref py py-attr docutils literal notranslate"><span class="pre">dependencies</span></code>
attribute)</p></li>
<li><p><strong>**kwargs</strong> – Further keywords may be used to specify different names for
children, dependencies and connection formatoptions that match the
setup of the plotter. Hence, keywords may be anything of the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">children</span></code>, <code class="xref py py-attr docutils literal notranslate"><span class="pre">dependencies</span></code> and <code class="xref py py-attr docutils literal notranslate"><span class="pre">connections</span></code>
attributes, with values being the name of the new formatoption in
this plotter.</p></li>
</ul>
</dd>
</dl>
<p><strong>Methods:</strong></p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.DictFormatoption.set_value" title="psyplot.plotter.DictFormatoption.set_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_value</span></code></a>(value[, validate, todefault])</p></td>
<td><p>Set (and validate) the value in the plotter</p></td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.plotter.DictFormatoption.set_value">
<span class="sig-name descname"><span class="pre">set_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">todefault</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/plotter.html#DictFormatoption.set_value"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.plotter.DictFormatoption.set_value" title="Link to this definition"></a></dt>
<dd><p>Set (and validate) the value in the plotter</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>value</strong> – Value to set</p></li>
<li><p><strong>validate</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – if True, validate the <cite>value</cite> before it is set</p></li>
<li><p><strong>todefault</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – True if the value is updated to the default value</p></li>
</ul>
</dd>
</dl>
<p class="rubric">Notes</p>
<ul class="simple">
<li><p>If the current value in the plotter is None, then it will be set with
the given <cite>value</cite>, otherwise the current value in the plotter is
updated</p></li>
<li><p>If the value is an empty dictionary, the value in the plotter is
cleared</p></li>
</ul>
</dd></dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="psyplot.plotter.END">
<span class="sig-prename descclassname"><span class="pre">psyplot.plotter.</span></span><span class="sig-name descname"><span class="pre">END</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></em><a class="headerlink" href="#psyplot.plotter.END" title="Link to this definition"></a></dt>
<dd><p>Priority value of formatoptions that are updated at the end.</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">psyplot.plotter.</span></span><span class="sig-name descname"><span class="pre">Formatoption</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plotter</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">index_in_list</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">additional_children</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additional_dependencies</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</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="reference internal" href="../_modules/psyplot/plotter.html#Formatoption"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.plotter.Formatoption" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Abstract formatoption</p>
<p>This class serves as an abstract version of an formatoption descriptor
that can be used by <a class="reference internal" href="#psyplot.plotter.Plotter" title="psyplot.plotter.Plotter"><code class="xref py py-class docutils literal notranslate"><span class="pre">Plotter</span></code></a> instances.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>key</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – formatoption key in the <cite>plotter</cite></p></li>
<li><p><strong>plotter</strong> (<a class="reference internal" href="#psyplot.plotter.Plotter" title="psyplot.plotter.Plotter"><em>psyplot.plotter.Plotter</em></a>) – Plotter instance that holds this formatoption. If None, it is
assumed that this instance serves as a descriptor.</p></li>
<li><p><strong>index_in_list</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em> or </em><em>None</em>) – The index that shall be used if the data is a
<code class="xref py py-class docutils literal notranslate"><span class="pre">psyplot.InteractiveList</span></code></p></li>
<li><p><strong>additional_children</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Additional children to use (see the <a class="reference internal" href="#psyplot.plotter.Formatoption.children" title="psyplot.plotter.Formatoption.children"><code class="xref py py-attr docutils literal notranslate"><span class="pre">children</span></code></a> attribute)</p></li>
<li><p><strong>additional_dependencies</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Additional dependencies to use (see the <a class="reference internal" href="#psyplot.plotter.Formatoption.dependencies" title="psyplot.plotter.Formatoption.dependencies"><code class="xref py py-attr docutils literal notranslate"><span class="pre">dependencies</span></code></a>
attribute)</p></li>
<li><p><strong>**kwargs</strong> – Further keywords may be used to specify different names for
children, dependencies and connection formatoptions that match the
setup of the plotter. Hence, keywords may be anything of the
<a class="reference internal" href="#psyplot.plotter.Formatoption.children" title="psyplot.plotter.Formatoption.children"><code class="xref py py-attr docutils literal notranslate"><span class="pre">children</span></code></a>, <a class="reference internal" href="#psyplot.plotter.Formatoption.dependencies" title="psyplot.plotter.Formatoption.dependencies"><code class="xref py py-attr docutils literal notranslate"><span class="pre">dependencies</span></code></a> and <a class="reference internal" href="#psyplot.plotter.Formatoption.connections" title="psyplot.plotter.Formatoption.connections"><code class="xref py py-attr docutils literal notranslate"><span class="pre">connections</span></code></a>
attributes, with values being the name of the new formatoption in
this plotter.</p></li>
</ul>
</dd>
</dl>
<p><strong>Interface to the data:</strong></p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.any_decoder" title="psyplot.plotter.Formatoption.any_decoder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">any_decoder</span></code></a></p></td>
<td><p>Return the first possible decoder</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.ax" title="psyplot.plotter.Formatoption.ax"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ax</span></code></a></p></td>
<td><p>The axes this Formatoption plots on</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.data" title="psyplot.plotter.Formatoption.data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">data</span></code></a></p></td>
<td><p>The data that is plotted</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.data_dependent" title="psyplot.plotter.Formatoption.data_dependent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">data_dependent</span></code></a></p></td>
<td><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a> or a callable.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.decoder" title="psyplot.plotter.Formatoption.decoder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">decoder</span></code></a></p></td>
<td><p>The <a class="reference internal" href="psyplot.data.html#psyplot.data.CFDecoder" title="psyplot.data.CFDecoder"><code class="xref py py-class docutils literal notranslate"><span class="pre">CFDecoder</span></code></a> instance that decodes the <a class="reference internal" href="#psyplot.plotter.Formatoption.raw_data" title="psyplot.plotter.Formatoption.raw_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">raw_data</span></code></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.index_in_list" title="psyplot.plotter.Formatoption.index_in_list"><code class="xref py py-obj docutils literal notranslate"><span class="pre">index_in_list</span></code></a></p></td>
<td><p>int or None.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.iter_data" title="psyplot.plotter.Formatoption.iter_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">iter_data</span></code></a></p></td>
<td><p>Returns an iterator over the plot data arrays</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.iter_raw_data" title="psyplot.plotter.Formatoption.iter_raw_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">iter_raw_data</span></code></a></p></td>
<td><p>Returns an iterator over the original data arrays</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.project" title="psyplot.plotter.Formatoption.project"><code class="xref py py-obj docutils literal notranslate"><span class="pre">project</span></code></a></p></td>
<td><p>Project of the plotter of this instance</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.raw_data" title="psyplot.plotter.Formatoption.raw_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">raw_data</span></code></a></p></td>
<td><p>The original data of the plotter of this formatoption</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.set_data" title="psyplot.plotter.Formatoption.set_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_data</span></code></a>(data[, i])</p></td>
<td><p>Replace the data to plot</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.set_decoder" title="psyplot.plotter.Formatoption.set_decoder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_decoder</span></code></a>(decoder[, i])</p></td>
<td><p>Replace the data to plot</p></td>
</tr>
</tbody>
</table>
<p><strong>Interface for the plotter:</strong></p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.changed" title="psyplot.plotter.Formatoption.changed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">changed</span></code></a></p></td>
<td><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a> indicating whether the value changed compared to the default or not.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.check_and_set" title="psyplot.plotter.Formatoption.check_and_set"><code class="xref py py-obj docutils literal notranslate"><span class="pre">check_and_set</span></code></a>(value[, todefault, validate])</p></td>
<td><p>Checks the value and sets the value if it changed</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.diff" title="psyplot.plotter.Formatoption.diff"><code class="xref py py-obj docutils literal notranslate"><span class="pre">diff</span></code></a>(value)</p></td>
<td><p>Checks whether the given value differs from what is currently set</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.finish_update" title="psyplot.plotter.Formatoption.finish_update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">finish_update</span></code></a>()</p></td>
<td><p>Finish the update, initialization and sharing process</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.initialize_plot" title="psyplot.plotter.Formatoption.initialize_plot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">initialize_plot</span></code></a>(value, *args, **kwargs)</p></td>
<td><p>Method that is called when the plot is made the first time</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.key" title="psyplot.plotter.Formatoption.key"><code class="xref py py-obj docutils literal notranslate"><span class="pre">key</span></code></a></p></td>
<td><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.lock" title="psyplot.plotter.Formatoption.lock"><code class="xref py py-obj docutils literal notranslate"><span class="pre">lock</span></code></a></p></td>
<td><p>A <code class="xref py py-class docutils literal notranslate"><span class="pre">threading.Rlock</span></code> instance to lock while updating</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.plot_fmt" title="psyplot.plotter.Formatoption.plot_fmt"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_fmt</span></code></a></p></td>
<td><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.plotter" title="psyplot.plotter.Formatoption.plotter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plotter</span></code></a></p></td>
<td><p><a class="reference internal" href="#psyplot.plotter.Plotter" title="psyplot.plotter.Plotter"><code class="xref py py-class docutils literal notranslate"><span class="pre">Plotter</span></code></a>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.priority" title="psyplot.plotter.Formatoption.priority"><code class="xref py py-obj docutils literal notranslate"><span class="pre">priority</span></code></a></p></td>
<td><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.remove" title="psyplot.plotter.Formatoption.remove"><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove</span></code></a>()</p></td>
<td><p>Method to remove the effects of this formatoption</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.requires_clearing" title="psyplot.plotter.Formatoption.requires_clearing"><code class="xref py py-obj docutils literal notranslate"><span class="pre">requires_clearing</span></code></a></p></td>
<td><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.requires_replot" title="psyplot.plotter.Formatoption.requires_replot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">requires_replot</span></code></a></p></td>
<td><p>Boolean that is True if an update of the formatoption requires a replot</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.set_value" title="psyplot.plotter.Formatoption.set_value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_value</span></code></a>(value[, validate, todefault])</p></td>
<td><p>Set (and validate) the value in the plotter.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.share" title="psyplot.plotter.Formatoption.share"><code class="xref py py-obj docutils literal notranslate"><span class="pre">share</span></code></a>(fmto[, initializing])</p></td>
<td><p>Share the settings of this formatoption with other data objects</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.update" title="psyplot.plotter.Formatoption.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(value)</p></td>
<td><p>Method that is call to update the formatoption on the axes</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.update_after_plot" title="psyplot.plotter.Formatoption.update_after_plot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_after_plot</span></code></a></p></td>
<td><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>.</p></td>
</tr>
</tbody>
</table>
<p><strong>Interface to other formatoptions:</strong></p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.children" title="psyplot.plotter.Formatoption.children"><code class="xref py py-obj docutils literal notranslate"><span class="pre">children</span></code></a></p></td>
<td><p><cite>list of str</cite>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.connections" title="psyplot.plotter.Formatoption.connections"><code class="xref py py-obj docutils literal notranslate"><span class="pre">connections</span></code></a></p></td>
<td><p><cite>list of str</cite>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.dependencies" title="psyplot.plotter.Formatoption.dependencies"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dependencies</span></code></a></p></td>
<td><p><cite>list of str</cite>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.parents" title="psyplot.plotter.Formatoption.parents"><code class="xref py py-obj docutils literal notranslate"><span class="pre">parents</span></code></a></p></td>
<td><p><cite>list of str</cite>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.shared" title="psyplot.plotter.Formatoption.shared"><code class="xref py py-obj docutils literal notranslate"><span class="pre">shared</span></code></a></p></td>
<td><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> of the <a class="reference internal" href="#psyplot.plotter.Formatoption" title="psyplot.plotter.Formatoption"><code class="xref py py-class docutils literal notranslate"><span class="pre">Formatoption</span></code></a> instance that are shared with this instance.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.shared_by" title="psyplot.plotter.Formatoption.shared_by"><code class="xref py py-obj docutils literal notranslate"><span class="pre">shared_by</span></code></a></p></td>
<td><p>None if the formatoption is not controlled by another formatoption of another plotter, otherwise the corresponding <a class="reference internal" href="#psyplot.plotter.Formatoption" title="psyplot.plotter.Formatoption"><code class="xref py py-class docutils literal notranslate"><span class="pre">Formatoption</span></code></a> instance</p></td>
</tr>
</tbody>
</table>
<p><strong>Methods:</strong></p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.convert_coordinate" title="psyplot.plotter.Formatoption.convert_coordinate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">convert_coordinate</span></code></a>(coord, *variables)</p></td>
<td><p>Convert a coordinate to units necessary for the plot.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.get_decoder" title="psyplot.plotter.Formatoption.get_decoder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_decoder</span></code></a>([i])</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.get_fmt_widget" title="psyplot.plotter.Formatoption.get_fmt_widget"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_fmt_widget</span></code></a>(parent, project)</p></td>
<td><p>Get a widget to update the formatoption in the GUI</p></td>
</tr>
</tbody>
</table>
<p><strong>Formatoption intrinsic:</strong></p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.default" title="psyplot.plotter.Formatoption.default"><code class="xref py py-obj docutils literal notranslate"><span class="pre">default</span></code></a></p></td>
<td><p>Default value of this formatoption</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.validate" title="psyplot.plotter.Formatoption.validate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">validate</span></code></a></p></td>
<td><p>Validation method of the formatoption</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.value" title="psyplot.plotter.Formatoption.value"><code class="xref py py-obj docutils literal notranslate"><span class="pre">value</span></code></a></p></td>
<td><p>Value of the formatoption in the corresponding <a class="reference internal" href="#psyplot.plotter.Formatoption.plotter" title="psyplot.plotter.Formatoption.plotter"><code class="xref py py-attr docutils literal notranslate"><span class="pre">plotter</span></code></a> or the shared value</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.value2pickle" title="psyplot.plotter.Formatoption.value2pickle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">value2pickle</span></code></a></p></td>
<td><p>The value that can be used when pickling the information of the project</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.value2share" title="psyplot.plotter.Formatoption.value2share"><code class="xref py py-obj docutils literal notranslate"><span class="pre">value2share</span></code></a></p></td>
<td><p>The value that is passed to shared formatoptions (by default, the <a class="reference internal" href="#psyplot.plotter.Formatoption.value" title="psyplot.plotter.Formatoption.value"><code class="xref py py-attr docutils literal notranslate"><span class="pre">value</span></code></a> attribute)</p></td>
</tr>
</tbody>
</table>
<p><strong>Information attributes:</strong></p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.default_key" title="psyplot.plotter.Formatoption.default_key"><code class="xref py py-obj docutils literal notranslate"><span class="pre">default_key</span></code></a></p></td>
<td><p>The key of this formatoption in the <code class="xref py py-attr docutils literal notranslate"><span class="pre">psyplot.rcParams</span></code></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.group" title="psyplot.plotter.Formatoption.group"><code class="xref py py-obj docutils literal notranslate"><span class="pre">group</span></code></a></p></td>
<td><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.groupname" title="psyplot.plotter.Formatoption.groupname"><code class="xref py py-obj docutils literal notranslate"><span class="pre">groupname</span></code></a></p></td>
<td><p>Long name of the group this formatoption belongs too.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.name" title="psyplot.plotter.Formatoption.name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">name</span></code></a></p></td>
<td><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>.</p></td>
</tr>
</tbody>
</table>
<p><strong>Miscellaneous:</strong></p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.init_kwargs" title="psyplot.plotter.Formatoption.init_kwargs"><code class="xref py py-obj docutils literal notranslate"><span class="pre">init_kwargs</span></code></a></p></td>
<td><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> key word arguments that are passed to the initialization of a new instance when accessed from the descriptor</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.plotter.Formatoption.logger" title="psyplot.plotter.Formatoption.logger"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logger</span></code></a></p></td>
<td><p>Logger of the plotter</p></td>
</tr>
</tbody>
</table>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.any_decoder">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">any_decoder</span></span><a class="headerlink" href="#psyplot.plotter.Formatoption.any_decoder" title="Link to this definition"></a></dt>
<dd><p>Return the first possible decoder</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.ax">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ax</span></span><a class="headerlink" href="#psyplot.plotter.Formatoption.ax" title="Link to this definition"></a></dt>
<dd><p>The axes this Formatoption plots on</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.changed">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">changed</span></span><a class="headerlink" href="#psyplot.plotter.Formatoption.changed" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a> indicating whether the value changed compared to the
default or not.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.check_and_set">
<span class="sig-name descname"><span class="pre">check_and_set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">todefault</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/plotter.html#Formatoption.check_and_set"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.plotter.Formatoption.check_and_set" title="Link to this definition"></a></dt>
<dd><p>Checks the value and sets the value if it changed</p>
<p>This method checks the value and sets it only if the <a class="reference internal" href="#psyplot.plotter.Formatoption.diff" title="psyplot.plotter.Formatoption.diff"><code class="xref py py-meth docutils literal notranslate"><span class="pre">diff()</span></code></a>
method result of the given <cite>value</cite> is True</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>value</strong> – A possible value to set</p></li>
<li><p><strong>todefault</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – True if the value is updated to the default value</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A boolean to indicate whether it has been set or not</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)">bool</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.children">
<span class="sig-name descname"><span class="pre">children</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></em><a class="headerlink" href="#psyplot.plotter.Formatoption.children" title="Link to this definition"></a></dt>
<dd><p><cite>list of str</cite>. List of formatoptions that have to be updated before this
one is updated. Those formatoptions are only updated if they exist in
the update parameters.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.connections">
<span class="sig-name descname"><span class="pre">connections</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></em><a class="headerlink" href="#psyplot.plotter.Formatoption.connections" title="Link to this definition"></a></dt>
<dd><p><cite>list of str</cite>. Connections to other formatoptions that are (different
from <a class="reference internal" href="#psyplot.plotter.Formatoption.dependencies" title="psyplot.plotter.Formatoption.dependencies"><code class="xref py py-attr docutils literal notranslate"><span class="pre">dependencies</span></code></a> and <a class="reference internal" href="#psyplot.plotter.Formatoption.children" title="psyplot.plotter.Formatoption.children"><code class="xref py py-attr docutils literal notranslate"><span class="pre">children</span></code></a>) not important for the
update process</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.convert_coordinate">
<span class="sig-name descname"><span class="pre">convert_coordinate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">coord</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">variables</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/plotter.html#Formatoption.convert_coordinate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.plotter.Formatoption.convert_coordinate" title="Link to this definition"></a></dt>
<dd><p>Convert a coordinate to units necessary for the plot.</p>
<p>This method takes a single coordinate variable (e.g. the <cite>bounds</cite> of a
coordinate, or the coordinate itself) and transforms the units that the
plotter requires.</p>
<p>One might also provide additional <cite>variables</cite> that are supposed to be
on the same unit, in case the given <cite>coord</cite> does not specify a <cite>units</cite>
attribute. <cite>coord</cite> might be a CF-conform <cite>bounds</cite> variable, and one of
the variables might be the corresponding <cite>coordinate</cite>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>coord</strong> (<em>xr.Variable</em>) – The variable to transform</p></li>
<li><p><strong>*variables</strong> – The variables that are on the same unit as <cite>coord</cite></p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The transformed <cite>coord</cite></p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>xr.Variable</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>By default, this method uses the <a class="reference internal" href="#psyplot.plotter.Plotter.convert_coordinate" title="psyplot.plotter.Plotter.convert_coordinate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">convert_coordinate()</span></code></a>
method of the <a class="reference internal" href="#psyplot.plotter.Formatoption.plotter" title="psyplot.plotter.Formatoption.plotter"><code class="xref py py-attr docutils literal notranslate"><span class="pre">plotter</span></code></a>.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.data">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">data</span></span><a class="headerlink" href="#psyplot.plotter.Formatoption.data" title="Link to this definition"></a></dt>
<dd><p>The data that is plotted</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.data_dependent">
<span class="sig-name descname"><span class="pre">data_dependent</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#psyplot.plotter.Formatoption.data_dependent" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a> or a callable. This attribute indicates whether this
<a class="reference internal" href="#psyplot.plotter.Formatoption" title="psyplot.plotter.Formatoption"><code class="xref py py-class docutils literal notranslate"><span class="pre">Formatoption</span></code></a> depends on the data and should be updated if the
data changes. If it is a callable, it must accept one argument: the
new data. (Note: This is automatically set to True for plot
formatoptions)</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.decoder">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">decoder</span></span><a class="headerlink" href="#psyplot.plotter.Formatoption.decoder" title="Link to this definition"></a></dt>
<dd><p>The <a class="reference internal" href="psyplot.data.html#psyplot.data.CFDecoder" title="psyplot.data.CFDecoder"><code class="xref py py-class docutils literal notranslate"><span class="pre">CFDecoder</span></code></a> instance that decodes the
<a class="reference internal" href="#psyplot.plotter.Formatoption.raw_data" title="psyplot.plotter.Formatoption.raw_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">raw_data</span></code></a></p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.default">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">default</span></span><a class="headerlink" href="#psyplot.plotter.Formatoption.default" title="Link to this definition"></a></dt>
<dd><p>Default value of this formatoption</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.default_key">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">default_key</span></span><a class="headerlink" href="#psyplot.plotter.Formatoption.default_key" title="Link to this definition"></a></dt>
<dd><p>The key of this formatoption in the <code class="xref py py-attr docutils literal notranslate"><span class="pre">psyplot.rcParams</span></code></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.dependencies">
<span class="sig-name descname"><span class="pre">dependencies</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></em><a class="headerlink" href="#psyplot.plotter.Formatoption.dependencies" title="Link to this definition"></a></dt>
<dd><p><cite>list of str</cite>. List of formatoptions that force an update of this
formatoption if they are updated.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.diff">
<span class="sig-name descname"><span class="pre">diff</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/plotter.html#Formatoption.diff"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.plotter.Formatoption.diff" title="Link to this definition"></a></dt>
<dd><p>Checks whether the given value differs from what is currently set</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>value</strong> – A possible value to set (make sure that it has been validate via
the <a class="reference internal" href="#psyplot.plotter.Formatoption.validate" title="psyplot.plotter.Formatoption.validate"><code class="xref py py-attr docutils literal notranslate"><span class="pre">validate</span></code></a> attribute before)</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>True if the value differs from what is currently set</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)">bool</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.finish_update">
<span class="sig-name descname"><span class="pre">finish_update</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/plotter.html#Formatoption.finish_update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.plotter.Formatoption.finish_update" title="Link to this definition"></a></dt>
<dd><p>Finish the update, initialization and sharing process</p>
<p>This function is called at the end of the <a class="reference internal" href="#psyplot.plotter.Plotter.start_update" title="psyplot.plotter.Plotter.start_update"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Plotter.start_update()</span></code></a>,
<a class="reference internal" href="#psyplot.plotter.Plotter.initialize_plot" title="psyplot.plotter.Plotter.initialize_plot"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Plotter.initialize_plot()</span></code></a> or the <a class="reference internal" href="#psyplot.plotter.Plotter.share" title="psyplot.plotter.Plotter.share"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Plotter.share()</span></code></a> methods.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.get_decoder">
<span class="sig-name descname"><span class="pre">get_decoder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">i</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/plotter.html#Formatoption.get_decoder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.plotter.Formatoption.get_decoder" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.get_fmt_widget">
<span class="sig-name descname"><span class="pre">get_fmt_widget</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">project</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/plotter.html#Formatoption.get_fmt_widget"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.plotter.Formatoption.get_fmt_widget" title="Link to this definition"></a></dt>
<dd><p>Get a widget to update the formatoption in the GUI</p>
<p>This method should return a QWidget that is loaded by the psyplot-gui
when the formatoption is selected in the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">psyplot_gui.main.Mainwindow.fmt_widget</span></code>. It should call the
<code class="xref py py-meth docutils literal notranslate"><span class="pre">insert_text()</span></code> method
when the update text for the formatoption should be changed.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>parent</strong> (<a class="reference external" href="https://psyplot.github.io/psyplot-gui/api/psyplot_gui.fmt_widget.html#psyplot_gui.fmt_widget.FormatoptionWidget" title="(in psyplot-gui)"><em>psyplot_gui.fmt_widget.FormatoptionWidget</em></a>) – The parent widget that contains the returned QWidget</p></li>
<li><p><strong>project</strong> (<a class="reference internal" href="psyplot.project.html#psyplot.project.Project" title="psyplot.project.Project"><em>psyplot.project.Project</em></a>) – The current subproject (see <a class="reference internal" href="psyplot.project.html#psyplot.project.gcp" title="psyplot.project.gcp"><code class="xref py py-func docutils literal notranslate"><span class="pre">psyplot.project.gcp()</span></code></a>)</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The widget to control the formatoption</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>PyQt5.QtWidgets.QWidget</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.group">
<span class="sig-name descname"><span class="pre">group</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'misc'</span></em><a class="headerlink" href="#psyplot.plotter.Formatoption.group" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>. Key of the group name in <a class="reference internal" href="#psyplot.plotter.groups" title="psyplot.plotter.groups"><code class="xref py py-data docutils literal notranslate"><span class="pre">groups</span></code></a> of this
formatoption keyword</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.groupname">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">groupname</span></span><a class="headerlink" href="#psyplot.plotter.Formatoption.groupname" title="Link to this definition"></a></dt>
<dd><p>Long name of the group this formatoption belongs too.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.index_in_list">
<span class="sig-name descname"><span class="pre">index_in_list</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#psyplot.plotter.Formatoption.index_in_list" title="Link to this definition"></a></dt>
<dd><p>int or None. Index that is used in case the plotting data is a
<code class="xref py py-class docutils literal notranslate"><span class="pre">psyplot.InteractiveList</span></code></p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.init_kwargs">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">init_kwargs</span></span><a class="headerlink" href="#psyplot.plotter.Formatoption.init_kwargs" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> key word arguments that are passed to the
initialization of a new instance when accessed from the descriptor</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.initialize_plot">
<span class="sig-name descname"><span class="pre">initialize_plot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</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="reference internal" href="../_modules/psyplot/plotter.html#Formatoption.initialize_plot"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.plotter.Formatoption.initialize_plot" title="Link to this definition"></a></dt>
<dd><p>Method that is called when the plot is made the first time</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>value</strong> – The value to use for the initialization</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.iter_data">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">iter_data</span></span><a class="headerlink" href="#psyplot.plotter.Formatoption.iter_data" title="Link to this definition"></a></dt>
<dd><p>Returns an iterator over the plot data arrays</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.iter_raw_data">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">iter_raw_data</span></span><a class="headerlink" href="#psyplot.plotter.Formatoption.iter_raw_data" title="Link to this definition"></a></dt>
<dd><p>Returns an iterator over the original data arrays</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.key">
<span class="sig-name descname"><span class="pre">key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#psyplot.plotter.Formatoption.key" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>. Formatoption key of this class in the
<a class="reference internal" href="#psyplot.plotter.Plotter" title="psyplot.plotter.Plotter"><code class="xref py py-class docutils literal notranslate"><span class="pre">Plotter</span></code></a> class</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.lock">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lock</span></span><a class="headerlink" href="#psyplot.plotter.Formatoption.lock" title="Link to this definition"></a></dt>
<dd><p>A <code class="xref py py-class docutils literal notranslate"><span class="pre">threading.Rlock</span></code> instance to lock while updating</p>
<p>This lock is used when multiple <a class="reference internal" href="#psyplot.plotter.Formatoption.plotter" title="psyplot.plotter.Formatoption.plotter"><code class="xref py py-class docutils literal notranslate"><span class="pre">plotter</span></code></a> instances are
updated at the same time while sharing formatoptions.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.logger">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">logger</span></span><a class="headerlink" href="#psyplot.plotter.Formatoption.logger" title="Link to this definition"></a></dt>
<dd><p>Logger of the plotter</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.name">
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#psyplot.plotter.Formatoption.name" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>. A bit more verbose name than the formatoption key to be
included in the gui. If None, the key is used in the gui</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.parents">
<span class="sig-name descname"><span class="pre">parents</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></em><a class="headerlink" href="#psyplot.plotter.Formatoption.parents" title="Link to this definition"></a></dt>
<dd><p><cite>list of str</cite>. List of formatoptions that, if included in the update,
prevent the update of this formatoption.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.plot_fmt">
<span class="sig-name descname"><span class="pre">plot_fmt</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#psyplot.plotter.Formatoption.plot_fmt" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>. Has to be True if the formatoption has a <code class="docutils literal notranslate"><span class="pre">make_plot</span></code>
method to make the plot.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.plotter">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">plotter</span></span><a class="headerlink" href="#psyplot.plotter.Formatoption.plotter" title="Link to this definition"></a></dt>
<dd><p><a class="reference internal" href="#psyplot.plotter.Plotter" title="psyplot.plotter.Plotter"><code class="xref py py-class docutils literal notranslate"><span class="pre">Plotter</span></code></a>. Plotter instance this
formatoption belongs to</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.priority">
<span class="sig-name descname"><span class="pre">priority</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></em><a class="headerlink" href="#psyplot.plotter.Formatoption.priority" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>. Priority value of the the formatoption determining when
the formatoption is updated.</p>
<ul class="simple">
<li><p>10: at the end (for labels, etc.)</p></li>
<li><p>20: before the plotting (e.g. for colormaps, etc.)</p></li>
<li><p>30: before loading the data (e.g. for lonlatbox)</p></li>
</ul>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.plotter.Formatoption.project">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">project</span></span><a class="headerlink" href="#psyplot.plotter.Formatoption.project" title="Link to this definition"></a></dt>