/ 
PDL-2.2
River stage three • 100 direct dependents • 108 total dependents
/ PDL::Graphics::PGPLOTOptions

NAME

PDL::Graphics::PGPLOTOptions - Setting PGPLOT options

SYNOPSIS

use PGPLOTOptions qw('default_options');

DESCRIPTION

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

OPTIONS

The following is a listing of options that are set in this file and what they do and what their default value is

Window specfic options

These options modify the appearance of windows and can also modify the default settings for creation of plot axes etc.

Device

The default PGPLOT device to use. The default value is set to the PGPLOT_DEV environment variable if set, otherwise to '?'.

AxisColour

The colour with which to draw axes

HardLW, HardCH, HardFont, HardAxisColour

The linewidth, character height, font and axis colour to use on hardcopy devices.

Axis

The axis style to use. See the PDL::Graphics::PGPLOT::Window documentation for details. It defaults to 'Normal' which is a labelled box. Valid arguments are 'Empty', 'Box', 'Normal', 'Axes', 'Grid', 'LogX', 'LogY', 'LogXY'.

AspectRatio

The aspect ratio of the output device it defaults to 0.618.

WindowWidth

The width of the output window in inches and defaults to as big as possible.

WindowXSize and WindowYSize

These are alternatives to AspectRatio and WindowWidth.

WindowName

The name of the window - can later be retrieved using name(). It defaults to 'Window'+Window ID.

NXPanel

The number of panels in the X-direction - defaults to 1

NYPanel

The number of panels in the Y-direction - defaults to 1

Justify

A boolean value which, if true, causes both axes to drawn to the same scale; see the PGPLOT pgenv() command for more information.

Border

Adjust the spacing around the plot. See the documentation in PDL::Graphics::PGPLOT::Window for details.

CharSize

The default charsize for the plot - used when annotating the axes for instance.

PlotPosition

The position of the plot in normalised coordinates.

NoErase

Allows plotting multiple panels on one plot, normally used with 'PlotPosition'.

Plot specific options

For the moment see the PDL::Graphics::PGPLOT::Window documentation for these.