Mercurial > octave
view scripts/plot/appearance/xticklabels.m @ 30875:5d3faba0342e
doc: Ensure documentation lists output argument when it exists for all m-files.
For new users of Octave it is best to show explicit calling forms
in the documentation and to show a return argument when it exists.
* bp-table.cc, shift.m, accumarray.m, accumdim.m, bincoeff.m, bitcmp.m,
bitget.m, bitset.m, blkdiag.m, celldisp.m, cplxpair.m, dblquad.m, flip.m,
fliplr.m, flipud.m, idivide.m, int2str.m, interpft.m, logspace.m, num2str.m,
polyarea.m, postpad.m, prepad.m, randi.m, repmat.m, rng.m, rot90.m, rotdim.m,
structfun.m, triplequad.m, uibuttongroup.m, uicontrol.m, uipanel.m,
uipushtool.m, uitoggletool.m, uitoolbar.m, waitforbuttonpress.m, help.m,
__additional_help_message__.m, hsv.m, im2double.m, im2frame.m, javachk.m,
usejava.m, argnames.m, char.m, formula.m, inline.m, __vectorize__.m, findstr.m,
flipdim.m, strmatch.m, vectorize.m, commutation_matrix.m, cond.m, cross.m,
duplication_matrix.m, expm.m, orth.m, rank.m, rref.m, trace.m, vech.m, cast.m,
compare_versions.m, delete.m, dir.m, fileattrib.m, grabcode.m, gunzip.m,
inputname.m, license.m, list_primes.m, ls.m, mexext.m, movefile.m,
namelengthmax.m, nargoutchk.m, nthargout.m, substruct.m, swapbytes.m, ver.m,
verLessThan.m, what.m, fminunc.m, fsolve.m, fzero.m, optimget.m, __fdjac__.m,
matlabroot.m, savepath.m, campos.m, camroll.m, camtarget.m, camup.m, camva.m,
camzoom.m, clabel.m, diffuse.m, legend.m, orient.m, rticks.m, specular.m,
thetaticks.m, xlim.m, xtickangle.m, xticklabels.m, xticks.m, ylim.m,
ytickangle.m, yticklabels.m, yticks.m, zlim.m, ztickangle.m, zticklabels.m,
zticks.m, ellipsoid.m, isocolors.m, isonormals.m, stairs.m, surfnorm.m,
__actual_axis_position__.m, __pltopt__.m, close.m, graphics_toolkit.m, pan.m,
print.m, printd.m, __ghostscript__.m, __gnuplot_print__.m, __opengl_print__.m,
rotate3d.m, subplot.m, zoom.m, compan.m, conv.m, poly.m, polyaffine.m,
polyder.m, polyint.m, polyout.m, polyreduce.m, polyvalm.m, roots.m, prefdir.m,
prefsfile.m, profexplore.m, profexport.m, profshow.m, powerset.m, unique.m,
arch_rnd.m, arma_rnd.m, autoreg_matrix.m, bartlett.m, blackman.m, detrend.m,
durbinlevinson.m, fftconv.m, fftfilt.m, fftshift.m, fractdiff.m, hamming.m,
hanning.m, hurst.m, ifftshift.m, rectangle_lw.m, rectangle_sw.m, triangle_lw.m,
sinc.m, sinetone.m, sinewave.m, spectral_adf.m, spectral_xdf.m, spencer.m,
ilu.m, __sprand__.m, sprand.m, sprandn.m, sprandsym.m, treelayout.m, beta.m,
betainc.m, betaincinv.m, betaln.m, cosint.m, expint.m, factorial.m, gammainc.m,
gammaincinv.m, lcm.m, nthroot.m, perms.m, reallog.m, realpow.m, realsqrt.m,
sinint.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, pascal.m, rosser.m,
toeplitz.m, vander.m, wilkinson.m, center.m, corr.m, cov.m, discrete_cdf.m,
discrete_inv.m, discrete_pdf.m, discrete_rnd.m, empirical_cdf.m,
empirical_inv.m, empirical_pdf.m, empirical_rnd.m, kendall.m, kurtosis.m,
mad.m, mean.m, meansq.m, median.m, mode.m, moment.m, range.m, ranks.m,
run_count.m, skewness.m, spearman.m, statistics.m, std.m, base2dec.m,
bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m,
hex2dec.m, index.m, regexptranslate.m, rindex.m, strcat.m, strjust.m,
strtrim.m, strtrunc.m, substr.m, untabify.m, __have_feature__.m,
__prog_output_assert__.m, __run_test_suite__.m, example.m, fail.m, asctime.m,
calendar.m, ctime.m, date.m, etime.m:
Add return arguments to @deftypefn macros where they were missing. Rename
variables in functions (particularly generic "retval") to match documentation.
Rename some return variables for (hopefully) better clarity (e.g., 'ax' to 'hax'
to indicate it is a graphics handle to an axes object).
author | Rik <rik@octave.org> |
---|---|
date | Wed, 30 Mar 2022 20:40:27 -0700 |
parents | 796f54d4ddbf |
children | a40c0b7aa376 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2017-2022 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{labels} =} xticklabels ## @deftypefnx {} {@var{mode} =} xticklabels ("mode") ## @deftypefnx {} {} xticklabels (@var{tickval}) ## @deftypefnx {} {} xticklabels ("auto") ## @deftypefnx {} {} xticklabels ("manual") ## @deftypefnx {} {@dots{} =} xticklabels (@var{hax}, @dots{}) ## Query or set the tick labels on the x-axis of the current axis. ## ## When called without an argument, return a cell array of strings of the ## current tick labels as specified in the @qcode{"xticklabel"} axes property. ## These labels can be changed by calling @code{xticklabels} with a cell array ## of strings. Note: a vector of numbers will be mapped to a cell array of ## strings. If fewer labels are specified than the current number of ticks, ## blank labels will be appended to the array. ## ## When called with argument @qcode{"mode"}, @code{xticklabels} returns the ## current value of the axes property @qcode{"xticklabelmode"}. This property ## can be changed by calling @code{xticklabels} with either @qcode{"auto"} ## (algorithm determines tick labels) or @qcode{"manual"} (tick labels remain ## fixed). Note: Specifying xticklabel values will also set the ## @qcode{"xticklabelmode"} and @qcode{"xticks"} properties 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{xticklabels} to set a property ## value will result in an error. ## ## @seealso{xticks, yticklabels, zticklabels, get, set} ## @end deftypefn function labels = xticklabels (varargin) hax = []; switch (nargin) case 0 labels = get (gca , "xticklabel"); # will error if no xticklabel exists. return; case 1 if (isaxes (varargin{1})) labels = get (varargin{1}, "xticklabel"); return; else arg = varargin{1}; endif case 2 if (! isaxes (varargin{1})) error ("xticklabels: 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 (iscell (arg) || isnumeric (arg)) if (nargout > 0) error ("xticklabels: too many output arguments requested"); endif if (isnumeric (arg)) ## NOTE: Matlab accepts a cell array, but a non-vector numeric array will ## simply produce a black set of labels without error or warning. ## This implementation allows for a numeric array, which is handled in ## the same order as Matlab handles a cell array arg = num2cell (arg(:)); endif ## Convert any numeric elements to characters, make it a 1D cell array. arg = cellfun (@num2str, arg, "UniformOutput", false)(:); ## Pad with blank cell entries if needed. arg((numel (arg) + 1):(numel (get (hax, "xtick")))) = {""}; ## Setting labels sets both ticklabel and tick mode to manual. set (hax, "xticklabel", arg, "xticklabelmode", "manual", "xtickmode", "manual"); elseif (ischar (arg)) arg = tolower (arg); switch (arg) case "mode" labels = get (hax, "xticklabelmode"); case {"auto", "manual"} if (nargout > 0) error (["xticklabels: " ... "too many output arguments requested for arg: ", arg]); endif set (hax, "xticklabelmode", arg); otherwise error ("xticklabels: invalid option: %s", arg); endswitch else print_usage (); endif endfunction %!test %! hf = figure ("visible", "off"); %! unwind_protect %! set (gca, "xticklabelmode", "auto"); %! hax = gca (); %! vals1 = xticklabels; %! assert (xticklabels (hax), vals1); %! mode1 = xticklabels ("mode"); %! assert (xticklabels (hax, "mode"), mode1); %! xticklabels (hax, "manual"); %! assert (xticklabels (hax, "mode"), "manual"); %! xticklabels (hax, "auto"); %! assert (xticks (hax, "mode"), "auto"); %! xticklabels (hax, {"1", "2", "3", "4", "5", "6"}); %! assert (xticklabels (hax), {"1"; "2"; "3"; "4"; "5"; "6"}); %! assert (xticklabels (hax, "mode"), "manual"); %! assert (xticks (hax, "mode"), "manual"); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect ## Test input validation %!error xticklabels (1,2,3) %!test %! hf = figure ("visible", "off"); %! unwind_protect %! hax = gca (); %! fail ("xticklabels (-1, {})", "HAX must be a handle to an axes"); %! fail ("tmp = xticklabels (hax, {'A','B'})", "too many output arguments"); %! fail ("tmp = xticklabels (hax, [0, 1])", "too many output arguments"); %! fail ("tmp = xticklabels (hax, 'auto')", "too many .* for arg: auto"); %! fail ("tmp = xticklabels (hax, 'foo')", "invalid option: foo"); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect