Interface: SheetNamespace

Defined in: src/batteries/media/builder.ts:241

sheet.* verbs, mirrored from the verb table.

Methods

addColumns()

addColumns(options: {
  after?: number;
  before?: number;
  columns?: {
     header: string;
     values?: (string | number | boolean | null)[];
  }[];
  headers?: string[];
  sheet?: string | number;
}): MediaChain;

Defined in: src/batteries/media/builder.ts:262

Insert columns.

Parameters

Parameter	Type
options	{ after?: number; before?: number; columns?: { header: string; values?: (string | number | boolean | null)[]; }[]; headers?: string[]; sheet?: string | number; }
options.after?	number
options.before?	number
options.columns?	{ header: string; values?: (string | number | boolean | null)[]; }[]
options.headers?	string[]
options.sheet?	string | number

Returns

MediaChain

---

addRows()

addRows(rows: (string | number | boolean | null)[][], options?: {
  after?: number;
  before?: number;
  sheet?: string | number;
}): MediaChain;

Defined in: src/batteries/media/builder.ts:247

Insert rows.

Parameters

Parameter	Type
rows	(string | number | boolean | null)[][]
options	{ after?: number; before?: number; sheet?: string | number; }
options.after?	number
options.before?	number
options.sheet?	string | number

Returns

MediaChain

---

addSheet()

addSheet(name: string, options?: {
  at?: number;
}): MediaChain;

Defined in: src/batteries/media/builder.ts:300

Add a worksheet.

Parameters

Parameter	Type
name	string
options	{ at?: number; }
options.at?	number

Returns

MediaChain

---

deleteColumns()

deleteColumns(columns: number[], options?: {
  sheet?: string | number;
}): MediaChain;

Defined in: src/batteries/media/builder.ts:292

Delete columns by 1-based index.

Parameters

Parameter	Type
columns	number[]
options	{ sheet?: string | number; }
options.sheet?	string | number

Returns

MediaChain

---

deleteRows()

deleteRows(rows: number[], options?: {
  sheet?: string | number;
}): MediaChain;

Defined in: src/batteries/media/builder.ts:288

Delete rows by 1-based index.

Parameters

Parameter	Type
rows	number[]
options	{ sheet?: string | number; }
options.sheet?	string | number

Returns

MediaChain

---

removeSheet()

removeSheet(sheet: string): MediaChain;

Defined in: src/batteries/media/builder.ts:304

Remove a worksheet (name-targeted).

Parameters

Parameter	Type
sheet	string

Returns

MediaChain

---

renameSheet()

renameSheet(sheet: string, to: string): MediaChain;

Defined in: src/batteries/media/builder.ts:296

Rename a worksheet (name-targeted).

Parameters

Parameter	Type
sheet	string
to	string

Returns

MediaChain

---

reorderSheets()

reorderSheets(order: (string | number)[]): MediaChain;

Defined in: src/batteries/media/builder.ts:308

Reorder worksheets by names and/or 1-based indices.

Parameters

Parameter	Type
order	(string | number)[]

Returns

MediaChain

---

transformTable()

transformTable(options: {
  drop?: string[];
  headerRow?: number;
  rename?: {
     from: string;
     to: string;
  }[];
  select?: string[];
  sheet?: string | number;
}): MediaChain;

Defined in: src/batteries/media/builder.ts:312

Table transforms by header name.

Parameters

Parameter	Type
options	{ drop?: string[]; headerRow?: number; rename?: { from: string; to: string; }[]; select?: string[]; sheet?: string | number; }
options.drop?	string[]
options.headerRow?	number
options.rename?	{ from: string; to: string; }[]
options.select?	string[]
options.sheet?	string | number

Returns

MediaChain

---

updateCells()

updateCells(updates: CellUpdate[], options?: {
  sheet?: string | number;
}): MediaChain;

Defined in: src/batteries/media/builder.ts:281

Update cells.

Parameters

Parameter	Type
updates	CellUpdate[]
options	{ sheet?: string | number; }
options.sheet?	string | number

Returns

MediaChain