Skip to content
2 min read · 380 words

Interface: SlidesNamespace

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

slides.* verbs.

Methods

add()

ts
add(options?: {
  at?: number;
  layout?: string;
  title?: string;
}): MediaChain;

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

Add a slide.

Parameters

ParameterType
options{ at?: number; layout?: string; title?: string; }
options.at?number
options.layout?string
options.title?string

Returns

MediaChain


delete()

ts
delete(slides: number[]): MediaChain;

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

Delete slides by 1-based index.

Parameters

ParameterType
slidesnumber[]

Returns

MediaChain


duplicate()

ts
duplicate(slide: number, options?: {
  at?: number;
}): MediaChain;

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

Duplicate a slide.

Parameters

ParameterType
slidenumber
options{ at?: number; }
options.at?number

Returns

MediaChain


reorder()

ts
reorder(order: number[]): MediaChain;

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

Reorder slides.

Parameters

ParameterType
ordernumber[]

Returns

MediaChain


updateChart()

ts
updateChart(data: unknown[][], options?: {
  slide?: string | number;
}): MediaChain;

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

Update chart data on a slide.

Parameters

ParameterType
dataunknown[][]
options{ slide?: string | number; }
options.slide?string | number

Returns

MediaChain


updateImage()

ts
updateImage(withMedia: MediaChainRef, options?: {
  placeholder?: string;
  slide?: string | number;
}): MediaChain;

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

Replace an image on a slide with another media.

Parameters

ParameterType
withMediaMediaChainRef
options{ placeholder?: string; slide?: string | number; }
options.placeholder?string
options.slide?string | number

Returns

MediaChain


updateTable()

ts
updateTable(updates: {
  col: number;
  row: number;
  value: string;
}[], options?: {
  slide?: string | number;
}): MediaChain;

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

Update table cells on a slide.

Parameters

ParameterType
updates{ col: number; row: number; value: string; }[]
options{ slide?: string | number; }
options.slide?string | number

Returns

MediaChain


updateText()

ts
updateText(text: string, options?: {
  placeholder?: string;
  slide?: string | number;
}): MediaChain;

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

Update text on a slide.

Parameters

ParameterType
textstring
options{ placeholder?: string; slide?: string | number; }
options.placeholder?string
options.slide?string | number

Returns

MediaChain