Mercurial > hg > octave-max
diff scripts/plot/text.m @ 14001:5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
* voronoi.m, image.m, imagesc.m, imshow.m, area.m, bar.m, barh.m, clabel.m,
clf.m, compass.m, ezcontour.m, ezcontourf.m, ezmesh.m, ezmeshc.m, ezplot.m,
ezplot3.m, ezpolar.m, ezsurf.m, ezsurfc.m, feather.m, fill.m, findall.m,
findobj.m, loglog.m, mesh.m, pareto.m, patch.m, pie.m, pie3.m, plot.m, polar.m,
quiver.m, quiver3.m, rectangle.m, ribbon.m, rose.m, scatter.m, scatter3.m,
semilogx.m, semilogy.m, slice.m, stem.m, surf.m, surface.m, text.m, title.m,
trimesh.m, triplot.m, trisurf.m, xlabel.m, ylabel.m, zlabel.m:
Update documentation for functions returning a graphics handle h.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Tue, 06 Dec 2011 13:09:17 -0800 |
| parents | e81ddf9cacd5 |
| children | 72c96de7a403 |
line wrap: on
line diff
--- a/scripts/plot/text.m +++ b/scripts/plot/text.m @@ -17,13 +17,17 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{h} =} text (@var{x}, @var{y}, @var{label}) -## @deftypefnx {Function File} {@var{h} =} text (@var{x}, @var{y}, @var{z}, @var{label}) -## @deftypefnx {Function File} {@var{h} =} text (@var{x}, @var{y}, @var{label}, @var{p1}, @var{v1}, @dots{}) -## @deftypefnx {Function File} {@var{h} =} text (@var{x}, @var{y}, @var{z}, @var{label}, @var{p1}, @var{v1}, @dots{}) +## @deftypefn {Function File} {} text (@var{x}, @var{y}, @var{label}) +## @deftypefnx {Function File} {} text (@var{x}, @var{y}, @var{z}, @var{label}) +## @deftypefnx {Function File} {} text (@var{x}, @var{y}, @var{label}, @var{p1}, @var{v1}, @dots{}) +## @deftypefnx {Function File} {} text (@var{x}, @var{y}, @var{z}, @var{label}, @var{p1}, @var{v1}, @dots{}) +## @deftypefnx {Function File} {@var{h} =} text (@dots{}) ## Create a text object with text @var{label} at position @var{x}, ## @var{y}, @var{z} on the current axes. Property-value pairs following ## @var{label} may be used to specify the appearance of the text. +## +## The optional return value @var{h} is a graphics handle to the created text +## object. ## @end deftypefn ## Author: jwe @@ -134,17 +138,17 @@ %! text (x(nh), y(nv), "Hello World", ... %! "rotation", t, ... %! "horizontalalignment", ha{nh}, ... -%! "verticalalignment", va{nv}) +%! "verticalalignment", va{nv}); %! endfor %! endfor %! endfor %! set (gca, "xtick", [0.25, 0.5, 0.75], ... %! "xticklabel", ha, ... %! "ytick", [0.25, 0.5, 0.75], ... -%! "yticklabel", va) -%! axis ([0 1 0 1]) -%! xlabel ("horizontal alignment") -%! ylabel ("vertical alignment") +%! "yticklabel", va); +%! axis ([0 1 0 1]); +%! xlabel ("horizontal alignment"); +%! ylabel ("vertical alignment"); %! title ("text alignment and rotation (0:30:360 degrees)") %!demo @@ -156,20 +160,20 @@ %! text (25, 25, 0, "Vertical Alignment = Bottom", ... %! "rotation", t, ... %! "horizontalalignment", "left", ... -%! "verticalalignment", "bottom") +%! "verticalalignment", "bottom"); %! endfor -%! caxis ([-100 100]) -%! title ("Vertically Aligned at Bottom") +%! caxis ([-100 100]); +%! title ("Vertically Aligned at Bottom"); %!demo %! clf -%! axis ([0 8 0 8]) -%! title (["1st title";"2nd title"]) -%! xlabel (["1st xlabel";"2nd xlabel"]) -%! ylabel (["1st ylabel";"2nd ylabel"]) +%! axis ([0 8 0 8]); +%! title (["1st title";"2nd title"]); +%! xlabel (["1st xlabel";"2nd xlabel"]); +%! ylabel (["1st ylabel";"2nd ylabel"]); %! text (4, 4, {"Hello", "World"}, ... %! "horizontalalignment", "center", ... -%! "verticalalignment", "middle") +%! "verticalalignment", "middle"); %! grid on %!demo @@ -177,74 +181,74 @@ %! h = mesh (peaks, "edgecolor", 0.7 * [1 1 1], ... %! "facecolor", "none", ... %! "facealpha", 0); -%! title (["1st title";"2nd title"]) -%! xlabel (["1st xlabel";"2nd xlabel"]) -%! ylabel (["1st ylabel";"2nd ylabel"]) -%! zlabel (["1st zlabel";"2nd zlabel"]) +%! title (["1st title";"2nd title"]); +%! xlabel (["1st xlabel";"2nd xlabel"]); +%! ylabel (["1st ylabel";"2nd ylabel"]); +%! zlabel (["1st zlabel";"2nd zlabel"]); %! text (0, 0, 5, {"Hello", "World"}, ... %! "horizontalalignment", "center", ... -%! "verticalalignment", "middle") -%! hold on -%! plot3 (0, 0, 5, "+k") -%! +%! "verticalalignment", "middle"); +%! hold on; +%! plot3 (0, 0, 5, "+k"); %!demo %! clf %! h = text (0.5, 0.3, "char"); -%! assert ("char", class (get (h, "string"))) +%! assert ("char", class (get (h, "string"))); %! h = text (0.5, 0.4, ["char row 1"; "char row 2"]); -%! assert ("char", class (get (h, "string"))) +%! assert ("char", class (get (h, "string"))); %! h = text (0.5, 0.6, {"cell2str (1,1)", "cell2str (1,2)"; "cell2str (2,1)", "cell2str (2,2)"}); -%! assert ("cell", class (get (h, "string"))) +%! assert ("cell", class (get (h, "string"))); %! h = text (0.5, 0.8, "foobar"); -%! set (h, "string", 1:3) +%! set (h, "string", 1:3); %! h = text ([0.1, 0.1], [0.3, 0.4], "one string & two objects"); -%! assert ("char", class (get (h(1), "string"))) -%! assert ("char", class (get (h(2), "string"))) +%! assert ("char", class (get (h(1), "string"))); +%! assert ("char", class (get (h(2), "string"))); %! h = text ([0.1, 0.1], [0.5, 0.6], {"one cellstr & two objects"}); -%! assert ("cell", class (get (h(1), "string"))) -%! assert ("cell", class (get (h(2), "string"))) +%! assert ("cell", class (get (h(1), "string"))); +%! assert ("cell", class (get (h(2), "string"))); %! h = text ([0.1, 0.1], [0.7, 0.8], {"cellstr 1 object 1", "cellstr 2 object 2"}); -%! assert ("char", class (get (h(1), "string"))) -%! assert ("char", class (get (h(2), "string"))) +%! assert ("char", class (get (h(1), "string"))); +%! assert ("char", class (get (h(2), "string"))); %! h = text ([0.1, 0.1], [0.1, 0.2], ["1st string & 1st object"; "2nd string & 2nd object"]); -%! assert ("char", class (get (h(1), "string"))) -%! assert ("char", class (get (h(2), "string"))) +%! assert ("char", class (get (h(1), "string"))); +%! assert ("char", class (get (h(2), "string"))); %! h = text (0.7, 0.6, "single string"); -%! assert ("char", class (get (h, "string"))) +%! assert ("char", class (get (h, "string"))); %! h = text (0.7, 0.5, {"single cell-string"}); -%! assert ("cell", class (get (h, "string"))) -%! xlabel (1:2) -%! ylabel (1:2) -%! title (1:2) +%! assert ("cell", class (get (h, "string"))); +%! xlabel (1:2); +%! ylabel (1:2); +%! title (1:2); %!test %! hf = figure ("visible", "off"); %! unwind_protect %! h = text (0.5, 0.3, "char"); -%! assert ("char", class (get (h, "string"))) +%! assert ("char", class (get (h, "string"))); %! h = text (0.5, 0.4, ["char row 1"; "char row 2"]); -%! assert ("char", class (get (h, "string"))) +%! assert ("char", class (get (h, "string"))); %! h = text (0.5, 0.6, {"cell2str (1,1)", "cell2str (1,2)"; "cell2str (2,1)", "cell2str (2,2)"}); -%! assert ("cell", class (get (h, "string"))) +%! assert ("cell", class (get (h, "string"))); %! h = text (0.5, 0.8, "foobar"); -%! set (h, "string", 1:3) +%! set (h, "string", 1:3); %! h = text ([0.1, 0.1], [0.3, 0.4], "one string & two objects"); -%! assert ("char", class (get (h(1), "string"))) -%! assert ("char", class (get (h(2), "string"))) +%! assert ("char", class (get (h(1), "string"))); +%! assert ("char", class (get (h(2), "string"))); %! h = text ([0.1, 0.1], [0.5, 0.6], {"one cellstr & two objects"}); -%! assert ("cell", class (get (h(1), "string"))) -%! assert ("cell", class (get (h(2), "string"))) +%! assert ("cell", class (get (h(1), "string"))); +%! assert ("cell", class (get (h(2), "string"))); %! h = text ([0.1, 0.1], [0.7, 0.8], {"cellstr 1 object 1", "cellstr 2 object 2"}); -%! assert ("char", class (get (h(1), "string"))) -%! assert ("char", class (get (h(2), "string"))) +%! assert ("char", class (get (h(1), "string"))); +%! assert ("char", class (get (h(2), "string"))); %! h = text ([0.1, 0.1], [0.1, 0.2], ["1st string & 1st object"; "2nd string & 2nd object"]); -%! assert ("char", class (get (h(1), "string"))) -%! assert ("char", class (get (h(2), "string"))) +%! assert ("char", class (get (h(1), "string"))); +%! assert ("char", class (get (h(2), "string"))); %! h = text (0.7, 0.6, "single string"); -%! assert ("char", class (get (h, "string"))) +%! assert ("char", class (get (h, "string"))); %! h = text (0.7, 0.5, {"single cell-string"}); -%! assert ("cell", class (get (h, "string"))) +%! assert ("cell", class (get (h, "string"))); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect +