Difference between revisions of "Functions To Read Excel Worksheets"
Line 256: Line 256:
 
* [[Media:Functions for Reading Excel Worksheets.ana|Reading Excel Worksheets.ana]]
 
* [[Media:Functions for Reading Excel Worksheets.ana|Reading Excel Worksheets.ana]]
 
* [[Read and Write Spreadsheets]]
 
* [[Read and Write Spreadsheets]]
−
* [[Read from and write to Excel spreadsheets]]
+
* [[Excel spreadsheets read and write]]
 
* [[Functions to Write Data to Excel Worksheets]] -- [[SpreadsheetSetCell]], [[SpreadsheetSetRange]] and [[SpreadsheetSave]]
 
* [[Functions to Write Data to Excel Worksheets]] -- [[SpreadsheetSetCell]], [[SpreadsheetSetRange]] and [[SpreadsheetSave]]
 
* You can also use [[DbQuery| ODBC]] -- a standard database access method to read from Excel spreadsheets.
 
* You can also use [[DbQuery| ODBC]] -- a standard database access method to read from Excel spreadsheets.

Revision as of 16:20, 2 June 2016



These functions let you open an Excel spreadsheet file, and read cells and ranges from it. For writing to a spreadsheet, see Functions to Write Data to Excel Worksheets.

SpreadsheetOpen(filename, showDialog)

Opens the Excel file with given filename. It returns a Workbook object for use by the other functions to read from and write to the spreadsheet. The result displays in a result table as <<ExcelWorkbook>>.

Unless you include a complete file path in «filename», it looks for it in the CurrentDataFolder.

If you omit optional parameter «showDialog», it opens the file browser dialog to let you find a spreadsheet only if it can't find the file (as does ReadTextFile). If you set «showDialog» to true (1), it opens the file browser even if it finds the file «filename». If «showDialog» is false (0), it never prompts you even if it can't find the file. In each case, it flags an error if it doesn't end up opening a file.

«filename» can also be the name of a workbook that is currently open in Excel, even if it has not yet been saved.

Example

SpreadsheetOpen("C:\MyModels\Sales Numbers.xls") → «ExcelWorkbook»

Use with Office 2010

If you have installed the "Click-to-Run" version of Office 2010 from a web download, these spreadsheet functions may not work, due to a "feature" introduced in Office 2010 that apparently disables several common operations. In this case, you may need to re-install Office using the MSI-based edition. See how to do this at:

http://office.microsoft.com/en-gb/excel-help/click-to-run-switch-to-using-a-full-office-edition-HA101850538.aspx

Remembering the selected filename

When SpreadsheetOpen() shows the file dialog and you select a file, it does not save the file name. So, the next time you load the model, you'll have to select the file again. If you want the model to remember the selected file, so it will just load it without asking, prompt using that file name as the default, you can use the SpreadsheetOpenEx function in the Spreadsheet Helper Library.

SpreadsheetCell(workbook, sheet, column, row, what)

Returns the value (or other information) of a cell of a worksheet given its coordinates. The function fully array abstracts, so you can get a range of cells by specifying the column and/or row as an array.

Parameters:

«workbook»
A workbook object returned by SpreadsheetOpen()
«sheet»
The name or number of a worksheet from the workbook. Number 1 is the first worksheet, etc.
If you specify sheet: "*", it returns the cell value from column, row for all sheets in the workbook, indexed by .Sheet, a local index containing the names of the worksheets. This is a way to get a list of all the worksheets in the workbook. If you specify column and/or rows as arrays, you can also use this to get a 3D array for a range over all worksheets.
«column»
The column label, e.g., "A", "B", or "AB", or the column number as an integer.
«row»
The row number as an integer
«what»
optional. Let's you get the formula or format information from the cell. See below under SpreadsheetRange for details.

If the worksheet cell is empty, it returns Null. It flags an error if «workbook» is not a valid workbook, if it does not contain «sheet», or if the coordinates are invalid.

