Mercurial > octave-antonio
view scripts/plot/util/zoom.m @ 19152:0f9c5a15c8fa
doc: Periodic grammarcheck of documentation.
* doc/interpreter/contrib.txi, doc/interpreter/expr.txi,
doc/interpreter/func.txi, doc/interpreter/linalg.txi, doc/interpreter/plot.txi,
libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/load-save.cc, libinterp/corefcn/profiler.cc,
libinterp/corefcn/syscalls.cc, libinterp/corefcn/utils.cc,
libinterp/corefcn/variables.cc, libinterp/dldfcn/__init_fltk__.cc,
scripts/general/deal.m, scripts/help/__gripe_missing_component__.m,
scripts/miscellaneous/desktop.m, scripts/pkg/private/default_prefix.m,
scripts/plot/appearance/__getlegenddata__.m, scripts/plot/util/pan.m,
scripts/plot/util/rotate.m, scripts/plot/util/rotate3d.m,
scripts/plot/util/zoom.m, scripts/signal/periodogram.m,
scripts/specfun/factor.m, scripts/specfun/primes.m,
scripts/statistics/base/lscov.m, scripts/testfun/private/compare_plot_demos.m,
scripts/testfun/private/dump_demos.m,
scripts/testfun/private/html_compare_plot_demos.m, scripts/testfun/test.m:
Periodic grammarcheck of documentation.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 22 Sep 2014 20:46:54 -0700 |
parents | 8a6f87637c16 |
children | ec037d41da06 |
line wrap: on
line source
## Copyright (C) 2014 John W. Eaton ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Command} {} zoom (@var{factor}) ## @deftypefnx {Command} {} zoom out ## @deftypefnx {Command} {} zoom reset ## Zoom the current axes object. ## ## Given a numeric argument greater than zero, zoom by the given factor. ## If the zoom factor is greater than one, zoom in on the plot. If the ## factor is less than one, zoom out. ## ## Given the option @qcode{"out"}, zoom to the initial zoom setting. ## ## Given the option @qcode{"reset"}, set the initial zoom setting to the ## current axes limits. ## ## @seealso{pan, rotate3d} ## @end deftypefn ## Eventually we need to also support these features: ## @deftypefn {Command} {} zoom ## @deftypefnx {Command} {} zoom on ## @deftypefnx {Command} {} zoom off ## @deftypefnx {Command} {} zoom xon ## @deftypefnx {Command} {} zoom yon ## @deftypefnx {Command} {} zoom (@var{hfig}, @var{option}) ## @deftypefnx {Command} {zoom_object_handle =} zoom (@var{hfig}) function zoom (varargin) hfig = NaN; nargs = nargin; if (nargs > 2) print_usage (); endif if (nargin == 1 && isfigure (varargin{1})) error ("zoom_object_handle = zoom (hfig): not implemented"); endif if (nargs == 2) hfig = varargin{1}; if (isfigure (hfig)) varargin(1) = []; nargs--; else error ("zoom: expecting figure handle as first argument"); endif endif if (isnan (hfig)) hfig = gcf (); endif if (nargs == 0) error ("zoom: toggling zoom mode is not implemented"); elseif (nargs == 1) arg = varargin{1}; if (isnumeric (arg)) factor = arg; if (factor < 0) error ("zoom: factor must be greater than 1"); elseif (factor == 1) return; endif cax = get (hfig, "currentaxes"); if (! isempty (cax)) limits = axis (); initial_zoom = getappdata (cax, "initial_zoom"); if (isempty (initial_zoom)) setappdata (cax, "__initial_zoom__", limits); endif axis (cax, limits / factor); endif elseif (ischar (arg)) switch (arg) case {"on", "off", "xon", "yon"} error ("zoom %s: not implemented", arg); case "out" cax = get (hfig, "currentaxes"); if (! isempty (cax)) initial_zoom = getappdata (cax, "__initial_zoom__"); if (! isempty (initial_zoom)) axis (cax, initial_zoom); endif endif case "reset" cax = get (hfig, "currentaxes"); if (! isempty (cax)) setappdata (cax, "__initial_zoom__", axis ()); endif otherwise error ("zoom: unrecognized option '%s'", arg); endswitch else error ("zoom: wrong type argument '%s'", class (arg)); endif endif endfunction