comparison doc/interpreter/plot.txi @ 10828:322f43e0e170

Grammarcheck .txi documentation files.
author Rik <octave@nomad.inbox5.com>
date Wed, 28 Jul 2010 12:45:04 -0700
parents fbd7843974fa
children a4f482e66b65
comparison
equal deleted inserted replaced
10827:228cd18455a6 10828:322f43e0e170
32 @node Introduction to Plotting 32 @node Introduction to Plotting
33 @section Introduction to Plotting 33 @section Introduction to Plotting
34 34
35 Earlier versions of Octave provided plotting through the use of 35 Earlier versions of Octave provided plotting through the use of
36 gnuplot. This capability is still available. But, a newer plotting 36 gnuplot. This capability is still available. But, a newer plotting
37 capability is provided by access to OpenGL. Which plotting system 37 capability is provided by access to OpenGL@. Which plotting system
38 is used is controlled by the @code{backend} function. (See @ref{Graphics Backends}.) 38 is used is controlled by the @code{backend} function. (See @ref{Graphics
39 Backends}.)
39 40
40 The function call @code{backend("fltk")} selects the fltk/OpenGL system, and 41 The function call @code{backend("fltk")} selects the fltk/OpenGL system, and
41 @code{backend("gnuplot")} selects the gnuplot system. 42 @code{backend("gnuplot")} selects the gnuplot system.
42 The two systems may be used selectively through the use of the @code{backend} 43 The two systems may be used selectively through the use of the @code{backend}
43 property of the graphics handle for each figure. This is 44 property of the graphics handle for each figure. This is
299 300
300 The @code{meshc} function is similar to @code{mesh}, but also produces a 301 The @code{meshc} function is similar to @code{mesh}, but also produces a
301 plot of contours for the surface. 302 plot of contours for the surface.
302 303
303 The @code{plot3} function displays arbitrary three-dimensional data, 304 The @code{plot3} function displays arbitrary three-dimensional data,
304 without requiring it to form a surface. For example 305 without requiring it to form a surface. For example,
305 306
306 @example 307 @example
307 @group 308 @group
308 t = 0:0.1:10*pi; 309 t = 0:0.1:10*pi;
309 r = linspace (0, 1, numel (t)); 310 r = linspace (0, 1, numel (t));
315 @noindent 316 @noindent
316 displays the spiral in three dimensions shown in @ref{fig:plot3}. 317 displays the spiral in three dimensions shown in @ref{fig:plot3}.
317 318
318 @float Figure,fig:plot3 319 @float Figure,fig:plot3
319 @center @image{plot3,4in} 320 @center @image{plot3,4in}
320 @caption{Three dimensional spiral.} 321 @caption{Three-dimensional spiral.}
321 @end float 322 @end float
322 323
323 Finally, the @code{view} function changes the viewpoint for 324 Finally, the @code{view} function changes the viewpoint for
324 three-dimensional plots. 325 three-dimensional plots.
325 326
388 389
389 @node Plot Annotations 390 @node Plot Annotations
390 @subsection Plot Annotations 391 @subsection Plot Annotations
391 392
392 You can add titles, axis labels, legends, and arbitrary text to an 393 You can add titles, axis labels, legends, and arbitrary text to an
393 existing plot. For example, 394 existing plot. For example:
394 395
395 @example 396 @example
396 @group 397 @group
397 x = -10:0.1:10; 398 x = -10:0.1:10;
398 plot (x, sin (x)); 399 plot (x, sin (x));
456 457
457 @node Multiple Plot Windows 458 @node Multiple Plot Windows
458 @subsection Multiple Plot Windows 459 @subsection Multiple Plot Windows
459 460
460 You can open multiple plot windows using the @code{figure} function. 461 You can open multiple plot windows using the @code{figure} function.
461 For example 462 For example,
462 463
463 @example 464 @example
464 @group 465 @group
465 figure (1); 466 figure (1);
466 fplot (@@sin, [-10, 10]); 467 fplot (@@sin, [-10, 10]);
573 @item @tab \sl @tab Oblique Font @tab 574 @item @tab \sl @tab Oblique Font @tab
574 @item @tab \rm @tab Normal font @tab 575 @item @tab \rm @tab Normal font @tab
575 @end multitable 576 @end multitable
576 577
577 These are be used in conjunction with the @{ and @} characters to limit 578 These are be used in conjunction with the @{ and @} characters to limit
578 the change in the font to part of the string. For example 579 the change in the font to part of the string. For example,
579 580
580 @example 581 @example
581 xlabel ('@{\bf H@} = a @{\bf V@}') 582 xlabel ('@{\bf H@} = a @{\bf V@}')
582 @end example 583 @end example
583 584
860 @code{surface}, @code{text} and @code{image}. 861 @code{surface}, @code{text} and @code{image}.
861 862
862 Each of these objects has a function by the 863 Each of these objects has a function by the
863 same name. and, each of these functions returns a graphics handle pointing 864 same name. and, each of these functions returns a graphics handle pointing
864 to an object of corresponding type. In addition there are several functions 865 to an object of corresponding type. In addition there are several functions
865 which operate on properties of the graphics objects and which return handles: the functions @code{ plot} 866 which operate on properties of the graphics objects and which return handles:
866 and @code{plot3} 867 the functions @code{ plot} and @code{plot3} return a handle pointing to an
867 return a handle pointing to an object of type line, the function @code{subplot} 868 object of type line, the function @code{subplot} returns a handle pointing to an
868 returns a handle pointing to an object of type axes, the function @code{fill} returns a 869 object of type axes, the function @code{fill} returns a handle pointing to an
869 handle pointing to an object of type patch, the functions @code{area}, @code{bar}, 870 object of type patch, the functions @code{area}, @code{bar},
870 @code{barh}, @code{contour}, @code{contourf}, @code{contour3}, @code{surf}, @code{mesh}, 871 @code{barh}, @code{contour}, @code{contourf}, @code{contour3}, @code{surf}, @code{mesh},
871 @code{surfc}, @code{meshc}, 872 @code{surfc}, @code{meshc},
872 @code{errorbar}, @code{quiver}, @code{quiver3}, @code{scatter}, @code{scatter3}, 873 @code{errorbar}, @code{quiver}, @code{quiver3}, @code{scatter}, @code{scatter3},
873 @code{stair}, @code{stem}, @code{stem3} each return a handle as documented 874 @code{stair}, @code{stem}, @code{stem3} each return a handle as documented
874 in @ref{doc-datasources,, Data Sources}. 875 in @ref{doc-datasources,, Data Sources}.
885 886
886 4. Below the @code{axes} objects are 887 4. Below the @code{axes} objects are
887 @code{line}, @code{text}, @code{patch}, 888 @code{line}, @code{text}, @code{patch},
888 @code{surface}, and @code{image} objects. 889 @code{surface}, and @code{image} objects.
889 890
890 Graphics handles may be distinguished from function handles (@ref{Function Handles}) 891 Graphics handles may be distinguished from function handles (@ref{Function
891 by means of the function @code{ishandle()}. @code{ishandle} returns true if its 892 Handles}) by means of the function @code{ishandle()}. @code{ishandle} returns
892 argument is a handle of a graphics object. In addition, the figure object 893 true if its argument is a handle of a graphics object. In addition, the figure
893 may be tested using @code{isfigure()}. @code{isfigure} returns true only if its 894 object may be tested using @code{isfigure()}. @code{isfigure} returns true only
894 argument is a handle of a figure. 895 if its argument is a handle of a figure. ishghandle() is synonymous with
895 ishghandle() is synonymous with ishandle(). The @code{whos} function can be used 896 ishandle(). The @code{whos} function can be used to show the object type of
896 to show the object type of each currently defined graphics handle. (Note: this is 897 each currently defined graphics handle. (Note: this is not true today, but it
897 not true today, but it is, I hope, considered an error in whos. It may be better 898 is, I hope, considered an error in whos. It may be better to have whos just
898 to have whos just show graphics_handle as the class, and provide a new function 899 show graphics_handle as the class, and provide a new function which, given a
899 which, given a graphics handle, returns its object type. This could generalize 900 graphics handle, returns its object type. This could generalize the ishandle()
900 the ishandle() functions and, in fact, replace them.) 901 functions and, in fact, replace them.)
901 902
902 The @code{get} and @code{set} commands are 903 The @code{get} and @code{set} commands are
903 used to obtain and set the values of properties of graphics objects. In addition, 904 used to obtain and set the values of properties of graphics objects. In
904 the @code{get} command may be used to obtain property names. 905 addition, the @code{get} command may be used to obtain property names.
905 906
906 For example, the property "type" of the graphics object pointed to by the graphics 907 For example, the property "type" of the graphics object pointed to by the
907 handle h may be displayed by: 908 graphics handle h may be displayed by:
908 909
909 @code{get(h, "type")} 910 @code{get(h, "type")}
910 911
911 The properties and their current values are returned by @code{get(h)} 912 The properties and their current values are returned by @code{get(h)}
912 where h is a handle of a graphics object. If only the names of the 913 where h is a handle of a graphics object. If only the names of the
1168 1169
1169 The @code{root figure} properties are: 1170 The @code{root figure} properties are:
1170 @table @code 1171 @table @code
1171 @item __modified__ 1172 @item __modified__
1172 --- Values: "on," "off" 1173 --- Values: "on," "off"
1174
1173 @item __myhandle__ 1175 @item __myhandle__
1176
1174 @item beingdeleted 1177 @item beingdeleted
1175 --- Values: "on," "off" 1178 --- Values: "on," "off"
1179
1176 @item busyaction 1180 @item busyaction
1181
1177 @item buttondownfcn 1182 @item buttondownfcn
1183
1178 @item callbackobject 1184 @item callbackobject
1185
1179 @item children 1186 @item children
1187
1180 @item clipping 1188 @item clipping
1181 --- Values: "on," "off" 1189 --- Values: "on," "off"
1190
1182 @item createfcn 1191 @item createfcn
1192
1183 @item currentfigure 1193 @item currentfigure
1194
1184 @item deletefcn 1195 @item deletefcn
1196
1185 @item handlevisibility 1197 @item handlevisibility
1186 --- Values: "on," "off" 1198 --- Values: "on," "off"
1199
1187 @item hittest 1200 @item hittest
1188 --- Values: "on," "off" 1201 --- Values: "on," "off"
1202
1189 @item interruptible 1203 @item interruptible
1190 --- Values: "on," "off" 1204 --- Values: "on," "off"
1205
1191 @item parent 1206 @item parent
1207
1192 @item screendepth 1208 @item screendepth
1209
1193 @item screenpixelsperinch 1210 @item screenpixelsperinch
1211
1194 @item screensize 1212 @item screensize
1213
1195 @item selected 1214 @item selected
1215
1196 @item selectionhighlight 1216 @item selectionhighlight
1217
1197 @item screendepth 1218 @item screendepth
1219
1198 @item screenpixelsperinch 1220 @item screenpixelsperinch
1221
1199 @item showhiddenhandles 1222 @item showhiddenhandles
1200 --- Values: "on," "off" 1223 --- Values: "on," "off"
1224
1201 @item tag 1225 @item tag
1226
1202 @item type 1227 @item type
1228
1203 @item uicontextmenu 1229 @item uicontextmenu
1230
1204 @item units 1231 @item units
1232
1205 @item userdata 1233 @item userdata
1234
1206 @item visible 1235 @item visible
1207 @end table 1236 @end table
1208 1237
1209 @node Figure Properties 1238 @node Figure Properties
1210 @subsubsection Figure Properties 1239 @subsubsection Figure Properties
1212 1241
1213 The @code{figure} properties are: 1242 The @code{figure} properties are:
1214 @table @code 1243 @table @code
1215 @item __backend__ 1244 @item __backend__
1216 --- The backend currently in use. 1245 --- The backend currently in use.
1246
1217 @item __enhanced__ 1247 @item __enhanced__
1248
1218 @item __modified__ 1249 @item __modified__
1250
1219 @item __myhandle__ 1251 @item __myhandle__
1252
1220 @item __plot_stream__ 1253 @item __plot_stream__
1254
1221 @item alphamap 1255 @item alphamap
1256
1222 @item beingdeleted 1257 @item beingdeleted
1223 --- Values: "on," "off" 1258 --- Values: "on," "off"
1259
1224 @item busyaction 1260 @item busyaction
1261
1225 @item buttondownfcn 1262 @item buttondownfcn
1263
1226 @item children 1264 @item children
1227 Handle to children. 1265 Handle to children.
1266
1228 @item clipping 1267 @item clipping
1229 --- Values: "on," "off" 1268 --- Values: "on," "off"
1269
1230 @item closerequestfcn 1270 @item closerequestfcn
1231 --- Handle of function to call on close. 1271 --- Handle of function to call on close.
1272
1232 @item color 1273 @item color
1274
1233 @item colormap 1275 @item colormap
1234 An N-by-3 matrix containing the color map for the current axes. 1276 An N-by-3 matrix containing the color map for the current axes.
1277
1235 @item paperorientation 1278 @item paperorientation
1279
1236 @item createfcn 1280 @item createfcn
1281
1237 @item currentaxes 1282 @item currentaxes
1238 Handle to graphics object of current axes. 1283 Handle to graphics object of current axes.
1284
1239 @item currentcharacter 1285 @item currentcharacter
1286
1240 @item currentobject 1287 @item currentobject
1288
1241 @item currentpoint 1289 @item currentpoint
1242 Holds the coordinates of the point over which the mouse pointer was when 1290 Holds the coordinates of the point over which the mouse pointer was when
1243 the mouse button was pressed. If a mouse callback function is defined, 1291 the mouse button was pressed. If a mouse callback function is defined,
1244 @code{"currentpoint"} holds the coordinates of the point over which the 1292 @code{"currentpoint"} holds the coordinates of the point over which the
1245 mouse pointer is when the function gets called. 1293 mouse pointer is when the function gets called.
1294
1246 @item deletefcn 1295 @item deletefcn
1296
1247 @item dockcontrols 1297 @item dockcontrols
1248 --- Values: "on," "off" 1298 --- Values: "on," "off"
1299
1249 @item doublebuffer 1300 @item doublebuffer
1250 --- Values: "on," "off" 1301 --- Values: "on," "off"
1302
1251 @item filename 1303 @item filename
1304
1252 @item handlevisibility 1305 @item handlevisibility
1253 --- Values: "on," "off" 1306 --- Values: "on," "off"
1307
1254 @item hittest 1308 @item hittest
1309
1255 @item integerhandle 1310 @item integerhandle
1311
1256 @item interruptible 1312 @item interruptible
1257 --- Values: "on," "off" 1313 --- Values: "on," "off"
1314
1258 @item inverthardcopy 1315 @item inverthardcopy
1316
1259 @item keypressfcn 1317 @item keypressfcn
1260 see @code{"keypressfcn"} 1318 see @code{"keypressfcn"}
1319
1261 @item keyreleasefcn 1320 @item keyreleasefcn
1262 With @code{"keypressfcn"}, The keyboard callback functions. These 1321 With @code{"keypressfcn"}, The keyboard callback functions. These
1263 callback functions get called when a key is pressed/released 1322 callback functions get called when a key is pressed/released
1264 respectively. The functions are called with two input arguments. The 1323 respectively. The functions are called with two input arguments. The
1265 first argument holds the handle of the calling figure. The second 1324 first argument holds the handle of the calling figure. The second
1266 argument holds the event structure which has the following members: 1325 argument holds the event structure which has the following members:
1267 @table @code 1326 @table @code
1268 @item Character 1327 @item Character
1269 The ASCII value of the key 1328 The ASCII value of the key
1329
1270 @item Key 1330 @item Key
1271 lowercase value of the key 1331 lowercase value of the key
1332
1272 @item Modifier 1333 @item Modifier
1273 A cell array containing strings representing the modifiers pressed with 1334 A cell array containing strings representing the modifiers pressed with
1274 the key. Possible values are @code{"shift"}, @code{"alt"}, and 1335 the key. Possible values are @code{"shift"}, @code{"alt"}, and
1275 @code{"control"}. 1336 @code{"control"}.
1276 @end table 1337 @end table
1338
1277 @item menubar 1339 @item menubar
1340
1278 @item mincolormap 1341 @item mincolormap
1342
1279 @item name 1343 @item name
1344
1280 @item nextplot 1345 @item nextplot
1281 May be one of 1346 May be one of
1282 @table @code 1347 @table @code
1283 @item "new" 1348 @item "new"
1349
1284 @item "add" 1350 @item "add"
1351
1285 @item "replace" 1352 @item "replace"
1353
1286 @item "replacechildren" 1354 @item "replacechildren"
1287 @end table 1355 @end table
1356
1288 @item numbertitle 1357 @item numbertitle
1358
1289 @item paperorientation 1359 @item paperorientation
1290 Indicates the orientation for printing. Either @code{"landscape"} or 1360 Indicates the orientation for printing. Either @code{"landscape"} or
1291 @code{"portrait"}. 1361 @code{"portrait"}.
1362
1292 @item paperposition 1363 @item paperposition
1364
1293 @item paperpositionmode 1365 @item paperpositionmode
1366
1294 @item papersize 1367 @item papersize
1368
1295 @item papertype 1369 @item papertype
1370
1296 @item paperunits 1371 @item paperunits
1372
1297 @item pointer 1373 @item pointer
1374
1298 @item pointershapecdata 1375 @item pointershapecdata
1376
1299 @item pointershapehotspot 1377 @item pointershapehotspot
1378
1300 @item position 1379 @item position
1380
1301 @item renderer 1381 @item renderer
1382
1302 @item renderermode 1383 @item renderermode
1384
1303 @item resize 1385 @item resize
1386
1304 @item resizefcn 1387 @item resizefcn
1388
1305 @item selected 1389 @item selected
1390
1306 @item selectionhighlight 1391 @item selectionhighlight
1307 --- Values: "on," "off" 1392 --- Values: "on," "off"
1393
1308 @item selectiontype 1394 @item selectiontype
1395
1309 @item tag 1396 @item tag
1397
1310 @item toolbar 1398 @item toolbar
1399
1311 @item type 1400 @item type
1401
1312 @item units 1402 @item units
1403
1313 @item userdata 1404 @item userdata
1405
1314 @item visible 1406 @item visible
1315 Either @code{"on"} or @code{"off"} to toggle display of the figure. 1407 Either @code{"on"} or @code{"off"} to toggle display of the figure.
1408
1316 @item windowbuttondownfcn 1409 @item windowbuttondownfcn
1317 See @code{"windowbuttonupfcn"} 1410 See @code{"windowbuttonupfcn"}
1411
1318 @item windowbuttonmotionfcn 1412 @item windowbuttonmotionfcn
1319 See @code{"windowbuttonupfcn"} 1413 See @code{"windowbuttonupfcn"}
1414
1320 @item windowbuttonupfcn 1415 @item windowbuttonupfcn
1321 With @code{"windowbuttondownfcn"} and @code{"windowbuttonmotionfcn"}, 1416 With @code{"windowbuttondownfcn"} and @code{"windowbuttonmotionfcn"},
1322 The mouse callback functions. These callback functions get called when 1417 The mouse callback functions. These callback functions get called when
1323 the mouse button is pressed, dragged, and released respectively. When 1418 the mouse button is pressed, dragged, and released respectively. When
1324 these callback functions are called, the @code{"currentpoint"} property 1419 these callback functions are called, the @code{"currentpoint"} property
1325 holds the current coordinates of the cursor. 1420 holds the current coordinates of the cursor.
1421
1326 @item windowbuttonwheelfcn 1422 @item windowbuttonwheelfcn
1423
1327 @item windowstyle 1424 @item windowstyle
1425
1328 @item wvisual 1426 @item wvisual
1427
1329 @item wvisualmode 1428 @item wvisualmode
1429
1330 @item xdisplay 1430 @item xdisplay
1431
1331 @item xvisual 1432 @item xvisual
1433
1332 @item xvisualmode 1434 @item xvisualmode
1333 @end table 1435 @end table
1334 1436
1335 @node Axes Properties 1437 @node Axes Properties
1336 @subsubsection Axes Properties 1438 @subsubsection Axes Properties
1337 @cindex axes properties 1439 @cindex axes properties
1338 1440
1339 The @code{axes} properties are: 1441 The @code{axes} properties are:
1340 @table @code 1442 @table @code
1341 @item __modified__ 1443 @item __modified__
1444
1342 @item __myhandle__ 1445 @item __myhandle__
1446
1343 @item activepositionproperty 1447 @item activepositionproperty
1448
1344 @item alim 1449 @item alim
1450
1345 @item alimmode 1451 @item alimmode
1452
1346 @item ambientlightcolor 1453 @item ambientlightcolor
1454
1347 @item beingdeleted 1455 @item beingdeleted
1456
1348 @item box 1457 @item box
1349 Box surrounding axes. 1458 Box surrounding axes.
1350 --- Values: "on," "off" 1459 --- Values: "on," "off"
1460
1351 @item busyaction 1461 @item busyaction
1462
1352 @item buttondownfcn 1463 @item buttondownfcn
1464
1353 @item cameraposition 1465 @item cameraposition
1466
1354 @item camerapositionmode 1467 @item camerapositionmode
1468
1355 @item cameratarget 1469 @item cameratarget
1470
1356 @item cameratargetmode 1471 @item cameratargetmode
1472
1357 @item cameraupvector 1473 @item cameraupvector
1474
1358 @item cameraupvectormode 1475 @item cameraupvectormode
1476
1359 @item cameraviewangle 1477 @item cameraviewangle
1478
1360 @item cameraviewanglemode 1479 @item cameraviewanglemode
1480
1361 @item children 1481 @item children
1482
1362 @item clim 1483 @item clim
1363 Two-element vector defining the limits for the c axis of 1484 Two-element vector defining the limits for the c axis of
1364 an image. See @code{pcolor} property. 1485 an image. See @code{pcolor} property.
1365 Setting this property also forces the corresponding mode 1486 Setting this property also forces the corresponding mode
1366 property to be set to @code{"manual"}. 1487 property to be set to @code{"manual"}.
1488
1367 @item climmode 1489 @item climmode
1368 Either @code{"manual"} or @code{"auto"}. 1490 Either @code{"manual"} or @code{"auto"}.
1491
1369 @item clipping 1492 @item clipping
1493
1370 @item color 1494 @item color
1495
1371 @item colororder 1496 @item colororder
1497
1372 @item createfcn 1498 @item createfcn
1499
1373 @item currentpoint 1500 @item currentpoint
1374 Holds the coordinates of the point over which the mouse pointer was when 1501 Holds the coordinates of the point over which the mouse pointer was when
1375 the mouse button was pressed. If a mouse callback function is defined, 1502 the mouse button was pressed. If a mouse callback function is defined,
1376 @code{"currentpoint"} holds the coordinates of the point over which the 1503 @code{"currentpoint"} holds the coordinates of the point over which the
1377 mouse pointer is when the function gets called. 1504 mouse pointer is when the function gets called.
1505
1378 @item dataaspectratio 1506 @item dataaspectratio
1379 A two-element vector specifying the relative height and width of the 1507 A two-element vector specifying the relative height and width of the
1380 data displayed in the axes. Setting @code{dataaspectratio} to @samp{1, 1508 data displayed in the axes. Setting @code{dataaspectratio} to @samp{1,
1381 2]} causes the length of one unit as displayed on the y-axis to be the 1509 2]} causes the length of one unit as displayed on the y-axis to be the
1382 same as the length of 2 units on the x-axis. Setting 1510 same as the length of 2 units on the x-axis. Setting
1383 @code{dataaspectratio} also forces the @code{dataaspectratiomode} 1511 @code{dataaspectratio} also forces the @code{dataaspectratiomode}
1384 property to be set to @code{"manual"}. 1512 property to be set to @code{"manual"}.
1513
1385 @item dataaspectratiomode 1514 @item dataaspectratiomode
1386 Either @code{"manual"} or @code{"auto"}. 1515 Either @code{"manual"} or @code{"auto"}.
1516
1387 @item deletefcn 1517 @item deletefcn
1518
1388 @item drawmode 1519 @item drawmode
1520
1389 @item fontangle 1521 @item fontangle
1522
1390 @item fontname 1523 @item fontname
1524
1391 @item fontsize 1525 @item fontsize
1526
1392 @item fontunits 1527 @item fontunits
1528
1393 @item fontweight 1529 @item fontweight
1530
1394 @item gridlinestyle 1531 @item gridlinestyle
1532
1395 @item handlevisibility 1533 @item handlevisibility
1534
1396 @item hittest 1535 @item hittest
1536
1397 @item interpreter 1537 @item interpreter
1538
1398 @item interruptible 1539 @item interruptible
1540
1399 @item key 1541 @item key
1400 Toggle display of the legend. --- Values: "on," "off" 1542 Toggle display of the legend. --- Values: "on," "off"
1401 Note that this property is not compatible with @sc{matlab} and may be 1543 Note that this property is not compatible with @sc{matlab} and may be
1402 removed in a future version of Octave. 1544 removed in a future version of Octave.
1545
1403 @item keybox 1546 @item keybox
1404 Toggle display of a box around the 1547 Toggle display of a box around the
1405 legend. --- Values: "on," "off" 1548 legend. --- Values: "on," "off"
1406 Note that this property is not compatible with @sc{matlab} and 1549 Note that this property is not compatible with @sc{matlab} and
1407 may be removed in a future version of Octave. 1550 may be removed in a future version of Octave.
1551
1408 @item keypos 1552 @item keypos
1409 An integer from 1 to 4 specifying the position of the legend. 1 1553 An integer from 1 to 4 specifying the position of the legend. 1
1410 indicates upper right corner, 2 indicates upper left, 3 indicates lower 1554 indicates upper right corner, 2 indicates upper left, 3 indicates lower
1411 left, and 4 indicates lower right. Note that this property is not 1555 left, and 4 indicates lower right. Note that this property is not
1412 compatible with @sc{matlab} and may be removed in a future version of 1556 compatible with @sc{matlab} and may be removed in a future version of
1413 Octave. 1557 Octave.
1558
1414 @item keyreverse 1559 @item keyreverse
1560
1415 @item layer 1561 @item layer
1562
1416 @item linestyleorder 1563 @item linestyleorder
1564
1417 @item linewidth 1565 @item linewidth
1566
1418 @item minorgridlinestyle 1567 @item minorgridlinestyle
1568
1419 @item nextplot 1569 @item nextplot
1420 May be one of 1570 May be one of
1421 @table @code 1571 @table @code
1422 @item "new" 1572 @item "new"
1573
1423 @item "add" 1574 @item "add"
1575
1424 @item "replace" 1576 @item "replace"
1577
1425 @item "replacechildren" 1578 @item "replacechildren"
1426 @end table 1579 @end table
1580
1427 @item outerposition 1581 @item outerposition
1428 A vector specifying the position of the plot, including titles, axes and 1582 A vector specifying the position of the plot, including titles, axes and
1429 legend. The four elements of the vector are the coordinates of the 1583 legend. The four elements of the vector are the coordinates of the
1430 lower left corner and width and height of the plot, in units normalized 1584 lower left corner and width and height of the plot, in units normalized
1431 to the width and height of the plot window. For example, @code{[0.2, 1585 to the width and height of the plot window. For example, @code{[0.2,
1432 0.3, 0.4, 0.5]} sets the lower left corner of the axes at @math{(0.2, 1586 0.3, 0.4, 0.5]} sets the lower left corner of the axes at @math{(0.2,
1433 0.3)} and the width and height to be 0.4 and 0.5 respectively. See also 1587 0.3)} and the width and height to be 0.4 and 0.5 respectively. See also
1434 the @code{position} property. 1588 the @code{position} property.
1589
1435 @item parent 1590 @item parent
1591
1436 @item plotboxaspectratio 1592 @item plotboxaspectratio
1593
1437 @item plotboxaspectratiomode 1594 @item plotboxaspectratiomode
1595
1438 @item position 1596 @item position
1439 A vector specifying the position of the plot, excluding titles, axes and 1597 A vector specifying the position of the plot, excluding titles, axes and
1440 legend. The four elements of the vector are the coordinates of the 1598 legend. The four elements of the vector are the coordinates of the
1441 lower left corner and width and height of the plot, in units normalized 1599 lower left corner and width and height of the plot, in units normalized
1442 to the width and height of the plot window. For example, @code{[0.2, 1600 to the width and height of the plot window. For example, @code{[0.2,
1443 0.3, 0.4, 0.5]} sets the lower left corner of the axes at @math{(0.2, 1601 0.3, 0.4, 0.5]} sets the lower left corner of the axes at @math{(0.2,
1444 0.3)} and the width and height to be 0.4 and 0.5 respectively. See also 1602 0.3)} and the width and height to be 0.4 and 0.5 respectively. See also
1445 the @code{outerposition} property. 1603 the @code{outerposition} property.
1604
1446 @item projection 1605 @item projection
1606
1447 @item selected 1607 @item selected
1608
1448 @item selectionhighlight 1609 @item selectionhighlight
1610
1449 @item tag 1611 @item tag
1612
1450 @item tickdir 1613 @item tickdir
1614
1451 @item tickdirmode 1615 @item tickdirmode
1616
1452 @item ticklength 1617 @item ticklength
1618
1453 @item tightinset 1619 @item tightinset
1620
1454 @item title 1621 @item title
1455 Index of text object for the axes title. 1622 Index of text object for the axes title.
1623
1456 @item type 1624 @item type
1625
1457 @item uicontextmenu 1626 @item uicontextmenu
1627
1458 @item units 1628 @item units
1629
1459 @item userdata 1630 @item userdata
1631
1460 @item view 1632 @item view
1461 A three element vector specifying the view point for three-dimensional plots. 1633 A three element vector specifying the view point for three-dimensional plots.
1634
1462 @item visible 1635 @item visible
1463 Either @code{"on"} or @code{"off"} to toggle display of the axes. 1636 Either @code{"on"} or @code{"off"} to toggle display of the axes.
1637
1464 @item x_normrendertransform 1638 @item x_normrendertransform
1639
1465 @item x_projectiontransform 1640 @item x_projectiontransform
1641
1466 @item x_rendertransform 1642 @item x_rendertransform
1643
1467 @item x_viewporttransform 1644 @item x_viewporttransform
1645
1468 @item x_viewtransform 1646 @item x_viewtransform
1647
1469 @item xaxislocation 1648 @item xaxislocation
1470 Either @code{"top"} or @code{"bottom"}. 1649 Either @code{"top"} or @code{"bottom"}.
1650
1471 @item xcolor 1651 @item xcolor
1652
1472 @item xdir 1653 @item xdir
1473 Either @code{"forward"} or @code{"reverse"}. 1654 Either @code{"forward"} or @code{"reverse"}.
1655
1474 @item xgrid 1656 @item xgrid
1475 Either @code{"on"} or @code{"off"} to toggle display of grid lines. 1657 Either @code{"on"} or @code{"off"} to toggle display of grid lines.
1658
1476 @item xlabel 1659 @item xlabel
1477 Indices to text objects for the axes labels. 1660 Indices to text objects for the axes labels.
1661
1478 @item xlim 1662 @item xlim
1479 Two-element vector defining the limits for the x-axis. 1663 Two-element vector defining the limits for the x-axis.
1480 Setting this property also forces the corresponding mode 1664 Setting this property also forces the corresponding mode
1481 property to be set to @code{"manual"}. 1665 property to be set to @code{"manual"}.
1666
1482 @item xlimmode 1667 @item xlimmode
1483 Either @code{"manual"} or @code{"auto"}. 1668 Either @code{"manual"} or @code{"auto"}.
1669
1484 @item xminorgrid 1670 @item xminorgrid
1485 Either @code{"on"} or @code{"off"} to toggle display of minor grid lines. 1671 Either @code{"on"} or @code{"off"} to toggle display of minor grid lines.
1672
1486 @item xminortick 1673 @item xminortick
1674
1487 @item xscale 1675 @item xscale
1488 Either @code{"linear"} or @code{"log"}. 1676 Either @code{"linear"} or @code{"log"}.
1677
1489 @item xtick 1678 @item xtick
1490 Set position of tick marks. 1679 Set position of tick marks.
1491 Setting this property also forces the corresponding mode 1680 Setting this property also forces the corresponding mode
1492 property to be set to @code{"manual"}. 1681 property to be set to @code{"manual"}.
1682
1493 @item xticklabel 1683 @item xticklabel
1494 Setting this property also forces the corresponding mode 1684 Setting this property also forces the corresponding mode
1495 property to be set to @code{"manual"}. 1685 property to be set to @code{"manual"}.
1686
1496 @item xticklabelmode 1687 @item xticklabelmode
1497 Either @code{"manual"} or @code{"auto"}. 1688 Either @code{"manual"} or @code{"auto"}.
1689
1498 @item xtickmode 1690 @item xtickmode
1499 Either @code{"manual"} or @code{"auto"}. 1691 Either @code{"manual"} or @code{"auto"}.
1692
1500 @item yaxislocation 1693 @item yaxislocation
1501 Either @code{"left"} or @code{"right"} 1694 Either @code{"left"} or @code{"right"}
1695
1502 @item ycolor 1696 @item ycolor
1697
1503 @item ydir 1698 @item ydir
1504 Either @code{"forward"} or @code{"reverse"}. 1699 Either @code{"forward"} or @code{"reverse"}.
1700
1505 @item ygrid 1701 @item ygrid
1506 Either @code{"on"} or @code{"off"} to toggle display of grid lines. 1702 Either @code{"on"} or @code{"off"} to toggle display of grid lines.
1703
1507 @item ylabel 1704 @item ylabel
1508 Indices to text objects for the axes labels. 1705 Indices to text objects for the axes labels.
1706
1509 @item ylim 1707 @item ylim
1510 Two-element vectors defining the limits for the x, y, and z axes and the 1708 Two-element vectors defining the limits for the x, y, and z axes and the
1511 Setting one of these properties also forces the corresponding mode 1709 Setting one of these properties also forces the corresponding mode
1512 property to be set to @code{"manual"}. 1710 property to be set to @code{"manual"}.
1711
1513 @item ylimmode 1712 @item ylimmode
1514 Either @code{"manual"} or @code{"auto"}. 1713 Either @code{"manual"} or @code{"auto"}.
1714
1515 @item yminorgrid 1715 @item yminorgrid
1516 Either @code{"on"} or @code{"off"} to toggle display of minor grid lines. 1716 Either @code{"on"} or @code{"off"} to toggle display of minor grid lines.
1717
1517 @item yminortick 1718 @item yminortick
1719
1518 @item yscale 1720 @item yscale
1519 Either @code{"linear"} or @code{"log"}. 1721 Either @code{"linear"} or @code{"log"}.
1722
1520 @item ytick 1723 @item ytick
1521 Set position of tick marks. 1724 Set position of tick marks.
1522 Setting this property also forces the corresponding mode 1725 Setting this property also forces the corresponding mode
1523 property to be set to @code{"manual"}. 1726 property to be set to @code{"manual"}.
1727
1524 @item yticklabel 1728 @item yticklabel
1525 Setting this property also forces the corresponding mode 1729 Setting this property also forces the corresponding mode
1526 property to be set to @code{"manual"}. 1730 property to be set to @code{"manual"}.
1731
1527 @item yticklabelmode 1732 @item yticklabelmode
1528 Either @code{"manual"} or @code{"auto"}. 1733 Either @code{"manual"} or @code{"auto"}.
1734
1529 @item ytickmode 1735 @item ytickmode
1530 Either @code{"manual"} or @code{"auto"}. 1736 Either @code{"manual"} or @code{"auto"}.
1737
1531 @item zcolor 1738 @item zcolor
1739
1532 @item zdir 1740 @item zdir
1533 Either @code{"forward"} or @code{"reverse"}. 1741 Either @code{"forward"} or @code{"reverse"}.
1742
1534 @item zgrid 1743 @item zgrid
1535 Either @code{"on"} or @code{"off"} to toggle display of grid lines. 1744 Either @code{"on"} or @code{"off"} to toggle display of grid lines.
1745
1536 @item zlabel 1746 @item zlabel
1537 Indices to text objects for the axes labels. 1747 Indices to text objects for the axes labels.
1748
1538 @item zlim 1749 @item zlim
1539 Two-element vector defining the limits for z-axis. 1750 Two-element vector defining the limits for z-axis.
1540 Setting this property also forces the corresponding mode 1751 Setting this property also forces the corresponding mode
1541 property to be set to @code{"manual"}. 1752 property to be set to @code{"manual"}.
1753
1542 @item zlimmode 1754 @item zlimmode
1543 Either @code{"manual"} or @code{"auto"}. 1755 Either @code{"manual"} or @code{"auto"}.
1756
1544 @item zminorgrid 1757 @item zminorgrid
1545 Either @code{"on"} or @code{"off"} to toggle display of minor grid lines. 1758 Either @code{"on"} or @code{"off"} to toggle display of minor grid lines.
1759
1546 @item zminortick 1760 @item zminortick
1761
1547 @item zscale 1762 @item zscale
1548 Either @code{"linear"} or @code{"log"}. 1763 Either @code{"linear"} or @code{"log"}.
1764
1549 @item ztick 1765 @item ztick
1550 Set position of tick marks. 1766 Set position of tick marks.
1551 Setting this property also forces the corresponding mode 1767 Setting this property also forces the corresponding mode
1552 property to be set to @code{"manual"}. 1768 property to be set to @code{"manual"}.
1769
1553 @item zticklabel 1770 @item zticklabel
1554 Setting this property also forces the corresponding mode 1771 Setting this property also forces the corresponding mode
1555 property to be set to @code{"manual"}. 1772 property to be set to @code{"manual"}.
1773
1556 @item zticklabelmode 1774 @item zticklabelmode
1557 Either @code{"manual"} or @code{"auto"}. 1775 Either @code{"manual"} or @code{"auto"}.
1776
1558 @item ztickmode 1777 @item ztickmode
1559 Either @code{"manual"} or @code{"auto"}. 1778 Either @code{"manual"} or @code{"auto"}.
1560 1779
1561 @end table 1780 @end table
1562 1781
1565 @cindex line properties 1784 @cindex line properties
1566 1785
1567 The @code{line} properties are: 1786 The @code{line} properties are:
1568 @table @code 1787 @table @code
1569 @item __modified__ 1788 @item __modified__
1789
1570 @item __myhandle__ 1790 @item __myhandle__
1791
1571 @item beingdeleted 1792 @item beingdeleted
1793
1572 @item busyaction 1794 @item busyaction
1795
1573 @item buttondownfcn 1796 @item buttondownfcn
1797
1574 @item children 1798 @item children
1799
1575 @item clipping 1800 @item clipping
1801
1576 @item color 1802 @item color
1577 The RGB color of the line, or a color name. @xref{Colors}. 1803 The RGB color of the line, or a color name. @xref{Colors}.
1804
1578 @item createfcn 1805 @item createfcn
1806
1579 @item deletefcn 1807 @item deletefcn
1808
1580 @item displayname 1809 @item displayname
1810
1581 @item erasemode 1811 @item erasemode
1812
1582 @item handlevisibility 1813 @item handlevisibility
1814
1583 @item hittest 1815 @item hittest
1816
1584 @item interpreter 1817 @item interpreter
1818
1585 @item interruptible 1819 @item interruptible
1820
1586 @item keylabel 1821 @item keylabel
1587 The text of the legend entry corresponding to this line. Note that this 1822 The text of the legend entry corresponding to this line. Note that this
1588 property is not compatible with @sc{matlab} and may be removed in a 1823 property is not compatible with @sc{matlab} and may be removed in a
1589 future version of Octave. 1824 future version of Octave.
1825
1590 @item ldata 1826 @item ldata
1591 The lower errorbar in the y direction to be plotted. 1827 The lower errorbar in the y direction to be plotted.
1828
1592 @item linestyle 1829 @item linestyle
1593 @itemx linewidth 1830 @itemx linewidth
1594 @xref{Line Styles}. 1831 @xref{Line Styles}.
1832
1595 @item linewidth 1833 @item linewidth
1834
1596 @item marker 1835 @item marker
1836
1597 @item markeredgecolor 1837 @item markeredgecolor
1838
1598 @item markerfacecolor 1839 @item markerfacecolor
1840
1599 @item markersize 1841 @item markersize
1600 @xref{Marker Styles}. 1842 @xref{Marker Styles}.
1843
1601 @item parent 1844 @item parent
1845
1602 @item selected 1846 @item selected
1847
1603 @item selectionhighlight 1848 @item selectionhighlight
1849
1604 @item tag 1850 @item tag
1851
1605 @item type 1852 @item type
1853
1606 @item udata 1854 @item udata
1607 The upper errorbar in the y direction to be plotted. 1855 The upper errorbar in the y direction to be plotted.
1856
1608 @item uicontextmenu 1857 @item uicontextmenu
1858
1609 @item userdata 1859 @item userdata
1860
1610 @item visible 1861 @item visible
1862
1611 @item xdata 1863 @item xdata
1612 The data to be plotted. 1864 The data to be plotted.
1865
1613 @item xdatasource 1866 @item xdatasource
1867
1614 @item xldata 1868 @item xldata
1615 The lower errorbar to be plotted. 1869 The lower errorbar to be plotted.
1870
1616 @item xlim 1871 @item xlim
1872
1617 @item xliminclude 1873 @item xliminclude
1874
1618 @item xudata 1875 @item xudata
1619 The upper errorbar to be plotted. 1876 The upper errorbar to be plotted.
1877
1620 @item ydata 1878 @item ydata
1621 The data to be plotted. 1879 The data to be plotted.
1880
1622 @item ydatasource 1881 @item ydatasource
1882
1623 @item ylim 1883 @item ylim
1884
1624 @item yliminclude 1885 @item yliminclude
1886
1625 @item zdata 1887 @item zdata
1626 The data to be plotted. 1888 The data to be plotted.
1889
1627 @item zdatasource 1890 @item zdatasource
1891
1628 @item zlim 1892 @item zlim
1893
1629 @item zliminclude 1894 @item zliminclude
1630 @end table 1895 @end table
1631 1896
1632 @node Text Properties 1897 @node Text Properties
1633 @subsubsection Text Properties 1898 @subsubsection Text Properties
1634 @cindex text properties 1899 @cindex text properties
1635 1900
1636 The @code{text} properties are: 1901 The @code{text} properties are:
1637 @table @code 1902 @table @code
1638 @item __modified__ 1903 @item __modified__
1904
1639 @item __myhandle__ 1905 @item __myhandle__
1906
1640 @item backgroundcolor 1907 @item backgroundcolor
1908
1641 @item beingdeleted 1909 @item beingdeleted
1910
1642 @item busyaction 1911 @item busyaction
1912
1643 @item buttondownfcn 1913 @item buttondownfcn
1914
1644 @item children 1915 @item children
1916
1645 @item clipping 1917 @item clipping
1918
1646 @item color 1919 @item color
1647 The color of the text. @xref{Colors}. 1920 The color of the text. @xref{Colors}.
1921
1648 @item createfcn 1922 @item createfcn
1923
1649 @item deletefcn 1924 @item deletefcn
1925
1650 @item displayname 1926 @item displayname
1927
1651 @item edgecolor 1928 @item edgecolor
1929
1652 @item editing 1930 @item editing
1931
1653 @item erasemode 1932 @item erasemode
1933
1654 @item fontangle 1934 @item fontangle
1655 Flag whether the font is italic or normal. Valid values are 'normal', 1935 Flag whether the font is italic or normal. Valid values are 'normal',
1656 'italic' and 'oblique'. 1936 'italic' and 'oblique'.
1937
1657 @item fontname 1938 @item fontname
1658 The font used for the text. 1939 The font used for the text.
1940
1659 @item fontsize 1941 @item fontsize
1660 The size of the font, in points to use. 1942 The size of the font, in points to use.
1943
1661 @item fontunits 1944 @item fontunits
1945
1662 @item fontweight 1946 @item fontweight
1663 Flag whether the font is bold, etc. Valid values are 'normal', 'bold', 1947 Flag whether the font is bold, etc. Valid values are 'normal', 'bold',
1664 'demi' or 'light'. 1948 'demi' or 'light'.
1949
1665 @item handlevisibility 1950 @item handlevisibility
1951
1666 @item hittest 1952 @item hittest
1953
1667 @item horizontalalignment 1954 @item horizontalalignment
1668 May be @code{"left"}, @code{"center"}, or @code{"right"}. 1955 May be @code{"left"}, @code{"center"}, or @code{"right"}.
1956
1669 @item interpreter 1957 @item interpreter
1670 Determines how the text is rendered. Valid values are 'none', 'tex' or 1958 Determines how the text is rendered. Valid values are 'none', 'tex' or
1671 'latex'. 1959 'latex'.
1960
1672 @item interruptible 1961 @item interruptible
1962
1673 @item linestyle 1963 @item linestyle
1964
1674 @item linewidth 1965 @item linewidth
1966
1675 @item margin 1967 @item margin
1968
1676 @item parent 1969 @item parent
1970
1677 @item position 1971 @item position
1678 The coordinates of the text object. 1972 The coordinates of the text object.
1973
1679 @item rotation 1974 @item rotation
1680 The angle of rotation for the displayed text, measured in degrees. 1975 The angle of rotation for the displayed text, measured in degrees.
1976
1681 @item selected 1977 @item selected
1978
1682 @item selectionhighlight 1979 @item selectionhighlight
1980
1683 @item string 1981 @item string
1684 The character string contained by the text object. 1982 The character string contained by the text object.
1983
1685 @item tag 1984 @item tag
1985
1686 @item type 1986 @item type
1987
1687 @item uicontextmenu 1988 @item uicontextmenu
1989
1688 @item units 1990 @item units
1689 May be @code{"normalized"} or @code{"graph"}. 1991 May be @code{"normalized"} or @code{"graph"}.
1992
1690 @item userdata 1993 @item userdata
1994
1691 @item verticalalignment 1995 @item verticalalignment
1996
1692 @item visible 1997 @item visible
1998
1693 @item xlim 1999 @item xlim
2000
1694 @item xliminclude 2001 @item xliminclude
2002
1695 @item ylim 2003 @item ylim
2004
1696 @item yliminclude 2005 @item yliminclude
2006
1697 @item zlim 2007 @item zlim
2008
1698 @item zliminclude 2009 @item zliminclude
1699 2010
1700 @end table 2011 @end table
1701 2012
1702 @node Image Properties 2013 @node Image Properties
1704 @cindex image properties 2015 @cindex image properties
1705 2016
1706 The @code{image} properties are: 2017 The @code{image} properties are:
1707 @table @code 2018 @table @code
1708 @item __modified__ 2019 @item __modified__
2020
1709 @item __myhandle__ 2021 @item __myhandle__
2022
1710 @item beingdeleted 2023 @item beingdeleted
2024
1711 @item busyaction 2025 @item busyaction
2026
1712 @item buttondownfcn 2027 @item buttondownfcn
2028
1713 @item cdata 2029 @item cdata
1714 The data for the image. Each pixel of the image corresponds to an 2030 The data for the image. Each pixel of the image corresponds to an
1715 element of @code{cdata}. The value of an element of @code{cdata} 2031 element of @code{cdata}. The value of an element of @code{cdata}
1716 specifies the row-index into the colormap of the axes object containing 2032 specifies the row-index into the colormap of the axes object containing
1717 the image. The color value found in the color map for the given index 2033 the image. The color value found in the color map for the given index
1718 determines the color of the pixel. 2034 determines the color of the pixel.
2035
1719 @item cdatamapping 2036 @item cdatamapping
2037
1720 @item children 2038 @item children
2039
1721 @item clim 2040 @item clim
2041
1722 @item climinclude 2042 @item climinclude
2043
1723 @item clipping 2044 @item clipping
2045
1724 @item createfcn 2046 @item createfcn
2047
1725 @item deletefcn 2048 @item deletefcn
2049
1726 @item handlevisibility 2050 @item handlevisibility
2051
1727 @item hittest 2052 @item hittest
2053
1728 @item interruptible 2054 @item interruptible
2055
1729 @item parent 2056 @item parent
2057
1730 @item selected 2058 @item selected
2059
1731 @item selectionhighlight 2060 @item selectionhighlight
2061
1732 @item tag 2062 @item tag
2063
1733 @item type 2064 @item type
2065
1734 @item uicontextmenu 2066 @item uicontextmenu
2067
1735 @item userdata 2068 @item userdata
2069
1736 @item visible 2070 @item visible
2071
1737 @item xdata 2072 @item xdata
1738 Two-element vector specifying the range of the x-coordinates for 2073 Two-element vector specifying the range of the x-coordinates for
1739 the image. 2074 the image.
2075
1740 @item xlim 2076 @item xlim
2077
1741 @item xliminclude 2078 @item xliminclude
2079
1742 @item ydata 2080 @item ydata
1743 Two-element vector specifying the range of the y-coordinates for 2081 Two-element vector specifying the range of the y-coordinates for
1744 the image. 2082 the image.
2083
1745 @item ylim 2084 @item ylim
2085
1746 @item yliminclude 2086 @item yliminclude
1747 @end table 2087 @end table
1748 2088
1749 @node Patch Properties 2089 @node Patch Properties
1750 @subsubsection Patch Properties 2090 @subsubsection Patch Properties
1751 @cindex patch properties 2091 @cindex patch properties
1752 2092
1753 The @code{patch} properties are: 2093 The @code{patch} properties are:
1754 @table @code 2094 @table @code
1755 @item __modified__ 2095 @item __modified__
2096
1756 @item __myhandle__ 2097 @item __myhandle__
2098
1757 @item alim 2099 @item alim
2100
1758 @item aliminclude 2101 @item aliminclude
2102
1759 @item alphadatamapping 2103 @item alphadatamapping
2104
1760 @item ambientstrength 2105 @item ambientstrength
2106
1761 @item backfacelighting 2107 @item backfacelighting
2108
1762 @item beingdeleted 2109 @item beingdeleted
2110
1763 @item busyaction 2111 @item busyaction
2112
1764 @item buttondownfcn 2113 @item buttondownfcn
2114
1765 @item cdata 2115 @item cdata
1766 Data defining the patch object. 2116 Data defining the patch object.
2117
1767 @item cdatamapping 2118 @item cdatamapping
2119
1768 @item children 2120 @item children
2121
1769 @item clim 2122 @item clim
2123
1770 @item climinclude 2124 @item climinclude
2125
1771 @item clipping 2126 @item clipping
2127
1772 @item createfcn 2128 @item createfcn
2129
1773 @item deletefcn 2130 @item deletefcn
2131
1774 @item diffusestrength 2132 @item diffusestrength
2133
1775 @item edgealpha 2134 @item edgealpha
2135
1776 @item edgecolor 2136 @item edgecolor
1777 The color of the line defining the patch. @xref{Colors}. 2137 The color of the line defining the patch. @xref{Colors}.
2138
1778 @item edgelighting 2139 @item edgelighting
2140
1779 @item erasemode 2141 @item erasemode
2142
1780 @item facealpha 2143 @item facealpha
1781 A number in the range [0, 1] indicating the transparency of the patch. 2144 A number in the range [0, 1] indicating the transparency of the patch.
2145
1782 @item facecolor 2146 @item facecolor
1783 The fill color of the patch. @xref{Colors}. 2147 The fill color of the patch. @xref{Colors}.
2148
1784 @item facelighting 2149 @item facelighting
2150
1785 @item faces 2151 @item faces
2152
1786 @item facevertexalphadata 2153 @item facevertexalphadata
2154
1787 @item facevertexcdata 2155 @item facevertexcdata
2156
1788 @item handlevisibility 2157 @item handlevisibility
2158
1789 @item hittest 2159 @item hittest
2160
1790 @item interpreter 2161 @item interpreter
2162
1791 @item interruptible 2163 @item interruptible
2164
1792 @item keylabel 2165 @item keylabel
2166
1793 @item linestyle 2167 @item linestyle
1794 @xref{Line Styles}. 2168 @xref{Line Styles}.
2169
1795 @item linewidth 2170 @item linewidth
1796 @xref{Line Styles}. 2171 @xref{Line Styles}.
2172
1797 @item marker 2173 @item marker
1798 @xref{Marker Styles}. 2174 @xref{Marker Styles}.
2175
1799 @item markeredgecolor 2176 @item markeredgecolor
1800 @xref{Marker Styles}. 2177 @xref{Marker Styles}.
2178
1801 @item markerfacecolor 2179 @item markerfacecolor
1802 @xref{Marker Styles}. 2180 @xref{Marker Styles}.
2181
1803 @item markersize 2182 @item markersize
1804 @xref{Marker Styles}. 2183 @xref{Marker Styles}.
2184
1805 @item normalmode 2185 @item normalmode
2186
1806 @item parent 2187 @item parent
2188
1807 @item selected 2189 @item selected
2190
1808 @item selectionhighlight 2191 @item selectionhighlight
2192
1809 @item specularcolorreflectance 2193 @item specularcolorreflectance
2194
1810 @item specularexponent 2195 @item specularexponent
2196
1811 @item specularstrength 2197 @item specularstrength
2198
1812 @item tag 2199 @item tag
2200
1813 @item type 2201 @item type
2202
1814 @item uicontextmenu 2203 @item uicontextmenu
2204
1815 @item userdata 2205 @item userdata
2206
1816 @item vertexnormals 2207 @item vertexnormals
2208
1817 @item vertices 2209 @item vertices
2210
1818 @item visible 2211 @item visible
2212
1819 @item xdata 2213 @item xdata
1820 Data defining the patch object. 2214 Data defining the patch object.
2215
1821 @item xlim 2216 @item xlim
2217
1822 @item xliminclude 2218 @item xliminclude
2219
1823 @item ydata 2220 @item ydata
1824 Data defining the patch object. 2221 Data defining the patch object.
2222
1825 @item ylim 2223 @item ylim
2224
1826 @item yliminclude 2225 @item yliminclude
2226
1827 @item zdata 2227 @item zdata
1828 Data defining the patch object. 2228 Data defining the patch object.
2229
1829 @item zlim 2230 @item zlim
2231
1830 @item zliminclude 2232 @item zliminclude
1831 2233
1832 @end table 2234 @end table
1833 2235
1834 @node Surface Properties 2236 @node Surface Properties
1836 @cindex surface properties 2238 @cindex surface properties
1837 2239
1838 The @code{surface} properties are: 2240 The @code{surface} properties are:
1839 @table @code 2241 @table @code
1840 @item __modified__ 2242 @item __modified__
2243
1841 @item __myhandle__ 2244 @item __myhandle__
2245
1842 @item alim 2246 @item alim
2247
1843 @item aliminclude 2248 @item aliminclude
2249
1844 @item alphadata 2250 @item alphadata
2251
1845 @item alphadatamapping 2252 @item alphadatamapping
2253
1846 @item ambientstrength 2254 @item ambientstrength
2255
1847 @item backfacelighting 2256 @item backfacelighting
2257
1848 @item beingdeleted 2258 @item beingdeleted
2259
1849 @item busyaction 2260 @item busyaction
2261
1850 @item buttondownfcn 2262 @item buttondownfcn
2263
1851 @item cdata 2264 @item cdata
2265
1852 @item cdatamapping 2266 @item cdatamapping
2267
1853 @item cdatasource 2268 @item cdatasource
2269
1854 @item children 2270 @item children
2271
1855 @item clim 2272 @item clim
2273
1856 @item climinclude 2274 @item climinclude
2275
1857 @item clipping 2276 @item clipping
2277
1858 @item createfcn 2278 @item createfcn
2279
1859 @item deletefcn 2280 @item deletefcn
2281
1860 @item diffusestrength 2282 @item diffusestrength
2283
1861 @item edgealpha 2284 @item edgealpha
2285
1862 @item edgecolor 2286 @item edgecolor
2287
1863 @item edgelighting 2288 @item edgelighting
2289
1864 @item erasemode 2290 @item erasemode
2291
1865 @item facealpha 2292 @item facealpha
2293
1866 @item facecolor 2294 @item facecolor
2295
1867 @item facelighting 2296 @item facelighting
2297
1868 @item handlevisibility 2298 @item handlevisibility
2299
1869 @item hittest 2300 @item hittest
2301
1870 @item interpreter 2302 @item interpreter
2303
1871 @item interruptible 2304 @item interruptible
2305
1872 @item keylabel 2306 @item keylabel
1873 The text of the legend entry corresponding to this surface. Note that 2307 The text of the legend entry corresponding to this surface. Note that
1874 this property is not compatible with @sc{matlab} and may be removed in a 2308 this property is not compatible with @sc{matlab} and may be removed in a
1875 future version of Octave. 2309 future version of Octave.
2310
1876 @item linestyle 2311 @item linestyle
2312
1877 @item linewidth 2313 @item linewidth
2314
1878 @item marker 2315 @item marker
2316
1879 @item markeredgecolor 2317 @item markeredgecolor
2318
1880 @item markerfacecolor 2319 @item markerfacecolor
2320
1881 @item markersize 2321 @item markersize
2322
1882 @item meshstyle 2323 @item meshstyle
2324
1883 @item normalmode 2325 @item normalmode
2326
1884 @item parent 2327 @item parent
2328
1885 @item selected 2329 @item selected
2330
1886 @item selectionhighlight 2331 @item selectionhighlight
2332
1887 @item specularcolorreflectance 2333 @item specularcolorreflectance
2334
1888 @item specularexponent 2335 @item specularexponent
2336
1889 @item specularstrength 2337 @item specularstrength
2338
1890 @item tag 2339 @item tag
2340
1891 @item type 2341 @item type
2342
1892 @item uicontextmenu 2343 @item uicontextmenu
2344
1893 @item userdata 2345 @item userdata
2346
1894 @item vertexnormals 2347 @item vertexnormals
2348
1895 @item visible 2349 @item visible
2350
1896 @item xdata 2351 @item xdata
1897 The data determining the surface. The @code{xdata} and @code{ydata} 2352 The data determining the surface. The @code{xdata} and @code{ydata}
1898 elements are vectors and @code{zdata} must be a matrix. 2353 elements are vectors and @code{zdata} must be a matrix.
2354
1899 @item xdatasource 2355 @item xdatasource
2356
1900 @item xlim 2357 @item xlim
2358
1901 @item xliminclude 2359 @item xliminclude
2360
1902 @item ydata 2361 @item ydata
1903 The data determining the surface. The @code{xdata} and @code{ydata} 2362 The data determining the surface. The @code{xdata} and @code{ydata}
1904 elements are vectors and @code{zdata} must be a matrix. 2363 elements are vectors and @code{zdata} must be a matrix.
2364
1905 @item ydatasource 2365 @item ydatasource
2366
1906 @item ylim 2367 @item ylim
2368
1907 @item yliminclude 2369 @item yliminclude
2370
1908 @item zdata 2371 @item zdata
1909 The data determining the surface. The @code{xdata} and @code{ydata} 2372 The data determining the surface. The @code{xdata} and @code{ydata}
1910 elements are vectors and @code{zdata} must be a matrix. 2373 elements are vectors and @code{zdata} must be a matrix.
2374
1911 @item zdatasource 2375 @item zdatasource
2376
1912 @item zlim 2377 @item zlim
2378
1913 @item zliminclude 2379 @item zliminclude
1914 @end table 2380 @end table
1915 2381
1916 @node Searching Properties 2382 @node Searching Properties
1917 @subsection Searching Properties 2383 @subsection Searching Properties
2042 @item linestyle 2508 @item linestyle
2043 May be one of 2509 May be one of
2044 @table @code 2510 @table @code
2045 @item "-" 2511 @item "-"
2046 Solid lines. 2512 Solid lines.
2513
2047 @item "--" 2514 @item "--"
2048 Dashed lines. 2515 Dashed lines.
2516
2049 @item ":" 2517 @item ":"
2050 Points. 2518 Points.
2519
2051 @item "-." 2520 @item "-."
2052 A dash-dot line. 2521 A dash-dot line.
2053 @end table 2522 @end table
2054 2523
2055 @item linewidth 2524 @item linewidth
2098 @end example 2567 @end example
2099 2568
2100 where @code{src} gives a handle to the source of the callback, and 2569 where @code{src} gives a handle to the source of the callback, and
2101 @code{code} gives some event specific data. This can then be associated 2570 @code{code} gives some event specific data. This can then be associated
2102 with an object either at the objects creation or later with the 2571 with an object either at the objects creation or later with the
2103 @code{set} function. For example 2572 @code{set} function. For example,
2104 2573
2105 @example 2574 @example
2106 plot (x, "DeleteFcn", @@(s, e) disp("Window Deleted")) 2575 plot (x, "DeleteFcn", @@(s, e) disp("Window Deleted"))
2107 @end example 2576 @end example
2108 2577
2109 @noindent 2578 @noindent
2110 where at the moment that the plot is deleted, the message "Window 2579 where at the moment that the plot is deleted, the message "Window
2111 Deleted" will be displayed. 2580 Deleted" will be displayed.
2112 2581
2113 Additional user arguments can be passed to callback functions, and will 2582 Additional user arguments can be passed to callback functions, and will
2114 be passed after the 2 default arguments. For example 2583 be passed after the 2 default arguments. For example:
2115 2584
2116 @example 2585 @example
2117 @group 2586 @group
2118 plot (x, "DeleteFcn", @{@@mycallback, "1"@}) 2587 plot (x, "DeleteFcn", @{@@mycallback, "1"@})
2119 @dots{} 2588 @dots{}
2239 The @code{hggroup} objects created by the functions of Octave contain 2708 The @code{hggroup} objects created by the functions of Octave contain
2240 one or more graphics object and are used to: 2709 one or more graphics object and are used to:
2241 2710
2242 @itemize @bullet 2711 @itemize @bullet
2243 @item group together multiple graphics objects, 2712 @item group together multiple graphics objects,
2713
2244 @item create linked properties between different graphics objects, and 2714 @item create linked properties between different graphics objects, and
2715
2245 @item to hide the nominal user data, from the actual data of the objects. 2716 @item to hide the nominal user data, from the actual data of the objects.
2246 @end itemize 2717 @end itemize
2247 2718
2248 @noindent 2719 @noindent
2249 For example the @code{stem} function creates a stem series where each 2720 For example the @code{stem} function creates a stem series where each
2327 The line width and style of the edge of the patch objects making up the 2798 The line width and style of the edge of the patch objects making up the
2328 areas. @xref{Line Styles}. 2799 areas. @xref{Line Styles}.
2329 2800
2330 @item edgecolor 2801 @item edgecolor
2331 @itemx facecolor 2802 @itemx facecolor
2332 The line and fill color of the patch objects making up the areas. @xref{Colors}. 2803 The line and fill color of the patch objects making up the areas.
2804 @xref{Colors}.
2333 2805
2334 @item xdata 2806 @item xdata
2335 @itemx ydata 2807 @itemx ydata
2336 The x and y coordinates of the original columns of the data passed to 2808 The x and y coordinates of the original columns of the data passed to
2337 @code{area} prior to the cumulative summation used in the @code{area} 2809 @code{area} prior to the cumulative summation used in the @code{area}
2452 2924
2453 @item labelspacing 2925 @item labelspacing
2454 The distance between labels on a single contour in points. 2926 The distance between labels on a single contour in points.
2455 2927
2456 @item linewidth 2928 @item linewidth
2929
2457 @item linestyle 2930 @item linestyle
2931
2458 @item linecolor 2932 @item linecolor
2459 The properties of the contour lines. The properties @code{linewidth} and 2933 The properties of the contour lines. The properties @code{linewidth} and
2460 @code{linestyle} are similar to the corresponding properties for lines. The 2934 @code{linestyle} are similar to the corresponding properties for lines. The
2461 property @code{linecolor} is a color property (@pxref{Colors}), that can also 2935 property @code{linecolor} is a color property (@pxref{Colors}), that can also
2462 have the values of "none" or "auto". If @code{linecolor} is "none", then no 2936 have the values of "none" or "auto". If @code{linecolor} is "none", then no
2483 @code{hggroup} element contains two line objects representing the data and 2957 @code{hggroup} element contains two line objects representing the data and
2484 the errorbars separately. The properties of the error bar series are 2958 the errorbars separately. The properties of the error bar series are
2485 2959
2486 @table @code 2960 @table @code
2487 @item color 2961 @item color
2488 The RGB color or color name of the line objects of the error bars. @xref{Colors}. 2962 The RGB color or color name of the line objects of the error bars.
2963 @xref{Colors}.
2489 2964
2490 @item linewidth 2965 @item linewidth
2491 @itemx linestyle 2966 @itemx linestyle
2492 The line width and style of the line objects of the error bars. @xref{Line Styles}. 2967 The line width and style of the line objects of the error bars. @xref{Line
2968 Styles}.
2493 2969
2494 @item marker 2970 @item marker
2495 @itemx markeredgecolor 2971 @itemx markeredgecolor
2496 @itemx markerfacecolor 2972 @itemx markerfacecolor
2497 @itemx markersize 2973 @itemx markersize
2738 3214
2739 The properties of the surface group are 3215 The properties of the surface group are
2740 3216
2741 @table @code 3217 @table @code
2742 @item edgecolor 3218 @item edgecolor
3219
2743 @item facecolor 3220 @item facecolor
2744 The RGB color or color name of the edges or faces of the surface. @xref{Colors}. 3221 The RGB color or color name of the edges or faces of the surface.
3222 @xref{Colors}.
2745 3223
2746 @item linewidth 3224 @item linewidth
2747 @itemx linestyle 3225 @itemx linestyle
2748 The line width and style of the lines on the surface. @xref{Line Styles}. 3226 The line width and style of the lines on the surface. @xref{Line Styles}.
2749 3227
2754 The line and fill color of the markers on the surface. @xref{Colors}. 3232 The line and fill color of the markers on the surface. @xref{Colors}.
2755 3233
2756 @item xdata 3234 @item xdata
2757 @itemx ydata 3235 @itemx ydata
2758 @itemx zdata 3236 @itemx zdata
2759 @item cdata 3237 @itemx cdata
2760 The original x, y, z and c data. 3238 The original x, y, z and c data.
2761 3239
2762 @item xdatasource 3240 @item xdatasource
2763 @itemx ydatasource 3241 @itemx ydatasource
2764 @itemx zdatasource 3242 @itemx zdatasource