Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

plmtex(3plplot) [debian man page]

PLMTEX(3plplot) 						    PLplot API							   PLMTEX(3plplot)

NAME

       plmtex - Write text relative to viewport boundaries

SYNOPSIS

       plmtex(side, disp, pos, just, text)

DESCRIPTION

       Writes  text  at  a  specified  position  relative  to the viewport boundaries.	Text may be written inside or outside the viewport, but is
       clipped at the subpage boundaries.  The reference point of a string lies along a line passing through the string at half the  height  of  a
       capital	letter.   The position of the reference point along this line is determined by just, and the position of the reference point rela-
       tive to the viewport is set by disp and pos.

       Redacted form:  General: plmtex(side, disp, pos, just, text) Perl/PDL: plmtex(disp, pos, just, side, text)

       This function is used in examples 3,4,6-8,11,12,14,18,23,26.

ARGUMENTS

       side (const char *, input)
	      Specifies the side of the viewport along which the text is to be written. The string must be one of: b:  Bottom  of  viewport,  text
	      written parallel to edge.  bv: Bottom of viewport, text written at right angles to edge.	l: Left of viewport, text written parallel
	      to edge.	lv: Left of viewport, text written at right angles to edge.  r: Right of viewport, text written  parallel  to  edge.   rv:
	      Right  of  viewport, text written at right angles to edge.  t: Top of viewport, text written parallel to edge.  tv: Top of viewport,
	      text written at right angles to edge.

       disp (PLFLT, input)
	      Position of the reference point of string, measured outwards from the specified viewport edge in	units  of  the	current  character
	      height.  Use negative disp to write within the viewport.

       pos (PLFLT, input)
	      Position of the reference point of string along the specified edge, expressed as a fraction of the length of the edge.

       just (PLFLT, input)
	      Specifies  the  position	of  the  string  relative  to  its reference point.  If just=0., the reference point is at the left and if
	      just=1., it is at the right of the string.  Other values of just give intermediate justifications.

       text (const char *, input)
	      The string to be written out.

AUTHORS

       Geoffrey Furnish and Maurice LeBrun wrote and maintain PLplot.  This man page was automatically generated from the DocBook  source  of  the
       PLplot documentation, maintained by Alan W. Irwin and Rafael Laboissiere.

SEE ALSO

       PLplot documentation at http://plplot.sourceforge.net/resources.

								   August, 2012 						   PLMTEX(3plplot)

Check Out this Related Man Page

PLCALC_WORLD(3plplot)						    PLplot API						     PLCALC_WORLD(3plplot)

NAME

       plcalc_world - Calculate world coordinates and corresponding window index from relative device coordinates

SYNOPSIS

       plcalc_world(rx, ry, wx, wy, window)

DESCRIPTION

       Calculate world coordinates, wx and wy, and corresponding window index from relative device coordinates, rx and ry.

       Redacted form:  General: plcalc_world(rx, ry, wx, wy, window) Perl/PDL: Not available?

       This function is used in example 31.

ARGUMENTS

       rx (PLFLT, input)
	      Input relative device coordinate (ranging from 0. to 1.) for the x coordinate.

       ry (PLFLT, input)
	      Input relative device coordinate (ranging from 0. to 1.) for the y coordinate.

       wx (PLFLT *, output)
	      Pointer to the returned world coordinate for x corresponding to the relative device coordinates rx and ry.

       wy (PLFLT *, output)
	      Pointer to the returned world coordinate for y corresponding to the relative device coordinates rx and ry.

       window (PLINT *, output)
	      Pointer  to the returned last defined window index that corresponds to the input relative device coordinates (and the returned world
	      coordinates).  To give some background on the window index, for each page the initial window index is set to  zero,  and	each  time
	      plwind(3plplot)  is  called  within  the page, world and device coordinates are stored for the window and the window index is incre-
	      mented.  Thus, for a simple page layout with non-overlapping viewports and one window per viewport, window corresponds to the  view-
	      port  index (in the order which the viewport/windows were created) of the only viewport/window corresponding to rx and ry.  However,
	      for more complicated layouts with potentially overlapping viewports and possibly more than one window (set of world coordinates) per
	      viewport,  window  and  the corresponding output world coordinates corresponds to the last window created that fulfils the criterion
	      that the relative device coordinates are inside it.  Finally, in all cases where the  input  relative  device  coordinates  are  not
	      inside any viewport/window, then window is set to -1.

AUTHORS

       Geoffrey  Furnish  and  Maurice LeBrun wrote and maintain PLplot.  This man page was automatically generated from the DocBook source of the
       PLplot documentation, maintained by Alan W. Irwin and Rafael Laboissiere.

SEE ALSO

       PLplot documentation at http://plplot.sourceforge.net/resources.

								   August, 2012 					     PLCALC_WORLD(3plplot)
Man Page