Mercurial > octave-nkf
comparison scripts/plot/ylim.m @ 7050:bd56a0609c4f
[project @ 2007-10-23 12:02:17 by dbateman]
| author | dbateman |
|---|---|
| date | Tue, 23 Oct 2007 12:02:18 +0000 |
| parents | |
| children | a730e47fda4d |
comparison
equal
deleted
inserted
replaced
| 7049:e426f849fc36 | 7050:bd56a0609c4f |
|---|---|
| 1 ## Copyright (C) 2007 David Bateman | |
| 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 -*- | |
| 20 ## @deftypefn {Function File} {@var{xl} =} ylim () | |
| 21 ## @deftypefnx {Function File} {} ylim (@var{xl}) | |
| 22 ## @deftypefnx {Function File} {@var{m} =} ylim ('mode') | |
| 23 ## @deftypefnx {Function File} {} ylim (@var{m}) | |
| 24 ## @deftypefnx {Function File} {} ylim (@var{h}, @dots{}) | |
| 25 ## Get or set the limits of the y axis of the current plot. Called without | |
| 26 ## argumenst @code{ylim] returns the y axis limits of the current plot. | |
| 27 ## If passed a two element vector @var{xl}, the limits of the y axis are set | |
| 28 ## to this value. | |
| 29 ## | |
| 30 ## The current mode for calculation of the y axis can be returned with a | |
| 31 ## call @code{ylim ('mode')}, and can be either 'auto' or 'manual'. The | |
| 32 ## current plotting mode can be set by passing either 'auto' or 'manual' | |
| 33 ## as the argument. | |
| 34 ## | |
| 35 ## If passed an handle as the first argument, then operate on this handle | |
| 36 ## rather than the current axes handle. | |
| 37 ## @seealso{xlim, zlim, set, get, gca} | |
| 38 ## @end deftypefn | |
| 39 | |
| 40 function retval = ylim (varargin) | |
| 41 ret = __axes_limits__ ("ylim", varargin {:}); | |
| 42 | |
| 43 if (! isempty (ret)) | |
| 44 retval = ret; | |
| 45 endif | |
| 46 endfunction |