The PLplot Plotting Library: Programmer's Reference Manual
PrevNext

Chapter 15. The Common API for PLplot

Table of Contents
pl_setcontlabelparam: Set parameters of contour labelling other than format of numerical label
pl_setcontlabelformat: Set format of numerical label for contours
pladv: Advance the (sub-)page
plaxes: Draw a box with axes, etc. with arbitrary origin
plbin: Plot a histogram from binned data
plbop: Begin a new page
plbox: Draw a box with axes, etc
plbox3: Draw a box with axes, etc, in 3-d
plclear: Clear current (sub)page
plclr: Eject current page
plcol: Set color
plcol0: Set color, map0
plcol1: Set color, map1
plcont: Contour plot
plcpstrm: Copy state parameters from the reference stream to the current stream
plend: End plotting session
plend1: End plotting session for 1 stream
plenv: Set up standard window and draw box
pleop: Eject current page
plerrx: Draw x error bar
plerry: Draw y error bar
plfamadv: Advance to the next family file on the next new page
plfill: Area fill
plfill3: Area fill in 3D
plflush: Flushes the output stream
plfont: Set character font
plfontld: Load character font
plgchr: Get character default height and current (scaled) height
plgcol0: Returns 8-bit RGB values for given color from color map0
plgcolbg: Returns the background color (cmap0[0]) by 8-bit RGB value
plgcompression: Get the current device-compression setting
plgdev: Get the current device (keyword) name
plgdidev: Get parameters that define current device-space window
plgdiori: Get plot orientation
plgdiplt: Get parameters that define current plot-space window
plgfam: Get family file parameters
plgfnam: Get output file name
plglevel: Get the (current) run level
plgpage: Get page parameters
plgra: Switch to graphics screen
plgspa: Get current subpage parameters
plgstrm: Get current stream number
plgver: Get the current library version number
plgxax: Get x axis parameters
plgyax: Get y axis parameters
plgzax: Get z axis parameters
plhist: Plot a histogram from unbinned data
plhls: Set current color by HLS
plinit: Initialize PLplot
pljoin: Draw a line between two points
pllab: Simple routine to write labels
pllightsource: Sets the 3D position of the light source
plline: Draw a line
plline3: Draw a line in 3 space
pllsty: Select line style
plmesh: Plot surface mesh
plmkstrm: Creates a new stream and makes it the default
plmtex: Write text relative to viewport boundaries
plot3d: Plot 3-d surface plot
plotsh3d: Plot shaded 3-d surface plot
plpage: Begin a new page
plpat: Set area fill pattern
plpoin: Plots a character at the specified points
plpoin3: Plots a character at the specified points in 3 space
plpoly3: Draw a polygon in 3 space
plprec: Set precision in numeric labels
plpsty: Select area fill pattern
plptex: Write text inside the viewport
plreplot: Replays contents of plot buffer to current device/file
plrgb: Set line color by red, green
plrgb1: Set line color by 8-bit RGB values
plschr: Set character size
plscmap0: Set color map0 colors by 8-bit RGB values
plscmap0n: Set number of colors in color map0
plscmap1: Set color map1 colors using 8-bit RGB values
plscmap1l: Set color map1 colors using a piece-wise linear relationship
plscmap1n: Set number of colors in color map1
plscol0: Set a given color from color map0 by 8 bit RGB value
plscolbg: Set the background color (cmap0[0]) by 8-bit RGB value
plscolor: Used to globally turn color output on/off
plscompression: Set device-compression level
plsdev: Set the device (keyword) name
plsdidev: Set parameters that define current device-space window
plsdimap: Set up transformation from metafile coordinates
plsdiori: Set plot orientation
plsdiplt: Set parameters that define current plot-space window
plsdiplz: Set parameters incrementally (zoom mode) that define current plot-space window
plsesc: Set the escape character for text strings
plsfam: Set family file parameters
plsfnam: Set output file name
plshades: Shade regions on the basis of value
plshade: Shade individual region on the basis of value
plshade1: Shade individual region on the basis of value
plsmaj: Set length of major ticks
plsmin: Set length of minor ticks
plsori: Set orientation
plspage: Set page parameters
plspause: Set the pause (on end-of-page) status
plsstrm: Set current output stream
plssub: Set the number of subwindows in x and y
plssym: Set symbol size
plstar: Initialization
plstart: Initialization
plstripa: Add a point to a stripchart
plstripc: Create a 4-pen stripchart
plstripd: Deletes and releases memory used by a stripchart
plstyl: Set line style
plsvpa: Specify viewport in absolute coordinates
plsxax: Set x axis parameters
plsyax: Set y axis parameters
plsym: Plots a symbol at the specified points
plszax: Set z axis parameters
pltext: Switch to text screen
plvasp: Specify viewport using aspect ratio only
plvpas: Specify viewport using coordinates and aspect ratio
plvpor: Specify viewport using coordinates
plvsta: Select standard viewport
plw3d: Set up window for 3-d plotting
plwid: Set pen width
plwind: Specify world coordinates of viewport boundaries
plxormod: Enter or leave xor mode

The purpose of this chapter is to document the API for every C function in PLplot that should have a counterpart in other PLplot language bindings such as Fortran. These common API routines have a special "c_" prefix name assigned to them in plplot.h. This common API between the various languages constitutes the most important part of the PLplot API that programmers need to know. Additional PLplot API specialized for each language binding is documented in Chapter 16 and subsequent chapters.

All common API functions of the current CVS HEAD are listed here with their arguments. All functions have at least a short description, but there are still a fair number of undocumented parameters as indicated by the string "NEEDS DOCUMENTATION".

pl_setcontlabelparam: Set parameters of contour labelling other than format of numerical label

pl_setcontlabelparam (offset, size, spacing, active);

Set parameters of contour labelling other than those handled by pl_setcontlabelformat.

offset (PLFLT, input)

Offset of label from contour line (if set to 0.0, labels are printed on the lines). Default value is 0.006.

size (PLFLT, input)

Font height for contour labels (normalized). Default value is 0.3.

spacing (PLFLT, input)

Spacing parameter for contour labels. Default value is 0.1.

active (PLINT, input)

Activate labels. Set to 1 if you want contour labels on. Default is off (0).

PrevHomeNext
BibliographyUppl_setcontlabelformat: Set format of numerical label for contours