List worksheets
xlide_list_sheetsLists all Excel worksheets with their used ranges, visibility, pivot tables, chart sheets, and named ranges. Run before reading cells so you request the correct data range.
Instructions
Lists the worksheets in an Excel file with their used ranges, whether each is hidden, and the pivot tables on each, the chart sheets, and the workbook's named ranges. Call this before reading cells, so the range you ask for is one that holds data. On .xlsx, .xlsm and .xlam the file also supplies pivot tables, chart sheets and named ranges. For .xlsb and .xls, Windows with Excel is required; that path surveys sheet names, used ranges and visibility only. Unreadable visibility or pivot metadata is marked unknown with hidden_error or pivot_tables_error. A malformed Excel survey is refused rather than returned as a partial sheet list.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| timeout | No | Seconds allowed if Excel has to answer. | |
| file_path | Yes | Absolute path to the Excel file. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||