1## Copyright (C) 2007, 2008, 2009 David Bateman
3## This file is part of Octave.
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.
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.
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/>.
20## @deftypefn {Function File} {@var{xl} =} xlim ()
21## @deftypefnx {Function File} {} xlim (@var{xl})
22## @deftypefnx {Function File} {@var{m} =} xlim ('mode')
23## @deftypefnx {Function File} {} xlim (@var{m})
24## @deftypefnx {Function File} {} xlim (@var{h}, @dots{})
25## Get or set the limits of the x-axis of the current plot. Called without
26## arguments @code{xlim} returns the x-axis limits of the current plot.
27## If passed a two element vector @var{xl}, the limits of the x-axis are set
30## The current mode for calculation of the x-axis can be returned with a
31## call @code{xlim ('mode')}, and can be either 'auto' or 'manual'. The
32## current plotting mode can be set by passing either 'auto' or 'manual'
35## If passed an handle as the first argument, then operate on this handle
36## rather than the current axes handle.
37## @seealso{ylim, zlim, set, get, gca}
40function retval = xlim (varargin)
41 ret = __axes_limits__ ("xlim", varargin{:});