Examples

These expressions are different ways to get the same result, the value from cell C7 in the first sheet, "Sheet1" of workbook:

SpreadsheetCell(workbook, "Sheet1", "C", 7)
SpreadsheetCell(workbook, "Sheet1", 3, 7)
SpreadsheetCell(workbook, 1, 3, 7)

Suppose the spreadsheet contains a 2-D table in the region C4:J19. The columns of this table correspond to the years 2008..2015. The rows correspond to different assets. It is easier to refer to the columns by number, so that the columns "C" thru "J" are columns 3 thru 10. To hold this 2-D table, we need two indexes in Analytica, Time and Asset.

Index Time := 2008..2015
Index Asset := 1..16
Variable Workbook := SpreadsheetOpen("C:\Asset Data.xls")
Variable Data := SpreadsheetCell( workbook, "Sheet1", @Time+2, @Asset+3)

SpreadsheetRange(workbook, range, colIndex, rowIndex, howToIndex, sheet, what)

Returns the values (or other information) for a range of cells from an Excel worksheet. The «range» can be can be a cell range such as "C7" or "C7:F12", or the name of a range defined in the spreadsheet. If you want to read or write several cells or ranges in a spreadsheet, it is often convenient to use Excel's name mechanism and refer to them by name in Analytica.

Parameters:

«workbook»
A workbook object returned by SpreadsheetOpen() may be a named range label in the spreadsheet, or it
«range»
A cell range. This may be of the form "Sheet1!A1:BC99", "A1:BC99", or the name defined in the spreadsheet for a cell. If you don't mention the sheet name, you must specify «sheet» as a parameter.
If you specify the range as "Sheet1!", with nothing following the "!", or omit «range» and specify only «sheet», it returns the smallest rectangular range that includes all used cells within the sheet.
«colIndex»
(optional) A pre-existing index for indexing the column dimension of the result.
«rowIndex»
(optional) A pre-existing index for indexing the row dimension of the result.
«howToIndex»
(optional) A set of flags controlling how the result is indexed when «colIndex» or «rowIndex» is not specified. Any of the following values can be added together for this parameter:
1 = Force column index. Forces a column index to be included even if the range spans only a single column. Has no effect if colIndex is specified.
2 = Force row index. Forces a row index to be included even if the range spans only a single row. Has no effect if rowIndex is specified.
4 = Use first row for column labels: The first row in the range is not included in the result returned, but the values in the first row are used as the column labels for the local index .Column.
8 = Use first column for row labels: The first column in the range is not included in the result returned, but the values from the first column are used as row labels for the local index .Row.
16 = Do not issue an error if the supplied «colIndex» or «rowIndex» are not the correct length.
«sheet»
The name of a worksheet inside the workbook, or a number.
«what»
(optional; defaults to Value when not specified). Indicates whether you want to retrieve the value or the formula. Possible values:
"Value": The computed value. Dates are read as date-time numbers, and thus display in Analytica as dates.
"NumericValue": The computed value, but the numeric value of dates is read, so they display as numbers.
"Formula": The textual cell formula in the format you normally see in the Excel interface, e.g., "=Sum(D4:D10)"
"RelativeFormula": The cell formula in relative offset format, e.g., "=Sum(RC[-9]:R[+6]C[-9])"
These require Analytica 4.4:
"NumberFormat": Textual description of the cell number format
"BackColor": Cell background color, integer value: red*65536 + green*256 + blue
"Text Color": Font color, integer value: red*65536 + green*256 + blue
"FontName": Name of the font used to display the cell
"FontSize": Point size of font used to display the cell
"FontStyle": Special font styles for cell separated by spaces, may include "bold italic underline strikethrough subscript superscript outline shadow"
"WrapText": 0 or 1 indicating whether text should be word wrapped in the cell.
"Border[Left|Right|Up|Down]Color": Color of the indicated side of the border. E.g., "BorderLeftColor" returns an integer equal to red*65535+green*256+blue
"Border[Left|Right|Up|Down]Style": Style of indicated border, or Null if not set. May be "Solid", "Dash", "DashDot", "DashDotDot", "Dot", "Double", or "SlantDashDot".
"Border[Left|Right|Up|Down]Weight": Thickness of indicated border, usually between 1 and 4
"DirectPrecedents": Description of cells that are referenced directly by the cell formula in the cell. This includes only precedents in the same worksheet. It unfortunately does not include references to cells appearing on other sheets. Each cell or cell range is separated by a comma.
"DirectPrecedentsRelative": Same as "DirectPrecedents", but cells are identified by their offset relative to the current cell, e.g., R[-3]C[6].
"DirectDependents": Description of cells that reference the given cell in their formula. This includes only dependents in the worksheet. It unfortunately does not include references to dependents appearing in other sheets. Each cell or cell range description is separated by a comma.
"DirectDependentsRelative": Same as "DirectDependents", but cells are identified by their offset relative to the current cell, e.g., R[-3]C[6].
"Precedents": Description of all cells in the current worksheet that the given cell formula depends on directly or indirectly. It does not include cells reached by paths passing through other sheets.
"PrecedentsRelative": Same as "Precedents", but cells are identified by their offset relative to the current cell, e.g., R[-3]C[6]</code..
"Descendants": Description of all cells in the current worksheet that depend directly or indirectly on the given cell. It does not include cells reached by paths passing through other sheets.
"DirectDescendantsRelative": Same as "DirectDescendants", but cells are identified by their offset relative to the current cell, e.g., R[-3]C[6].
These require Analytica 4.6:
"Address": The address of the cell range, e.g., "B12:C13"
"AddressR1C1": The address of the cell range in R1C1 format, e.g., "R12C2:R13C3"
"Sheet": The sheet name where the cell range exists.
"RangeName": The name of the range, if it is a named range.

