Mercurial > octave-antonio

comparison doc/interpreter/plot.txi @ 8817:03b7f618ab3d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
include docstrings for new functions in the manual
author John W. Eaton <jwe@octave.org>
date Thu, 19 Feb 2009 15:39:19 -0500
parents 68aa5abfd136
children eb63fbe60fab
comparison
equal deleted inserted replaced
8816:a4a8f871be81 8817:03b7f618ab3d
68 @caption{Simple Two-Dimensional Plot.} 68 @caption{Simple Two-Dimensional Plot.}
69 @end float 69 @end float
70 70
71 @DOCSTRING(plot) 71 @DOCSTRING(plot)
72 72
73 The @code{plotyy} function may be used to create a plot with two
74 independent y axes.
75
76 @DOCSTRING(plotyy)
77
73 The functions @code{semilogx}, @code{semilogy}, and @code{loglog} are 78 The functions @code{semilogx}, @code{semilogy}, and @code{loglog} are
74 similar to the @code{plot} function, but produce plots in which one or 79 similar to the @code{plot} function, but produce plots in which one or
75 both of the axes use log scales. 80 both of the axes use log scales.
76 81
77 @DOCSTRING(semilogx) 82 @DOCSTRING(semilogx)
106 111
107 @DOCSTRING(stairs) 112 @DOCSTRING(stairs)
108 113
109 @DOCSTRING(stem) 114 @DOCSTRING(stem)
110 115
116 @DOCSTRING(stem3)
117
118 @DOCSTRING(scatter)
119
120 @DOCSTRING(scatter3)
121
122 @DOCSTRING(plotmatrix)
123
124 @DOCSTRING(pareto)
125
126 @DOCSTRING(rose)
127
111 The @code{contour}, @code{contourf} and @code{contourc} functions 128 The @code{contour}, @code{contourf} and @code{contourc} functions
112 produce two-dimensional contour plots from three dimensional data. 129 produce two-dimensional contour plots from three dimensional data.
113 130
114 @DOCSTRING(contour) 131 @DOCSTRING(contour)
115 132
116 @DOCSTRING(contourf) 133 @DOCSTRING(contourf)
117 134
118 @DOCSTRING(contourc) 135 @DOCSTRING(contourc)
136
137 @DOCSTRING(contour3)
119 138
120 The @code{errorbar}, @code{semilogxerr}, @code{semilogyerr}, and 139 The @code{errorbar}, @code{semilogxerr}, @code{semilogyerr}, and
121 @code{loglogerr} functions produce plots with error bar markers. For 140 @code{loglogerr} functions produce plots with error bar markers. For
122 example, 141 example,
123 142
165 184
166 @DOCSTRING(pie) 185 @DOCSTRING(pie)
167 186
168 @DOCSTRING(quiver) 187 @DOCSTRING(quiver)
169 188
189 @DOCSTRING(quiver3)
190
191 @DOCSTRING(compass)
192
193 @DOCSTRING(feather)
194
170 @DOCSTRING(pcolor) 195 @DOCSTRING(pcolor)
171 196
172 @DOCSTRING(area) 197 @DOCSTRING(area)
198
199 @DOCSTRING(comet)
173 200
174 The axis function may be used to change the axis limits of an existing 201 The axis function may be used to change the axis limits of an existing
175 plot and various other axis properties, such as the aspect ratio and the 202 plot and various other axis properties, such as the aspect ratio and the
176 appearance of tic marks. 203 appearance of tic marks.
177 204
179 206
180 Similarly the axis limits of the colormap can be changed with the caxis 207 Similarly the axis limits of the colormap can be changed with the caxis
181 function. 208 function.
182 209
183 @DOCSTRING(caxis) 210 @DOCSTRING(caxis)
211
212 The @code{xlim}, @code{ylim}, and @code{zlim} functions may be used to
213 get or set individual axis limits. Each has the same form.
214
215 @anchor{doc-ylim}
216 @anchor{doc-zlim}
217 @DOCSTRING(xlim)
184 218
185 @menu 219 @menu
186 * Two-dimensional Function Plotting:: 220 * Two-dimensional Function Plotting::
187 @end menu 221 @end menu
188 222
274 308
275 @DOCSTRING(mesh) 309 @DOCSTRING(mesh)
276 310
277 @DOCSTRING(meshc) 311 @DOCSTRING(meshc)
278 312
313 @DOCSTRING(meshz)
314
279 @DOCSTRING(hidden) 315 @DOCSTRING(hidden)
280 316
281 @DOCSTRING(surf) 317 @DOCSTRING(surf)
282 318
283 @DOCSTRING(surfc) 319 @DOCSTRING(surfc)
284 320
321 @DOCSTRING(surfl)
322
323 @DOCSTRING(surfnorm)
324
325 @DOCSTRING(diffuse)
326
327 @DOCSTRING(specular)
328
285 @DOCSTRING(meshgrid) 329 @DOCSTRING(meshgrid)
286 330
287 @DOCSTRING(ndgrid) 331 @DOCSTRING(ndgrid)
288 332
289 @DOCSTRING(plot3) 333 @DOCSTRING(plot3)
290 334
291 @DOCSTRING(view) 335 @DOCSTRING(view)
336
337 @DOCSTRING(slice)
338
339 @DOCSTRING(ribbon)
292 340
293 @DOCSTRING(shading) 341 @DOCSTRING(shading)
294 342
295 @menu 343 @menu
296 * Three-dimensional Function Plotting:: 344 * Three-dimensional Function Plotting::
345 * Three-dimensional Geometric Shapes::
297 @end menu 346 @end menu
298 347
299 @node Three-dimensional Function Plotting 348 @node Three-dimensional Function Plotting
300 @subsubsection Three-dimensional Function Plotting 349 @subsubsection Three-dimensional Function Plotting
301 350
306 @DOCSTRING(ezmeshc) 355 @DOCSTRING(ezmeshc)
307 356
308 @DOCSTRING(ezsurf) 357 @DOCSTRING(ezsurf)
309 358
310 @DOCSTRING(ezsurfc) 359 @DOCSTRING(ezsurfc)
360
361 @node Three-dimensional Geometric Shapes
362 @subsubsection Three-dimensional Geometric Shapes
363
364 @DOCSTRING(cylinder)
365
366 @DOCSTRING(sphere)
367
368 @DOCSTRING(ellipsoid)
311 369
312 @node Plot Annotations 370 @node Plot Annotations
313 @subsection Plot Annotations 371 @subsection Plot Annotations
314 372
315 You can add titles, axis labels, legends, and arbitrary text to an 373 You can add titles, axis labels, legends, and arbitrary text to an
340 See @ref{Text Properties} for the properties that you can set. 398 See @ref{Text Properties} for the properties that you can set.
341 399
342 @anchor{doc-ylabel} 400 @anchor{doc-ylabel}
343 @anchor{doc-zlabel} 401 @anchor{doc-zlabel}
344 @DOCSTRING(xlabel) 402 @DOCSTRING(xlabel)
403
404 @DOCSTRING(clabel)
345 405
346 @DOCSTRING(box) 406 @DOCSTRING(box)
347 407
348 @DOCSTRING(grid) 408 @DOCSTRING(grid)
349 409
506 To determine whether an object is a graphics object index or a figure 566 To determine whether an object is a graphics object index or a figure
507 index, use the functions @code{ishandle} and @code{isfigure}. 567 index, use the functions @code{ishandle} and @code{isfigure}.
508 568
509 @DOCSTRING(ishandle) 569 @DOCSTRING(ishandle)
510 570
571 @DOCSTRING(ishghandle)
572
511 @DOCSTRING(isfigure) 573 @DOCSTRING(isfigure)
512 574
513 The function @code{gcf} returns an index to the current figure object, 575 The function @code{gcf} returns an index to the current figure object,
514 or creates one if none exists. Similarly, @code{gca} returns the 576 or creates one if none exists. Similarly, @code{gca} returns the
515 current axes object, or creates one (and its parent figure object) if 577 current axes object, or creates one (and its parent figure object) if
593 @DOCSTRING(axes) 655 @DOCSTRING(axes)
594 656
595 @DOCSTRING(line) 657 @DOCSTRING(line)
596 658
597 @DOCSTRING(patch) 659 @DOCSTRING(patch)
660
661 @DOCSTRING(fill)
598 662
599 @DOCSTRING(surface) 663 @DOCSTRING(surface)
600 664
601 By default, Octave refreshes the plot window when a prompt is printed, 665 By default, Octave refreshes the plot window when a prompt is printed,
602 or when waiting for input. To force an update at other times, call the 666 or when waiting for input. To force an update at other times, call the
1506 property is used, the @code{addlistener} function is used to define a 1570 property is used, the @code{addlistener} function is used to define a
1507 callback function that is executed when the property is altered. 1571 callback function that is executed when the property is altered.
1508 1572
1509 @DOCSTRING(addlistener) 1573 @DOCSTRING(addlistener)
1510 1574
1575 @DOCSTRING(dellistener)
1576
1511 An example of the use of these two functions might be 1577 An example of the use of these two functions might be
1512 1578
1513 @example 1579 @example
1514 @group 1580 @group
1515 x = 0:0.1:10; 1581 x = 0:0.1:10;