octave-nkf: doc/interpreter/plot.txi comparison

comparison doc/interpreter/plot.txi @ 11878:2415586d0f5a release-3-0-x

doc fixes

author	John W. Eaton <jwe@octave.org>
date	Sun, 12 Oct 2008 19:38:43 +0200
parents	233de4b9b259
children	3342d1a7c4c9

comparison

equal deleted inserted replaced

-:d11919389e09
+:2415586d0f5a
 appearance and may also contain links to other graphics objects.
 Graphics objects are only referenced by a numeric index, or @dfn{handle}.
 @table @asis
 @item root figure
+@cindex root figure graphics object
+@cindex graphics object, root figure
 The parent of all figure objects.  The index for the root figure is
 defined to be 0.
 @item figure
+@cindex figure graphics object
+@cindex graphics object, figure
 A figure window.
 @item axes
+@cindex axes graphics object
+@cindex graphics object, axes
 An set of axes.  This object is a child of a figure object and may be a
 parent of line, text, image, patch, or surface objects.
 @item line
+@cindex line graphics object
+@cindex graphics object, line
 A line in two or three dimensions.
 @item text
+@cindex text graphics object
+@cindex graphics object, text
 Text annotations.
 @item image
+@cindex image graphics object
+@cindex graphics object, image
 A bitmap image.
 @item patch
+@cindex patch graphics object
+@cindex graphics object, patch
 A filled polygon, currently limited to two dimensions.
 @item surface
+@cindex surface graphics object
+@cindex graphics object, surface
 A three-dimensional surface.
 @end table
 To determine whether an object is a graphics object index or a figure
 index, use the functions @code{ishandle} and @code{isfigure}.
 @c Either @code{"on"} or @code{"off"} to toggle display of figures.
 @end table
 @node Figure Properties
 @subsubsection Figure Properties
+@cindex figure properties
 @table @code
 @item nextplot
 May be one of
 @table @code
 @code{"portrait"}.
 @end table
 @node Axes Properties
 @subsubsection Axes Properties
+@cindex axes properties
 @table @code
 @item position
-A four-element vector specifying the coordinates of the lower left
+A vector specifying the position of the plot, excluding titles, axes and
-corner and width and height of the plot, in normalized units.  For
+legend.  The four elements of the vector are the coordinates of the
-example, @code{[0.2, 0.3, 0.4, 0.5]} sets the lower left corner of the
+lower left corner and width and height of the plot, in units normalized
-axes at @math{(0.2, 0.3)} and the width and height to be 0.4 and 0.5
+to the width and height of the plot window.  For example, @code{[0.2,
-respectively.
+0.3, 0.4, 0.5]} sets the lower left corner of the axes at @math{(0.2,
+0.3)} and the width and height to be 0.4 and 0.5 respectively.  See also
+the @code{outerposition} property.
 @item title
 Index of text object for the axes title.
 @item box
 @item "replace"
 @item "replacechildren"
 @end table
 @item outerposition
-A four-element vector specifying the coordinates of the lower left
+A vector specifying the position of the plot, including titles, axes and
-corner and width and height of the plot, in normalized units including
+legend.  The four elements of the vector are the coordinates of the
-the tics, labels etc.  For example, @code{[0.2, 0.3, 0.4, 0.5]} sets the
+lower left corner and width and height of the plot, in units normalized
-lower left corner of the axes at @math{(0.2, 0.3)} and the width and
+to the width and height of the plot window.  For example, @code{[0.2,
-height to be 0.4 and 0.5 respectively.
+0.3, 0.4, 0.5]} sets the lower left corner of the axes at @math{(0.2,
+0.3)} and the width and height to be 0.4 and 0.5 respectively.  See also
+the @code{position} property.
 @end table
 @node Line Properties
 @subsubsection Line Properties
+@cindex line properties
 @table @code
 @itemx xdata
 @itemx ydata
 @itemx zdata
 future version of Octave.
 @end table
 @node Text Properties
 @subsubsection Text Properties
+@cindex text properties
 @table @code
 @item string
 The character string contained by the text object.
 @end float
 @end ifnotinfo
 @node Image Properties
 @subsubsection Image Properties
+@cindex image properties
 @table @code
 @item cdata
 The data for the image.  Each pixel of the image corresponds to an
 element of @code{cdata}.  The value of an element of @code{cdata}
 the image.
 @end table
 @node Patch Properties
 @subsubsection Patch Properties
+@cindex patch properties
 @table @code
 @item cdata
 @itemx xdata
 @itemx ydata
 @xref{Marker Styles}.
 @end table
 @node Surface Properties
 @subsubsection Surface Properties
+@cindex surface properties
 @table @code
 @item xdata
 @itemx ydata
 @itemx zdata
 future version of Octave.
 @end table
 @node Managing Default Properties
 @subsection Managing Default Properties
+@cindex default graphics properties
+@cindex graphics properties, default
 Object properties have two classes of default values, @dfn{factory
 defaults} (the initial values) and @dfn{user-defined defaults}, which
 may override the factory defaults.
 @noindent
 returns a list of factory defaults.
 @node Colors
 @subsection Colors
+@cindex graphics colors
+@cindex colors, graphics
 Colors may be specified as RGB triplets with values ranging from zero to
 one, or by name.  Recognized color names include @code{"blue"},
 @code{"black"}, @code{"cyan"}, @code{"green"}, @code{"magenta"},
 @code{"red"}, @code{"white"}, and @code{"yellow"}.
 @node Line Styles
 @subsection Line Styles
+@cindex line styles, graphics
+@cindex graphics line styles
 Line styles are specified by the following properties:
 @table @code
 @item linestyle
 May be one of
 of 2 is twice as wide as the default, etc.
 @end table
 @node Marker Styles
 @subsection Marker Styles
+@cindex graphics marker styles
+@cindex marker styles, graphics
 Marker styles are specified by the following properties:
 @table @code
 @item marker
 A character indicating a plot marker to be place at each data point, or
 @code{"none"}, meaning no markers should be displayed.

Mercurial > octave-nkf

comparison doc/interpreter/plot.txi @ 11878:2415586d0f5a release-3-0-x