Depending on the dimensions of the cell range, the result may be a scalar (single cell), a column vector, a row vector, or a 2-D array.

If the range spans more than one column in the spreadsheet, the result must be indexed by a column index. If you already have this index, you can specify it in the optional «colIndex» parameter; otherwise, it creates a local index named .Column as a dimension of the result. By default, the elements of the column index are set to the sheet's column labels, e.g., ["A","B",...."AA","AB",..]. If desired, you can also use the first row of values as elements for the .Column index (this row is then not included in the actual array retrieved -- thus should only be used when the range spans at least two rows). To use the first row for the elements of the local column index, specify howToIndex: 4 and leave the «colIndex» parameter unspecified.

If your result falls entirely within a single column, but you wish to force a local column index to be included, so that the result is a 2-dimensional array of size 1xR, rather than a 1-D vector of length R, then specify howToIndex: 1. If you are using a named range and don't know how many columns there actually are, and it is possible there is only one, then you would want to force a column index so that an error doesn't occur if you use result.Column in an expression.

If the range spans more than one row in the spreadsheet, then a row index must dimension the result. If you already have this index, specify it in the «rowIndex» parameter; otherwise, if the range spans more than one row, a local index named .Row is created by the function and used to dimension the result. The local .Row index that is created contains the row numbers from the spreadsheet as its elements, so for example, if the range is "C7:F12", the .Row index would contain the elements [7, 8, 9, 10, 11, 12]. To force the creation of a local .Row index when the result spans only a single row, specify howToIndex: 2. To use the values from the first column as the elements of the local .Row index, specify howToIndex: 8.

If you specify «colIndex» or «rowIndex», and the length of the indexes do not match the length of the specified range, the range is truncated if the index is too short, or the result filled out with Null values if the index is too long. If the flag howToIndex: 16 is specified, it issues an error if the index length does not match.

Empty cells in the range are Null in the result.

No dependency is maintained between the original data in the spreadsheet and the result. The data retrieved are the value that were there at the time the function is evaluated. If the data in the spreadsheet changes after the function has been evaluated, the results are not invalidated and continue to retain the original values.

