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