Class MinimapPlugin

Hierarchy

BasePlugin<MinimapPluginEvents, MinimapPluginOptions>
- MinimapPlugin

Index

Constructors

Properties

container miniWavesurfer minimapWrapper options overlay subscriptions wavesurfer?

Methods

destroy emit getOverlayWidth init initMinimap initMinimapWrapper initOverlay initWaveSurferEvents on onInit onRedraw onScroll once un unAll create

Constructors

constructor

new MinimapPlugin(options): MinimapPlugin
Parameters
- options: MinimapPluginOptions
Returns MinimapPlugin
Overrides BasePlugin<MinimapPluginEvents, MinimapPluginOptions>.constructor
- Defined in plugins/minimap.ts:31

Properties

`Private` container

container: null | HTMLElement = null

`Private` miniWavesurfer

miniWavesurfer: null | WaveSurfer = null

`Private` minimapWrapper

minimapWrapper: HTMLElement

`Protected` options

options: {
    insertPosition?: InsertPosition;
    overlayColor?: string;
} & WaveSurferOptions & {
    height: number;
    insertPosition: string;
    overlayColor: string;
}

Type declaration

Optional insertPosition?: InsertPosition
Optional overlayColor?: string

Type declaration

height: number
insertPosition: string
overlayColor: string

`Private` overlay

overlay: HTMLElement

`Protected` subscriptions

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

Type declaration

- (): void
- Returns void

`Protected` `Optional` wavesurfer

wavesurfer?: WaveSurfer

Methods

destroy

destroy(): void
Unmount

Returns void
Overrides BasePlugin.destroy
- Defined in plugins/minimap.ts:150

`Protected` emit

emit<EventName>(eventName, ...args): void
Emit an event
Type Parameters
- EventName extends keyof MinimapPluginEvents
Parameters
- eventName: EventName
- Rest ...args: MinimapPluginEvents[EventName]
Returns void
Inherited from BasePlugin.emit
- Defined in event-emitter.ts:69

`Private` getOverlayWidth

getOverlayWidth(): number
Returns number
- Defined in plugins/minimap.ts:115

init

init(wavesurfer): void
Parameters
- wavesurfer: WaveSurfer
Returns void
Inherited from BasePlugin.init
- Defined in base-plugin.ts:21

`Private` initMinimap

initMinimap(): void
Returns void
- Defined in plugins/minimap.ts:82

`Private` initMinimapWrapper

initMinimapWrapper(): HTMLElement
Returns HTMLElement
- Defined in plugins/minimap.ts:64

`Private` initOverlay

initOverlay(): HTMLElement
Returns HTMLElement
- Defined in plugins/minimap.ts:71

`Private` initWaveSurferEvents

initWaveSurferEvents(): void
Returns void
- Defined in plugins/minimap.ts:131

on

on<EventName>(eventName, listener): (() => void)
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
- EventName extends keyof MinimapPluginEvents
Parameters
- eventName: EventName
- listener: EventListener<MinimapPluginEvents, EventName>
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/minimap.ts:44

`Private` onRedraw

onRedraw(): void
Returns void
- Defined in plugins/minimap.ts:120

`Private` onScroll

onScroll(startTime): void
Parameters
- startTime: number
Returns void
- Defined in plugins/minimap.ts:125

once

once<EventName>(eventName, listener): (() => void)
Subscribe to an event only once
Type Parameters
- EventName extends keyof MinimapPluginEvents
Parameters
- eventName: EventName
- listener: EventListener<MinimapPluginEvents, EventName>
Returns (() => void)
- - (): void
  - Subscribe to an event only once
    
    Returns void
Inherited from BasePlugin.once
- Defined in event-emitter.ts:33

un

un<EventName>(eventName, listener): void
Unsubscribe from an event
Type Parameters
- EventName extends keyof MinimapPluginEvents
Parameters
- eventName: EventName
- listener: EventListener<MinimapPluginEvents, EventName>
Returns void
Inherited from BasePlugin.un
- Defined in event-emitter.ts:50

unAll

unAll(): void
Clear all events

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

`Static` create

create(options): MinimapPlugin
Parameters
- options: MinimapPluginOptions
Returns MinimapPlugin
- Defined in plugins/minimap.ts:39

Class MinimapPlugin

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: MinimapPluginOptions

Returns MinimapPlugin

Properties

Private container

Private miniWavesurfer

Private minimapWrapper

Protected options

Type declaration

Optional insertPosition?: InsertPosition

Optional overlayColor?: string

Type declaration

height: number

insertPosition: string

overlayColor: string

Private overlay

Protected subscriptions

Type declaration

Returns void

Protected Optional wavesurfer

Methods

destroy

Returns void

Protected emit

Type Parameters

EventName extends keyof MinimapPluginEvents

Parameters

eventName: EventName

Rest ...args: MinimapPluginEvents[EventName]

Returns void

Private getOverlayWidth

Returns number

init

Parameters

wavesurfer: WaveSurfer

Returns void

Private initMinimap

Returns void

Private initMinimapWrapper

Returns HTMLElement

Private initOverlay

Returns HTMLElement

Private initWaveSurferEvents

Returns void

on

Type Parameters

EventName extends keyof MinimapPluginEvents

Parameters

eventName: EventName

listener: EventListener<MinimapPluginEvents, EventName>

Returns (() => void)

Returns void

onInit

Returns void

Private onRedraw

Returns void

Private onScroll

Parameters

startTime: number

Returns void

once

Type Parameters

EventName extends keyof MinimapPluginEvents

Parameters

eventName: EventName

listener: EventListener<MinimapPluginEvents, EventName>

Returns (() => void)

Returns void

un

Type Parameters

EventName extends keyof MinimapPluginEvents

Parameters

`Private` container

`Private` miniWavesurfer

`Private` minimapWrapper

`Protected` options

`Optional` insertPosition?: InsertPosition

`Optional` overlayColor?: string

`Private` overlay

`Protected` subscriptions

`Protected` `Optional` wavesurfer

`Protected` emit

`Rest` ...args: MinimapPluginEvents[EventName]

`Private` getOverlayWidth

`Private` initMinimap

`Private` initMinimapWrapper

`Private` initOverlay

`Private` initWaveSurferEvents

`Private` onRedraw

`Private` onScroll

`Static` create