Mercurial > hg > octave-lojdl
changeset 12526:f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sat, 19 Mar 2011 12:12:57 -0700 |
parents | d36266a54202 |
children | 30ee8f0cc7c2 |
files | doc/ChangeLog doc/interpreter/octave.texi doc/interpreter/plot.txi scripts/ChangeLog scripts/plot/daspect.m scripts/plot/pbaspect.m |
diffstat | 6 files changed, 48 insertions(+), 11 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,4 +1,9 @@ -2010-03-18 Rik <octave@nomad.inbox5.com> +2010-03-19 Rik <octave@nomad.inbox5.com> + + * interpreter/octave.texi, interpreter/plot.txi: Add daspect, pbaspect + functions to documentation. + +2010-03-19 Rik <octave@nomad.inbox5.com> * interpreter/octave.texi, interpreter/plot.txi: Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
--- a/doc/interpreter/octave.texi +++ b/doc/interpreter/octave.texi @@ -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::
--- a/doc/interpreter/plot.txi +++ b/doc/interpreter/plot.txi @@ -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
--- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,8 @@ +2010-03-19 Rik <octave@nomad.inbox5.com> + + * plot/daspect.m, plot/pbaspect.m: Use newline between @deftypefnx + macros to get correct appearance. + 2011-03-19 Ben Abbott <bpabbott@mac.com> * geometry/trisurf.m: Set default edgecolor as Matlab does. Add demos.
--- a/scripts/plot/daspect.m +++ b/scripts/plot/daspect.m @@ -17,16 +17,20 @@ ## <http://www.gnu.org/licenses/>. ## -*- 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. ##
--- a/scripts/plot/pbaspect.m +++ b/scripts/plot/pbaspect.m @@ -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. ##