IProvenanceSlidedeck | @visualstorytelling/provenance-core

Hierarchy

IProvenanceSlidedeck

Implemented by

ProvenanceSlidedeck

Index

Properties

Methods

Properties

application

application: Application

Application metadata

autoScreenShot

autoScreenShot: boolean

If true, adds a screenshot to all slides (if screenShotProvider is set)

graph

graph: IProvenanceGraph

screenShotProvider

screenShotProvider: IScreenShotProvider | null

selectedSlide

selectedSlide: IProvenanceSlide | null

slides

slides: IProvenanceSlide[]

Methods

addSlide

addSlide(slide?: IProvenanceSlide, index?: undefined | number): IProvenanceSlide

- Defined in api.ts:402
Parameters
- Optional slide: IProvenanceSlide
- Optional index: undefined | number
Returns IProvenanceSlide

moveSlide

moveSlide(indexFrom: number, indexTo: number, count?: undefined | number): void

- Defined in api.ts:405
Parameters
- indexFrom: number
- indexTo: number
- Optional count: undefined | number
Returns void

next

next(): void

- Defined in api.ts:406
Returns void

off

off(type: string, handler: Handler): void

- Defined in api.ts:422
Parameters
- type: string
- handler: Handler
Returns void

on

on(type: string, handler: Handler): void

- Defined in api.ts:421
Available events:
- slideAdded, emitted when slide is added via this.addSlide()
- slideSelected, emitted when this.selectedSlide is changed
- slidesMoved, emitted when this.moveSlide() is called
- slideRemoved, emitted when this.removeSlide() is called
Parameters
- type: string
- handler: Handler
Returns void

previous

previous(): void

- Defined in api.ts:407
Returns void

removeSlide

removeSlide(slide: IProvenanceSlide): void

- Defined in api.ts:403
Parameters
- slide: IProvenanceSlide
Returns void

removeSlideAtIndex

removeSlideAtIndex(index: number): void

- Defined in api.ts:404
Parameters
- index: number
Returns void

slideAtTime

slideAtTime(time: number): IProvenanceSlide | null

- Defined in api.ts:409
Parameters
- time: number
Returns IProvenanceSlide | null

startTime

startTime(slide: IProvenanceSlide): number

- Defined in api.ts:408
Parameters
- slide: IProvenanceSlide
Returns number

Generated using TypeDoc