Mercurial > octave
view scripts/plot/appearance/yticks.m @ 27980:bdad8ca48700
maint: Remove "Created:" lines from code base.
* lin2mu.m, mu2lin.m, bincoeff.m, common_size.m, deal.m, nextpow2.m,
postpad.m, prepad.m, repmat.m, shift.m, xor.m, inpolygon.m, rotx.m, roty.m,
rotz.m, getappdata.m, isappdata.m, rmappdata.m, setappdata.m, colormap.m,
gray.m, gray2ind.m, image.m, imagesc.m, ind2gray.m, ind2rgb.m, ocean.m,
rgb2ind.m, javachk.m, javamem.m, commutation_matrix.m, cross.m,
duplication_matrix.m, gls.m, housh.m, isdefinite.m, ishermitian.m,
issymmetric.m, null.m, ols.m, orth.m, qzhess.m, vech.m, __w2mpth__.m,
expand_rel_paths.m, make_rel_paths.m, daspect.m, pbaspect.m, rticks.m,
thetaticks.m, xticklabels.m, xticks.m, yticklabels.m, yticks.m, zticklabels.m,
zticks.m, comet.m, errorbar.m, loglogerr.m, __errplot__.m, semilogxerr.m,
semilogyerr.m, cla.m, copyobj.m, hdl2struct.m, linkaxes.m, __ghostscript__.m,
__gnuplot_get_var__.m, __gnuplot_has_feature__.m, __gnuplot_has_terminal__.m,
__gnuplot_open_stream__.m, struct2hdl.m, compan.m, conv.m, deconv.m, mpoles.m,
poly.m, polyder.m, polyfit.m, polyint.m, polyout.m, polyreduce.m, polyval.m,
polyvalm.m, residue.m, roots.m, __parse_movargs__.m, detrend.m, fftconv.m,
fftfilt.m, fftshift.m, ifftshift.m, movfun.m, movslice.m, beta.m, betaln.m,
lcm.m, pow2.m, corr.m, kurtosis.m, skewness.m, untabify.m, calendar.m,
datestr.m, datevec.m, eomday.m, now.m, weekday.m:
Remove "Created:" lines from code base.
author | Rik <rik@octave.org> |
---|---|
date | Tue, 21 Jan 2020 13:06:02 -0800 |
parents | bd51beb6205e |
children | 9f9ac219896d |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2017-2020 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## 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 ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{tickval} =} yticks ## @deftypefnx {} {@var{mode} =} yticks ("mode") ## @deftypefnx {} {} yticks (@var{tickval}) ## @deftypefnx {} {} yticks ("auto") ## @deftypefnx {} {} yticks ("manual") ## @deftypefnx {} {@dots{} =} yticks (@var{hax}, @dots{}) ## Query or set the tick values on the y-axis of the current axis. ## ## When called without an argument, return the current tick locations as ## specified in the @qcode{"ytick"} axes property. These locations can be ## changed by calling @code{yticks} with a vector of tick values. Note: ## ascending order is not required. ## ## When called with argument @qcode{"mode"}, @code{yticks} returns the current ## value of the axes property @qcode{"ytickmode"}. This property can be ## changed by calling @code{yticks} with either @qcode{"auto"} (algorithm ## determines tick positions) or @qcode{"manual"} (tick values remain fixed ## regardless of axes resizing or rotation). Note: Specifying ytick values ## will also set the property @qcode{"ytickmode"} to @qcode{"manual"}. ## ## If the first argument @var{hax} is an axes handle, then operate on ## this axis rather than the current axes returned by @code{gca}. ## ## Requesting a return value when calling @code{yticks} to set a property value ## will result in an error. ## ## @seealso{yticklabels, xticks, zticks, rticks, thetaticks, get, set} ## @end deftypefn ## Author: Nicholas Jankowski <jankowskin@asme.org> function retval = yticks (varargin) hax = []; switch (nargin) case 0 retval = get (gca , "ytick"); # will error if no ytick exists. return; case 1 if (isaxes (varargin{1})) retval = get (varargin{1}, "ytick"); return; else arg = varargin{1}; endif case 2 if (! isaxes (varargin{1})) error ("yticks: HAX must be a handle to an axes object"); endif hax = varargin{1}; arg = varargin{2}; otherwise print_usage (); endswitch if (isempty (hax)) hax = gca (); endif if (isnumeric (arg)) if (nargout > 0) error ("yticks: too many output arguments requested"); else ## NOTE: Matlab errors if tick points are not in ascending order. Octave ## permits out of order tick points, so error is not produced. set (hax, "ytick", arg); endif elseif (ischar (arg)) arg = tolower (arg); switch (arg) case "mode" retval = get (hax, "ytickmode"); case {"auto", "manual"} if (nargout > 0) error ("yticks: too many output arguments requested for arg: %s", arg); endif set (hax, "ytickmode", arg); otherwise error ("yticks: invalid option: %s", arg); endswitch else print_usage (); endif endfunction %!test %! hf = figure ("visible", "off"); %! unwind_protect %! set (gca, "ytickmode", "auto"); %! hax = gca; %! vals1 = yticks; %! assert (yticks (hax), vals1); %! mode1 = yticks ("mode"); %! assert (yticks (hax, "mode"), mode1); %! yticks (hax, "manual"); %! assert (yticks (hax, "mode"), "manual"); %! yticks (hax, "auto"); %! assert (yticks (hax, "mode"), "auto"); %! yticks (hax, [1 2 3 4]); %! assert (yticks (hax), [1 2 3 4]); %! assert (yticks (hax, "mode"), "manual"); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect ## Test input validation %!error yticks (1,2,3) %!test %! hf = figure ("visible", "off"); %! unwind_protect %! hax = gca; %! fail ("yticks (-1, [0 1])", "HAX must be a handle to an axes"); %! fail ("tmp = yticks (hax, [0 1])", "too many output arguments"); %! fail ("tmp = yticks (hax, 'auto')", "too many .* for arg: auto"); %! fail ("tmp = yticks (hax, 'foo')", "invalid option: foo"); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect