import MinimapPlugin from 'wavesurfer.js/src/plugin/minimap/index.js'

public class | source

MinimapPlugin

Extends:

Observer → MinimapPlugin

Implements:

PluginClass

Renders a smaller version waveform as a minimap of the main waveform.

Example:

// es6
import MinimapPlugin from 'wavesurfer.minimap.js';

// commonjs
var MinimapPlugin = require('wavesurfer.minimap.js');

// if you are using <script> tags
var MinimapPlugin = window.WaveSurfer.minimap;

// ... initialising wavesurfer with the plugin
var wavesurfer = WaveSurfer.create({
  // wavesurfer options ...
  plugins: [
    MinimapPlugin.create({
      // plugin options ...
    })
  ]
});

Static Method Summary

Static Public Methods
public static	create(params: MinimapPluginParams): PluginDefinition Minimap plugin definition factory

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	cleared: boolean
public	draggingOverview: boolean
public	drawer: *
public	overviewPosition: number
public	overviewRegion: *
public	overviewWidth: *
public	params: *
public	ratio: *
public	regions: {}
public	regionsPlugin: *
public	renderEvent: string
public	util: *
public	waveShowedWidth: *
public	waveWidth: *
public	wavesurfer: *

Method Summary

Public Methods
public	bindMinimapEvents()
public	bindWavesurferEvents()
public	createElements()
public	destroy()
public	drawRegions()
public	getWidth(): *
public	init()
public	moveOverviewRegion(pixels: *)
public	render()
public	renderRegions()

Inherited Summary

From class Observer
public	handlers: *
public	fireEvent(event: string, args: ...any) Manually fire an event
public	on(event: string, fn: function): ListenerDescriptor Attach a handler function for an event.
public	once(event: string, handler: function): ListenerDescriptor Attach a handler to an event.
public	setDisabledEventEmissions(eventNames: string[]) Disable firing a list of events by name.	since 4.0.0
public	un(event: string, fn: function) Remove an event handler.
public	unAll() Remove all event handlers.

Static Public Methods

public static create(params: MinimapPluginParams): PluginDefinition source

Minimap plugin definition factory

This function must be used to create a plugin definition which can be used by wavesurfer to correctly instantiate the plugin.

Params:

Name	Type	Attribute	Description
params	MinimapPluginParams		parameters use to initialise the plugin

Return:

PluginDefinition

an object representing the plugin

Public Constructors

public constructor() source

Instantiate Observer

Override:

Observer#constructor

Public Members

public cleared: boolean source

public draggingOverview: boolean source

public drawer: * source

public overviewPosition: number source

public overviewRegion: * source

public overviewWidth: * source

public params: * source

public ratio: * source

public regions: {} source

public regionsPlugin: * source

public renderEvent: string source

public util: * source

public waveShowedWidth: * source

public waveWidth: * source

public wavesurfer: * source

Public Methods

public bindMinimapEvents() source

public bindWavesurferEvents() source

public createElements() source

public destroy() source

public drawRegions() source

public getWidth(): * source

Return:

public init() source

public moveOverviewRegion(pixels: *) source

Params:

Name	Type	Attribute	Description
pixels	*

MinimapPlugin

Extends:

Implements:

Example:

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Static Public Methods

public static create(params: MinimapPluginParams): PluginDefinition source

Params:

Return:

Public Constructors

public constructor() source

Override:

Public Members

public cleared: boolean source

public draggingOverview: boolean source

public drawer: * source

public overviewPosition: number source

public overviewRegion: * source

public overviewWidth: * source

public params: * source

public ratio: * source

public regions: {} source

public regionsPlugin: * source

public renderEvent: string source

public util: * source

public waveShowedWidth: * source

public waveWidth: * source

public wavesurfer: * source

Public Methods

public bindMinimapEvents() source

public bindWavesurferEvents() source

public createElements() source

public destroy() source

public drawRegions() source

public getWidth(): * source

Return:

public init() source

public moveOverviewRegion(pixels: *) source

Params:

public render() source

public renderRegions() source