Skip to content

excel sheet get

zmworm edited this page Apr 22, 2026 · 48 revisions

Excel: Sheet - get

Get worksheet properties and contents.

Path: /{SheetName}

Attributes

Attribute Type Description
freeze string Freeze pane anchor cell (e.g., A2, B3) or empty if none
autoFilter string AutoFilter range if set (e.g., A1:D10)
zoom number Zoom scale percentage (10-400)
tabColor string Sheet tab color (hex RGB) or empty if none

Children

When retrieved, a sheet lists its rows and cells as child elements. Use --depth to control how deep the output traverses.

Child Description
row[N] Rows with data or formatting
A1, B2, ... Cells within those rows
chart[N] Charts on the sheet

Examples

# Get sheet overview
officecli get data.xlsx /Sheet1
/Sheet1
  freeze: A2
  children:
    /Sheet1/row[1]
    /Sheet1/row[2]
    /Sheet1/row[3]
# Get sheet with deeper traversal
officecli get data.xlsx /Sheet1 --depth 2

# Get as JSON
officecli get data.xlsx /Sheet1 --json

See Also


Based on OfficeCLI v1.0.54

Clone this wiki locally