# HG changeset patch # User Rik # Date 1300561977 25200 # Node ID f8ea3eabcb85fc015c56ea52c43217465cf723b9 # Parent d36266a542024fb0f761088929563ce7f057fa18 Add daspect, pbaspect functions to documentation. diff -r d36266a54202 -r f8ea3eabcb85 doc/ChangeLog --- a/doc/ChangeLog Sat Mar 19 11:10:16 2011 -0700 +++ b/doc/ChangeLog Sat Mar 19 12:12:57 2011 -0700 @@ -1,4 +1,9 @@ -2010-03-18 Rik +2010-03-19 Rik + + * interpreter/octave.texi, interpreter/plot.txi: Add daspect, pbaspect + functions to documentation. + +2010-03-19 Rik * interpreter/octave.texi, interpreter/plot.txi: Add getappdata, setappdata, isappdata, rmappdata functions to documentation. diff -r d36266a54202 -r f8ea3eabcb85 doc/interpreter/octave.texi --- a/doc/interpreter/octave.texi Sat Mar 19 11:10:16 2011 -0700 +++ b/doc/interpreter/octave.texi Sat Mar 19 12:12:57 2011 -0700 @@ -510,7 +510,7 @@ High-Level Plotting * Two-Dimensional Plots:: -* Three-Dimensional Plotting:: +* Three-Dimensional Plots:: * Plot Annotations:: * Multiple Plots on One Page:: * Multiple Plot Windows:: @@ -520,10 +520,12 @@ Two-Dimensional Plots +* Axis Configuration:: * Two-dimensional Function Plotting:: -Three-Dimensional Plotting +Three-Dimensional Plots +* Aspect Ratio:: * Three-dimensional Function Plotting:: * Three-dimensional Geometric Shapes:: diff -r d36266a54202 -r f8ea3eabcb85 doc/interpreter/plot.txi --- a/doc/interpreter/plot.txi Sat Mar 19 11:10:16 2011 -0700 +++ b/doc/interpreter/plot.txi Sat Mar 19 12:12:57 2011 -0700 @@ -54,7 +54,7 @@ @menu * Two-Dimensional Plots:: -* Three-Dimensional Plotting:: +* Three-Dimensional Plots:: * Plot Annotations:: * Multiple Plots on One Page:: * Multiple Plot Windows:: @@ -66,6 +66,11 @@ @node Two-Dimensional Plots @subsection Two-Dimensional Plots +@menu +* Axis Configuration:: +* Two-dimensional Function Plotting:: +@end menu + The @code{plot} function allows you to create simple x-y plots with linear axes. For example, @@ -219,6 +224,9 @@ @DOCSTRING(comet3) +@node Axis Configuration +@subsubsection Axis Configuration + The axis function may be used to change the axis limits of an existing plot and various other axis properties, such as the aspect ratio and the appearance of tic marks. @@ -237,10 +245,6 @@ @anchor{doc-zlim} @DOCSTRING(xlim) -@menu -* Two-dimensional Function Plotting:: -@end menu - @node Two-dimensional Function Plotting @subsubsection Two-dimensional Function Plotting @@ -275,8 +279,8 @@ @DOCSTRING(ezpolar) -@node Three-Dimensional Plotting -@subsection Three-Dimensional Plotting +@node Three-Dimensional Plots +@subsection Three-Dimensional Plots The function @code{mesh} produces mesh surface plots. For example, @@ -364,10 +368,23 @@ @DOCSTRING(scatter3) @menu +* Aspect Ratio:: * Three-dimensional Function Plotting:: * Three-dimensional Geometric Shapes:: @end menu +@node Aspect Ratio +@subsubsection Aspect Ratio + +For three-dimensional plots the aspect ratio can be set for data with +@code{daspect} and for the plot box with @code{pbaspect}. +See @ref{Axis Configuration} for controlling the x-, y-, and z-limits for +plotting. + +@DOCSTRING(daspect) + +@DOCSTRING(pbaspect) + @node Three-dimensional Function Plotting @subsubsection Three-dimensional Function Plotting diff -r d36266a54202 -r f8ea3eabcb85 scripts/ChangeLog --- a/scripts/ChangeLog Sat Mar 19 11:10:16 2011 -0700 +++ b/scripts/ChangeLog Sat Mar 19 12:12:57 2011 -0700 @@ -1,3 +1,8 @@ +2010-03-19 Rik + + * plot/daspect.m, plot/pbaspect.m: Use newline between @deftypefnx + macros to get correct appearance. + 2011-03-19 Ben Abbott * geometry/trisurf.m: Set default edgecolor as Matlab does. Add demos. diff -r d36266a54202 -r f8ea3eabcb85 scripts/plot/daspect.m --- a/scripts/plot/daspect.m Sat Mar 19 11:10:16 2011 -0700 +++ b/scripts/plot/daspect.m Sat Mar 19 12:12:57 2011 -0700 @@ -17,16 +17,20 @@ ## . ## -*- texinfo -*- -## @deftypefn {Function File} {} daspect (@var{data_aspect_ratio}) +## @deftypefn {Function File} {} daspect (@var{data_aspect_ratio}) ## Set the data aspect ratio of the current axes. The aspect ratio is ## a normalized 3-element vector representing the span of the x, y, and ## z-axes limits. +## ## @deftypefnx {Function File} {@var{data_aspect_ratio} =} daspect ( ) ## Return the data aspect ratio of the current axes. +## ## @deftypefnx {Function File} {} daspect (@var{mode}) ## Set the data aspect ratio mode of the current axes. +## ## @deftypefnx {Function File} {@var{data_aspect_ratio_mode} =} daspect ("mode") ## Return the data aspect ratio mode of the current axes. +## ## @deftypefnx {Function File} {} daspect (@var{hax}, @dots{}) ## Uses the axes, with handle @var{hax}, instead of the current axes. ## diff -r d36266a54202 -r f8ea3eabcb85 scripts/plot/pbaspect.m --- a/scripts/plot/pbaspect.m Sat Mar 19 11:10:16 2011 -0700 +++ b/scripts/plot/pbaspect.m Sat Mar 19 12:12:57 2011 -0700 @@ -21,12 +21,16 @@ ## Set the plot box aspect ratio of the current axes. The aspect ratio ## is a normalized 3-element vector representing the rendered lengths of ## the x, y, and z-axes. +## ## @deftypefnx {Function File} {@var{plot_box_aspect_ratio} =} pbaspect ( ) ## Return the plot box aspect ratio of the current axes. +## ## @deftypefnx {Function File} {} pbaspect (@var{mode}) ## Set the plot box aspect ratio mode of the current axes. +## ## @deftypefnx {Function File} {@var{plot_box_aspect_ratio_mode} =} pbaspect ("mode") ## Return the plot box aspect ratio mode of the current axes. +## ## @deftypefnx {Function File} {} pbaspect (@var{hax}, @dots{}) ## Uses the axes, with handle @var{hax}, instead of the current axes. ##