Mercurial > hg > octave-lyh
changeset 17169:52931d71400f
doc: Document that first argument can be an axes handle for several plot functions.
* scripts/plot/feather.m, scripts/plot/hggroup.m, scripts/plot/loglogerr.m,
scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/semilogxerr.m,
scripts/plot/semilogyerr.m: Document that first argument can be an axes handle
for several plot functions.
author | Rik <rik@octave.org> |
---|---|
date | Fri, 02 Aug 2013 17:37:34 -0700 |
parents | 6e8c621c3496 |
children | 1e2641277b2a |
files | scripts/plot/feather.m scripts/plot/hggroup.m scripts/plot/loglogerr.m scripts/plot/quiver.m scripts/plot/quiver3.m scripts/plot/semilogxerr.m scripts/plot/semilogyerr.m |
diffstat | 7 files changed, 23 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/plot/feather.m +++ b/scripts/plot/feather.m @@ -20,7 +20,7 @@ ## @deftypefn {Function File} {} feather (@var{u}, @var{v}) ## @deftypefnx {Function File} {} feather (@var{z}) ## @deftypefnx {Function File} {} feather (@dots{}, @var{style}) -## @deftypefnx {Function File} {} feather (@var{h}, @dots{}) +## @deftypefnx {Function File} {} feather (@var{hax}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} feather (@dots{}) ## ## Plot the @code{(@var{u}, @var{v})} components of a vector field emanating @@ -32,6 +32,9 @@ ## The style to use for the plot can be defined with a line style @var{style} ## of the same format as the @code{plot} command. ## +## If the first argument @var{hax} is an axes handle, then plot into this axis, +## rather than the current axes returned by @code{gca}. +## ## The optional return value @var{h} is a vector of graphics handles to the ## line objects representing the drawn vectors. ##
--- a/scripts/plot/hggroup.m +++ b/scripts/plot/hggroup.m @@ -25,7 +25,7 @@ ## ## If no parent is specified, the group is created in the current axes. ## -## Multiple property-value pairs may be specified for the hggroup, but they +## Multiple property/value pairs may be specified for the hggroup, but they ## must appear in pairs. ## ## The optional return value @var{h} is a graphics handle to the created
--- a/scripts/plot/loglogerr.m +++ b/scripts/plot/loglogerr.m @@ -34,6 +34,9 @@ ## with errors in the @var{y}-scale defined by @var{ey} and the plot ## format defined by @var{fmt}. @xref{XREFerrorbar,,errorbar}, for available ## formats and additional information. +## +## If the first argument @var{hax} is an axes handle, then plot into this axis, +## rather than the current axes returned by @code{gca}. ## @seealso{errorbar, semilogxerr, semilogyerr} ## @end deftypefn
--- a/scripts/plot/quiver.m +++ b/scripts/plot/quiver.m @@ -22,7 +22,7 @@ ## @deftypefnx {Function File} {} quiver (@dots{}, @var{s}) ## @deftypefnx {Function File} {} quiver (@dots{}, @var{style}) ## @deftypefnx {Function File} {} quiver (@dots{}, "filled") -## @deftypefnx {Function File} {} quiver (@var{h}, @dots{}) +## @deftypefnx {Function File} {} quiver (@var{hax}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} quiver (@dots{}) ## ## Plot the (@var{u}, @var{v}) components of a vector field in @@ -43,6 +43,9 @@ ## drawn rather than arrows. If the argument "filled" is given then the ## markers are filled. ## +## If the first argument @var{hax} is an axes handle, then plot into this axis, +## rather than the current axes returned by @code{gca}. +## ## The optional return value @var{h} is a graphics handle to a quiver object. ## A quiver object regroups the components of the quiver plot (body, arrow, ## and marker), and allows them to be changed together.
--- a/scripts/plot/quiver3.m +++ b/scripts/plot/quiver3.m @@ -43,6 +43,9 @@ ## drawn rather than arrows. If the argument "filled" is given then the ## markers are filled. ## +## If the first argument @var{hax} is an axes handle, then plot into this axis, +## rather than the current axes returned by @code{gca}. +## ## The optional return value @var{h} is a graphics handle to a quiver object. ## A quiver object regroups the components of the quiver plot (body, arrow, ## and marker), and allows them to be changed together.
--- a/scripts/plot/semilogxerr.m +++ b/scripts/plot/semilogxerr.m @@ -35,6 +35,10 @@ ## with errors in the @var{y}-scale defined by @var{ey} and the plot ## format defined by @var{fmt}. @xref{XREFerrorbar,,errorbar}, for available ## formats and additional information. +## +## If the first argument @var{hax} is an axes handle, then plot into this axis, +## rather than the current axes returned by @code{gca}. +## ## @seealso{errorbar, semilogyerr, loglogerr} ## @end deftypefn
--- a/scripts/plot/semilogyerr.m +++ b/scripts/plot/semilogyerr.m @@ -35,6 +35,10 @@ ## with errors in the @var{y}-scale defined by @var{ey} and the plot ## format defined by @var{fmt}. @xref{XREFerrorbar,,errorbar}, for available ## formats and additional information. +## +## If the first argument @var{hax} is an axes handle, then plot into this axis, +## rather than the current axes returned by @code{gca}. +## ## @seealso{errorbar, semilogxerr, loglogerr} ## @end deftypefn