Mercurial > hg > octave-lyh
annotate scripts/plot/ylim.m @ 14245:4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
* contrast.m, axis.m, clabel.m, colorbar.m, comet.m, contour.m, contour3.m,
cylinder.m, daspect.m, errorbar.m, ezplot.m, fplot.m, grid.m, hold.m,
isosurface.m, legend.m, loglog.m, loglogerr.m, pareto.m, patch.m, pbaspect.m,
pie.m, pie3.m, plot3.m, plotmatrix.m, plotyy.m, quiver.m, quiver3.m,
rectangle.m, refreshdata.m, scatter.m, scatter3.m, semilogx.m, semilogxerr.m,
semilogy.m, semilogyerr.m, shading.m, stem.m, subplot.m, text.m, title.m,
trimesh.m, triplot.m, trisurf.m, uigetdir.m, uigetfile.m, uimenu.m,
uiputfile.m, waitbar.m, xlim.m, ylim.m, zlim.m: Use Matlab coding conventions
for demos so that compare plots scripts will function.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sun, 22 Jan 2012 07:31:32 -0800 |
parents | 11949c9795a0 |
children | 7277fe922e99 |
rev | line source |
---|---|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
13141
diff
changeset
|
1 ## Copyright (C) 2007-2012 David Bateman |
7050 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
5 ## Octave is free software; you can redistribute it and/or modify it | |
6 ## under the terms of the GNU General Public License as published by | |
7 ## the Free Software Foundation; either version 3 of the License, or (at | |
8 ## your option) any later version. | |
9 ## | |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 ## General Public License for more details. | |
14 ## | |
15 ## You should have received a copy of the GNU General Public License | |
16 ## along with Octave; see the file COPYING. If not, see | |
17 ## <http://www.gnu.org/licenses/>. | |
18 | |
19 ## -*- texinfo -*- | |
11152
39ae406df598
Improve docstrings for functions found in undocumented list.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
20 ## @deftypefn {Function File} {@var{yl} =} ylim () |
39ae406df598
Improve docstrings for functions found in undocumented list.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
21 ## @deftypefnx {Function File} {} ylim (@var{yl}) |
7050 | 22 ## @deftypefnx {Function File} {@var{m} =} ylim ('mode') |
23 ## @deftypefnx {Function File} {} ylim (@var{m}) | |
24 ## @deftypefnx {Function File} {} ylim (@var{h}, @dots{}) | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
25 ## Get or set the limits of the y-axis of the current plot. Called without |
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
26 ## arguments @code{ylim} returns the y-axis limits of the current plot. |
11152
39ae406df598
Improve docstrings for functions found in undocumented list.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
27 ## If passed a two element vector @var{yl}, the limits of the y-axis are set |
7050 | 28 ## to this value. |
29 ## | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
30 ## The current mode for calculation of the y-axis can be returned with a |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
31 ## call @code{ylim ('mode')}, and can be either 'auto' or 'manual'. The |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
32 ## current plotting mode can be set by passing either 'auto' or 'manual' |
7050 | 33 ## as the argument. |
34 ## | |
11189
a3cb42b394eb
Fix typos in docstring and demo string.
Rik <octave@nomad.inbox5.com>
parents:
11152
diff
changeset
|
35 ## If passed a handle as the first argument, then operate on this handle |
7050 | 36 ## rather than the current axes handle. |
37 ## @seealso{xlim, zlim, set, get, gca} | |
38 ## @end deftypefn | |
39 | |
40 function retval = ylim (varargin) | |
7208 | 41 ret = __axes_limits__ ("ylim", varargin{:}); |
7050 | 42 |
43 if (! isempty (ret)) | |
44 retval = ret; | |
45 endif | |
46 endfunction | |
13083
0e231bbd78bc
codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
47 |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
48 |
13083
0e231bbd78bc
codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
49 %!demo |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
50 %! clf; |
13083
0e231bbd78bc
codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
51 %! line (); |
0e231bbd78bc
codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
52 %! ylim ([0.2, 0.8]); |
14245
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
53 %! title ('ylim is [0.2, 0.8]'); |
13083
0e231bbd78bc
codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
54 %! assert (ylim (), [0.2, 0.8]); |
0e231bbd78bc
codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
55 |
0e231bbd78bc
codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
56 %!demo |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
57 %! clf; |
13083
0e231bbd78bc
codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
58 %! line (); |
14245
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
59 %! ylim ('auto'); |
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
60 %! title ('ylim is auto'); |
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
61 %! assert (ylim ('mode'), 'auto'); |
13083
0e231bbd78bc
codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
62 |
0e231bbd78bc
codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
63 %!demo |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
64 %! clf; |
13083
0e231bbd78bc
codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
65 %! plot3 ([0,1], [0,1], [0,1]); |
0e231bbd78bc
codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
66 %! ylim ([0.2, 0.8]); |
14245
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
67 %! title ('ylim is [0.2, 0.8]'); |
13083
0e231bbd78bc
codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
68 %! assert (ylim (), [0.2, 0.8]); |
0e231bbd78bc
codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
69 |
0e231bbd78bc
codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
70 %!demo |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
71 %! clf; |
13083
0e231bbd78bc
codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
72 %! plot3 ([0,1], [0,1], [0,1]); |
14245
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
73 %! ylim ('auto'); |
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
74 %! title ('ylim is auto'); |
4506eade9f04
Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents:
14237
diff
changeset
|
75 %! assert (ylim ('mode'), 'auto'); |
13083
0e231bbd78bc
codesprint: demos for xlim, ylim, and zlim
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
76 |
13096 | 77 %!test |
13124
2ea1658ad049
Don't use explicit figure number for tests to avoid interference with any figures opened by user.
Kai Habel <kai.habel@gmx.de>
parents:
13096
diff
changeset
|
78 %! hf = figure ("visible", "off"); |
13141
e81ddf9cacd5
maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
13124
diff
changeset
|
79 %! unwind_protect |
13096 | 80 %! limy = [0, 1.1]; |
81 %! plot3 ([0,1], [0,1], [0,1]); | |
82 %! ylim (limy); | |
83 %! assert (get (gca, "ylim"), limy, eps); | |
84 %! assert (ylim ("mode"), "manual"); | |
85 %! unwind_protect_cleanup | |
86 %! close (hf); | |
87 %! end_unwind_protect | |
88 | |
89 %!test | |
13124
2ea1658ad049
Don't use explicit figure number for tests to avoid interference with any figures opened by user.
Kai Habel <kai.habel@gmx.de>
parents:
13096
diff
changeset
|
90 %! hf = figure ("visible", "off"); |
13141
e81ddf9cacd5
maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
13124
diff
changeset
|
91 %! unwind_protect |
13096 | 92 %! plot3 ([0,1], [0,1.1], [0, 1]); |
93 %! assert (get (gca, "ylim"), [0, 1.4], eps); | |
94 %! assert (ylim ("mode"), "auto"); | |
95 %! unwind_protect_cleanup | |
96 %! close (hf); | |
97 %! end_unwind_protect | |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
98 |