Class default

Hierarchy

BasePlugin<TimelinePluginEvents, TimelinePluginOptions>
- default

Index

Constructors

Properties

options subscriptions timelineWrapper wavesurfer?

Methods

_init defaultPrimaryLabelInterval defaultSecondaryLabelInterval defaultTimeInterval destroy emit initTimeline initTimelineWrapper on onInit once un unAll virtualAppend create

Constructors

constructor

new default(options?): default
Parameters
- Optional options: TimelinePluginOptions
Returns default
Overrides BasePlugin<TimelinePluginEvents, TimelinePluginOptions>.constructor
- Defined in plugins/timeline.ts:61

Properties

`Protected` options

options: TimelinePluginOptions & {
    formatTimeCallback: ((seconds) => string);
    height: number;
    timeOffset: number;
}

Type declaration

formatTimeCallback: ((seconds) => string)
- - (seconds): string
  - Parameters
    - seconds: number
    Returns string
height: number
timeOffset: number

`Protected` subscriptions

subscriptions: (() => void)[] = []

Type declaration

- (): void
- Returns void

`Private` timelineWrapper

timelineWrapper: HTMLElement

`Protected` `Optional` wavesurfer

wavesurfer?: default

Methods

_init

_init(wavesurfer): void
Do not call directly, only called by WavesSurfer internally
Parameters
- wavesurfer: default
Returns void
Inherited from BasePlugin._init
- Defined in base-plugin.ts:28

`Private` defaultPrimaryLabelInterval

defaultPrimaryLabelInterval(pxPerSec): number
Parameters
- pxPerSec: number
Returns number
- Defined in plugins/timeline.ts:126

`Private` defaultSecondaryLabelInterval

defaultSecondaryLabelInterval(pxPerSec): number
Parameters
- pxPerSec: number
Returns number
- Defined in plugins/timeline.ts:138

`Private` defaultTimeInterval

defaultTimeInterval(pxPerSec): number
Parameters
- pxPerSec: number
Returns number
- Defined in plugins/timeline.ts:114

destroy

destroy(): void
Unmount

Returns void
Overrides BasePlugin.destroy
- Defined in plugins/timeline.ts:104

`Protected` emit

emit<EventName>(eventName, ...args): void
Emit an event
Type Parameters
- EventName extends "ready" | "destroy"
Parameters
- eventName: EventName
- Rest ...args: TimelinePluginEvents[EventName]
Returns void
Inherited from BasePlugin.emit
- Defined in event-emitter.ts:64

`Private` initTimeline

initTimeline(): void
Returns void
- Defined in plugins/timeline.ts:180

`Private` initTimelineWrapper

initTimelineWrapper(): HTMLElement
Returns HTMLElement
- Defined in plugins/timeline.ts:109

on

on<EventName>(event, listener, options?): (() => void)
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
- EventName extends "ready" | "destroy"
Parameters
- event: EventName
- listener: EventListener<TimelinePluginEvents, EventName>
- Optional options: {
  once?: boolean;
  }
  - Optional once?: boolean
Returns (() => void)
- - (): void
  - Subscribe to an event. Returns an unsubscribe function.
    
    Returns void
Inherited from BasePlugin.on
- Defined in event-emitter.ts:20

onInit

onInit(): void
Called by wavesurfer, don't call manually

Returns void
Overrides BasePlugin.onInit
- Defined in plugins/timeline.ts:73

once

once<EventName>(event, listener): (() => void)
Subscribe to an event only once
Type Parameters
- EventName extends "ready" | "destroy"
Parameters
- event: EventName
- listener: EventListener<TimelinePluginEvents, EventName>
Returns (() => void)
- - (): void
  - Subscribe to an event only once
    
    Returns void
Inherited from BasePlugin.once
- Defined in event-emitter.ts:51

un

un<EventName>(event, listener): void
Unsubscribe from an event
Type Parameters
- EventName extends "ready" | "destroy"
Parameters
- event: EventName
- listener: EventListener<TimelinePluginEvents, EventName>
Returns void
Inherited from BasePlugin.un
- Defined in event-emitter.ts:43

unAll

unAll(): void
Clear all events

Returns void
Inherited from BasePlugin.unAll
- Defined in event-emitter.ts:59

`Private` virtualAppend

virtualAppend(start, container, element): void
Parameters
- start: number
- container: HTMLElement
- element: HTMLElement
Returns void
- Defined in plugins/timeline.ts:149

`Static` create

create(options?): default
Parameters
- Optional options: TimelinePluginOptions
Returns default
- Defined in plugins/timeline.ts:68

Generated using TypeDoc