Worksheets: list, get, add, rename, update and delete. A worksheet is addressed by name or id.

Functions

add-worksheet

fn (item: Any, name: Str): Map
fn (item: Any, name: Str, opts: Map): Map

POST /workbook/worksheets/add. Returns the new worksheet.

Example

sheet ::microsoft::excel::worksheets/add-worksheet("/Reports/Q3.xlsx", "Pipeline")
sheet.id

delete-worksheet

fn (item: Any, sheet: Str): Map
fn (item: Any, sheet: Str, opts: Map): Map

DELETE /workbook/worksheets/{sheet}. Returns {}.

Example

::microsoft::excel::worksheets/delete-worksheet("/Reports/Q3.xlsx", "Scratch")

get-worksheet

fn (item: Any, sheet: Str): Map
fn (item: Any, sheet: Str, opts: Map): Map

GET /workbook/worksheets/{sheet}.

Example

sheet ::microsoft::excel::worksheets/get-worksheet("/Reports/Q3.xlsx", "Data")
sheet.visibility

list-worksheets

fn (item: Any): Vec
fn (item: Any, opts: Map): Vec

GET /workbook/worksheets. Returns a Vec of {id, name, position, visibility}.

Example

sheets ::microsoft::excel::worksheets/list-worksheets("/Reports/Q3.xlsx")
map(sheets, %.name)

// A workbook in another drive
::microsoft::excel::worksheets/list-worksheets("01ABC", {drive: "b1"})

rename-worksheet

fn (item: Any, sheet: Str, name: Str): Map
fn (item: Any, sheet: Str, name: Str, opts: Map): Map

Rename a worksheet.

Example

::microsoft::excel::worksheets/rename-worksheet("/Reports/Q3.xlsx", "Sheet1", "Data")

update-worksheet

fn (item: Any, sheet: Str, changes: Map): Map
fn (item: Any, sheet: Str, changes: Map, opts: Map): Map

PATCH /workbook/worksheets/{sheet}. changes holds name, position or visibility (Visible, Hidden, VeryHidden).

Example

::microsoft::excel::worksheets/update-worksheet("/Reports/Q3.xlsx", "Scratch", {position: 0, visibility: "Hidden"})