(Requires Analytica 4.4 or later) You can obtain the entire used range of a worksheet named "Sheet1" by specifying the «range» as "Sheet1!" or by omitting the «range» parameter and specifying just the «sheet» parameter.

Examples

These example use the following spreadsheet:

WorksheetRange ExcelShot.jpg

In the above spreadsheet, several cell ranges are labelled as named ranges, as follows:

Label Range
Rate B1
Year B3:F3
Cash_flow B4:F4
Divisions A7:A9
Employee_count B7:F9
SpreadsheetRange(wb, "Rate") → 0.08
SpreadsheetRange(wb, "Sheet1!B1") → 0.08
SpreadsheetRange(wb, "Sheet1!B3:F3") →
.Column → 'B' 'C' 'D' 'E' 'F'
2008 2009 2010 2011 2012
Index Year := CopyIndex( SpreadsheetRange(wb, "Year", howToIndex: 1));
SpreadsheetRange(wb, "Cash_flow", colIndex: Year) →
.Year → 2008 2009 2010 2011 2012
-100 10 30 50 60

Note: howToIndex: 1 was specified for Year here so that we would have a 1-D array even if only one year were present in the spreadsheet.

SpreadsheetRange(wb, "Employee_count") →
.Column → 'B' 'C' 'D' 'E' 'F'
.Row
↓		 7 24 27 28 32 35
8 13 13 13 13 13
9 25 22 21 19 16
Index Time := [2008, 2009, 2010, 2011, 2012];
SpreadsheetRange(wb, "A7:F9", colIndex: Time, howToIndex: 8, sheet: 1) →
Time → 2008 2009 2010 2011 2012
.Row
↓		 "Div A" 24 27 28 32 35
"Div B" 13 13 13 13 13
"Div C" 25 22 21 19 16

The examples below require Analytica 4.4 or later:

To obtain the list of worksheet names:

SpreadsheetCell(wb, "*", 1, 1).Sheet

To obtain all used cells in sheet named "Sheet2":

SpreadsheetRange(wb, sheet:"Sheet2")

To obtain the number format of all cells in "Sheet2":

SpreadsheetRange(wb, sheet:"Sheet2", what:"NumberFormat")

SpreadsheetInfo(workbook, item)

Introduced in Analytica 4.5

SpreadsheetInfo gets various kinds of information about the spreadsheet («workbook») specified by parameter «item»:

Value Description
"ActiveSheet" The number of the active (displayed) worksheet.
"Author" The name of the author, usually the name of the person who created the spreadsheet as recorded by Windows OS.
"CalculationMode" The calculation mode set for the workbook, which may be "Automatic", "Manual" or "Semiautomatic", meaning automatic except for data tables.
"CodeName"
"Date1904" The base for dates used in the workbook.
"Filename" The name of the file, including the full file path.
"Name" The name of the file, without the file path.
"Names" A list of all the named ranges.
"ReadOnly" True (1) if the file is saved as Readonly.
"Saved" False (0) if it has unsaved changes.
"SelectedRange" The currently selected Range.
"SelectedRangeR1C1" The currently selected Range specified by row and column number.
"Sheets" A list of the names of all the worksheets
"Title" The title of the spreadsheet

History

Functions for reading cells from Excel were first present in Analytica 4.1 with functions named OpenExcelFile, WorksheetCell and WorksheetRange, although these were labelled as experimental, and the present functions were not officially available until 4.2.0.

The old names are now deprecated, replaced with SpreadsheetOpen, SpreadsheetCell and SpreadsheetRange. The old functions still work at present, but may be removed in future Analytica builds. The parameters have changed slightly from WorksheetRange to SpreadsheetRange, with the sheet parameter moved from being the second to being the last parameter and now optional -- no longer required for named ranges or ranges of the form "Sheet1!A1:Z99".

See Also
Comments


You are not allowed to post comments.