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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>Veusz command line and embedding interface (API) — Veusz 3.6.2 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Reading data" href="datasets.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="veusz-command-line-and-embedding-interface-api">
<h1>Veusz command line and embedding interface (API)<a class="headerlink" href="#veusz-command-line-and-embedding-interface-api" title="Permalink to this headline">¶</a></h1>
<section id="introduction">
<span id="commands"></span><h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<p>Veusz uses a common API, or set of commands, to control the program
via its command line (from the Veusz console; click View, Windows,
Console Window), the embedding interface (when Veusz is embedded in
other Python programs), from within plugins, within documents (VSZ
documents contain commands used to generate the document) or
externally from the operating system command line (using <cite>veusz
–listen</cite>).</p>
<p>As Veusz is a a Python application it uses Python as its scripting
language. You can therefore freely mix Veusz and Python commands on
the Veusz command line (Click View, Windows, Console Window to get
access to the command line). Veusz can also read in Python scripts
from files on the command line (see the <a class="reference internal" href="#command-load"><span class="std std-ref">Load</span></a>
command).</p>
<p>When commands are entered in the command prompt in the Veusz window,
Veusz supports a simplified command syntax, whereq brackets following
commands names, and commas, can replaced by spaces in Veusz commands
(not Python commands). For example, <strong class="command">Add('graph',
name='foo')</strong>, may be entered as <strong class="command">Add 'graph' name='foo'</strong>.</p>
<p>The <strong class="command">numpy</strong> package is already imported into the command line
interface (as <cite>*</cite>), so you do not need to import it first.</p>
<p>The command prompt supports history (use the up and down cursor keys
to recall previous commands).</p>
<p>Most of the commands listed below can be used in the in-program
command line interface, using the embedding interface or using <cite>veusz
–listen</cite>. Commands specific to particular modes are documented as
such.</p>
<p>Veusz also includes a new object-oriented version of the API, which is
documented at <a class="reference internal" href="#new-api">new_api</a>.</p>
</section>
<section id="commands-and-api">
<h2>Commands and API<a class="headerlink" href="#commands-and-api" title="Permalink to this headline">¶</a></h2>
<p>We list the allowed set of commands below</p>
<section id="action">
<h3>Action<a class="headerlink" href="#action" title="Permalink to this headline">¶</a></h3>
<p id="command-action"><strong class="command">Action('actionname',
componentpath='.')</strong></p>
<p>Initiates the specified action on the widget (component)
given the action name. Actions perform certain automated
routines. These include “fit” on a fit widget, and
“zeroMargins” on grids.</p>
</section>
<section id="add">
<h3>Add<a class="headerlink" href="#add" title="Permalink to this headline">¶</a></h3>
<p id="command-add"><strong class="command">Add('widgettype', name='nameforwidget',
autoadd=True, optionalargs)</strong></p>
<p>The Add command adds a graph into the current widget (See the <a class="reference internal" href="#command-to"><span class="std std-ref">To</span></a> command to change the current position).</p>
<p>The first argument is the type of widget to add. These include
“graph”, “page”, “axis”, “xy” and “grid”. <strong class="command">name</strong> is the name
of the new widget (if not given, it will be generated from the type of
the widget plus a number). The <strong class="command">autoadd</strong> parameter if set,
constructs the default sub-widgets this widget has (for example, axes
in a graph).</p>
<p>Optionally, default values for the graph settings may be given, for
example <strong class="command">Add('axis', name='y', direction='vertical')</strong>.</p>
<p>Subsettings may be set by using double underscores, for example
<strong class="command">Add('xy', MarkerFill__color='red',
ErrorBarLine__hide=True)</strong>.</p>
<p>Returns: Name of widget added.</p>
</section>
<section id="addcustom">
<h3>AddCustom<a class="headerlink" href="#addcustom" title="Permalink to this headline">¶</a></h3>
<p id="command-addcustom"><strong class="command">AddCustom(type, name, value)</strong></p>
<p>Add a custom definition for evaluation of expressions. This can define
a constant (can be in terms of other constants), a function of 1 or
more variables, or a function imported from an external python module.</p>
<p>ctype is “constant”, “function” or “import”.</p>
<p>name is name of constant, or “function(x, y, …)” or module name.</p>
<p>val is definition for constant or function (both are _strings_), or is
a list of symbols for a module (comma separated items in a string).</p>
<p>If mode is ‘appendalways’, the custom value is appended to the end of
the list even if there is one with the same name. If mode is
‘replace’, it replaces any existing definition in the same place in
the list or is appended otherwise. If mode is ‘append’, then an
existing definition is deleted, and the new one appended to the end.</p>
</section>
<section id="addimportpath">
<h3>AddImportPath<a class="headerlink" href="#addimportpath" title="Permalink to this headline">¶</a></h3>
<p id="command-addimportpath"><strong class="command">AddImportPath(directory)</strong></p>
<p>Add a directory to the list of directories to try to import data from.</p>
</section>
<section id="clonewidget">
<h3>CloneWidget<a class="headerlink" href="#clonewidget" title="Permalink to this headline">¶</a></h3>
<p id="command-clonewidget"><strong class="command">CloneWidget(widget, newparent,
newname=None)</strong></p>
<p>Clone the widget given, placing the copy in newparent and the name
given. newname is an optional new name to give it Returns new widget
path.</p>
</section>
<section id="close">
<h3>Close<a class="headerlink" href="#close" title="Permalink to this headline">¶</a></h3>
<p id="command-close"><strong class="command">Close()</strong></p>
<p>Closes the plotwindow. This is only supported in embedded mode.</p>
</section>
<section id="createhistogram">
<h3>CreateHistogram<a class="headerlink" href="#createhistogram" title="Permalink to this headline">¶</a></h3>
<p id="command-createhistogram"><strong class="command">CreateHistogram(inexpr, outbinsds,
outvalsds, binparams=None, binmanual=None,
method='counts', cumulative = 'none',
errors=False)</strong></p>
<p>Histogram an input expression. inexpr is input expression. outbinds
is the name of the dataset to create giving bin positions. outvalsds
is name of dataset for bin values. binparams is None or (numbins,
minval, maxval, islogbins). binmanual is None or a list of bin
values. method is ‘counts’, ‘density’, or ‘fractions’. cumulative is
to calculate cumulative distributions which is ‘none’, ‘smalltolarge’
or ‘largetosmall’. errors is to calculate Poisson error bars.</p>
</section>
<section id="currentpath">
<h3>CurrentPath<a class="headerlink" href="#currentpath" title="Permalink to this headline">¶</a></h3>
<p id="command-currentpath"><strong class="command">CurrentPath()</strong></p>
<p>Returns current widget path, as set by <a class="reference internal" href="#command-to"><span class="std std-ref">To</span></a>.</p>
</section>
<section id="datasetplugin">
<h3>DatasetPlugin<a class="headerlink" href="#datasetplugin" title="Permalink to this headline">¶</a></h3>
<p id="command-datasetplugin"><strong class="command">DatasetPlugin(pluginname, fields,
datasetnames={})></strong></p>
<p>Use a dataset plugin. pluginname: name of plugin to use fields: dict
of input values to plugin datasetnames: dict mapping old names to new
names of datasets if they are renamed. The new name None means dataset
is deleted</p>
</section>
<section id="enabletoolbar">
<h3>EnableToolbar<a class="headerlink" href="#enabletoolbar" title="Permalink to this headline">¶</a></h3>
<p id="command-enabletoolbar"><strong class="command">EnableToolbar(enable=True)</strong></p>
<p>Enable/disable the zooming toolbar in the plotwindow. This command is
only supported in embedded mode or from <cite>veusz –listen</cite>.</p>
</section>
<section id="export">
<h3>Export<a class="headerlink" href="#export" title="Permalink to this headline">¶</a></h3>
<p id="command-export"><strong class="command">Export(filename, color=True, page=0, dpi=100,
antialias=True, quality=85, backcolor='#ffffff00', pdfdpi=150,
svgdpi=96, svgtextastext=False)</strong></p>
<p>Export the page given to the filename given. The <strong class="command">filename</strong>
must end with the correct extension to get the right sort of output
file. Currrenly supported extensions are ‘.eps’, ‘.pdf’, ‘.ps’,
‘.svg’, ‘.jpg’, ‘.jpeg’, ‘.bmp’ and ‘.png’. If <strong class="command">color</strong> is
True, then the output is in colour, else greyscale. <strong class="command">page</strong> is
the page number of the document to export (starting from 0 for the
first page!). A list of pages can be given for multipage formats (.pdf
or .ps). <strong class="command">dpi</strong> is the number of dots per inch for bitmap
output files. <strong class="command">antialias</strong> - antialiases output if
True. <strong class="command">quality</strong> is a quality parameter for jpeg
output. <strong class="command">backcolor</strong> is the background color for bitmap files,
which is a name or a #RRGGBBAA value (red, green, blue,
alpha). <strong class="command">pdfdpi</strong> is the dpi to use when exporting EPS or PDF
files. <strong class="command">svgdpi</strong> is the dpi to use when exporting to SVG files.
<strong class="command">svgtextastext</strong> says whether to export SVG text as
text, rather than curves.</p>
</section>
<section id="filterdatasets">
<h3>FilterDatasets<a class="headerlink" href="#filterdatasets" title="Permalink to this headline">¶</a></h3>
<p id="command-filterdatasets"><strong class="command">FilterDatasets(filterexpr, datasets, prefix="", suffix="",
invert=False, replaceblanks=False)</strong></p>
<p>Filter a list of datasets given. Creates new datasets for each with
prefix and suffix added to input dataset names. filterexpr is an input
numpy eexpression for filtering the datasets. If invert is set, the
filter condition is inverted. If replaceblanks is set, filtered values
are not removed, but replaced with a blank or NaN value. This command
only works on 1D numeric, date or text datasets.</p>
</section>
<section id="forceupdate">
<h3>ForceUpdate<a class="headerlink" href="#forceupdate" title="Permalink to this headline">¶</a></h3>
<p id="command-forceupdate"><strong class="command">ForceUpdate()</strong></p>
<p>Force the window to be updated to reflect the current state of the
document. Often used when periodic updates have been disabled (see
SetUpdateInterval). This command is only supported in embedded mode or
from <cite>veusz –listen</cite>.</p>
</section>
<section id="get">
<h3>Get<a class="headerlink" href="#get" title="Permalink to this headline">¶</a></h3>
<p id="command-get"><strong class="command">Get('settingpath')</strong></p>
<p>Returns: The value of the setting given by the path.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">Get</span><span class="p">(</span><span class="s1">'/page1/graph1/x/min'</span><span class="p">)</span>
<span class="go">'Auto'</span>
</pre></div>
</div>
</section>
<section id="getchildren">
<h3>GetChildren<a class="headerlink" href="#getchildren" title="Permalink to this headline">¶</a></h3>
<p id="command-getchildren"><strong class="command">GetChildren(where='.')</strong></p>
<p>Returns: The names of the widgets which are children of
the path given</p>
</section>
<section id="getclick">
<h3>GetClick<a class="headerlink" href="#getclick" title="Permalink to this headline">¶</a></h3>
<p id="command-getclick"><strong class="command">GetClick()</strong></p>
<p>Waits for the user to click on a graph and returns the
position of the click on appropriate axes. Command only works
in embedded mode.</p>
<p>Returns: A list containing tuples of the form (axispath,
val) for each axis for which the click was in range. The value
is the value on the axis for the click.</p>
</section>
<section id="getcolormap">
<h3>GetColormap<a class="headerlink" href="#getcolormap" title="Permalink to this headline">¶</a></h3>
<p id="command-getcolormap"><strong class="command">GetColormap(name, invert=False, nvals=256)</strong></p>
<p>Returns a colormap as a numpy array of red, green, blue, alpha values
(ranging from 0 to 255) with the number of steps given.</p>
</section>
<section id="getdata">
<h3>GetData<a class="headerlink" href="#getdata" title="Permalink to this headline">¶</a></h3>
<p id="command-getdata"><strong class="command">GetData(name)</strong></p>
<p>Returns: For a 1D dataset, a tuple containing the dataset with the
name given. The value is (data, symerr, negerr, poserr), with each a
numpy array of the same size or None. data are the values of the
dataset, symerr are the symmetric errors (if set), negerr and poserr
and negative and positive asymmetric errors (if set). If a text
dataset, return a list of text elements. If the dataset is a date-time
dataset, return a list of Python datetime objects. If the dataset is a
2D dataset return the tuple (data, rangex, rangey), where data is a 2D
numpy array and rangex/y are tuples giving the range of the x and y
coordinates of the data. If it is an ND dataset, return an
n-dimensional array.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">data</span> <span class="o">=</span> <span class="n">GetData</span><span class="p">(</span><span class="s1">'x'</span><span class="p">)</span>
<span class="n">SetData</span><span class="p">(</span><span class="s1">'x'</span><span class="p">,</span> <span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">*</span><span class="mf">0.1</span><span class="p">,</span> \<span class="o">*</span><span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">:])</span>
</pre></div>
</div>
</section>
<section id="getdatatype">
<h3>GetDataType<a class="headerlink" href="#getdatatype" title="Permalink to this headline">¶</a></h3>
<p id="command-getdatatype"><strong class="command">GetDataType(name)</strong></p>
<p>Get type of dataset with name given. Returns ‘1d’ for a
1d dataset, ‘2d’ for a 2d dataset, ‘text’ for a text dataset
and ‘datetime’ for a datetime dataset.</p>
</section>
<section id="getdatasets">
<h3>GetDatasets<a class="headerlink" href="#getdatasets" title="Permalink to this headline">¶</a></h3>
<p id="command-getdatasets"><strong class="command">GetDatasets()</strong></p>
<p>Returns: The names of the datasets in the current document.</p>
</section>
<section id="gpl">
<h3>GPL<a class="headerlink" href="#gpl" title="Permalink to this headline">¶</a></h3>
<p id="command-gpl"><strong class="command">GPL()</strong></p>
<p>Print out the GNU Public Licence, which Veusz is licenced under.</p>
</section>
<section id="importfile">
<h3>ImportFile<a class="headerlink" href="#importfile" title="Permalink to this headline">¶</a></h3>
<p id="command-importfile"><strong class="command">ImportFile(comm, filename, descriptor, useblocks=False, linked=False, prefix='', suffix='', ignoretext=False, encoding='utf_8', renames=None)</strong></p>
<p>Imports data from a file. The arguments are the filename to load data
from and the descriptor.</p>
<p>The format of the descriptor is a list of variable names representing
the columns of the data. For more information see <a class="reference internal" href="datasets.html#id1"><span class="std std-ref">Descriptors</span></a>.</p>
<p>If the linked parameter is set to True, if the document is saved, the
data imported will not be saved with the document, but will be reread
from the filename given the next time the document is opened. The
linked parameter is optional.</p>
<p>If useblocks is set, then blank lines or the word ‘no’ are used to
split the data into blocks. Dataset names are appended with an
underscore and the block number (starting from 1). encoding is the
name of the text file encoding. renames is a dict mapping existing to
new names after import.</p>
<p>If prefix and/or suffix are set, then the prefix and suffix are added
to each dataset name. If set, renames maps imported dataset names to
final dataset names after import.</p>
<p>Returns: A tuple containing a list of the imported datasets and the
number of conversions which failed for a dataset.</p>
</section>
<section id="importfile2d">
<h3>ImportFile2D<a class="headerlink" href="#importfile2d" title="Permalink to this headline">¶</a></h3>
<p id="command-importfile2d"><strong class="command">ImportFile2D(filename, datasetnames, xrange=None, yrange=None, invertrows=None, invertcols=None, transpose=None, gridatedge=None, mode='text', csvdelimiter=',', csvtextdelimiter='"', csvlocale='en_US', prefix="", suffix="", encoding='utf_8', linked=False)</strong></p>
<p>Imports two-dimensional data from a file. The required arguments are
the filename to load data from and the dataset name, or a list of
names to use.</p>
<p>In text mode, the file format this command accepts is a
two-dimensional matrix of numbers, with the columns separated by
spaces or tabs, and the rows separated by new lines. The X-coordinate
is taken to be in the direction of the columns. Comments are supported
(use <cite>#</cite>, <cite>!</cite> or <cite>%</cite>), as are continuation characters (<cite>\</cite>). Separate
datasets are deliminated by using blank lines. In csv mode, the csv
parameters give the type of CSV file sypported.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">xrange</span> <span class="ow">is</span> <span class="n">a</span> <span class="nb">tuple</span> <span class="n">containing</span> <span class="n">the</span> <span class="nb">range</span> <span class="n">of</span> <span class="n">data</span> <span class="ow">in</span> <span class="n">x</span> <span class="n">coordinates</span>
<span class="n">yrange</span> <span class="ow">is</span> <span class="n">a</span> <span class="nb">tuple</span> <span class="n">containing</span> <span class="n">the</span> <span class="nb">range</span> <span class="n">of</span> <span class="n">data</span> <span class="ow">in</span> <span class="n">y</span> <span class="n">coordinates</span>
<span class="k">if</span> <span class="n">invertrows</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">then</span> <span class="n">rows</span> <span class="n">are</span> <span class="n">inverted</span> <span class="n">when</span> <span class="n">read</span>
<span class="k">if</span> <span class="n">invertcols</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">then</span> <span class="n">cols</span> <span class="n">are</span> <span class="n">inverted</span> <span class="n">when</span> <span class="n">read</span>
<span class="k">if</span> <span class="n">transpose</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">then</span> <span class="n">rows</span> <span class="ow">and</span> <span class="n">columns</span> <span class="n">are</span> <span class="n">swapped</span>
<span class="k">if</span> <span class="n">gridatedge</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">use</span> <span class="n">top</span> <span class="n">row</span> <span class="ow">and</span> <span class="n">left</span> <span class="n">column</span> <span class="k">for</span> <span class="n">pixel</span> <span class="n">positions</span>
<span class="n">mode</span> <span class="ow">is</span> <span class="n">either</span> <span class="s1">'text'</span> <span class="ow">or</span> <span class="s1">'csv'</span>
<span class="n">csvdelimiter</span> <span class="ow">is</span> <span class="n">the</span> <span class="n">csv</span> <span class="n">delimiter</span> <span class="k">for</span> <span class="n">csv</span>
<span class="n">csvtextdelimiter</span> <span class="ow">is</span> <span class="n">the</span> <span class="n">csv</span> <span class="n">text</span> <span class="n">delimiter</span> <span class="k">for</span> <span class="n">csv</span>
<span class="n">csvlocale</span> <span class="ow">is</span> <span class="n">locale</span> <span class="n">to</span> <span class="n">use</span> <span class="n">when</span> <span class="n">reading</span> <span class="n">csv</span> <span class="n">data</span>
<span class="n">prefix</span> <span class="ow">and</span> <span class="n">suffix</span> <span class="n">are</span> <span class="n">prepended</span> <span class="ow">and</span> <span class="n">appended</span> <span class="n">to</span> <span class="n">dataset</span> <span class="n">names</span>
<span class="n">encoding</span> <span class="ow">is</span> <span class="n">encoding</span> <span class="n">character</span> <span class="nb">set</span>
<span class="k">if</span> <span class="n">linked</span><span class="o">=</span><span class="kc">True</span> <span class="n">then</span> <span class="n">the</span> <span class="n">dataset</span> <span class="ow">is</span> <span class="n">linked</span> <span class="n">to</span> <span class="n">the</span> <span class="n">file</span>
<span class="n">Returns</span><span class="p">:</span> <span class="nb">list</span> <span class="n">of</span> <span class="n">imported</span> <span class="n">datasets</span>
</pre></div>
</div>
<p>In addition to the matrix of numbers, the various optional parameters
this command takes can also be specified in the data file. These
commands should be given on separate lines before the matrix of
numbers. They are:</p>
<ol class="arabic simple">
<li><p>xrange A B</p></li>
<li><p>yrange C D</p></li>
<li><p>invertrows</p></li>
<li><p>invertcols</p></li>
<li><p>transpose</p></li>
</ol>
</section>
<section id="importfilecsv">
<h3>ImportFileCSV<a class="headerlink" href="#importfilecsv" title="Permalink to this headline">¶</a></h3>
<p id="command-importfilecsv"><strong class="command">ImportFileCSV('filename', readrows=False,
delimiter=',', skipwhitespace=False, textdelimiter='"',
encoding='utf_8',
headerignore=0, rowsignore=0,
blanksaredata=False,
numericlocale='en_US',
dateformat='YYYY-MM-DD|T|hh:mm:ss',
headermode='multi',
dsprefix='', dssuffix='', prefix=None,
renames=None,
linked=False)</strong></p>
<p>This command imports data from a CSV format file. Data are read from
the file using the dataset names given at the top of the files in
columns. Please see the reading data section of this manual for more
information. The options are explained below.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">readrows</span><span class="p">:</span> <span class="k">if</span> <span class="n">true</span><span class="p">,</span> <span class="n">data</span> <span class="n">are</span> <span class="n">read</span> <span class="n">across</span> <span class="n">rather</span> <span class="n">than</span> <span class="n">down</span>
<span class="n">delimiter</span><span class="p">:</span> <span class="n">character</span> <span class="k">for</span> <span class="n">delimiting</span> <span class="n">data</span> <span class="p">(</span><span class="n">usually</span> <span class="s1">','</span><span class="p">)</span>
<span class="n">skipwhitespace</span><span class="p">:</span> <span class="k">if</span> <span class="n">true</span><span class="p">,</span> <span class="n">white</span> <span class="n">space</span> <span class="n">following</span> <span class="n">delimiter</span> <span class="ow">is</span> <span class="n">ignored</span>
<span class="n">textdelimiter</span><span class="p">:</span> <span class="n">character</span> <span class="n">surrounding</span> <span class="n">text</span> <span class="p">(</span><span class="n">usually</span> <span class="s1">'"'</span><span class="p">)</span>
<span class="n">encoding</span><span class="p">:</span> <span class="n">encoding</span> <span class="n">used</span> <span class="ow">in</span> <span class="n">file</span>
<span class="n">headerignore</span><span class="p">:</span> <span class="n">number</span> <span class="n">of</span> <span class="n">lines</span> <span class="n">to</span> <span class="n">ignore</span> <span class="n">after</span> <span class="n">header</span> <span class="n">text</span>
<span class="n">rowsignore</span><span class="p">:</span> <span class="n">number</span> <span class="n">of</span> <span class="n">rows</span> <span class="n">to</span> <span class="n">ignore</span> <span class="n">at</span> <span class="n">top</span> <span class="n">of</span> <span class="n">file</span>
<span class="n">blanksaredata</span><span class="p">:</span> <span class="n">treats</span> <span class="n">blank</span> <span class="n">lines</span> <span class="ow">in</span> <span class="n">csv</span> <span class="n">files</span> <span class="k">as</span> <span class="n">blank</span> <span class="n">data</span> <span class="n">values</span>
<span class="n">numericlocale</span><span class="p">:</span> <span class="nb">format</span> <span class="n">to</span> <span class="n">use</span> <span class="k">for</span> <span class="n">reading</span> <span class="n">numbers</span>
<span class="n">dateformat</span><span class="p">:</span> <span class="nb">format</span> <span class="k">for</span> <span class="n">interpreting</span> <span class="n">dates</span>
<span class="n">headermode</span><span class="p">:</span> <span class="s1">'multi'</span><span class="p">:</span> <span class="n">multiple</span> <span class="n">headers</span> <span class="n">allowed</span> <span class="ow">in</span> <span class="n">file</span>
<span class="s1">'1st'</span><span class="p">:</span> <span class="n">first</span> <span class="n">text</span> <span class="n">found</span> <span class="n">are</span> <span class="n">headers</span>
<span class="s1">'none'</span><span class="p">:</span> <span class="n">no</span> <span class="n">headers</span><span class="p">,</span> <span class="n">guess</span> <span class="n">data</span> <span class="ow">and</span> <span class="n">use</span> <span class="n">default</span> <span class="n">names</span>
<span class="n">Dataset</span> <span class="n">names</span> <span class="n">are</span> <span class="n">prepended</span> <span class="ow">and</span> <span class="n">appended</span><span class="p">,</span> <span class="n">by</span> <span class="n">dsprefix</span> <span class="ow">and</span> <span class="n">dssuffix</span><span class="p">,</span>
<span class="n">respectively</span>
<span class="p">(</span><span class="n">prefix</span> <span class="ow">is</span> <span class="n">backware</span> <span class="n">compatibility</span> <span class="n">only</span><span class="p">,</span> <span class="n">it</span> <span class="n">adds</span> <span class="n">an</span> <span class="n">underscore</span>
<span class="n">relative</span> <span class="n">to</span> <span class="n">dsprefix</span><span class="p">)</span>
<span class="n">renames</span> <span class="ow">is</span> <span class="n">a</span> <span class="nb">map</span> <span class="n">of</span> <span class="n">old</span> <span class="n">names</span> <span class="n">to</span> <span class="n">new</span> <span class="n">names</span> <span class="n">to</span> <span class="n">rename</span> <span class="n">on</span> <span class="kn">import</span>
<span class="nn">If</span> <span class="n">linked</span> <span class="ow">is</span> <span class="kc">True</span> <span class="n">the</span> <span class="n">data</span> <span class="n">are</span> <span class="n">linked</span> <span class="k">with</span> <span class="n">the</span> <span class="n">file</span><span class="o">.</span>
<span class="n">Returns</span><span class="p">:</span> <span class="nb">list</span> <span class="n">of</span> <span class="n">imported</span> <span class="n">datasets</span>
</pre></div>
</div>
</section>
<section id="importfilefits">
<h3>ImportFileFITS<a class="headerlink" href="#importfilefits" title="Permalink to this headline">¶</a></h3>
<p id="command-importfilefits"><strong class="command">ImportFileFits(filename, items, namemap={},
slices={}, twodranges={}, twod_as_oned=set([]),
wcsmodes={}, prefix='', suffix='', renames={},
linked=False)</strong></p>
<p>Import data from a FITS file.</p>
<p>items is a list of datasets to be imported. items are formatted like
the following:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s1">'/'</span><span class="p">:</span> <span class="kn">import</span> <span class="nn">whole</span> <span class="n">file</span>
<span class="s1">'/hduname'</span><span class="p">:</span> <span class="kn">import</span> <span class="nn">whole</span> <span class="n">HDU</span> <span class="p">(</span><span class="n">image</span> <span class="ow">or</span> <span class="n">table</span><span class="p">)</span>
<span class="s1">'/hduname/column'</span><span class="p">:</span> <span class="kn">import</span> <span class="nn">column</span> <span class="kn">from</span> <span class="nn">table</span> <span class="n">HDU</span>
</pre></div>
</div>
<p>all values in items should be lower case.</p>
<p>HDU names have to follow a Veusz-specific naming. If the HDU has a
standard name (e.g. primary or events), then this is used. If the
HDU has a EXTVER keyword then this number is appended to this
name. An extra number is appended if this name is not unique. If
the HDU has no name, then the name used should be ‘hduX’, where X
is the HDU number (0 is the primary HDU).</p>
<p>namemap maps an input dataset (using the scheme above for items)
to a Veusz dataset name. Special suffixes can be used on the Veusz
dataset name to indicate that the dataset should be imported
specially.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s1">'foo (+)'</span><span class="p">:</span> <span class="kn">import</span> <span class="nn">as</span> <span class="o">+</span><span class="n">ve</span> <span class="n">error</span> <span class="k">for</span> <span class="n">dataset</span> <span class="n">foo</span>
<span class="s1">'foo (-)'</span><span class="p">:</span> <span class="kn">import</span> <span class="nn">as</span> <span class="o">-</span><span class="n">ve</span> <span class="n">error</span> <span class="k">for</span> <span class="n">dataset</span> <span class="n">foo</span>
<span class="s1">'foo (+-)'</span><span class="p">:</span> <span class="kn">import</span> <span class="nn">as</span> <span class="n">symmetric</span> <span class="n">error</span> <span class="k">for</span> <span class="n">dataset</span> <span class="n">foo</span>
</pre></div>
</div>
<p>slices is an optional dict specifying slices to be selected when
importing. For each dataset to be sliced, provide a tuple of
values, one for each dimension. The values should be a single
integer to select that index, or a tuple (start, stop, step),
where the entries are integers or None.</p>
<p>twodranges is an optional dict giving data ranges for 2D
datasets. It maps names to (minx, miny, maxx, maxy).</p>
<p>twod_as_oned: optional set containing 2D datasets to attempt to
read as 1D, treating extra columns as error bars</p>
<p>wcsmodes is an optional dict specfying the WCS import mode for 2D
datasets in HDUs. The keys are ‘/hduname’ and the values can be
‘pixel’: number pixel range from 0 to maximum (default)
‘pixel_wcs’: pixel number relative to WCS reference pixel
‘linear_wcs’: linear coordinate system from the WCS keywords
‘fraction’: fractional values from 0 to 1.</p>
<p>renames is an optional dict mapping old to new dataset names, to
be renamed after importing</p>
<p>linked specifies that the dataset is linked to the file.</p>
<p>Values under the VEUSZ header keyword can be used to override defaults:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s1">'name'</span><span class="p">:</span> <span class="n">override</span> <span class="n">name</span> <span class="k">for</span> <span class="n">dataset</span>
<span class="s1">'slice'</span><span class="p">:</span> <span class="nb">slice</span> <span class="n">on</span> <span class="n">importing</span> <span class="p">(</span><span class="n">use</span> <span class="nb">format</span> <span class="s2">"start:stop:step,..."</span><span class="p">)</span>
<span class="s1">'range'</span><span class="p">:</span> <span class="n">should</span> <span class="n">be</span> <span class="mi">4</span> <span class="n">item</span> <span class="n">array</span> <span class="n">to</span> <span class="n">specify</span> <span class="n">x</span> <span class="ow">and</span> <span class="n">y</span> <span class="n">ranges</span><span class="p">:</span>
<span class="p">[</span><span class="n">minx</span><span class="p">,</span> <span class="n">miny</span><span class="p">,</span> <span class="n">maxx</span><span class="p">,</span> <span class="n">maxy</span><span class="p">]</span>
<span class="s1">'xrange'</span> <span class="o">/</span> <span class="s1">'yrange'</span><span class="p">:</span> <span class="n">individual</span> <span class="n">ranges</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">and</span> <span class="n">y</span>
<span class="s1">'xcent'</span> <span class="o">/</span> <span class="s1">'ycent'</span><span class="p">:</span> <span class="n">arrays</span> <span class="n">giving</span> <span class="n">the</span> <span class="n">centres</span> <span class="n">of</span> <span class="n">pixels</span>
<span class="s1">'xedge'</span> <span class="o">/</span> <span class="s1">'yedge'</span><span class="p">:</span> <span class="n">arrays</span> <span class="n">giving</span> <span class="n">the</span> <span class="n">edges</span> <span class="n">of</span> <span class="n">pixels</span>
<span class="s1">'twod_as_oned'</span><span class="p">:</span> <span class="n">treat</span> <span class="mi">2</span><span class="n">d</span> <span class="n">dataset</span> <span class="k">as</span> <span class="mi">1</span><span class="n">d</span> <span class="n">dataset</span> <span class="k">with</span> <span class="n">errors</span>
<span class="s1">'wcsmode'</span><span class="p">:</span> <span class="n">use</span> <span class="n">specific</span> <span class="n">WCS</span> <span class="n">mode</span> <span class="k">for</span> <span class="n">dataset</span> <span class="p">(</span><span class="n">see</span> <span class="n">values</span> <span class="n">above</span><span class="p">)</span>
<span class="n">These</span> <span class="n">are</span> <span class="n">specified</span> <span class="n">under</span> <span class="n">the</span> <span class="n">VEUSZ</span> <span class="n">header</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">form</span>
<span class="n">KEY</span><span class="o">=</span><span class="n">VALUE</span>
<span class="ow">or</span> <span class="k">for</span> <span class="n">column</span><span class="o">-</span><span class="n">specific</span> <span class="n">values</span>
<span class="n">COLUMNNAME</span><span class="p">:</span> <span class="n">KEY</span><span class="o">=</span><span class="n">VALUE</span>
</pre></div>
</div>
<p>Returns: list of imported datasets</p>
</section>
<section id="importfilehdf5">
<h3>ImportFileHDF5<a class="headerlink" href="#importfilehdf5" title="Permalink to this headline">¶</a></h3>
<p id="command-importfilehdf5"><strong class="command">ImportFileHDF5(filename, items, namemap={},
slices={}, twodranges={}, twod_as_oned=set([]),
convert_datetime={}, prefix='', suffix='', renames={},
linked=False)</strong></p>
<p>Import data from a HDF5 file. items is a list of groups and
datasets which can be imported. If a group is imported, all
child datasets are imported. namemap maps an input dataset
to a veusz dataset name. Special suffixes can be used on the
veusz dataset name to indicate that the dataset should be
imported specially.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s1">'foo (+)'</span><span class="p">:</span> <span class="kn">import</span> <span class="nn">as</span> <span class="o">+</span><span class="n">ve</span> <span class="n">error</span> <span class="k">for</span> <span class="n">dataset</span> <span class="n">foo</span>
<span class="s1">'foo (-)'</span><span class="p">:</span> <span class="kn">import</span> <span class="nn">as</span> <span class="o">-</span><span class="n">ve</span> <span class="n">error</span> <span class="k">for</span> <span class="n">dataset</span> <span class="n">foo</span>
<span class="s1">'foo (+-)'</span><span class="p">:</span> <span class="kn">import</span> <span class="nn">as</span> <span class="n">symmetric</span> <span class="n">error</span> <span class="k">for</span> <span class="n">dataset</span> <span class="n">foo</span>
</pre></div>
</div>
<p>slices is an optional dict specifying slices to be selected when
importing. For each dataset to be sliced, provide a tuple of values,
one for each dimension. The values should be a single integer to
select that index, or a tuple (start, stop, step), where the entries
are integers or None.</p>
<p>twodranges is an optional dict giving data ranges for 2d datasets. It
maps names to (minx, miny, maxx, maxy). twod_as_oned: optional set
containing 2d datasets to attempt to read as 1d</p>
<p>convert_datetime should be a dict mapping hdf name to specify
date/time importing. For a 1d numeric dataset: if this is set to
‘veusz’, this is the number of seconds since 2009-01-01, if this is
set to ‘unix’, this is the number of seconds since 1970-01-01. For a
text dataset, this should give the format of the date/time,
e.g. ‘YYYY-MM-DD|T|hh:mm:ss’ or ‘iso’ for iso format.</p>
<p>renames is a dict mapping old to new dataset names, to be renamed
after importing. linked specifies that the dataset is linked to the
file.</p>
<p>Attributes can be used in datasets to override defaults:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s1">'vsz_name'</span><span class="p">:</span> <span class="nb">set</span> <span class="n">to</span> <span class="n">override</span> <span class="n">name</span> <span class="k">for</span> <span class="n">dataset</span> <span class="ow">in</span> <span class="n">veusz</span>
<span class="s1">'vsz_slice'</span><span class="p">:</span> <span class="nb">slice</span> <span class="n">on</span> <span class="n">importing</span> <span class="p">(</span><span class="n">use</span> <span class="nb">format</span> <span class="s2">"start:stop:step,..."</span><span class="p">)</span>
<span class="s1">'vsz_range'</span><span class="p">:</span> <span class="n">should</span> <span class="n">be</span> <span class="mi">4</span> <span class="n">item</span> <span class="n">array</span> <span class="n">to</span> <span class="n">specify</span> <span class="n">x</span> <span class="ow">and</span> <span class="n">y</span> <span class="n">ranges</span><span class="p">:</span>
<span class="p">[</span><span class="n">minx</span><span class="p">,</span> <span class="n">miny</span><span class="p">,</span> <span class="n">maxx</span><span class="p">,</span> <span class="n">maxy</span><span class="p">]</span>
<span class="s1">'vsz_twod_as_oned'</span><span class="p">:</span> <span class="n">treat</span> <span class="mi">2</span><span class="n">d</span> <span class="n">dataset</span> <span class="k">as</span> <span class="mi">1</span><span class="n">d</span> <span class="n">dataset</span> <span class="k">with</span> <span class="n">errors</span>
<span class="s1">'vsz_convert_datetime'</span><span class="p">:</span> <span class="n">treat</span> <span class="k">as</span> <span class="n">date</span><span class="o">/</span><span class="n">time</span><span class="p">,</span> <span class="nb">set</span> <span class="n">to</span> <span class="n">one</span> <span class="n">of</span> <span class="n">the</span> <span class="n">values</span>
<span class="n">above</span><span class="o">.</span>
</pre></div>
</div>
<p>For compound datasets these attributes can be given on a per-column
basis using attribute names vsz_attributename_columnname.</p>
<p>Returns: list of imported datasets</p>
</section>
<section id="importfilend">
<h3>ImportFileND<a class="headerlink" href="#importfilend" title="Permalink to this headline">¶</a></h3>
<p id="command-importfilend"><strong class="command">def ImportFileND(comm, filename, dataset, shape=None,
transpose=False, mode='text', csvdelimiter=',', csvtextdelimiter='"',
csvlocale='en_US', prefix="", suffix="", encoding='utf_8',
linked=False)</strong></p>
<p>Import an n-dimensional dataset from a file. The file should either be
in CSV format (mode=’csv’) or whitespace-separated text (mode=’text’).
A one-dimensional dataset is given as a list of numbers on a single
line/row. A two-dimensional dataset is given by a set of rows. A
three-dimensional dataset is given by a set of two-dimensional
datasets, with blank lines between them. a four-dimensional dataset is
given by a set of three-dimensional datasets with two blank lines
between each. Each additional dataset increases the separating number
of blank lines by one. Alternatively, the numbers can be given in any
form (number of numbers on each row) and “shape” is included to
reshape the data into the desired shape.</p>
<p>In the file, or included as parameters above, the command “shape num1
num2…” can be included to reshape the output dataset to the shape
given by the numbers in the row after “shape” (these should be in
separate columns in CSV format). If one of these numbers is -1, then
this dimension is inferred from the number of values and the other
dimensions. Also supported is the “transpose” command or optional
argument which reverses the order of the dimensions.</p>
</section>
<section id="importfileplugin">
<h3>ImportFilePlugin<a class="headerlink" href="#importfileplugin" title="Permalink to this headline">¶</a></h3>
<p id="command-importfileplugin"><strong class="command">ImportFilePlugin('pluginname', 'filename', **pluginargs,
linked=False, encoding='utf_8', prefix='', suffix='', renames={})</strong></p>
<p>Import data from file using import plugin ‘pluginname’. The arguments
to the plugin are given, plus optionally a text encoding, and prefix
and suffix to prepend or append to dataset names. renames, if set,
provides new names for datasets after import.</p>
</section>
<section id="importfitsfile">
<h3>ImportFITSFile<a class="headerlink" href="#importfitsfile" title="Permalink to this headline">¶</a></h3>
<p id="command-importfitsfile"><strong class="command">ImportFITSFile(datasetname, filename, hdu, datacol='A',
symerrcol='B', poserrcol='C', negerrcol='D', linked=True/False,
renames={})</strong></p>
<p>This command is deprecated. Please do not use in new code, but instead
use ImportFileFITS.</p>
<p>This command does a simple import from a FITS file. The FITS format is
used within the astronomical community to transport binary data. For a
more powerful FITS interface, you can use PyFITS within your scripts.</p>
<p>The datasetname is the name of the dataset to import, the filename is
the name of the FITS file to import from. The hdu parameter specifies
the HDU to import data from (numerical or a name).</p>
<p>If the HDU specified is a primary HDU or image extension, then a
two-dimensional dataset is loaded from the file. The optional
parameters (other than linked) are ignored. Any WCS information within
the HDU are used to provide a suitable xrange and yrange.</p>
<p>If the HDU is a table, then the datacol parameter must be specified
(and optionally symerrcol, poserrcol and negerrcol). The dataset is
read in from the named column in the table. Any errors are read in
from the other specified columns.</p>
<p>If linked is True, then the dataset is not saved with a saved
document, but is reread from the data file each time the document is
loaded. renames, if set, provides new names for datasets after
import.</p>
</section>
<section id="importstring">
<h3>ImportString<a class="headerlink" href="#importstring" title="Permalink to this headline">¶</a></h3>
<p id="command-importstring"><strong class="command">ImportString('descriptor',
'data')</strong></p>
<p>Like, <a class="reference internal" href="#command-importfile"><span class="std std-ref">ImportFile</span></a>, but loads the data from
the specfied string rather than a file. This allows data to be easily
embedded within a document. The data string is usually a multi-line
Python string.</p>
<p>Returns: A tuple containing a list of the imported datasets and the
number of conversions which failed for a dataset.</p>
<p>Changed in version 0.5: A tuple is returned rather than just the
number of imported variables.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">ImportString</span><span class="p">(</span><span class="s1">'x y'</span><span class="p">,</span> <span class="s1">'''</span>
<span class="s1"> 1 2</span>
<span class="s1"> 2 5</span>
<span class="s1"> 3 10</span>
<span class="s1">'''</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="importstring2d">
<h3>ImportString2D<a class="headerlink" href="#importstring2d" title="Permalink to this headline">¶</a></h3>
<p id="command-importstring2d"><strong class="command">ImportString2D(datasets, string, xrange=None, yrange=None,
invertrows=None, invertcols=None, transpose=None)</strong></p>
<p>Imports a two-dimensional dataset from the string given. This is
similar to the <a class="reference internal" href="#command-importfile2d"><span class="std std-ref">ImportFile2D</span></a> command,
with the same dataset format within the string. The optional values
are also listed there. The various controlling parameters can be set
within the string. See the <a class="reference internal" href="#command-importfile2d"><span class="std std-ref">ImportFile2D</span></a>
section for details.</p>
</section>
<section id="importstringnd">
<h3>ImportStringND<a class="headerlink" href="#importstringnd" title="Permalink to this headline">¶</a></h3>
<p id="command-importstringnd"><strong class="command">ImportStringND(dataset, string, shape=None,
transpose=False)</strong></p>
<p>Imports a n-dimensional dataset from the string given. This is similar
to the <a class="reference internal" href="#command-importfilend"><span class="std std-ref">ImportFileND</span></a> command. Please look
there for more detail and the description of the optional parameters
and in-stream allowed parameters.</p>
</section>
<section id="isclosed">
<h3>IsClosed<a class="headerlink" href="#isclosed" title="Permalink to this headline">¶</a></h3>
<p id="command-isclosed"><strong class="command">IsClosed()</strong></p>
<p>Returns a boolean value telling the caller whether the plotting window
has been closed.</p>
<p>Note: this command is only supported in the embedding interface.</p>
</section>
<section id="list">
<h3>List<a class="headerlink" href="#list" title="Permalink to this headline">¶</a></h3>
<p id="command-list"><strong class="command">List(where='.')</strong></p>
<p>List the widgets which are contained within the widget with the path
given, the type of widgets, and a brief description.</p>
</section>
<section id="load">
<h3>Load<a class="headerlink" href="#load" title="Permalink to this headline">¶</a></h3>
<p id="command-load"><strong class="command">Load('filename.vsz')</strong></p>
<p>Loads the veusz script file given. The script file can be any Python
code. The code is executed using the Veusz interpreter.</p>
<p>Note: this command is only supported at the command line and not in a
script. Scripts may use the python <strong class="command">execfile</strong> function
instead.</p>
</section>
<section id="movetopage">
<h3>MoveToPage<a class="headerlink" href="#movetopage" title="Permalink to this headline">¶</a></h3>
<p id="command-movetopage"><strong class="command">MoveToPage(pagenum)</strong></p>
<p>Updates window to show the page number given of the document.</p>
<p>Note: this command is only supported in the embedding interface or
<cite>veusz –listen</cite>.</p>
</section>
<section id="reloaddata">
<h3>ReloadData<a class="headerlink" href="#reloaddata" title="Permalink to this headline">¶</a></h3>
<p id="command-reloaddata"><strong class="command">ReloadData()</strong></p>
<p>Reload any datasets which have been linked to files.</p>
<p>Returns: A tuple containing a list of the imported datasets and the
number of conversions which failed for a dataset.</p>
</section>
<section id="rename">
<h3>Rename<a class="headerlink" href="#rename" title="Permalink to this headline">¶</a></h3>
<p id="command-rename"><strong class="command">Remove('widgetpath', 'newname')</strong></p>
<p>Rename the widget at the path given to a new name. This command does
not move widgets. See <a class="reference internal" href="#command-to"><span class="std std-ref">To</span></a> for a description of the
path syntax. ‘.’ can be used to select the current widget.</p>
</section>
<section id="remove">
<h3>Remove<a class="headerlink" href="#remove" title="Permalink to this headline">¶</a></h3>
<p id="command-remove"><strong class="command">Remove('widgetpath')</strong></p>
<p>Remove the widget selected using the path. See <a class="reference internal" href="#command-to"><span class="std std-ref">To</span></a>
for a description of the path syntax.</p>
</section>
<section id="resizewindow">
<h3>ResizeWindow<a class="headerlink" href="#resizewindow" title="Permalink to this headline">¶</a></h3>
<p id="command-resizewindow"><strong class="command">ResizeWindow(width, height)</strong></p>
<p>Resizes window to be width by height pixels.</p>
<p>Note: this command is only supported in the embedding interface or
<cite>veusz –listen</cite>.</p>
</section>
<section id="save">
<h3>Save<a class="headerlink" href="#save" title="Permalink to this headline">¶</a></h3>
<p id="command-save"><strong class="command">Save('filename.vsz')</strong></p>
<p>Save the current document under the filename
given.</p>
</section>
<section id="set">
<h3>Set<a class="headerlink" href="#set" title="Permalink to this headline">¶</a></h3>
<p id="command-set"><strong class="command">Set('settingpath', val)</strong></p>
<p>Set the setting given by the path to the value given. If the type of
<strong class="command">val</strong> is incorrect, an <strong class="command">InvalidType</strong> exception is
thrown. The path to the setting is the optional path to the widget the
setting is contained within, an optional subsetting specifier, and the
setting itself.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">Set</span><span class="p">(</span><span class="s1">'page1/graph1/x/min'</span><span class="p">,</span> <span class="o">-</span><span class="mf">10.</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="setantialiasing">
<h3>SetAntiAliasing<a class="headerlink" href="#setantialiasing" title="Permalink to this headline">¶</a></h3>
<p id="command-setantialiasing"><strong class="command">SetAntiAliasing(on)</strong></p>
<p>Enable or disable anti aliasing in the plot window, replotting the
image.</p>
</section>
<section id="setcompatlevel">
<h3>SetCompatLevel<a class="headerlink" href="#setcompatlevel" title="Permalink to this headline">¶</a></h3>
<p id="command-setcompatlevel"><strong class="command">SetCompatLevel(level)</strong></p>
<p>Set the document compatibility level. If <cite>level<0</cite>, then choose the latest version. As a side effect, this wipes any widgets in the document and resets all settings.</p>
</section>
<section id="setdata">
<h3>SetData<a class="headerlink" href="#setdata" title="Permalink to this headline">¶</a></h3>
<p id="command-setdata"><strong class="command">SetData(name, val, symerr=None, negerr=None, poserr=None)</strong></p>
<p>Set the dataset name with the values given. If None is given for an
item, it will be left blank. val is the actual data, symerr are the
symmetric errors, negerr and poserr and the getative and positive
asymmetric errors. The data can be given as lists or numpys.</p>
</section>
<section id="setdataexpression">
<h3>SetDataExpression<a class="headerlink" href="#setdataexpression" title="Permalink to this headline">¶</a></h3>
<p id="command-setdataexpression"><strong class="command">SetDataExpression(name, val, symerr=None, negerr=None,
poserr=None, linked=False, parametric=None)</strong></p>
<p>Create a new dataset based on the expressions given. The expressions
are Python syntax expressions based on existing datasets.</p>
<p>If linked is True, the dataset will change as the datasets in the
expressions change.</p>
<p>Parametric can be set to a tuple of (minval, maxval,
numitems). <strong class="command">t</strong> in the expression will iterate from minval to
maxval in numitems values.</p>
</section>
<section id="setdatand">
<h3>SetDataND<a class="headerlink" href="#setdatand" title="Permalink to this headline">¶</a></h3>
<p id="command-setdatand"><strong class="command">SetDataRange(name, val)</strong></p>
<p>Set a n-dimensional dataset to be the values given by val. val should
be an n-dimensional numpy array of values, or a list of lists.</p>
</section>
<section id="setdatarange">
<h3>SetDataRange<a class="headerlink" href="#setdatarange" title="Permalink to this headline">¶</a></h3>
<p id="command-setdatarange"><strong class="command">SetDataRange(name, numsteps, val, symerr=None, negerr=None,
poserr=None, linked=False)</strong></p>
<p>Set dataset to be a range of values with numsteps steps. val is tuple
made up of (minimum value, maximum value). symerr, negerr and poserr
are optional tuples for the error bars.</p>
<p>If linked is True, the dataset can be saved in a document as a
SetDataRange, otherwise it is expanded to the values which would make
it up.</p>
</section>
<section id="setdata2d">
<h3>SetData2D<a class="headerlink" href="#setdata2d" title="Permalink to this headline">¶</a></h3>
<p id="command-setdata2d"><strong class="command">SetData2D('name', val, xrange=(A,B), yrange=(C,D),
xgrid=[1,2,3...], ygrid=[4,5,6...])</strong></p>
<p>Creates a two-dimensional dataset with the name given. val is either a
two-dimensional numpy array, or is a list of lists, with each list in
the list representing a row. Do not give xrange if xgrid is set and do
not give yrange if ygrid is set, and vice versa.</p>
<p>xrange and yrange are optional tuples giving the inclusive range of
the X and Y coordinates of the data. xgrid and ygrid are optional
lists, tuples or arrays which give the coordinates of the edges of the
pixels. There should be one more item in each array than pixels.</p>
</section>
<section id="setdata2dexpression">
<h3>SetData2DExpression<a class="headerlink" href="#setdata2dexpression" title="Permalink to this headline">¶</a></h3>
<p id="command-setdata2dexpression"><strong class="command">SetData2DExpression('name', expr, linked=False)</strong></p>
<p>Create a 2D dataset based on expressions. name is the new dataset
name expr is an expression which should return a 2D array linked
specifies whether to permanently link the dataset to the expressions.</p>
</section>
<section id="setdata2dexpressionxyz">
<h3>SetData2DExpressionXYZ<a class="headerlink" href="#setdata2dexpressionxyz" title="Permalink to this headline">¶</a></h3>
<p id="command-setdata2dexpressionxyz"><strong class="command">SetData2DExpressionXYZ('name', 'xexpr', 'yexpr', 'zexpr',
linked=False)</strong></p>
<p>Create a 2D dataset based on three 1D expressions. The x, y
expressions need to evaluate to a grid of x, y points, with the z
expression as the 2D value at that point. Currently only linear fixed
grids are supported. This function is intended to convert calculations
or measurements at fixed points into a 2D dataset easily. Missing
values are filled with NaN.</p>
</section>
<section id="setdata2dxyfunc">
<h3>SetData2DXYFunc<a class="headerlink" href="#setdata2dxyfunc" title="Permalink to this headline">¶</a></h3>
<p id="command-setdata2dxyfunc"><strong class="command">SetData2DXYFunc('name', xstep, ystep, 'expr', linked=False)</strong></p>
<p>Construct a 2D dataset using a mathematical expression of “x” and
“y”. The x values are specified as (min, max, step) in xstep as a
tuple, the y values similarly. If linked remains as False, then a real
2D dataset is created, where values can be modified and the data are
stored in the saved file.</p>
</section>
<section id="setdatadatetime">
<h3>SetDataDateTime<a class="headerlink" href="#setdatadatetime" title="Permalink to this headline">¶</a></h3>
<p id="command-setdatadatetime"><strong class="command">SetDataDateTime('name', vals)</strong></p>
<p>Creates a datetime dataset of name given. vals is a list of Python
datetime objects.</p>
</section>
<section id="setdatatext">
<h3>SetDataText<a class="headerlink" href="#setdatatext" title="Permalink to this headline">¶</a></h3>
<p id="command-setdatatext"><strong class="command">SetDataText(name, val)</strong></p>
<p>Set the text dataset name with the values given. <strong class="command">val</strong> must
be a type that can be converted into a Python list.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">SetDataText</span><span class="p">(</span><span class="s1">'mylabel'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'oranges'</span><span class="p">,</span> <span class="s1">'apples'</span><span class="p">,</span> <span class="s1">'pears'</span><span class="p">,</span> <span class="s1">'spam'</span><span class="p">])</span>
</pre></div>
</div>
</section>
<section id="settoreference">
<h3>SetToReference<a class="headerlink" href="#settoreference" title="Permalink to this headline">¶</a></h3>
<p id="command-settoreference"><strong class="command">SetToReference(setting, refval)</strong></p>
<p>Link setting given to other setting refval.</p>
</section>
<section id="setupdateinterval">
<h3>SetUpdateInterval<a class="headerlink" href="#setupdateinterval" title="Permalink to this headline">¶</a></h3>
<p id="command-setupdateinterval"><strong class="command">SetUpdateInterval(interval)</strong></p>
<p>Tells window to update every interval milliseconds at most. The value
0 disables updates until this function is called with a non-zero. The
value -1 tells Veusz to update the window every time the document has
changed. This will make things slow if repeated changes are made to
the document. Disabling updates and using the ForceUpdate command will
allow the user to control updates directly.</p>
<p>Note: this command is only supported in the embedding interface or
<cite>veusz –listen</cite>.</p>
</section>
<section id="setverbose">
<h3>SetVerbose<a class="headerlink" href="#setverbose" title="Permalink to this headline">¶</a></h3>
<p id="command-setverbose"><strong class="command">SetVerbose(v=True)</strong></p>
<p>If <strong class="command">v</strong> is <strong class="command">True</strong>, then extra information is printed
out by commands.</p>
</section>
<section id="startsecondview">
<h3>StartSecondView<a class="headerlink" href="#startsecondview" title="Permalink to this headline">¶</a></h3>
<p id="command-startsecondview"><strong class="command">StartSecondView(name = 'window title')</strong></p>
<p>In the embedding interface, this method will open a new Embedding
interface onto the same document, returning the object. This new
window provides a second view onto the document. It can, for instance,
show a different page to the primary view. name is a window title for
the new window.</p>
<p>Note: this command is only supported in the embedding interface.</p>
</section>
<section id="tagdatasets">
<h3>TagDatasets<a class="headerlink" href="#tagdatasets" title="Permalink to this headline">¶</a></h3>
<p id="command-tagdatasets"><strong class="command">TagDatasets('tag', ['ds1', 'ds2'...])</strong></p>
<p>Adds the tag to the list of datasets given..</p>
</section>
<section id="to">
<h3>To<a class="headerlink" href="#to" title="Permalink to this headline">¶</a></h3>
<p id="command-to"><strong class="command">To('widgetpath')</strong></p>
<p>The To command takes a path to a widget and moves to that widget. For
example, this may be “/”, the root widget, “graph1”,
“/page1/graph1/x”, “../x”. The syntax is designed to mimic Unix paths
for files. “/” represents the base widget (where the pages reside),
and “..” represents the widget next up the tree.</p>
</section>
<section id="quit">
<h3>Quit<a class="headerlink" href="#quit" title="Permalink to this headline">¶</a></h3>
<p id="command-quit"><strong class="command">Quit()</strong></p>
<p>Quits Veusz. This is only supported in <cite>veusz –listen</cite>.</p>
</section>
<section id="waitforclose">
<h3>WaitForClose<a class="headerlink" href="#waitforclose" title="Permalink to this headline">¶</a></h3>
<p id="command-waitforclose"><strong class="command">WaitForClose()</strong></p>
<p>Wait until the plotting window has been closed.</p>
<p>Note: this command is only supported in the embedding interface.</p>
</section>
<section id="zoom">
<h3>Zoom<a class="headerlink" href="#zoom" title="Permalink to this headline">¶</a></h3>
<p id="command-zoom"><strong class="command">Zoom(factor)</strong></p>
<p>Sets the plot zoom factor, relative to a 1:1 scaling. factor can also
be “width”, “height” or “page”, to zoom to the page width, height or
page, respectively.</p>
<p>This is only supported in embedded mode or <cite>veusz –listen</cite>.</p>
</section>
</section>
<section id="security">
<h2>Security<a class="headerlink" href="#security" title="Permalink to this headline">¶</a></h2>
<p>With the 1.0 release of Veusz, input scripts and expressions are
checked for possible security risks. Only a limited subset of Python
functionality is allowed, or a dialog box is opened allowing the user
to cancel the operation. Specifically you cannot import modules, get
attributes of Python objects, access globals() or locals() or do any
sort of file reading or manipulation. Basically anything which might
break in Veusz or modify a system is not supported. In addition
internal Veusz functions which can modify a system are also warned
against, specifically Print(), Save() and Export().</p>
<p>If you are running your own scripts and do not want to be bothered by
these dialogs, you can run veusz with the <strong class="command">--unsafe-mode</strong>
option.</p>
</section>
<section id="using-veusz-from-other-programs">
<h2>Using Veusz from other programs<a class="headerlink" href="#using-veusz-from-other-programs" title="Permalink to this headline">¶</a></h2>
<section id="non-qt-python-programs">
<h3>Non-Qt Python programs<a class="headerlink" href="#non-qt-python-programs" title="Permalink to this headline">¶</a></h3>
<p>Veusz can be used as a Python module for plotting data. There are two
ways to use the module: (1) with an older path-based Veusz commands,
used in Veusz saved document files or (2) using an object-oriented
interface. With the old style method the user uses a unix-path
inspired API to navigate the widget tree and add or manipulate
widgets. With the new style interface, the user navigates the tree
with attributes of the <code class="docutils literal notranslate"><span class="pre">Root</span></code> object to access Nodes. The new
interface is likely to be easier to use unless you are directly
translating saved files.</p>
</section>
<section id="older-path-based-interface">
<h3>Older path-based interface<a class="headerlink" href="#older-path-based-interface" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="sd">"""An example embedding program. Veusz needs to be installed into</span>
<span class="sd">the Python path for this to work (use setup.py)</span>
<span class="sd">This animates a sin plot, then finishes</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="kn">import</span> <span class="nn">numpy</span>
<span class="kn">import</span> <span class="nn">veusz.embed</span> <span class="k">as</span> <span class="nn">veusz</span>
<span class="c1"># construct a Veusz embedded window</span>
<span class="c1"># many of these can be opened at any time</span>
<span class="n">g</span> <span class="o">=</span> <span class="n">veusz</span><span class="o">.</span><span class="n">Embedded</span><span class="p">(</span><span class="s1">'window title'</span><span class="p">)</span>
<span class="n">g</span><span class="o">.</span><span class="n">EnableToolbar</span><span class="p">()</span>
<span class="c1"># construct the plot</span>
<span class="n">g</span><span class="o">.</span><span class="n">To</span><span class="p">(</span> <span class="n">g</span><span class="o">.</span><span class="n">Add</span><span class="p">(</span><span class="s1">'page'</span><span class="p">)</span> <span class="p">)</span>
<span class="n">g</span><span class="o">.</span><span class="n">To</span><span class="p">(</span> <span class="n">g</span><span class="o">.</span><span class="n">Add</span><span class="p">(</span><span class="s1">'graph'</span><span class="p">)</span> <span class="p">)</span>
<span class="n">g</span><span class="o">.</span><span class="n">Add</span><span class="p">(</span><span class="s1">'xy'</span><span class="p">,</span> <span class="n">marker</span><span class="o">=</span><span class="s1">'tiehorz'</span><span class="p">,</span> <span class="n">MarkerFill__color</span><span class="o">=</span><span class="s1">'green'</span><span class="p">)</span>
<span class="c1"># this stops intelligent axis extending</span>
<span class="n">g</span><span class="o">.</span><span class="n">Set</span><span class="p">(</span><span class="s1">'x/autoExtend'</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
<span class="n">g</span><span class="o">.</span><span class="n">Set</span><span class="p">(</span><span class="s1">'x/autoExtendZero'</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
<span class="c1"># zoom out</span>
<span class="n">g</span><span class="o">.</span><span class="n">Zoom</span><span class="p">(</span><span class="mf">0.8</span><span class="p">)</span>
<span class="c1"># loop, changing the values of the x and y datasets</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">10</span><span class="p">):</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">numpy</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">0</span><span class="o">+</span><span class="n">i</span><span class="o">/</span><span class="mf">2.</span><span class="p">,</span> <span class="mf">7.</span><span class="o">+</span><span class="n">i</span><span class="o">/</span><span class="mf">2.</span><span class="p">,</span> <span class="mf">0.05</span><span class="p">)</span>
<span class="n">y</span> <span class="o">=</span> <span class="n">numpy</span><span class="o">.</span><span class="n">sin</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
<span class="n">g</span><span class="o">.</span><span class="n">SetData</span><span class="p">(</span><span class="s1">'x'</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span>
<span class="n">g</span><span class="o">.</span><span class="n">SetData</span><span class="p">(</span><span class="s1">'y'</span><span class="p">,</span> <span class="n">y</span><span class="p">)</span>
<span class="c1"># wait to animate the graph</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
<span class="c1"># let the user see the final result</span>
<span class="nb">print</span> <span class="s2">"Waiting for 10 seconds"</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span>
<span class="nb">print</span> <span class="s2">"Done!"</span>
<span class="c1"># close the window (this is not strictly necessary)</span>
<span class="n">g</span><span class="o">.</span><span class="n">Close</span><span class="p">()</span>
</pre></div>
</div>
<p>The embed interface has the methods listed in the command line
interface listed in the Veusz manual
<a class="reference external" href="https://veusz.github.io/docs/manual.html">https://veusz.github.io/docs/manual.html</a></p>
<p>Multiple Windows are supported by creating more than one <code class="docutils literal notranslate"><span class="pre">Embedded</span></code>
object. Other useful methods include:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">WaitForClose()</span></code> - wait until window has closed</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GetClick()</span></code> - return a list of <code class="docutils literal notranslate"><span class="pre">(axis,</span> <span class="pre">value)</span></code> tuples where the
user clicks on a graph</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ResizeWndow(width,</span> <span class="pre">height)</span></code> - resize window to be <code class="docutils literal notranslate"><span class="pre">width</span></code> x
<code class="docutils literal notranslate"><span class="pre">height</span></code> pixels</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">SetUpdateInterval(interval)</span></code> - set update interval in ms or 0 to
disable</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">MoveToPage(page)</span></code> - display page given (starting from 1)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">IsClosed()</span></code> - has the page been closed</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Zoom(factor)</span></code> - set zoom level (float) or ‘page’, ‘width’,
‘height’</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Close()</span></code> - close window</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">SetAntiAliasing(enable)</span></code> - enable or disable antialiasing</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">EnableToolbar(enable=True)</span></code> - enable plot toolbar</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">StartSecondView(name='Veusz')</span></code> - start a second view onto the
document of the current <code class="docutils literal notranslate"><span class="pre">Embedded</span></code> object. Returns a new
<code class="docutils literal notranslate"><span class="pre">Embedded</span></code> object.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Wipe()</span></code> - wipe the document of all widgets and datasets.</p></li>
</ul>
</section>
<section id="new-style-object-interface">
<span id="new-api"></span><h3>New-style object interface<a class="headerlink" href="#new-style-object-interface" title="Permalink to this headline">¶</a></h3>
<p>In Veusz 1.9 or late a new style of object interface is present, which
makes it easier to construct the widget tree. Each widget, group of
settings or setting is stored as a Node object, or its subclass, in a
tree. The root document widget can be accessed with the <code class="docutils literal notranslate"><span class="pre">Root</span></code>
object. The dot operator “.” finds children inside other nodes. In
Veusz some widgets can contain other widgets (Root, pages, graphs,
grids). Widgets contain setting nodes, accessed as attributes. Widgets
can also contain groups of settings, again accessed as attributes.</p>
<p>An example tree for a document (not complete) might look like this</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Root</span>
\<span class="o">--</span> <span class="n">page1</span> <span class="p">(</span><span class="n">page</span> <span class="n">widget</span><span class="p">)</span>
\<span class="o">--</span> <span class="n">graph1</span> <span class="p">(</span><span class="n">graph</span> <span class="n">widget</span><span class="p">)</span>
\<span class="o">--</span> <span class="n">x</span> <span class="p">(</span><span class="n">axis</span> <span class="n">widget</span><span class="p">)</span>
\<span class="o">--</span> <span class="n">y</span> <span class="p">(</span><span class="n">axis</span> <span class="n">widget</span><span class="p">)</span>
\<span class="o">--</span> <span class="n">function</span> <span class="p">(</span><span class="n">function</span> <span class="n">widget</span><span class="p">)</span>
\<span class="o">--</span> <span class="n">grid1</span> <span class="p">(</span><span class="n">grid</span> <span class="n">widget</span><span class="p">)</span>
\<span class="o">--</span> <span class="n">graph2</span> <span class="p">(</span><span class="n">graph</span> <span class="n">widget</span><span class="p">)</span>
\<span class="o">--</span> <span class="n">xy1</span> <span class="p">(</span><span class="n">xy</span> <span class="n">widget</span><span class="p">)</span>
\<span class="o">--</span> <span class="n">xData</span> <span class="p">(</span><span class="n">setting</span><span class="p">)</span>
\<span class="o">--</span> <span class="n">yData</span> <span class="p">(</span><span class="n">setting</span><span class="p">)</span>
\<span class="o">--</span> <span class="n">PlotLine</span> <span class="p">(</span><span class="n">setting</span> <span class="n">group</span><span class="p">)</span>
\<span class="o">--</span> <span class="n">width</span> <span class="p">(</span><span class="n">setting</span><span class="p">)</span>
<span class="o">...</span>
<span class="o">...</span>
\<span class="o">--</span> <span class="n">x</span> <span class="p">(</span><span class="n">axis</span> <span class="n">widget</span><span class="p">)</span>
\<span class="o">--</span> <span class="n">y</span> <span class="p">(</span><span class="n">axis</span> <span class="n">widget</span><span class="p">)</span>
\<span class="o">--</span> <span class="n">graph3</span> <span class="p">(</span><span class="n">graph</span> <span class="n">widget</span><span class="p">)</span>
\<span class="o">--</span> <span class="n">contour1</span> <span class="p">(</span><span class="n">contour</span> <span class="n">widget</span><span class="p">)</span>
\<span class="o">--</span> <span class="n">x</span> <span class="p">(</span><span class="n">axis</span> <span class="n">widget</span><span class="p">)</span>
\<span class="o">--</span> <span class="n">y</span> <span class="p">(</span><span class="n">axis</span> <span class="n">widget</span><span class="p">)</span>
</pre></div>
</div>
<p>Here the user could access the xData setting node of the
xy1 widget using <code class="docutils literal notranslate"><span class="pre">Root.page1.graph2.xy1.xData</span></code>. To
actually read or modify the value of a setting, you should get
or set the <code class="docutils literal notranslate"><span class="pre">val</span></code> property of the setting node. The line
width could be changed like this</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">graph</span> <span class="o">=</span> <span class="n">embed</span><span class="o">.</span><span class="n">Root</span><span class="o">.</span><span class="n">page1</span><span class="o">.</span><span class="n">graph2</span>
<span class="n">graph</span><span class="o">.</span><span class="n">xy1</span><span class="o">.</span><span class="n">PlotLine</span><span class="o">.</span><span class="n">width</span><span class="o">.</span><span class="n">val</span> <span class="o">=</span> <span class="s1">'2pt'</span>
</pre></div>
</div>
<p>For instance, this constructs a simple x-squared plot which
changes to x-cubed:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">veusz.embed</span> <span class="k">as</span> <span class="nn">veusz</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="c1"># open a new window and return a new Embedded object</span>
<span class="n">embed</span> <span class="o">=</span> <span class="n">veusz</span><span class="o">.</span><span class="n">Embedded</span><span class="p">(</span><span class="s1">'window title'</span><span class="p">)</span>
<span class="c1"># make a new page, but adding a page widget to the root widget</span>
<span class="n">page</span> <span class="o">=</span> <span class="n">embed</span><span class="o">.</span><span class="n">Root</span><span class="o">.</span><span class="n">Add</span><span class="p">(</span><span class="s1">'page'</span><span class="p">)</span>
<span class="c1"># add a new graph widget to the page</span>
<span class="n">graph</span> <span class="o">=</span> <span class="n">page</span><span class="o">.</span><span class="n">Add</span><span class="p">(</span><span class="s1">'graph'</span><span class="p">)</span>
<span class="c1"># add a function widget to the graph. The Add() method can take a list of settings</span>
<span class="c1"># to set after widget creation. Here, "function='x**2'" is equivalent to</span>
<span class="c1"># function.function.val = 'x**2'</span>
<span class="n">function</span> <span class="o">=</span> <span class="n">graph</span><span class="o">.</span><span class="n">Add</span><span class="p">(</span><span class="s1">'function'</span><span class="p">,</span> <span class="n">function</span><span class="o">=</span><span class="s1">'x**2'</span><span class="p">)</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
<span class="n">function</span><span class="o">.</span><span class="n">function</span><span class="o">.</span><span class="n">val</span> <span class="o">=</span> <span class="s1">'x**3'</span>
<span class="c1"># this is the same if the widgets have the default names</span>
<span class="n">Root</span><span class="o">.</span><span class="n">page1</span><span class="o">.</span><span class="n">graph1</span><span class="o">.</span><span class="n">function1</span><span class="o">.</span><span class="n">function</span><span class="o">.</span><span class="n">val</span> <span class="o">=</span> <span class="s1">'x**3'</span>
</pre></div>
</div>
<p>If the document contains a page called “page1” then <code class="docutils literal notranslate"><span class="pre">Root.page1</span></code> is
the object representing the page. Similarly, <code class="docutils literal notranslate"><span class="pre">Root.page1.graph1</span></code> is
a graph called <code class="docutils literal notranslate"><span class="pre">graph1</span></code> in the page. You can also use
dictionary-style indexing to get child widgets,
e.g. Root[‘page1’][‘graph1’]. This style is easier to use if the names
of widgets contain spaces or if widget names shadow methods or
properties of the Node object, i.e. if you do not control the widget
names.</p>
<p>Widget nodes can contain as children other widgets, groups of
settings, or settings. Groups of settings can contain child
settings. Settings cannot contain other nodes. Here are the useful
operations of Nodes:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Node</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""properties:</span>
<span class="sd"> path - return path to object in document, e.g. /page1/graph1/function1</span>
<span class="sd"> type - type of node: "widget", "settinggroup" or "setting"</span>
<span class="sd"> name - name of this node, e.g. "graph1"</span>
<span class="sd"> children - a generator to return all the child Nodes of this Node, e.g.</span>
<span class="sd"> for c in Root.children:</span>
<span class="sd"> print c.path</span>
<span class="sd"> children_widgets - generator to return child widget Nodes of this Node</span>
<span class="sd"> children_settinggroups - generator for child setting groups of this Node</span>
<span class="sd"> children_settings - a generator to get the child settings</span>
<span class="sd"> childnames - return a list of the names of the children of this Node</span>
<span class="sd"> childnames_widgets - return a list of the names of the child widgets</span>
<span class="sd"> childnames_settinggroups - return a list of the names of the setting groups</span>
<span class="sd"> childnames_settings - return a list of the names of the settings</span>
<span class="sd"> parent - return the Node corresponding to the parent widget of this Node</span>
<span class="sd"> __getattr__ - get a child Node with name given, e.g. Root.page1</span>
<span class="sd"> __getitem__ - get a child Node with name given, e.g. Root['page1']</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">fromPath</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
<span class="sd">"""Returns a new Node corresponding to the path given, e.g. '/page1/graph1'"""</span>
<span class="k">class</span> <span class="nc">SettingNode</span><span class="p">(</span><span class="n">Node</span><span class="p">):</span>
<span class="sd">"""A node which corresponds to a setting. Extra properties:</span>
<span class="sd"> val - get or set the setting value corresponding to this value, e.g.</span>
<span class="sd"> Root.page1.graph1.leftMargin.val = '2cm'</span>
<span class="sd"> """</span>
<span class="k">class</span> <span class="nc">SettingGroupNode</span><span class="p">(</span><span class="n">Node</span><span class="p">):</span>
<span class="sd">"""A node corresponding to a setting group. No extra properties."""</span>
<span class="k">class</span> <span class="nc">WidgetNode</span><span class="p">(</span><span class="n">Node</span><span class="p">):</span>
<span class="sd">"""A node corresponding to a widget.</span>
<span class="sd"> property:</span>
<span class="sd"> widgettype - get Veusz type of widget</span>
<span class="sd"> Methods are below."""</span>
<span class="k">def</span> <span class="nf">WalkWidgets</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">widgettype</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Generator to walk widget tree and get widgets below this</span>
<span class="sd"> WidgetNode of type given.</span>
<span class="sd"> widgettype is a Veusz widget type name or None to get all</span>
<span class="sd"> widgets."""</span>
<span class="k">def</span> <span class="nf">Add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">widgettype</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">args_opt</span><span class="p">):</span>
<span class="sd">"""Add a widget of the type given, returning the Node instance.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">Rename</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">newname</span><span class="p">):</span>
<span class="sd">"""Renames widget to name given.</span>
<span class="sd"> Existing Nodes corresponding to children are no longer valid."""</span>
<span class="k">def</span> <span class="nf">Action</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">action</span><span class="p">):</span>
<span class="sd">"""Applies action on widget."""</span>
<span class="k">def</span> <span class="nf">Remove</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Removes a widget and its children.</span>
<span class="sd"> Existing Nodes corresponding to children are no longer valid."""</span>
</pre></div>
</div>
<p>Note that Nodes are temporary objects which are created on
the fly. A real widget in Veusz can have several different
WidgetNode objects. The operators == and != can test whether
a Node points to the same widget, setting or setting group.</p>
<p>Here is an example to set all functions in the document to
be <code class="docutils literal notranslate"><span class="pre">x**2</span></code>:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="n">Root</span><span class="o">.</span><span class="n">WalkWidgets</span><span class="p">(</span><span class="n">widgettype</span><span class="o">=</span><span class="s1">'function'</span><span class="p">):</span>
<span class="n">n</span><span class="o">.</span><span class="n">function</span><span class="o">.</span><span class="n">val</span> <span class="o">=</span> <span class="s1">'x**2'</span>
</pre></div>
</div>
</section>
<section id="translating-old-to-new-style">
<h3>Translating old to new style<a class="headerlink" href="#translating-old-to-new-style" title="Permalink to this headline">¶</a></h3>
<p>Here is an example how you might translate the old to new
style interface (this is taken from the <code class="docutils literal notranslate"><span class="pre">sin.vsz</span></code>
example).</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># old (from saved document file)</span>
<span class="n">Add</span><span class="p">(</span><span class="s1">'page'</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s1">'page1'</span><span class="p">)</span>
<span class="n">To</span><span class="p">(</span><span class="s1">'page1'</span><span class="p">)</span>
<span class="n">Add</span><span class="p">(</span><span class="s1">'graph'</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s1">'graph1'</span><span class="p">,</span> <span class="n">autoadd</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">To</span><span class="p">(</span><span class="s1">'graph1'</span><span class="p">)</span>
<span class="n">Add</span><span class="p">(</span><span class="s1">'axis'</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s1">'x'</span><span class="p">)</span>
<span class="n">To</span><span class="p">(</span><span class="s1">'x'</span><span class="p">)</span>
<span class="n">Set</span><span class="p">(</span><span class="s1">'label'</span><span class="p">,</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">italic</span><span class="si">{x}</span><span class="s1">'</span><span class="p">)</span>
<span class="n">To</span><span class="p">(</span><span class="s1">'..'</span><span class="p">)</span>
<span class="n">Add</span><span class="p">(</span><span class="s1">'axis'</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s1">'y'</span><span class="p">)</span>
<span class="n">To</span><span class="p">(</span><span class="s1">'y'</span><span class="p">)</span>
<span class="n">Set</span><span class="p">(</span><span class="s1">'label'</span><span class="p">,</span> <span class="s1">'sin </span><span class="se">\\</span><span class="s1">italic</span><span class="si">{x}</span><span class="s1">'</span><span class="p">)</span>
<span class="n">Set</span><span class="p">(</span><span class="s1">'direction'</span><span class="p">,</span> <span class="s1">'vertical'</span><span class="p">)</span>
<span class="n">To</span><span class="p">(</span><span class="s1">'..'</span><span class="p">)</span>
<span class="n">Add</span><span class="p">(</span><span class="s1">'xy'</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s1">'xy1'</span><span class="p">)</span>
<span class="n">To</span><span class="p">(</span><span class="s1">'xy1'</span><span class="p">)</span>
<span class="n">Set</span><span class="p">(</span><span class="s1">'MarkerFill/color'</span><span class="p">,</span> <span class="s1">'cyan'</span><span class="p">)</span>
<span class="n">To</span><span class="p">(</span><span class="s1">'..'</span><span class="p">)</span>
<span class="n">Add</span><span class="p">(</span><span class="s1">'function'</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s1">'function1'</span><span class="p">)</span>
<span class="n">To</span><span class="p">(</span><span class="s1">'function1'</span><span class="p">)</span>
<span class="n">Set</span><span class="p">(</span><span class="s1">'function'</span><span class="p">,</span> <span class="s1">'sin(x)'</span><span class="p">)</span>
<span class="n">Set</span><span class="p">(</span><span class="s1">'Line/color'</span><span class="p">,</span> <span class="s1">'red'</span><span class="p">)</span>
<span class="n">To</span><span class="p">(</span><span class="s1">'..'</span><span class="p">)</span>
<span class="n">To</span><span class="p">(</span><span class="s1">'..'</span><span class="p">)</span>
<span class="n">To</span><span class="p">(</span><span class="s1">'..'</span><span class="p">)</span>
</pre></div>
</div>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># new (in python)</span>
<span class="kn">import</span> <span class="nn">veusz.embed</span>
<span class="n">embed</span> <span class="o">=</span> <span class="n">veusz</span><span class="o">.</span><span class="n">embed</span><span class="o">.</span><span class="n">Embedded</span><span class="p">(</span><span class="s1">'window title'</span><span class="p">)</span>
<span class="n">page</span> <span class="o">=</span> <span class="n">embed</span><span class="o">.</span><span class="n">Root</span><span class="o">.</span><span class="n">Add</span><span class="p">(</span><span class="s1">'page'</span><span class="p">)</span>
<span class="c1"># note: autoAdd=False stops graph automatically adding own axes (used in saved files)</span>
<span class="n">graph</span> <span class="o">=</span> <span class="n">page</span><span class="o">.</span><span class="n">Add</span><span class="p">(</span><span class="s1">'graph'</span><span class="p">,</span> <span class="n">autoadd</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">graph</span><span class="o">.</span><span class="n">Add</span><span class="p">(</span><span class="s1">'axis'</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s1">'x'</span><span class="p">)</span>
<span class="n">x</span><span class="o">.</span><span class="n">label</span><span class="o">.</span><span class="n">val</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">italic</span><span class="si">{x}</span><span class="s1">'</span>
<span class="n">y</span> <span class="o">=</span> <span class="n">graph</span><span class="o">.</span><span class="n">Add</span><span class="p">(</span><span class="s1">'axis'</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s1">'y'</span><span class="p">)</span>
<span class="n">y</span><span class="o">.</span><span class="n">label</span><span class="o">.</span><span class="n">val</span> <span class="o">=</span> <span class="s1">'sin </span><span class="se">\\</span><span class="s1">italic</span><span class="si">{x}</span><span class="s1">'</span>
<span class="n">y</span><span class="o">.</span><span class="n">direction</span><span class="o">.</span><span class="n">val</span> <span class="o">=</span> <span class="s1">'vertical'</span>
<span class="n">xy</span> <span class="o">=</span> <span class="n">graph</span><span class="o">.</span><span class="n">Add</span><span class="p">(</span><span class="s1">'xy'</span><span class="p">)</span>
<span class="n">xy</span><span class="o">.</span><span class="n">MarkerFill</span><span class="o">.</span><span class="n">color</span><span class="o">.</span><span class="n">val</span> <span class="o">=</span> <span class="s1">'cyan'</span>
<span class="n">func</span> <span class="o">=</span> <span class="n">graph</span><span class="o">.</span><span class="n">Add</span><span class="p">(</span><span class="s1">'function'</span><span class="p">)</span>
<span class="n">func</span><span class="o">.</span><span class="n">function</span><span class="o">.</span><span class="n">val</span> <span class="o">=</span> <span class="s1">'sin(x)'</span>
<span class="n">func</span><span class="o">.</span><span class="n">Line</span><span class="o">.</span><span class="n">color</span><span class="o">.</span><span class="n">val</span> <span class="o">=</span> <span class="s1">'red'</span>
</pre></div>
</div>
<section id="pyqt-programs">
<h4>PyQt programs<a class="headerlink" href="#pyqt-programs" title="Permalink to this headline">¶</a></h4>
<p>There is no direct PyQt interface. The standard embedding interface
should work, however.</p>
</section>
<section id="non-python-programs">
<h4>Non Python programs<a class="headerlink" href="#non-python-programs" title="Permalink to this headline">¶</a></h4>
<p>Support for non Python programs is available in a limited
form. External programs may execute Veusz using <strong class="command">veusz
--listen</strong>. Veusz will read its input from the standard input, and
write output to standard output. This is a full Python execution
environment, and supports all the scripting commands mentioned in
<a class="reference internal" href="#commands"><span class="std std-ref">Commands</span></a>, a <strong class="command">Quit()</strong> command, the
<strong class="command">EnableToolbar()</strong> and the <strong class="command">Zoom(factor)</strong> command
listed above. Only one window is supported at once, but many
<strong class="command">veusz --listen</strong> programs may be started.</p>
<p><strong class="command">veusz --listen</strong> may be used from the shell command line by
doing something like:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>veusz --listen < <span class="k">in</span>.vsz
</pre></div>
</div>
<p>where <strong class="command">in.vsz</strong> contains:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">To</span><span class="p">(</span><span class="n">Add</span><span class="p">(</span><span class="s1">'page'</span><span class="p">)</span> <span class="p">)</span>
<span class="n">To</span><span class="p">(</span><span class="n">Add</span><span class="p">(</span><span class="s1">'graph'</span><span class="p">)</span> <span class="p">)</span>
<span class="n">SetData</span><span class="p">(</span><span class="s1">'x'</span><span class="p">,</span> <span class="n">arange</span><span class="p">(</span><span class="mi">20</span><span class="p">))</span>
<span class="n">SetData</span><span class="p">(</span><span class="s1">'y'</span><span class="p">,</span> <span class="n">arange</span><span class="p">(</span><span class="mi">20</span><span class="p">)</span><span class="o">**</span><span class="mi">2</span><span class="p">)</span>
<span class="n">Add</span><span class="p">(</span><span class="s1">'xy'</span><span class="p">)</span>
<span class="n">Zoom</span><span class="p">(</span><span class="mf">0.5</span><span class="p">)</span>
<span class="n">Export</span><span class="p">(</span><span class="s2">"foo.pdf"</span><span class="p">)</span>
<span class="n">Quit</span><span class="p">()</span>
</pre></div>
</div>
<p>A program may interface with Veusz in this way by using the
<strong class="command">popen</strong> C Unix function, which allows a program to be started
having control of its standard input and output. Veusz can then be
controlled by writing commands to an input pipe.</p>
</section>
</section>
</section>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">Veusz</a></h1>
<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="datasets.html">Reading data</a></li>
<li class="toctree-l1"><a class="reference internal" href="datasets.html#manipulating-datasets">Manipulating datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="datasets.html#capturing-data">Capturing data</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Veusz command line and embedding interface (API)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#introduction">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="#commands-and-api">Commands and API</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#action">Action</a></li>
<li class="toctree-l3"><a class="reference internal" href="#add">Add</a></li>
<li class="toctree-l3"><a class="reference internal" href="#addcustom">AddCustom</a></li>
<li class="toctree-l3"><a class="reference internal" href="#addimportpath">AddImportPath</a></li>
<li class="toctree-l3"><a class="reference internal" href="#clonewidget">CloneWidget</a></li>
<li class="toctree-l3"><a class="reference internal" href="#close">Close</a></li>
<li class="toctree-l3"><a class="reference internal" href="#createhistogram">CreateHistogram</a></li>
<li class="toctree-l3"><a class="reference internal" href="#currentpath">CurrentPath</a></li>
<li class="toctree-l3"><a class="reference internal" href="#datasetplugin">DatasetPlugin</a></li>
<li class="toctree-l3"><a class="reference internal" href="#enabletoolbar">EnableToolbar</a></li>
<li class="toctree-l3"><a class="reference internal" href="#export">Export</a></li>
<li class="toctree-l3"><a class="reference internal" href="#filterdatasets">FilterDatasets</a></li>
<li class="toctree-l3"><a class="reference internal" href="#forceupdate">ForceUpdate</a></li>
<li class="toctree-l3"><a class="reference internal" href="#get">Get</a></li>
<li class="toctree-l3"><a class="reference internal" href="#getchildren">GetChildren</a></li>
<li class="toctree-l3"><a class="reference internal" href="#getclick">GetClick</a></li>
<li class="toctree-l3"><a class="reference internal" href="#getcolormap">GetColormap</a></li>
<li class="toctree-l3"><a class="reference internal" href="#getdata">GetData</a></li>
<li class="toctree-l3"><a class="reference internal" href="#getdatatype">GetDataType</a></li>
<li class="toctree-l3"><a class="reference internal" href="#getdatasets">GetDatasets</a></li>
<li class="toctree-l3"><a class="reference internal" href="#gpl">GPL</a></li>
<li class="toctree-l3"><a class="reference internal" href="#importfile">ImportFile</a></li>
<li class="toctree-l3"><a class="reference internal" href="#importfile2d">ImportFile2D</a></li>
<li class="toctree-l3"><a class="reference internal" href="#importfilecsv">ImportFileCSV</a></li>
<li class="toctree-l3"><a class="reference internal" href="#importfilefits">ImportFileFITS</a></li>
<li class="toctree-l3"><a class="reference internal" href="#importfilehdf5">ImportFileHDF5</a></li>
<li class="toctree-l3"><a class="reference internal" href="#importfilend">ImportFileND</a></li>
<li class="toctree-l3"><a class="reference internal" href="#importfileplugin">ImportFilePlugin</a></li>
<li class="toctree-l3"><a class="reference internal" href="#importfitsfile">ImportFITSFile</a></li>
<li class="toctree-l3"><a class="reference internal" href="#importstring">ImportString</a></li>
<li class="toctree-l3"><a class="reference internal" href="#importstring2d">ImportString2D</a></li>
<li class="toctree-l3"><a class="reference internal" href="#importstringnd">ImportStringND</a></li>
<li class="toctree-l3"><a class="reference internal" href="#isclosed">IsClosed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#list">List</a></li>
<li class="toctree-l3"><a class="reference internal" href="#load">Load</a></li>
<li class="toctree-l3"><a class="reference internal" href="#movetopage">MoveToPage</a></li>
<li class="toctree-l3"><a class="reference internal" href="#reloaddata">ReloadData</a></li>
<li class="toctree-l3"><a class="reference internal" href="#rename">Rename</a></li>
<li class="toctree-l3"><a class="reference internal" href="#remove">Remove</a></li>
<li class="toctree-l3"><a class="reference internal" href="#resizewindow">ResizeWindow</a></li>
<li class="toctree-l3"><a class="reference internal" href="#save">Save</a></li>
<li class="toctree-l3"><a class="reference internal" href="#set">Set</a></li>
<li class="toctree-l3"><a class="reference internal" href="#setantialiasing">SetAntiAliasing</a></li>
<li class="toctree-l3"><a class="reference internal" href="#setcompatlevel">SetCompatLevel</a></li>
<li class="toctree-l3"><a class="reference internal" href="#setdata">SetData</a></li>
<li class="toctree-l3"><a class="reference internal" href="#setdataexpression">SetDataExpression</a></li>
<li class="toctree-l3"><a class="reference internal" href="#setdatand">SetDataND</a></li>
<li class="toctree-l3"><a class="reference internal" href="#setdatarange">SetDataRange</a></li>
<li class="toctree-l3"><a class="reference internal" href="#setdata2d">SetData2D</a></li>
<li class="toctree-l3"><a class="reference internal" href="#setdata2dexpression">SetData2DExpression</a></li>
<li class="toctree-l3"><a class="reference internal" href="#setdata2dexpressionxyz">SetData2DExpressionXYZ</a></li>
<li class="toctree-l3"><a class="reference internal" href="#setdata2dxyfunc">SetData2DXYFunc</a></li>
<li class="toctree-l3"><a class="reference internal" href="#setdatadatetime">SetDataDateTime</a></li>
<li class="toctree-l3"><a class="reference internal" href="#setdatatext">SetDataText</a></li>
<li class="toctree-l3"><a class="reference internal" href="#settoreference">SetToReference</a></li>
<li class="toctree-l3"><a class="reference internal" href="#setupdateinterval">SetUpdateInterval</a></li>
<li class="toctree-l3"><a class="reference internal" href="#setverbose">SetVerbose</a></li>
<li class="toctree-l3"><a class="reference internal" href="#startsecondview">StartSecondView</a></li>
<li class="toctree-l3"><a class="reference internal" href="#tagdatasets">TagDatasets</a></li>
<li class="toctree-l3"><a class="reference internal" href="#to">To</a></li>
<li class="toctree-l3"><a class="reference internal" href="#quit">Quit</a></li>
<li class="toctree-l3"><a class="reference internal" href="#waitforclose">WaitForClose</a></li>
<li class="toctree-l3"><a class="reference internal" href="#zoom">Zoom</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#security">Security</a></li>
<li class="toctree-l2"><a class="reference internal" href="#using-veusz-from-other-programs">Using Veusz from other programs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#non-qt-python-programs">Non-Qt Python programs</a></li>
<li class="toctree-l3"><a class="reference internal" href="#older-path-based-interface">Older path-based interface</a></li>
<li class="toctree-l3"><a class="reference internal" href="#new-style-object-interface">New-style object interface</a></li>
<li class="toctree-l3"><a class="reference internal" href="#translating-old-to-new-style">Translating old to new style</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="datasets.html" title="previous chapter">Reading data</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2003-2021, Jeremy Sanders.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.2</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="_sources/api.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
|
