1PGPLOTOptions(3)      User Contributed Perl Documentation     PGPLOTOptions(3)
2
3
4

NAME

6       PDL::Graphics::PGPLOTOptions - Setting PGPLOT options
7

SYNOPSIS

9       use PGPLOTOptions qw('default_options');
10

DESCRIPTION

12       This package contains one function (at present) which returns
13       PDL::Option objects for default settings for plot windows and plot
14       commands. This should be complemented by functions that could affect
15       this such as file reading commands etc.
16

OPTIONS

18       The following is a listing of options that are set in this file and
19       what they do and what their default value is
20
21   Window specific options
22       These options modify the appearance of windows and can also modify the
23       default settings for creation of plot axes etc.
24
25       Device
26           The default PGPLOT device to use. The default value is set to the
27           PGPLOT_DEV environment variable if set, otherwise to '?'.
28
29       AxisColour
30           The colour with which to draw axes. Default value=3 (Green)
31
32       HardLW, HardCH, HardFont, HardAxisColour, HardColour
33           The linewidth, character height, font and axis colour to use on
34           hardcopy devices. The default values are HardLW=1, HardCH=1.4,
35           HardFont=2 (Roman), HardAxisColour=1 (Black) and HardColour=1 as
36           well. The latter is the default plot colour to use on hardcopy
37           devices.
38
39       Axis
40           The axis style to use. See the PDL::Graphics::PGPLOT::Window
41           documentation for details. It defaults to 'Normal' which is a
42           labelled box. Valid arguments are 'Empty', 'Box', 'Normal', 'Axes',
43           'Grid', 'LogX', 'LogY', 'LogXY'.
44
45       AspectRatio
46           The aspect ratio of the output device. The default value is device
47           dependent.
48
49       WindowWidth
50           The width of the output window in inches and defaults to as big as
51           possible.
52
53       WindowXSize and WindowYSize
54           These are alternatives to AspectRatio and WindowWidth.
55
56       WindowName
57           The name of the window - can later be retrieved using name(). It
58           defaults to 'Window'+Window ID.
59
60       NXPanel
61           The number of panels in the X-direction - defaults to 1
62
63       NYPanel
64           The number of panels in the Y-direction - defaults to 1
65
66       Justify
67           A boolean value which, if true, causes both axes to drawn to the
68           same scale; see the PGPLOT "pgenv()" command for more information.
69
70       TightLabels
71           Boolean value which, if true, causes axis labels to be pulled
72           slightly closer to the main viewport than usual.  That's handy for
73           making multi-panel plots.  Undef (the default) is equivalent to 0
74           for panels with NYPanels <= 1 and 1 for panels with NYPanels > 1.
75
76       TitleSize
77           The relative size of a plot or image title, compared to other
78           annotations.  Defaults to 1.0 (original behavior) but can be set
79           to, e.g., 1.5 to emphasize graph titles in a multipanel plot.
80
81       Border
82           Adjust the spacing around the plot. See the documentation in
83           PDL::Graphics::PGPLOT::Window for details.
84
85       CharSize
86           The default charsize for the plot - used when annotating the axes
87           for instance. It defaults to 1.
88
89       PlotPosition
90           The position of the plot in normalised coordinates.
91
92       Erase
93           Explicitly erase the plotting surface, normally required when
94           making new plots with PlotPosition.
95
96   Plot specific options
97       For the moment see the "PDL::Graphics::PGPLOT::Window" documentation
98       for these.
99
100   set_pgplot_options
101       This function allows the user to set the default PGPLOT options. It is
102       particularly useful in the ".perldlrc" file since one can do
103
104         use PDL::Graphics::PGPLOTOptions ('set_pgplot_options');
105         set_pgplot_options('Device' => '/xs', 'HardLW' => 3);
106
107       for instance to set the default values. The main drawback is that the
108       routine is rather unflexible with no synonyms or case-insensitivity.
109
110
111
112perl v5.30.0                      2019-09-05                  PGPLOTOptions(3)
Impressum