/usr/share/octave/packages/3.2/io-1.0.14/doc-cache is in octave-io 1.0.14-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 | # Created by Octave 3.2.4, Mon May 02 15:48:59 2011 UTC <root@allspice>
# name: cache
# type: cell
# rows: 3
# columns: 23
# name: <cell-element>
# type: string
# elements: 1
# length: 11
append_save
# name: <cell-element>
# type: string
# elements: 1
# length: 17
Input checking:
# name: <cell-element>
# type: string
# elements: 1
# length: 17
Input checking:
# name: <cell-element>
# type: string
# elements: 1
# length: 15
calccelladdress
# name: <cell-element>
# type: string
# elements: 1
# length: 239
calccelladdress (R, C) - compute spreadsheet style cell address from
row & column index (both 1-based).
Max column index currently set to 18278 (max ODS: 1024, OOXML: 16384).
Row limits for ODF and OOXML are 65536 and 1048576, resp.
# name: <cell-element>
# type: string
# elements: 1
# length: 80
calccelladdress (R, C) - compute spreadsheet style cell address from
row & col
# name: <cell-element>
# type: string
# elements: 1
# length: 6
fexist
# name: <cell-element>
# type: string
# elements: 1
# length: 680
-- Function File: ex = fexist (file, tspec, aspec)
Checks whether a file exists. FILE is the queried file path.
TSPEC is a combination of letters f,d,p,S, corresponding to file
types:
* f: regular file
* d: directory
* p: named pipe (FIFO special file)
* S: socket
The query is true if the actual file type matches any of the
specified options.
ASPEC is a combination of letters r,w,x, corresponding to queried
access privileges to the file. The query is true if the current
user has all the spefied types of access, either through "user",
"group" or "other" specs.
See also: stat, lstat
# name: <cell-element>
# type: string
# elements: 1
# length: 29
Checks whether a file exists.
# name: <cell-element>
# type: string
# elements: 1
# length: 12
getusedrange
# name: <cell-element>
# type: string
# elements: 1
# length: 1505
-- Function File: [ TOPROW#, BOTTOMROW#, LEFTCOL#, RIGHTCOL# ] =
getusedrange (SPPTR, SHINDEX#)
Find occupied data range in worksheet SHINDEX# in a spreadsheet
pointed to in struct SPPTR (either MS-Excel or OpenOffice Calc).
SHINDEX# must be numeric and is 1-based. SPPTR can either refer to
an MS-Excel spreadsheet (spptr returned by xlsopen) or an
OpenOffice.org Calc spreadsheet (spptr returned by odsopen).
Be aware that especially for OpenOffice.org Calc (ODS) spreadsheets
the results can only be obtained by counting all cells in all rows;
this can be fairly time-consuming. For the ActiveX (COM)
interface the underlying Visual Basic call relies on cached range
values and counts empty cells with only formatting too, so COM
returns only approximate (but usually too big) range values.
Examples:
[trow, brow, lcol, rcol] = getusedrange (ods2, 3);
(which returns the outermost row & column numbers of the rectangle
enveloping the occupied cells in the third sheet of an OpenOffice.org
Calc spreadsheet pointedto in struct ods2)
[trow, brow, lcol, rcol] = getusedrange (xls3, 3);
(which returns the outermost row & column numbers of the rectangle
enveloping the occupied cells in the third sheet of an Excel
spreadsheet pointed to in struct xls3)
See also: xlsopen, xlsclose, odsopen, odsclose, xlsfinfo, odsfinfo
# name: <cell-element>
# type: string
# elements: 1
# length: 80
Find occupied data range in worksheet SHINDEX# in a spreadsheet pointed
to in st
# name: <cell-element>
# type: string
# elements: 1
# length: 11
object2json
# name: <cell-element>
# type: string
# elements: 1
# length: 1413
function json=object2json(object)
This function returns a valid json string that will describe object
The string will be in a compact form (i.e. no spaces or line breaks)
It will map simple octave values this way:
function handles: string with the name of the function
double (numbers): depends:
If it's real it will map to a string representing that number
If it's complex it will map to an object with the next properties:
real: real part of the number
imag: imaginary part of the number
char: A string enclosed by double quotes representing that character
And will map more complex octave values this other way:
struct: an object with properties equal to the struct's field names
and value equal to the json counterpart of that field
cell: it will be mapped depending on the value of the cell (for
example {i} will be mapped to an object with real=0 and imag=1)
vectors or cell arrays: it will map them to a corresponding js
array (same size) with the values transformed to their json
counterpart (Note: that in javascript all arrays are like octave's
cells ,i.e. they can store different type and size variables)
strings or char vectors: they will be mapped to the same string
enclosed by double quotes
Other octave values will be mapped to a string enclosed by double
quuotes with the value that the class() function returns
# name: <cell-element>
# type: string
# elements: 1
# length: 80
function json=object2json(object)
This function returns a valid json string th
# name: <cell-element>
# type: string
# elements: 1
# length: 7
oct2ods
# name: <cell-element>
# type: string
# elements: 1
# length: 3208
-- Function File: [ ODS, RSTATUS ] = oct2ods (ARR, ODS)
-- Function File: [ ODS, RSTATUS ] = oct2ods (ARR, ODS, WSH)
-- Function File: [ ODS, RSTATUS ] = oct2ods (ARR, ODS, WSH, RANGE)
-- Function File: [ ODS, RSTATUS ] = oct2ods (ARR, ODS, WSH, RANGE,
OPTIONS)
Transfer data to an OpenOffice_org Calc spreadsheet previously
opened by odsopen().
Data in 1D/2D array ARR are transferred into a cell range RANGE in
sheet WSH. ODS must have been made earlier by odsopen(). Return
argument ODS should be the same as supplied argument ODS and is
updated by oct2ods. A subsequent call to odsclose is needed to
write the updated spreadsheet to disk (and -if needed- close the
Java invocation holding the file pointer).
ARR can be any array type save complex. Mixed numeric/text arrays
can only be cell arrays.
ODS must be a valid pointer struct created earlier by odsopen.
WSH can be a number (sheet name) or string (sheet number). In
case of a yet non-existing Calc file, the first sheet will be used
& named according to WSH. In case of existing files, some checks
are made for existing sheet names or numbers. When new sheets are
to be added to the Calc file, they are inserted to the right of
all existing sheets. The pointer to the "active" sheet (shown when
Calc opens the file) remains untouched.
If RANGE omitted, the top left cell where the data will be put is
supposed to be 'A1'; only a top left cell address can be specified
as well. In these cases the actual range to be used is determined
by the size of ARR. Be aware that large data array sizes may
exhaust the java shared memory space. For larger arrays,
appropriate memory settings are needed in the file java.opts; then
the maximum array size for the java-based spreadsheet options can
be in the order of perhaps 10^6 elements.
Optional argument OPTIONS, a structure, can be used to specify
various write modes. Currently the only option field is
"formulas_as_text", which -if set to 1 or TRUE- specifies that
formula strings (i.e., text strings starting with "=" and ending
in a ")" ) should be entered as litteral text strings rather than
as spreadsheet formulas (the latter is the default). As
jOpenDocument doesn't support formula I/O at all yet, this option
is ignored for the JOD interface.
Data are added to the sheet, ignoring other data already present;
existing data in the range to be used will be overwritten.
If RANGE contains merged cells, also the elements of ARR not
corresponding to the top or left Calc cells of those merged cells
will be written, however they won't be shown until in Calc the
merge is undone.
Examples:
[ods, status] = ods2oct (arr, ods, 'Newsheet1', 'AA31:GH165');
Write array arr into sheet Newsheet1 with upperleft cell at AA31
[ods, status] = ods2oct ({'String'}, ods, 'Oldsheet3', 'B15:B15');
Put a character string into cell B15 in sheet Oldsheet3
See also: ods2oct, odsopen, odsclose, odsread, odswrite, odsfinfo
# name: <cell-element>
# type: string
# elements: 1
# length: 80
Transfer data to an OpenOffice_org Calc spreadsheet previously opened
by odsopen
# name: <cell-element>
# type: string
# elements: 1
# length: 7
oct2xls
# name: <cell-element>
# type: string
# elements: 1
# length: 3170
-- Function File: [ XLS, RSTATUS ] = oct2xls (ARR, XLS)
-- Function File: [ XLS, RSTATUS ] = oct2xls (ARR, XLS, WSH)
-- Function File: [ XLS, RSTATUS ] = oct2xls (ARR, XLS, WSH, RANGE)
-- Function File: [ XLS, RSTATUS ] = oct2xls (ARR, XLS, WSH, RANGE,
OPTIONS)
Add data in 1D/2D CELL array ARR into a range specified in RANGE
in worksheet WSH in an Excel spreadsheet file pointed to in
structure XLS. Return argument XLS equals supplied argument XLS
and is updated by oct2xls.
A subsequent call to xlsclose is needed to write the updated
spreadsheet to disk (and -if needed- close the Excel or Java
invocation).
ARR can be any array type save complex. Mixed numeric/text arrays
can only be cell arrays.
XLS must be a valid pointer struct created earlier by xlsopen.
WSH can be a number or string (max. 31 chars). In case of a yet
non-existing Excel file, the first worksheet will be used & named
according to WSH - extra empty worksheets that Excel creates by
default are deleted. In case of existing files, some checks are
made for existing worksheet names or numbers, or whether WSH
refers to an existing sheet with a type other than worksheet
(e.g., chart). When new worksheets are to be added to the Excel
file, they are inserted to the right of all existing worksheets.
The pointer to the "active" sheet (shown when Excel opens the
file) remains untouched.
If RANGE is omitted or just the top left cell of the range is
specified, the actual range to be used is determined by the size of
ARR. If nothing is specified for RANGE the top left cell is
assumed to be 'A1'.
Data are added to the worksheet, ignoring other data already
present; existing data in the range to be used will be overwritten.
If RANGE contains merged cells, only the elements of ARR
corresponding to the top or left Excel cells of those merged cells
will be written, other array cells corresponding to that cell will
be ignored.
Optional argument OPTIONS, a structure, can be used to specify
various write modes. Currently the only option field is
"formulas_as_text", which -if set to 1 or TRUE- specifies that
formula strings (i.e., text strings starting with "=" and ending
in a ")" ) should be entered as litteral text strings rather than
as spreadsheet formulas (the latter is the default).
Beware that -if invoked- Excel invocations may be left running
silently in case of COM errors. Invoke xlsclose with proper
pointer struct to close them. When using java, note that large
data array sizes elements may exhaust the java shared memory space
for the default java memory settings. For larger arrays,
appropriate memory settings are needed in the file java.opts; then
the maximum array size for the java-based spreadsheet options may
be in the order of 10^6 elements.
Examples:
[xlso, status] = xls2oct ('arr', xlsi, 'Third_sheet', 'AA31:AB278');
See also: xls2oct, xlsopen, xlsclose, xlsread, xlswrite, xlsfinfo
# name: <cell-element>
# type: string
# elements: 1
# length: 80
Add data in 1D/2D CELL array ARR into a range specified in RANGE in
worksheet WS
# name: <cell-element>
# type: string
# elements: 1
# length: 7
ods2oct
# name: <cell-element>
# type: string
# elements: 1
# length: 3575
-- Function File: [ RAWARR, ODS, RSTATUS ] = ods2oct (ODS)
-- Function File: [ RAWARR, ODS, RSTATUS ] = ods2oct (ODS, WSH)
-- Function File: [ RAWARR, ODS, RSTATUS ] = ods2oct (ODS, WSH, RANGE)
-- Function File: [ RAWARR, ODS, RSTATUS ] = ods2oct (ODS, WSH, RANGE,
OPTIONS)
Read data contained within range RANGE from worksheet WSH in an
OpenOffice_org spreadsheet file pointed to in struct ODS.
WSH is either numerical or text, in the latter case it is
case-sensitive and it may be max. 31 characters long. Note that
in case of a numerical WSH this number refers to the position in
the worksheet stack, counted from the left in a Calc window. The
default is numerical 1, i.e. the leftmost worksheet in the ODS
file.
RANGE is expected to be a regular spreadsheet range format, or ""
(empty string, indicating all data in a worksheet). If no range
is specified the occupied cell range will have to be determined
behind the scenes first; this can take some time.
Optional argument OPTIONS, a structure, can be used to specify
various read modes. Currently the only option field is
"formulas_as_text"; if set to TRUE or 1, spreadsheet formulas (if
at all present) are read as formula strings rather than the
evaluated formula result values. This only works for the OTK (Open
Document Toolkit) interface.
If only the first argument is specified, ods2oct will try to read
all contents from the first = leftmost (or the only) worksheet (as
if a range of '' (empty string) was specified).
If only two arguments are specified, ods2oct assumes the second
argument to be WSH. In that case ods2oct will try to read all data
contained in that worksheet.
Return argument RAWARR contains the raw spreadsheet cell data.
Optional return argument ODS contains the pointer struct. Field
ODS.limits contains the outermost column and row numbers of the
actually read cell range. RSTATUS will be set to 1 if the
requested data have been read successfully, 0 otherwise. Use
parsecell() to separate numeric and text values from RAWARR.
ODS is supposed to have been created earlier by odsopen in the
same octave session. It is only referred to, not changed.
Erroneous data and empty cells turn up empty in RAWARR. Date/time
values in OpenOffice.org are returned as numerical values with
base 1-1-0000 (same as octave). But beware that Excel spreadsheets
rewritten by OpenOffice.org into .ods format may have numerical
date cells with base 01-01-1900 (same as MS-Excel).
Be aware that ods2oct trims RAWARR from empty outer rows & columns,
so any returned cell array may turn out to be smaller than
requested in RANGE.
When reading from merged cells, all array elements NOT
corresponding to the leftmost or upper OpenOffice.org cell will be
treated as if the "corresponding" cells are empty.
ods2oct is a mere wrapper for interface-dependent scripts (e.g.,
ods2jotk2oct and ods2jod2oct) that do the actual reading.
Examples:
A = ods2oct (ods1, '2nd_sheet', 'C3:ABS40000');
(which returns the numeric contents in range C3:ABS40000 in worksheet
'2nd_sheet' from a spreadsheet file pointed to in pointer struct ods1,
into numeric array A)
[An, ods2, status] = ods2oct (ods2, 'Third_sheet');
See also: odsopen, odsclose, parsecell, odsread, odsfinfo,
oct2ods, odswrite
# name: <cell-element>
# type: string
# elements: 1
# length: 80
Read data contained within range RANGE from worksheet WSH in an
OpenOffice_org s
# name: <cell-element>
# type: string
# elements: 1
# length: 8
odsclose
# name: <cell-element>
# type: string
# elements: 1
# length: 1023
-- Function File: [ ODS] = odsclose (ODS)
-- Function File: [ ODS] = odsclose (ODS, FILENAME)
Close the OpenOffice_org Calc spreadsheet pointed to in struct
ODS, if needed write the file to disk. odsclose will determine if
the file must be written to disk based on information contained in
ODS. An empty pointer struct will be returned if no errors
occurred. Optional argument FILENAME can be used to write changed
spreadsheet files to an other file than opened by odsopen().
You need the Java package > 1.2.6 plus odfdom.jar + xercesImpl.jar
and/or jopendocument-<version>.jar installed on your computer +
proper javaclasspath set, to make this function work at all.
ODS must be a valid pointer struct made by odsopen() in the same
octave session.
Examples:
ods1 = odsclose (ods1);
(Close spreadsheet file pointed to in pointer struct ods1; ods1 is reset)
See also: odsopen, odsread, odswrite, ods2oct, oct2ods, odsfinfo
# name: <cell-element>
# type: string
# elements: 1
# length: 80
Close the OpenOffice_org Calc spreadsheet pointed to in struct ODS, if
needed wr
# name: <cell-element>
# type: string
# elements: 1
# length: 8
odsfinfo
# name: <cell-element>
# type: string
# elements: 1
# length: 1697
-- Function File: [ FILETYPE] = odsfinfo (FILENAME [, REQINTF])
-- Function File: [ FILETYPE, SH_NAMES] = odsfinfo (FILENAME [,
REQINTF])
Query an OpenOffice_org spreadsheet file FILENAME (with .ods
suffix) for some info about its contents.
If FILENAME is a recognizable OpenOffice.org spreadsheet file,
FILETYPE returns the string "OpenOffice.org Calc spreadsheet", or
'' (empty string) otherwise.
If FILENAME is a recognizable OpenOffice.org Calc spreadsheet
file, optional argument SH_NAMES contains a list (cell array) of
sheet names contained in FILENAME, in the order (from left to
right) in which they occur in the sheet stack.
If you omit return arguments FILETYPE and SH_NAMES altogether,
odsfinfo returns the sheet names and for each sheet the actual
occupied data ranges to the screen.The occupied cell range will
have to be determined behind the scenes first; this can take some
time.
odsfinfo execution can take its time for large spreadsheets as the
entire spreadsheet has to be parsed to get the sheet names, let
alone exploring used data ranges.
By specifying a value of 'jod' or 'otk' for REQINTF the automatic
selection of the java interface is bypassed and the specified
interface will be used (if at all present).
Examples:
exist = odsfinfo ('test4.ods');
(Just checks if file test4.ods is a readable Calc file)
[exist, names] = odsfinfo ('test4.ods');
(Checks if file test4.ods is a readable Calc file and return a
list of sheet names)
See also: odsread, odsopen, ods2oct, odsclose
# name: <cell-element>
# type: string
# elements: 1
# length: 57
Query an OpenOffice_org spreadsheet file FILENAME (with .
# name: <cell-element>
# type: string
# elements: 1
# length: 7
odsopen
# name: <cell-element>
# type: string
# elements: 1
# length: 1738
-- Function File: ODS = odsopen (FILENAME)
-- Function File: ODS = odsopen (FILENAME, READWRITE)
-- Function File: ODS = odsopen (FILENAME, READWRITE, REQINTF)
Get a pointer to an OpenOffice_org spreadsheet in the form of
return argument (file pointer struct) ODS.
Calling odsopen without specifying a return argument is fairly
useless!
To make this function work at all, you need the Java package >
1.2.5 plus ODFtoolkit (version 0.7.5 or 0.8.6) & xercesImpl,
and/or jOpenDocument installed on your computer + proper
javaclasspath set. These interfaces are referred to as OTK and
JOD, resp., and are preferred in that order by default (depending
on their presence).
FILENAME must be a valid .ods OpenOffice.org file name including
.ods suffix. If FILENAME does not contain any directory path, the
file is saved in the current directory.
READWRITE must be set to true ornumerical 1 if writing to
spreadsheet is desired immediately after calling odsopen(). It
merely serves proper handling of file errors (e.g., "file not
found" or "new file created").
Optional input argument REQINTF can be used to override the ODS
interface automatically selected by odsopen. Currently implemented
interfaces are 'OTK' (Java / ODFtoolkit) or 'JOD' (Java /
jOpenDocument).
Examples:
ods = odsopen ('test1.ods');
(get a pointer for reading from spreadsheet test1.ods)
ods = odsopen ('test2.ods', [], 'JOD');
(as above, indicate test2.ods will be read from; in this case using
the jOpenDocument interface is requested)
See also: odsclose, odsread, ods2oct, odsfinfo
# name: <cell-element>
# type: string
# elements: 1
# length: 80
Get a pointer to an OpenOffice_org spreadsheet in the form of return
argument (f
# name: <cell-element>
# type: string
# elements: 1
# length: 7
odsread
# name: <cell-element>
# type: string
# elements: 1
# length: 4285
-- Function File: [ NUMARR, TXTARR, RAWARR, LIMITS] = odsread
(FILENAME)
-- Function File: [ NUMARR, TXTARR, RAWARR, LIMITS] = odsread
(FILENAME, WSH)
-- Function File: [ NUMARR, TXTARR, RAWARR, LIMITS] = odsread
(FILENAME, WSH, RANGE)
-- Function File: [ NUMARR, TXTARR, RAWARR, LIMITS] = odsread
(FILENAME, WSH, RANGE, REQINTF)
Read data contained in range RANGE from worksheet WSH in
OpenOffice_org Calc spreadsheet file FILENAME.
You need the octave-forge java package (> 1.2.6) and one or both of
jopendocument-<version>.jar or preferrably: (odfdom.jar (version
0.7.5 3 or 0.8.6) & xercesImpl.jar) in your javaclasspath.
Return argument NUMARR contains the numeric data, optional return
arguments TXTARR and RAWARR contain text strings and the raw
spreadsheet cell data, respectively, and LIMITS is a struct
containing the data origins of the various returned arrays.
If FILENAME does not contain any directory, the file is assumed to
be in the current directory. FILENAME should include the filename
extension (.ods).
WSH is either numerical or text, in the latter case it is
case-sensitive and it should conform to OpenOffice.org Calc sheet
name requirements. Note that in case of a numerical WSH this
number refers to the position in the worksheet stack, counted from
the left in a Calc window. The default is numerical 1, i.e. the
leftmost worksheet in the Calc file.
RANGE is expected to be a regular spreadsheet range format, or ""
(empty string, indicating all data in a worksheet). If no range
is specified the occupied cell range will have to be determined
behind the scenes first; this can take some time.
If only the first argument is specified, odsread will try to read
all contents from the first = leftmost (or the only) worksheet (as
if a range of '' (empty string) was specified).
If only two arguments are specified, odsread assumes the second
argument to be WSH and to refer to a worksheet. In that case
odsread tries to read all data contained in that worksheet.
The optional last argument REQINTF can be used to override the
automatic selection by odsread of one interface out of the
supported ones: Java/ODFtoolkit ('OTK') or Java/jOpenDocument
('JOD').
Erroneous data and empty cells are set to NaN in NUMARR and turn
up empty in TXTARR and RAWARR. Date/time values in date/time
formatted cells are returned as numerical values in OBJ with base
1-1-000. Note that OpenOfice.org and MS-Excel have different date
base values (1/1/0000 & 1/1/1900, resp.) and internal
representation so MS-Excel spreadsheets rewritten into .ods format
by OpenOffice.org Calc may have different date base values.
NUMARR and TXTARR are trimmed from empty outer rows and columns,
so any returned array may turn out to be smaller than requested in
RANGE.
When reading from merged cells, all array elements NOT
corresponding to the leftmost or upper Calc cell will be treated
as if the "corresponding" Calc cells are empty.
odsread is just a wrapper for a collection of scripts that find out
the interface to be used and do the actual reading. For each call
to odsread the interface must be started and the Calc file read
into memory. When reading multiple ranges (in optionally multiple
worksheets) a significant speed boost can be obtained by invoking
those scripts directly (odsopen / ods2oct [/ parsecell] / ... /
odsclose).
Examples:
A = odsread ('test4.ods', '2nd_sheet', 'C3:AB40');
(which returns the numeric contents in range C3:AB40 in worksheet
'2nd_sheet' from file test4.ods into numeric array A)
[An, Tn, Ra, limits] = odsread ('Sales2009.ods', 'Third_sheet');
(which returns all data in worksheet 'Third_sheet' in file test4.ods
into array An, the text data into array Tn, the raw cell data into
cell array Ra and the ranges from where the actual data came in limits)
See also: odsopen, ods2oct, oct2ods, odsclose, odswrite, odsfinfo,
parsecell
# name: <cell-element>
# type: string
# elements: 1
# length: 80
Read data contained in range RANGE from worksheet WSH in OpenOffice_org
Calc spr
# name: <cell-element>
# type: string
# elements: 1
# length: 8
odswrite
# name: <cell-element>
# type: string
# elements: 1
# length: 3000
-- Function File: RSTATUS = odswrite (FILENAME, ARR)
-- Function File: RSTATUS = odswrite (FILENAME, ARR, WSH)
-- Function File: RSTATUS = odswrite (FILENAME, ARR, WSH, RANGE)
-- Function File: RSTATUS = odswrite (FILENAME, ARR, WSH, RANGE,
REQINTF)
Add data in 1D/2D array ARR to sheet WSH in OpenOffice_org Calc
spreadsheet file FILENAME in range RANGE.
RSTATUS returns 1 if write succeeded, 0 otherwise.
FILENAME must be a valid .ods OpenOffice.org file name (including
file name extension). If FILENAME does not contain any directory
path, the file is saved in the current directory.
ARR can be any array type save complex. Mixed numeric/text arrays
can only be cell arrays.
WSH can be a number or string. In case of a not yet existing
OpenOffice.org spreadsheet, the first sheet will be used & named
according to WSH - no extra empty sheets are created. In case of
existing files, some checks are made for existing sheet names or
numbers, or whether WSH refers to an existing sheet with a type
other than sheet (e.g., chart). When new sheets are to be added
to the spreadsheet file, they are inserted to the right of all
existing sheets. The pointer to the "active" sheet (shown when
OpenOffice.org Calc opens the file) remains untouched.
RANGE is expected to be a regular spreadsheet range. Data is
added to the sheet; existing data in the requested range will be
overwritten. Array ARR will be clipped at the right and/or bottom
if its size is bigger than can be accommodated in RANGE. If ARR
is smaller than the RANGE allows, it is placed in the top left of
RANGE.
If RANGE contains merged cells, only the elements of ARR
corresponding to the top or left Calc cells of those merged cells
will be written, other array cells corresponding to that cell will
be ignored.
The optional last argument REQINTF can be used to override the
automatic selection by odswrite of one interface out of the
supported ones: Java/ODFtooolkit ('OTK'), or Java/jOpenDocument
('JOD').
odswrite is a mere wrapper for various scripts which find out what
ODS interface to use (ODF toolkit or jOpenDocument) plus code to
mimic the other brand's syntax. For each call to odswrite such an
interface must be started and possibly an ODS file loaded. When
writing to multiple ranges and/or worksheets in the same ODS file,
a speed bonus can be obtained by invoking those scripts (odsopen /
octods / .... / odsclose) directly.
Example:
status = odswrite ('test4.ods', 'arr', 'Eight_sheet', 'C3:AB40');
(which adds the contents of array arr (any type) to range C3:AB40
in sheet 'Eight_sheet' in file test4.ods and returns a logical
True (= numerical 1) in status if al went well)
See also: odsread, oct2ods, ods2oct, odsopen, odsclose, odsfinfo
# name: <cell-element>
# type: string
# elements: 1
# length: 80
Add data in 1D/2D array ARR to sheet WSH in OpenOffice_org Calc
spreadsheet file
# name: <cell-element>
# type: string
# elements: 1
# length: 14
parse_sp_range
# name: <cell-element>
# type: string
# elements: 1
# length: 199
Parse a string representing a range of cells for a spreadsheet
into nr of rows and nr of columns and also extract top left
cell address + top row + left column. Some error checks are implemented.
# name: <cell-element>
# type: string
# elements: 1
# length: 80
Parse a string representing a range of cells for a spreadsheet
into nr of rows
# name: <cell-element>
# type: string
# elements: 1
# length: 9
parsecell
# name: <cell-element>
# type: string
# elements: 1
# length: 1431
-- Function File: [ NUMARR, TXTARR, LIM ] = parsecell (RAWARR)
-- Function File: [ NUMARR, TXTARR, LIM ] = parsecell (RAWARR, LIMITS)
Divide a heterogeneous 2D cell array into a 2D numeric array and a
2D cell array containing only strings. Both returned arrays are
trimmed from empty outer rows and columns. This function is
particularly useful for parsing cell arrays returned by functions
reading spreadsheets (e.g., xlsread, odsread).
Optional return argument LIM contains two field with the outer
column and row numbers of NUMARR and TXTARR in the original array
RAWARR. Optional input argument LIMITS can either be the
spreadsheet data limits returned in the spreadsheet file pointer
struct (field xls.limits or ods.limits), or the file ptr struct
itself. If one of these is specified, optional return argument LIM
will contain the real spreadsheet row & column numbers enclosing
the origins of the numerical and text data returned in NUMARR and
TXTARR.
Examples:
[An, Tn] = parsecell (Rn);
(which returns the numeric contents of Rn into array An and the
text data into array Tn)
[An, Tn, lims] = parsecell (Rn, xls.limits);
(which returns the numeric contents of Rn into array An and the
text data into array Tn.)
See also: xlsread, odsread, xls2oct, ods2oct
# name: <cell-element>
# type: string
# elements: 1
# length: 80
Divide a heterogeneous 2D cell array into a 2D numeric array and a 2D
cell array
# name: <cell-element>
# type: string
# elements: 1
# length: 13
spsh_chkrange
# name: <cell-element>
# type: string
# elements: 1
# length: 449
-- Function File: [ TOPLEFTADDR, NROWS, NCOLS, TOPROW, LEFTCOL ] =
spsh_chkrange ( RANGE, ROWSIZE, COLSIZE, INTF-TYPE, FILENAME)
(Internal function) Get and check various cell and range address
parameters for spreadsheet input.
spsh_chkrange should not be invoked directly but rather through
oct2xls or oct2ods.
Example:
[tl, nrw, ncl, trw, lcl] = spsh_chkrange (crange, nr, nc, xtype, fileptr);
# name: <cell-element>
# type: string
# elements: 1
# length: 80
(Internal function) Get and check various cell and range address
parameters for
# name: <cell-element>
# type: string
# elements: 1
# length: 12
spsh_prstype
# name: <cell-element>
# type: string
# elements: 1
# length: 521
-- Function File: [ TYPE-ARRAY ] = spsh_prstype ( IARRAY, ROWSIZE,
COLSIZE, CELLTYPES, OPTIONS)
(Internal function) Return rectangular array with codes for cell
types in rectangular input cell array IARRAY. Codes are contained
in input vector in order of Numeric, Boolean, Text, Formula and
Empty, resp.
spsh_prstype should not be invoked directly but rather through
oct2xls or oct2ods.
Example:
typarr = spsh_chkrange (cellarray, nr, nc, ctypes, options);
# name: <cell-element>
# type: string
# elements: 1
# length: 80
(Internal function) Return rectangular array with codes for cell types
in rectan
# name: <cell-element>
# type: string
# elements: 1
# length: 7
xls2oct
# name: <cell-element>
# type: string
# elements: 1
# length: 3912
-- Function File: [ RAWARR, XLS, RSTATUS ] = xls2oct (XLS)
-- Function File: [ RAWARR, XLS, RSTATUS ] = xls2oct (XLS, WSH)
-- Function File: [ RAWARR, XLS, RSTATUS ] = xls2oct (XLS, WSH, RANGE)
-- Function File: [ RAWARR, XLS, RSTATUS ] = xls2oct (XLS, WSH, RANGE,
OPTIONS)
Read data contained within range RANGE from worksheet WSH in an
Excel spreadsheet file pointed to in struct XLS.
WSH is either numerical or text, in the latter case it is
case-sensitive and it may be max. 31 characters long. Note that
in case of a numerical WSH this number refers to the position in
the worksheet stack, counted from the left in an Excel window. The
default is numerical 1, i.e. the leftmost worksheet in the Excel
file.
RANGE is expected to be a regular spreadsheet range format, or ""
(empty string, indicating all data in a worksheet). If no range
is specified the occupied cell range will have to be determined
behind the scenes first; this can take some time for the
Java-based interfaces. Be aware that in Excel/ActiveX interface the
used range can be outdated. The Java-based interfaces are more
reliable in this respect albeit much slower.
Optional argument OPTIONS, a structure, can be used to specify
various read modes. Currently the only option field is
"formulas_as_text"; if set to TRUE or 1, spreadsheet formulas (if
at all present) are read as formula strings rather than the
evaluated formula result values. This only works for the Java
based interfaces (POI and JXL).
If only the first argument is specified, xls2oct will try to read
all contents from the first = leftmost (or the only) worksheet (as
if a range of '' (empty string) was specified).
If only two arguments are specified, xls2oct assumes the second
argument to be WSH. In that case xls2oct will try to read all data
contained in that worksheet.
Return argument RAWARR contains the raw spreadsheet cell data.
Optional return argument XLS contains the pointer struct, RSTATUS
will be set to 1 if the requested data have been read
successfully, 0 otherwise. Use parsecell() to separate numeric
and text values from RAWARR.
XLS is supposed to have been created earlier by xlsopen in the
same octave session. It is only referred to, not changed.
If one of the Java interfaces is used, field XLS.limits contains
the outermost column and row numbers of the actually read cell
range.
Erroneous data and empty cells turn up empty in RAWARR. Date/time
values in Excel are returned as numerical values. Note that Excel
and Octave have different date base values (1/1/1900 & 1/1/0000,
resp.) Be aware that Excel trims RAWARR from empty outer rows &
columns, so any returned cell array may turn out to be smaller
than requested in RANGE. When using COM or POI interface,
formulas in cells are evaluated; if that fails cached values are
retrieved. These may be outdated depending on Excel's "Automatic
calculation" settings when the spreadsheet was saved.
When reading from merged cells, all array elements NOT
corresponding to the leftmost or upper Excel cell will be treated
as if the "corresponding" Excel cells are empty.
Beware: when the COM interface is used, hidden Excel invocations
may be kept running silently in case of COM errors.
Examples:
A = xls2oct (xls1, '2nd_sheet', 'C3:AB40');
(which returns the numeric contents in range C3:AB40 in worksheet
'2nd_sheet' from a spreadsheet file pointed to in pointer struct xls1,
into numeric array A)
[An, xls2, status] = xls2oct (xls2, 'Third_sheet');
See also: oct2xls, xlsopen, xlsclose, parsecell, xlsread,
xlsfinfo, xlswrite
# name: <cell-element>
# type: string
# elements: 1
# length: 80
Read data contained within range RANGE from worksheet WSH in an Excel
spreadshee
# name: <cell-element>
# type: string
# elements: 1
# length: 8
xlsclose
# name: <cell-element>
# type: string
# elements: 1
# length: 1618
-- Function File: [ XLS] = xlsclose (XLS)
-- Function File: [ XLS] = xlsclose (XLS, FILENAME)
Close the Excel spreadsheet pointed to in struct XLS, if needed
write the file to disk. Based on information contained in XLS,
xlsclose will determine if the file should be written to disk.
If no errors occured during writing, the xls file pointer struct
will be reset and -if COM interface was used- ActiveX/Excel will
be closed. However if errors occurred, the file pinter will be
ontouched so you can clean up before a next try with xlsclose().
Be warned that until xlsopen is called again with the same XLS
pointer struct and _KEEPXLS_ omitted or set to false, hidden Excel
or Java applications with associated (possibly large) memory
chunks are kept alive taking up resources.
FILENAME can be used to write changed spreadsheet files to an
other file than opened with xlsopen(); unfortunately this doesn't
work with JXL (JExcelAPI) interface.
You need MS-Excel (95 - 2010), and/or the Java package > 1.2.6
plus Apache POI > 3.5 and/or JExcelAPI installed on your computer
+ proper javaclasspath set, to make this function work at all.
XLS must be a valid pointer struct made by xlsopen() in the same
octave session.
Beware: Excel invocations may be left running invisibly in case of
COM errors.
Examples:
xls1 = xlsclose (xls1);
(Close spreadsheet file pointed to in pointer struct xls1; xls1 is reset)
See also: xlsopen, xlsread, xlswrite, xls2oct, oct2xls, xlsfinfo
# name: <cell-element>
# type: string
# elements: 1
# length: 80
Close the Excel spreadsheet pointed to in struct XLS, if needed write
the file t
# name: <cell-element>
# type: string
# elements: 1
# length: 8
xlsfinfo
# name: <cell-element>
# type: string
# elements: 1
# length: 2240
-- Function File: [ FILETYPE] = xlsfinfo (FILENAME [, REQINTF])
-- Function File: [ FILETYPE, SH_NAMES] = xlsfinfo (FILENAME [,
REQINTF])
-- Function File: [ FILETYPE, SH_NAMES, FFORMAT] = xlsfinfo (FILENAME
[, REQINTF])
Query Excel spreadsheet file FILENAME for some info about its
contents.
If FILENAME is a recognizable Excel spreadsheet file, FILETYPE
returns the string "Microsoft Excel Spreadsheet", or '' (empty
string) otherwise.
If FILENAME is a recognizable Excel spreadsheet file, optional
argument SH_NAMES contains a list (cell array) of sheet names (and
in case Excel is installed: sheet types) contained in FILENAME, in
the order (from left to right) in which they occur in the sheet
stack.
Optional return value FFORMAT currently returns '' (empty string)
unless FILENAME is a readable Excel 97-2003 .xls file or an Excel
2007 .xlsx / .xlsb file in which case FFORMAT is set to
"xlWorkbookNormal". Excel 95 .xls files can only be read through
the JXL (JExcelAPI) java-based interface.
If no return arguments are specified the sheet names are echoed to
the terminal screen; in case of java interfaces for each sheet the
actual occupied data range is echoed as well. The occupied cell
range will have to be determined behind the scenes first; this can
take some time for the Java-based interfaces.
If multiple xls interfaces have been installed, REQINTF can be
specified. This can sometimes be handy, e.g. to get an idea of
occupied cell ranges in each worksheet using a java-based
interface (the COM / ActiveX interface can't supply this
information).
For use on OOXML spreadsheets one needs full POI support (see
xlsopen) and 'poi' needs to be specified for REQINTF. For Excel 95
file use 'jxl'.
Examples:
exist = xlsfinfo ('test4.xls');
(Just checks if file test4.xls is a readable Excel file)
[exist, names] = xlsfinfo ('test4.xls');
(Checks if file test4.xls is a readable Excel file and return a
list of sheet names and -types)
See also: oct2xls, xlsread, xls2oct, xlswrite
# name: <cell-element>
# type: string
# elements: 1
# length: 71
Query Excel spreadsheet file FILENAME for some info about its contents.
# name: <cell-element>
# type: string
# elements: 1
# length: 7
xlsopen
# name: <cell-element>
# type: string
# elements: 1
# length: 2422
-- Function File: XLS = xlsopen (FILENAME)
-- Function File: XLS = xlsopen (FILENAME, READWRITE)
-- Function File: XLS = xlsopen (FILENAME, READWRITE, REQINTF)
Get a pointer to an Excel spreadsheet in the form of return
argument (file pointer struct) XLS. After processing the
spreadsheet, the file pointer must be explicitly closed by calling
xlsclose().
Calling xlsopen without specifying a return argument is fairly
useless!
To make this function work at all, you need MS-Excel (95 - 2003),
and/or the Java package > 1.2.6 plus either Apache POI > 3.5 or
JExcelAPI installed on your computer + proper javaclasspath set.
These interfaces are referred to as COM, POI and JXL, resp., and
are preferred in that order by default (depending on their
presence). For OOXML support, in addition to Apache POI support
you also need the following jars in your javaclasspath:
poi-ooxml-schemas-3.5.jar, xbean.jar and dom4j-1.6.1.jar (or later
versions).
FILENAME should be a valid .xls or xlsx Excel file name (including
extension); but if you use the COM interface you can specify any
extension that your installed Excel version can read AND write,
using the Java interfaces only .xls or .xlsx are allowed. If
FILENAME does not contain any directory path, the file is saved in
the current directory.
If READWRITE is set to 0 (default value) or omitted, the Excel file
is opened for reading. If READWRITE is set to True or 1, an Excel
file is opened (or created) for reading & writing.
Optional input argument REQINTF can be used to override the Excel
interface that otherwise is automatically selected by xlsopen.
Currently implemented interfaces (in order of preference) are
'COM' (Excel / COM), 'POI' (Java / Apache POI) or 'JXL' (Java /
JExcelAPI).
Beware: Excel invocations may be left running invisibly in case of
COM errors or forgetting to close the file pointer.
Examples:
xls = xlsopen ('test1.xls');
(get a pointer for reading from spreadsheet test1.xls)
xls = xlsopen ('test2.xls', 1, 'POI');
(as above, indicate test2.xls will be written to; in this case using Java
and the Apache POI interface are requested)
See also: xlsclose, xlsread, xlswrite, xls2oct, oct2xls, xlsfinfo
# name: <cell-element>
# type: string
# elements: 1
# length: 80
Get a pointer to an Excel spreadsheet in the form of return argument
(file point
# name: <cell-element>
# type: string
# elements: 1
# length: 7
xlsread
# name: <cell-element>
# type: string
# elements: 1
# length: 5638
-- Function File: [ NUMARR, TXTARR, RAWARR, LIMITS] = xlsread
(FILENAME)
-- Function File: [ NUMARR, TXTARR, RAWARR, LIMITS] = xlsread
(FILENAME, WSH)
-- Function File: [ NUMARR, TXTARR, RAWARR, LIMITS] = xlsread
(FILENAME, RANGE)
-- Function File: [ NUMARR, TXTARR, RAWARR, LIMITS] = xlsread
(FILENAME, WSH, RANGE)
-- Function File: [ NUMARR, TXTARR, RAWARR, LIMITS] = xlsread
(FILENAME, WSH, RANGE, REQINTF)
Read data contained in range RANGE from worksheet WSH in Excel
spreadsheet file FILENAME. Return argument NUMARR contains the
numeric data, optional return arguments TXTARR and RAWARR contain
text strings and the raw spreadsheet cell data, respectively.
If neither Excel, Java/Apache POI or Java/JExcelAPI are installed,
xlsread will fail and suggest .csv file reading.
LIMITS contains the outer column/row numbers of the read
spreadsheet range where NUMARR, TXTARR and RAWARR have come from
(remember, xlsread trims outer rows and columns).
If FILENAME does not contain any directory, the file is assumed to
be in the current directory. The filename extension (.xls or
.xlsx) must be included in the file name; when using the COM
interface any file format can be read from that can be read and
written by the locally installed MS-Excel version (e.g., wk1, csv,
dbf, ...).
RANGE is expected to be a regular spreadsheet range format, or ""
(empty string, indicating all data in a worksheet). If no range
is specified the occupied cell range will have to be determined
behind the scenes first; this can take some time for the
Java-based interfaces (but the results are more reliable than that
of ActiveX/COM).
WSH is either numerical or text; in the latter case it is
case-sensitive and it may be max. 31 characters long. Note that
in case of a numerical WSH this number refers to the position in
the worksheet stack, counted from the left in an Excel window. The
default is numerical 1, i.e. the leftmost worksheet in the Excel
file.
If only the first argument is specified, xlsread will try to read
all contents from the first = leftmost (or the only) worksheet (as
if a range of '' (empty string) was specified).
If only two arguments are specified, xlsread assumes the second
argument to be RANGE if it is a string argument and contains a
":" or if it is '' (empty string) and in those cases assumes the
data must be read from the first worksheet (not necessarily
Sheet1! but the leftmost sheet).
However, if only two arguments are specified and the second
argument is numeric or a text string that does not contain a ":",
it is assumed to be WSH and to refer to a worksheet. In that case
xlsread tries to read all data contained in that worksheet.
The optional last argument REQINTF can be used to override the
automatic selection by xlsread of one interface out of the
supported ones: COM/Excel, Java/Apache POI, or Java/JExcelAPI (in
that built-in order of preference). For reading from OOXML files
a value of 'poi' must be specified for REQINTF (see help for
xlsopen); for Excel'95 files use 'com', or if Excel is not
installed use 'jxl' or 'basic' (POI can't read Excel 95 but will
try to fall back to JXL). As REQINTF can also be a cell array of
strings, one can select or exclude one or more interfaces.
Erroneous data and empty cells are set to NaN in NUMARR and turn
up empty in TXTARR and RAWARR. Date/time values in Excel are
returned as numerical values in NUMARR. Note that Excel and Octave
have different date base values (1/1/1900 & 1/1/0000, resp.)
NUMARR and TXTARR are trimmed from empty outer rows and columns.
Be aware that Excel does the same for RAWARR, so any returned
array may turn out to be smaller than requested in RANGE.
When reading from merged cells, all array elements NOT
corresponding to the leftmost or upper Excel cell will be treated
as if the "corresponding" Excel cells are empty.
xlsread is just a wrapper for a collection of scripts that find out
the interface to be used (COM, Java/POI, Java/JXL) and do the
actual reading. For each call to xlsread the interface must be
started and the Excel file read into memory. When reading multiple
ranges (in optionally multiple worksheets) a significant speed
boost can be obtained by invoking those scripts directly as in:
xlsopen / xls2oct [/ parsecell] / ... / xlsclose
Beware: when using the COM interface, hidden Excel invocations may
be kept running silently if not closed explicitly.
Examples:
A = xlsread ('test4.xls', '2nd_sheet', 'C3:AB40');
(which returns the numeric contents in range C3:AB40 in worksheet
'2nd_sheet' from file test4.xls into numeric array A)
[An, Tn, Ra, limits] = xlsread ('Sales2009.xls', 'Third_sheet');
(which returns all data in worksheet 'Third_sheet' in file 'Sales2009.xls'
into array An, the text data into array Tn, the raw cell data into
cell array Ra and the ranges from where the actual data came in limits)
numarr = xlsread ('Sales2010.xls', 4, [], {'JXL', 'COM'});
(Read all data from 4th worksheet in file Sales2010.xls using either JXL
or COM interface (i.e, exclude POI interface).
See also: xlswrite, xlsopen, xls2oct, xlsclose, xlsfinfo, oct2xls
# name: <cell-element>
# type: string
# elements: 1
# length: 80
Read data contained in range RANGE from worksheet WSH in Excel
spreadsheet file
# name: <cell-element>
# type: string
# elements: 1
# length: 8
xlswrite
# name: <cell-element>
# type: string
# elements: 1
# length: 3422
-- Function File: RSTATUS = xlswrite (FILENAME, ARR)
-- Function File: RSTATUS = xlswrite (FILENAME, ARR, WSH)
-- Function File: RSTATUS = xlswrite (FILENAME, ARR, WSH, RANGE)
-- Function File: RSTATUS = xlswrite (FILENAME, ARR, WSH, RANGE,
REQINTF)
Add data in 1D/2D array ARR to worksheet WSH in Excel spreadsheet
file FILENAME in range RANGE.
RSTATUS returns 1 if write succeeded, 0 otherwise.
FILENAME must be a valid .xls Excel file name (including file name
extension). If FILENAME does not contain any directory path, the
file is saved in the current directory.
ARR can be any array type save complex. Mixed numeric/text arrays
can only be cell arrays.
If only 3 arguments are given, the 3rd is assumed to be a
spreadsheet range if it contains a ":" or is a completely empty
string (corresponding to A1:IV65336). The 3rd argument is assumed
to refer to a worksheet if it is a numeric value or a non-empty
text string not containing ":"
WSH can be a number or string (max. 31 chars). In case of a not
yet existing Excel file, the first worksheet will be used & named
according to WSH - the extra worksheets that Excel creates by
default are deleted. In case of existing files, some checks are
made for existing worksheet names or numbers, or whether WSH
refers to an existing sheet with a type other than worksheet
(e.g., chart). When new worksheets are to be added to the Excel
file, they are inserted to the right of all existing worksheets.
The pointer to the "active" sheet (shown when Excel opens the
file) remains untouched.
RANGE is expected to be a regular spreadsheet range. Data is
added to the worksheet; existing data in the requested range will
be overwritten. Array ARR will be clipped at the right and/or
bottom if its size is bigger than can be accommodated in RANGE.
If ARR is smaller than the RANGE allows, it is placed in the top
left of RANGE.
If RANGE contains merged cells, only the elements of ARR
corresponding to the top or left Excel cells of those merged cells
will be written, other array cells corresponding to that cell will
be ignored.
The optional last argument REQINTF can be used to override the
automatic selection by xlswrite of one interface out of the
supported ones: COM/Excel, Java/Apache POI, or Java/JExcelAPI.
For writing to OOXML files (.xlsx) a value of 'poi'
(case-insensitive) must be specified for REQINTF.
xlswrite is a mere wrapper for various scripts which find out what
Excel interface to use (COM, Java/POI) plus code to mimic the other
brand's syntax. For each call to xlswrite such an interface must be
started and possibly an Excel file loaded. When writing to multiple
ranges and/or worksheets in the same Excel file, a speed bonus can
be obtained by invoking those scripts (xlsopen / octxls / .... /
xlsclose) directly.
Examples:
status = xlswrite ('test4.xls', 'arr', 'Third_sheet', 'C3:AB40');
(which adds the contents of array arr (any type) to range C3:AB40
in worksheet 'Third_sheet' in file test4.xls and returns a logical
True (= numerical 1) in status if al went well)
See also: xlsread, oct2xls, xls2oct, xlsopen, xlsclose, xlsfinfo
# name: <cell-element>
# type: string
# elements: 1
# length: 80
Add data in 1D/2D array ARR to worksheet WSH in Excel spreadsheet file
FILENAME
|