Mercurial > octave-nkf

comparison doc/interpreter/plot.txi @ 17097:e7a059a9a644

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer. Correctly use @xref, @pxref, @ref macros in documentation. * doc/interpreter/arith.txi, doc/interpreter/basics.txi, doc/interpreter/container.txi, doc/interpreter/debug.txi, doc/interpreter/diagperm.txi, doc/interpreter/eval.txi, doc/interpreter/external.txi, doc/interpreter/func.txi, doc/interpreter/install.txi, doc/interpreter/interp.txi, doc/interpreter/intro.txi, doc/interpreter/java.txi, doc/interpreter/matrix.txi, doc/interpreter/munge-texi.pl, doc/interpreter/numbers.txi, doc/interpreter/package.txi, doc/interpreter/plot.txi, doc/interpreter/sparse.txi, doc/interpreter/stats.txi, doc/interpreter/strings.txi, doc/interpreter/system.txi, doc/interpreter/var.txi, doc/interpreter/vectorize.txi, libinterp/corefcn/error.cc, libinterp/corefcn/qz.cc, libinterp/corefcn/regexp.cc, scripts/general/accumarray.m, scripts/general/structfun.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/setfield.m, scripts/miscellaneous/warning_ids.m, scripts/optimization/fminbnd.m, scripts/optimization/fzero.m, scripts/optimization/lsqnonneg.m: Use XREF as anchor prefix in documentation for clearer results in Info viewer. Correctly use @xref, @pxref, @ref macros in documentation. * scripts/plot/line.m: Remove extra ')' in @deftypefn. * libgui/src/qtinfo/parser.cc(find_ref): Change doc anchor search pattern to XREF.
author Rik <rik@octave.org>
date Sat, 27 Jul 2013 10:49:21 -0700
parents 5d08a2ec7edb
children a033fd3669c0
comparison
equal deleted inserted replaced
17096:33037eddecd2 17097:e7a059a9a644
32 @section Introduction to Plotting 32 @section Introduction to Plotting
33 33
34 Earlier versions of Octave provided plotting through the use of 34 Earlier versions of Octave provided plotting through the use of
35 gnuplot. This capability is still available. But, a newer plotting 35 gnuplot. This capability is still available. But, a newer plotting
36 capability is provided by access to OpenGL@. Which plotting system 36 capability is provided by access to OpenGL@. Which plotting system
37 is used is controlled by the @code{graphics_toolkit} function. (See 37 is used is controlled by the @code{graphics_toolkit} function.
38 @ref{Graphics Toolkits}.) 38 @xref{Graphics Toolkits}.
39 39
40 The function call @code{graphics_toolkit ("fltk")} selects the 40 The function call @code{graphics_toolkit ("fltk")} selects the
41 FLTK/OpenGL system, and @code{graphics_toolkit ("gnuplot")} selects the 41 FLTK/OpenGL system, and @code{graphics_toolkit ("gnuplot")} selects the
42 gnuplot system. The two systems may be used selectively through the use 42 gnuplot system. The two systems may be used selectively through the use
43 of the @code{graphics_toolkit} property of the graphics handle for each 43 of the @code{graphics_toolkit} property of the graphics handle for each
250 @DOCSTRING(caxis) 250 @DOCSTRING(caxis)
251 251
252 The @code{xlim}, @code{ylim}, and @code{zlim} functions may be used to 252 The @code{xlim}, @code{ylim}, and @code{zlim} functions may be used to
253 get or set individual axis limits. Each has the same form. 253 get or set individual axis limits. Each has the same form.
254 254
255 @anchor{docXylim} 255 @anchor{XREFylim}
256 @anchor{docXzlim} 256 @anchor{XREFzlim}
257 @DOCSTRING(xlim) 257 @DOCSTRING(xlim)
258 258
259 @node Two-dimensional Function Plotting 259 @node Two-dimensional Function Plotting
260 @subsubsection Two-dimensional Function Plotting 260 @subsubsection Two-dimensional Function Plotting
261 261
402 @node Aspect Ratio 402 @node Aspect Ratio
403 @subsubsection Aspect Ratio 403 @subsubsection Aspect Ratio
404 404
405 For three-dimensional plots the aspect ratio can be set for data with 405 For three-dimensional plots the aspect ratio can be set for data with
406 @code{daspect} and for the plot box with @code{pbaspect}. 406 @code{daspect} and for the plot box with @code{pbaspect}.
407 See @ref{Axis Configuration} for controlling the x-, y-, and z-limits for 407 @xref{Axis Configuration}, for controlling the x-, y-, and z-limits for
408 plotting. 408 plotting.
409 409
410 @DOCSTRING(daspect) 410 @DOCSTRING(daspect)
411 411
412 @DOCSTRING(pbaspect) 412 @DOCSTRING(pbaspect)
461 461
462 @DOCSTRING(text) 462 @DOCSTRING(text)
463 463
464 See @ref{Text Properties} for the properties that you can set. 464 See @ref{Text Properties} for the properties that you can set.
465 465
466 @anchor{docXylabel} 466 @anchor{XREFylabel}
467 @anchor{docXzlabel} 467 @anchor{XREFzlabel}
468 @DOCSTRING(xlabel) 468 @DOCSTRING(xlabel)
469 469
470 @DOCSTRING(clabel) 470 @DOCSTRING(clabel)
471 471
472 @DOCSTRING(box) 472 @DOCSTRING(box)
893 @end menu 893 @end menu
894 894
895 @node Introduction to Graphics Structures 895 @node Introduction to Graphics Structures
896 @subsection Introduction to Graphics Structures 896 @subsection Introduction to Graphics Structures
897 @cindex introduction to graphics structures 897 @cindex introduction to graphics structures
898 @anchor{docXgraphics structures} 898 @anchor{XREFgraphics structures}
899 899
900 The graphics functions use pointers, which are of class graphics_handle, in 900 The graphics functions use pointers, which are of class graphics_handle, in
901 order to address the data structures which control graphical displays. A 901 order to address the data structures which control graphical displays. A
902 graphics handle may point any one of a number of different object types. The 902 graphics handle may point any one of a number of different object types. The
903 objects are the graphics data structures. The types of objects are: 903 objects are the graphics data structures. The types of objects are:
913 function @code{fill} returns a handle pointing to an object of type patch, the 913 function @code{fill} returns a handle pointing to an object of type patch, the
914 functions @code{area}, @code{bar}, @code{barh}, @code{contour}, 914 functions @code{area}, @code{bar}, @code{barh}, @code{contour},
915 @code{contourf}, @code{contour3}, @code{surf}, @code{mesh}, @code{surfc}, 915 @code{contourf}, @code{contour3}, @code{surf}, @code{mesh}, @code{surfc},
916 @code{meshc}, @code{errorbar}, @code{quiver}, @code{quiver3}, @code{scatter}, 916 @code{meshc}, @code{errorbar}, @code{quiver}, @code{quiver3}, @code{scatter},
917 @code{scatter3}, @code{stair}, @code{stem}, @code{stem3} each return a handle 917 @code{scatter3}, @code{stair}, @code{stem}, @code{stem3} each return a handle
918 as documented in @ref{docXdatasources,, Data Sources}. 918 as documented in @ref{XREFdatasources,,Data Sources}.
919 919
920 920
921 The graphics objects are arranged in a hierarchy: 921 The graphics objects are arranged in a hierarchy:
922 922
923 1. The root is at 0. i.e., @code{get (0)} returns the properties of the root 923 1. The root is at 0. i.e., @code{get (0)} returns the properties of the root
930 4. Below the @code{axes} objects are 930 4. Below the @code{axes} objects are
931 @code{line}, @code{text}, @code{patch}, 931 @code{line}, @code{text}, @code{patch},
932 @code{surface}, and @code{image} objects. 932 @code{surface}, and @code{image} objects.
933 933
934 Graphics handles may be distinguished from function handles 934 Graphics handles may be distinguished from function handles
935 (@ref{Function Handles}) by means of the function @code{ishandle}. 935 (@pxref{Function Handles}) by means of the function @code{ishandle}.
936 @code{ishandle} returns true if its argument is a handle of a graphics object. 936 @code{ishandle} returns true if its argument is a handle of a graphics object.
937 In addition, the figure object may be tested using @code{isfigure}. 937 In addition, the figure object may be tested using @code{isfigure}.
938 @code{isfigure} returns true only if its argument is a handle of a figure. The 938 @code{isfigure} returns true only if its argument is a handle of a figure. The
939 @code{whos} function can be used to show the object type of each currently 939 @code{whos} function can be used to show the object type of each currently
940 defined graphics handle. (Note: this is not true today, but it is, I hope, 940 defined graphics handle. (Note: this is not true today, but it is, I hope,
996 996
997 The root figure has index 0. Its properties may be displayed by: 997 The root figure has index 0. Its properties may be displayed by:
998 @code{get (0, "")}. 998 @code{get (0, "")}.
999 999
1000 The uses of @code{get} and @code{set} are further explained in 1000 The uses of @code{get} and @code{set} are further explained in
1001 @ref{docXget,,get}, @ref{docXset,,set}. 1001 @ref{XREFget,,get}, @ref{XREFset,,set}.
1002 1002
1003 @DOCSTRING(isprop) 1003 @DOCSTRING(isprop)
1004 1004
1005 @node Graphics Objects 1005 @node Graphics Objects
1006 @subsection Graphics Objects 1006 @subsection Graphics Objects
1007 @cindex graphics objects 1007 @cindex graphics objects
1008 1008
1009 The hierarchy of graphics objects was explained above. (See 1009 The hierarchy of graphics objects was explained above.
1010 @ref{Introduction to Graphics Structures}. Here the 1010 @xref{Introduction to Graphics Structures}. Here the
1011 specific objects are described, and the properties contained in 1011 specific objects are described, and the properties contained in
1012 these objects are discussed. Keep in mind that 1012 these objects are discussed. Keep in mind that
1013 graphics objects are always referenced by @dfn{handle}. 1013 graphics objects are always referenced by @dfn{handle}.
1014 1014
1015 @table @asis 1015 @table @asis
1857 @item interruptible 1857 @item interruptible
1858 1858
1859 @item ldata 1859 @item ldata
1860 The lower errorbar in the y direction to be plotted. 1860 The lower errorbar in the y direction to be plotted.
1861 1861
1862 @item linestyle 1862 @item linestyle
1863 @itemx linewidth 1863 @itemx linewidth
1864 @xref{Line Styles}. 1864 @xref{Line Styles}.
1865 1865
1866 @item linewidth 1866 @item linewidth
1867 1867
2837 @end menu 2837 @end menu
2838 2838
2839 @node Data Sources in Object Groups 2839 @node Data Sources in Object Groups
2840 @subsubsection Data Sources in Object Groups 2840 @subsubsection Data Sources in Object Groups
2841 @cindex data sources in object groups 2841 @cindex data sources in object groups
2842 @anchor{docXdatasources} 2842 @anchor{XREFdatasources}
2843 All of the group objects contain data source parameters. There are 2843 All of the group objects contain data source parameters. There are
2844 string parameters that contain an expression that is evaluated to update 2844 string parameters that contain an expression that is evaluated to update
2845 the relevant data property of the group when the @code{refreshdata} 2845 the relevant data property of the group when the @code{refreshdata}
2846 function is called. 2846 function is called.
2847 2847
2848 @DOCSTRING(refreshdata) 2848 @DOCSTRING(refreshdata)
2849 2849
2850 @anchor{docXlinkdata} 2850 @anchor{XREFlinkdata}
2851 @c add the description of the linkdata function here when it is written 2851 @c add the description of the linkdata function here when it is written
2852 @c remove the explicit anchor when you add the corresponding @DOCSTRING 2852 @c remove the explicit anchor when you add the corresponding @DOCSTRING
2853 @c command 2853 @c command
2854 2854
2855 @node Area Series 2855 @node Area Series