Mercurial > octave
view scripts/plot/appearance/clabel.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 | 597f3ee61a48 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2008-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 {} {} clabel (@var{c}, @var{h}) ## @deftypefnx {} {} clabel (@var{c}, @var{h}, @var{v}) ## @deftypefnx {} {} clabel (@var{c}, @var{h}, "manual") ## @deftypefnx {} {} clabel (@var{c}) ## @deftypefnx {} {} clabel (@dots{}, @var{prop}, @var{val}, @dots{}) ## @deftypefnx {} {@var{hlabels} =} clabel (@dots{}) ## Add labels to the contours of a contour plot. ## ## The contour levels are specified by the contour matrix @var{c} which is ## returned by @code{contour}, @code{contourc}, @code{contourf}, and ## @code{contour3}. Contour labels are rotated to match the local line ## orientation and centered on the line. The position of labels along the ## contour line is chosen randomly. ## ## If the argument @var{h} is a handle to a contour group object, then label ## this plot rather than the one in the current axes returned by @code{gca}. ## ## By default, all contours are labeled. However, the contours to label can be ## specified by the vector @var{v}. If the @qcode{"manual"} argument is ## given then the contours to label can be selected with the mouse. ## ## Additional property/value pairs that are valid properties of text objects ## can be given and are passed to the underlying text objects. Moreover, ## the contour group property @qcode{"LabelSpacing"} is available which ## determines the spacing between labels on a contour to be specified. The ## default is 144 points, or 2 inches. ## ## The optional return value @var{hlabels} is a vector of graphics handles to ## the text objects representing each label. ## The @qcode{"userdata"} property of the text objects contains the numerical ## value of the contour label. ## ## The full list of text object properties is documented at ## @ref{Text Properties}. ## ## @example ## @group ## [c, h] = contour (peaks (), -4 : 6); ## clabel (c, h, -4:2:6, "fontsize", 12); ## @end group ## @end example ## ## @seealso{contour, contourf, contour3, meshc, surfc, text} ## @end deftypefn function hlabels = clabel (c, varargin) have_hg = false; have_labelspacing = false; label_spacing = 144; # 2 inches in points if (nargin < 1) print_usage (); elseif (nargin == 1) hparent = gca (); else arg = varargin{1}; if (isscalar (arg) && isgraphics (arg, "hggroup")) try get (arg, "contourmatrix"); catch error ("clabel: H must be a handle to a contour group"); end_try_catch have_hg = true; hg = arg; varargin(1) = []; else hparent = gca (); endif endif if (length (varargin) > 0 && isnumeric (varargin{1})) v = varargin{1}(:); varargin(1) = []; else v = []; endif idx = strcmpi (varargin(1:2:end), "manual"); if (any (idx)) error ('clabel: "manual" contour mode is not supported'); endif idx = find (strcmpi (varargin(1:2:end), "labelspacing"), 1); if (! isempty (idx)) have_labelspacing = true; label_spacing = varargin{2*idx}; varargin(2*idx+(-1:0)) = []; endif if (have_hg) if (! isempty (v)) if (have_labelspacing) set (hg, "textlistmode", "manual", "textlist", v, "labelspacing", label_spacing, "showtext", "on"); else set (hg, "textlistmode", "manual", "textlist", v, "showtext", "on"); endif else if (have_labelspacing) set (hg, "showtext", "on", "labelspacing", label_spacing); else set (hg, "showtext", "on"); endif endif htmp = findobj (hg, "type", "text"); if (! isempty (varargin)) set (htmp, varargin{:}); endif else htmp = __clabel__ (c, v, hparent, label_spacing, [], varargin{:}); endif if (nargout > 0) hlabels = htmp; endif endfunction %!demo %! clf; %! colormap ("default"); %! [c, h] = contour (peaks (), -4:6); %! clabel (c, h, -4:2:6, "fontsize", 12); %! title ("clabel() labeling every other contour"); %!demo %! clf; %! colormap ("default"); %! [c, h] = contourf (peaks (), -7:6); %! clabel (c, h, -6:2:6, "fontsize", 12); %! title ("clabel() labeling every other contour");