Mercurial > hg > octave-nkf
comparison scripts/plot/axis.m @ 17122:eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
* doc/interpreter/plot.txi: Add @findex entries that were in xlim.m
* scripts/miscellaneous/getappdata.m scripts/miscellaneous/setappdata.m,
scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m,
scripts/plot/axes.m, scripts/plot/axis.m, scripts/plot/bar.m,
scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m,
scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m,
scripts/plot/close.m, scripts/plot/closereq.m, scripts/plot/colorbar.m,
scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m,
scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourc.m,
scripts/plot/contourf.m, scripts/plot/copyobj.m, scripts/plot/cylinder.m,
scripts/plot/daspect.m, scripts/plot/diffuse.m, scripts/plot/ellipsoid.m,
scripts/plot/errorbar.m, scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m,
scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezplot.m,
scripts/plot/ezplot3.m, scripts/plot/ezpolar.m, scripts/plot/ezsurf.m,
scripts/plot/ezsurfc.m, scripts/plot/feather.m, scripts/plot/figure.m,
scripts/plot/fill.m, scripts/plot/findall.m, scripts/plot/findobj.m,
scripts/plot/fplot.m, scripts/plot/gca.m, scripts/plot/gcbf.m,
scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m,
scripts/plot/ginput.m, scripts/plot/graphics_toolkit.m, scripts/plot/grid.m,
scripts/plot/gtext.m, scripts/plot/guidata.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hggroup.m, scripts/plot/hidden.m,
scripts/plot/hist.m, scripts/plot/hold.m, scripts/plot/ishghandle.m,
scripts/plot/ishold.m, scripts/plot/isocolors.m, scripts/plot/isprop.m,
scripts/plot/legend.m, scripts/plot/line.m, scripts/plot/linkprop.m,
scripts/plot/loglog.m, scripts/plot/loglogerr.m, scripts/plot/mesh.m,
scripts/plot/meshc.m, scripts/plot/meshgrid.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pcolor.m, scripts/plot/peaks.m,
scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plot.m,
scripts/plot/plot3.m, scripts/plot/plotmatrix.m, scripts/plot/plotyy.m,
scripts/plot/polar.m, scripts/plot/print.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/rectangle.m, scripts/plot/refresh.m,
scripts/plot/refreshdata.m, scripts/plot/ribbon.m, scripts/plot/rose.m,
scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m,
scripts/plot/semilogx.m, scripts/plot/semilogxerr.m, scripts/plot/semilogy.m,
scripts/plot/semilogyerr.m, scripts/plot/shading.m, scripts/plot/shg.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/specular.m,
scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surface.m, scripts/plot/surfc.m,
scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/text.m,
scripts/plot/title.m, scripts/plot/trimesh.m, scripts/plot/triplot.m,
scripts/plot/trisurf.m, scripts/plot/view.m, scripts/plot/waitbar.m,
scripts/plot/waitforbuttonpress.m, scripts/plot/waterfall.m,
scripts/plot/whitebg.m, scripts/plot/xlabel.m, scripts/plot/xlim.m,
scripts/plot/ylabel.m, scripts/plot/ylim.m, scripts/plot/zlabel.m,
scripts/plot/zlim.m: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
| author | Rik <rik@octave.org> |
|---|---|
| date | Wed, 31 Jul 2013 13:53:30 -0700 |
| parents | 6dec8dbf8a97 |
| children | df4c4b7708a4 |
comparison
equal
deleted
inserted
replaced
| 17121:d4549655b92e | 17122:eaab03308c0b |
|---|---|
| 21 ## @deftypefnx {Function File} {} axis ([@var{x}_lo @var{x}_hi]) | 21 ## @deftypefnx {Function File} {} axis ([@var{x}_lo @var{x}_hi]) |
| 22 ## @deftypefnx {Function File} {} axis ([@var{x}_lo @var{x}_hi @var{y}_lo @var{y}_hi]) | 22 ## @deftypefnx {Function File} {} axis ([@var{x}_lo @var{x}_hi @var{y}_lo @var{y}_hi]) |
| 23 ## @deftypefnx {Function File} {} axis ([@var{x}_lo @var{x}_hi @var{y}_lo @var{y}_hi @var{z}_lo @var{z}_hi]) | 23 ## @deftypefnx {Function File} {} axis ([@var{x}_lo @var{x}_hi @var{y}_lo @var{y}_hi @var{z}_lo @var{z}_hi]) |
| 24 ## @deftypefnx {Function File} {} axis (@var{option}) | 24 ## @deftypefnx {Function File} {} axis (@var{option}) |
| 25 ## @deftypefnx {Function File} {} axis (@dots{}, @var{option}) | 25 ## @deftypefnx {Function File} {} axis (@dots{}, @var{option}) |
| 26 ## @deftypefnx {Function File} {} axis (@var{h}, @dots{}) | 26 ## @deftypefnx {Function File} {} axis (@var{hax}, @dots{}) |
| 27 ## @deftypefnx {Function File} {@var{limits} =} axis () | 27 ## @deftypefnx {Function File} {@var{limits} =} axis () |
| 28 ## Set axis limits for plots. | 28 ## Set axis limits and appearance. |
| 29 ## | 29 ## |
| 30 ## The argument @var{limits} should be a 2-, 4-, or 6-element vector. The | 30 ## The argument @var{limits} should be a 2-, 4-, or 6-element vector. The |
| 31 ## first and second elements specify the lower and upper limits for the | 31 ## first and second elements specify the lower and upper limits for the |
| 32 ## x-axis. The third and fourth specify the limits for the y-axis, and the | 32 ## x-axis. The third and fourth specify the limits for the y-axis, and the |
| 33 ## fifth and sixth specify the limits for the z-axis. | 33 ## fifth and sixth specify the limits for the z-axis. |
| 34 ## | 34 ## |
| 35 ## Without any arguments, @code{axis} turns autoscaling on. | 35 ## Without any arguments, @code{axis} turns autoscaling on. |
| 36 ## | 36 ## |
| 37 ## With one output argument, @code{x = axis} returns the current axes. | 37 ## With one output argument, @code{@var{limits} = axis} returns the current |
| 38 ## axis limits. | |
| 38 ## | 39 ## |
| 39 ## The vector argument specifying limits is optional, and additional | 40 ## The vector argument specifying limits is optional, and additional |
| 40 ## string arguments may be used to specify various axis properties. For | 41 ## string arguments may be used to specify various axis properties. For |
| 41 ## example, | 42 ## example, |
| 42 ## | 43 ## |
| 64 ## | 65 ## |
| 65 ## @item "equal" | 66 ## @item "equal" |
| 66 ## Force x distance to equal y-distance. | 67 ## Force x distance to equal y-distance. |
| 67 ## | 68 ## |
| 68 ## @item "normal" | 69 ## @item "normal" |
| 69 ## Restore the balance. | 70 ## Restore default aspect ratio. |
| 70 ## @end table | 71 ## @end table |
| 71 ## | 72 ## |
| 72 ## @noindent | 73 ## @noindent |
| 73 ## The following options control the way axis limits are interpreted. | 74 ## The following options control the way axis limits are interpreted. |
| 74 ## | 75 ## |
| 80 ## @item "manual" | 81 ## @item "manual" |
| 81 ## Fix the current axes limits. | 82 ## Fix the current axes limits. |
| 82 ## | 83 ## |
| 83 ## @item "tight" | 84 ## @item "tight" |
| 84 ## Fix axes to the limits of the data. | 85 ## Fix axes to the limits of the data. |
| 86 ## | |
| 87 ## @item "image" | |
| 88 ## Equivalent to "tight" and "equal". | |
| 85 ## @end table | 89 ## @end table |
| 86 ## | |
| 87 ## @noindent | |
| 88 ## The option @code{"image"} is equivalent to @code{"tight"} and | |
| 89 ## @code{"equal"}. | |
| 90 ## | 90 ## |
| 91 ## @noindent | 91 ## @noindent |
| 92 ## The following options affect the appearance of tic marks. | 92 ## The following options affect the appearance of tic marks. |
| 93 ## | 93 ## |
| 94 ## @table @asis | 94 ## @table @asis |
| 111 ## @end table | 111 ## @end table |
| 112 ## | 112 ## |
| 113 ## Note, if there are no tic marks for an axis, there can be no labels. | 113 ## Note, if there are no tic marks for an axis, there can be no labels. |
| 114 ## | 114 ## |
| 115 ## @noindent | 115 ## @noindent |
| 116 ## The following options affect the direction of increasing values on | 116 ## The following options affect the direction of increasing values on the axes. |
| 117 ## the axes. | |
| 118 ## | 117 ## |
| 119 ## @table @asis | 118 ## @table @asis |
| 120 ## @item "ij" | 119 ## @item "ij" |
| 121 ## Reverse y-axis, so lower values are nearer the top. | 120 ## Reverse y-axis, so lower values are nearer the top. |
| 122 ## | 121 ## |
| 123 ## @item "xy" | 122 ## @item "xy" |
| 124 ## Restore y-axis, so higher values are nearer the top. | 123 ## Restore y-axis, so higher values are nearer the top. |
| 125 ## @end table | 124 ## @end table |
| 126 ## | 125 ## |
| 127 ## If an axes handle is passed as the first argument, then operate on | 126 ## If the first argument @var{hax} is an axes handle, then operate on |
| 128 ## this axes rather than the current axes. | 127 ## this axes rather than the current axes returned by @code{gca}. |
| 128 ## | |
| 129 ## @seealso{xlim, ylim, zlim, daspect, pbaspect, box, grid} | |
| 129 ## @end deftypefn | 130 ## @end deftypefn |
| 130 | 131 |
| 131 ## Author: jwe | 132 ## Author: jwe |
| 132 | 133 |
| 133 function limits = axis (varargin) | 134 function limits = axis (varargin) |