Mercurial > hg > octave-lyh

comparison scripts/plot/clabel.m @ 17126:eaab03308c0b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Rewrite docstrings for most plot functions. Emphasize clarity, use common "voice", and increase density of seealso links. * doc/interpreter/plot.txi: Add @findex entries that were in xlim.m * scripts/miscellaneous/getappdata.m scripts/miscellaneous/setappdata.m, scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axes.m, scripts/plot/axis.m, scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/closereq.m, scripts/plot/colorbar.m, scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m, scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourc.m, scripts/plot/contourf.m, scripts/plot/copyobj.m, scripts/plot/cylinder.m, scripts/plot/daspect.m, scripts/plot/diffuse.m, scripts/plot/ellipsoid.m, scripts/plot/errorbar.m, scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezplot.m, scripts/plot/ezplot3.m, scripts/plot/ezpolar.m, scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/feather.m, scripts/plot/figure.m, scripts/plot/fill.m, scripts/plot/findall.m, scripts/plot/findobj.m, scripts/plot/fplot.m, scripts/plot/gca.m, scripts/plot/gcbf.m, scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m, scripts/plot/ginput.m, scripts/plot/graphics_toolkit.m, scripts/plot/grid.m, scripts/plot/gtext.m, scripts/plot/guidata.m, scripts/plot/guihandles.m, scripts/plot/hdl2struct.m, scripts/plot/hggroup.m, scripts/plot/hidden.m, scripts/plot/hist.m, scripts/plot/hold.m, scripts/plot/ishghandle.m, scripts/plot/ishold.m, scripts/plot/isocolors.m, scripts/plot/isprop.m, scripts/plot/legend.m, scripts/plot/line.m, scripts/plot/linkprop.m, scripts/plot/loglog.m, scripts/plot/loglogerr.m, scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshgrid.m, scripts/plot/meshz.m, scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m, scripts/plot/patch.m, scripts/plot/pcolor.m, scripts/plot/peaks.m, scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plot.m, scripts/plot/plot3.m, scripts/plot/plotmatrix.m, scripts/plot/plotyy.m, scripts/plot/polar.m, scripts/plot/print.m, scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/rectangle.m, scripts/plot/refresh.m, scripts/plot/refreshdata.m, scripts/plot/ribbon.m, scripts/plot/rose.m, scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/semilogx.m, scripts/plot/semilogxerr.m, scripts/plot/semilogy.m, scripts/plot/semilogyerr.m, scripts/plot/shading.m, scripts/plot/shg.m, scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/specular.m, scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/stem.m, scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m, scripts/plot/surf.m, scripts/plot/surface.m, scripts/plot/surfc.m, scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/text.m, scripts/plot/title.m, scripts/plot/trimesh.m, scripts/plot/triplot.m, scripts/plot/trisurf.m, scripts/plot/view.m, scripts/plot/waitbar.m, scripts/plot/waitforbuttonpress.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m, scripts/plot/xlabel.m, scripts/plot/xlim.m, scripts/plot/ylabel.m, scripts/plot/ylim.m, scripts/plot/zlabel.m, scripts/plot/zlim.m: Rewrite docstrings for most plot functions. Emphasize clarity, use common "voice", and increase density of seealso links.
author Rik <rik@octave.org>
date Wed, 31 Jul 2013 13:53:30 -0700
parents 5d3a684236b0
children df4c4b7708a4
comparison
equal deleted inserted replaced
17125:d4549655b92e 17126:eaab03308c0b
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} clabel (@var{c}, @var{h}) 20 ## @deftypefn {Function File} {} clabel (@var{c}, @var{h})
21 ## @deftypefnx {Function File} {} clabel (@var{c}, @var{h}, @var{v}) 21 ## @deftypefnx {Function File} {} clabel (@var{c}, @var{h}, @var{v})
22 ## @deftypefnx {Function File} {} clabel (@var{c}, @var{h}, "manual") 22 ## @deftypefnx {Function File} {} clabel (@var{c}, @var{h}, "manual")
23 ## @deftypefnx {Function File} {} clabel (@var{c}) 23 ## @deftypefnx {Function File} {} clabel (@var{c})
24 ## @deftypefnx {Function File} {} clabel (@var{c}, @var{h})
25 ## @deftypefnx {Function File} {} clabel (@dots{}, @var{prop}, @var{val}, @dots{}) 24 ## @deftypefnx {Function File} {} clabel (@dots{}, @var{prop}, @var{val}, @dots{})
26 ## @deftypefnx {Function File} {@var{h} =} clabel (@dots{}) 25 ## @deftypefnx {Function File} {@var{h} =} clabel (@dots{})
27 ## Add labels to the contours of a contour plot. The contour plot is specified 26 ## Add labels to the contours of a contour plot.
28 ## by the contour matrix @var{c} and optionally the contourgroup object @var{h} 27 ##
29 ## that are returned by @code{contour}, @code{contourf} and @code{contour3}. 28 ## The contour levels are specified by the contour matrix @var{c} which is
30 ## The contour labels are rotated and placed in the contour itself. 29 ## returned by @code{contour}, @code{contourc}, @code{contourf}, and
30 ## @code{contour3}. Contour labels are rotated to match the local line
31 ## orientation and centered on the line. The position of labels along the
32 ## contour line is chosen randomly.
33 ##
34 ## If the argument @var{h} is a handle to a contour group object, then label
35 ## this plot rather than the one in the current axes returned by @code{gca}.
31 ## 36 ##
32 ## By default, all contours are labeled. However, the contours to label can be 37 ## By default, all contours are labeled. However, the contours to label can be
33 ## specified by the vector @var{v}. If the "manual" argument is given then 38 ## specified by the vector @var{v}. If the "manual" argument is given then
34 ## the contours to label can be selected with the mouse. 39 ## the contours to label can be selected with the mouse.
35 ## 40 ##
36 ## Additional property/value pairs that are valid properties of text objects 41 ## Additional property/value pairs that are valid properties of text objects
37 ## can be given and are passed to the underlying text objects. Additionally, 42 ## can be given and are passed to the underlying text objects. Moreover,
38 ## the property "LabelSpacing" is available allowing the spacing between labels 43 ## the contour group property "LabelSpacing" is available which determines
39 ## on a contour (in points) to be specified. The default is 144 points, or 2 44 ## the spacing between labels on a contour to be specified. The default is
40 ## inches. 45 ## 144 points, or 2 inches.
41 ## 46 ##
42 ## The optional return value @var{h} is a vector of graphics handles to 47 ## The optional return value @var{h} is a vector of graphics handles to
43 ## the text objects representing each label. 48 ## the text objects representing each label.
44 ## The "userdata" property of the text objects contains the numerical value of 49 ## The "userdata" property of the text objects contains the numerical value of
45 ## the contour label. 50 ## the contour label.
55 ## 60 ##
56 ## @seealso{contour, contourf, contour3, meshc, surfc, text} 61 ## @seealso{contour, contourf, contour3, meshc, surfc, text}
57 ## @end deftypefn 62 ## @end deftypefn
58 63
59 function retval = clabel (c, varargin) 64 function retval = clabel (c, varargin)
65
60 label_spacing = 2 * 72; 66 label_spacing = 2 * 72;
61 have_hg = false; 67 have_hg = false;
62 have_labelspacing = false; 68 have_labelspacing = false;
63 69
64 if (nargin < 1) 70 if (nargin < 1)