import MarkersPlugin from 'wavesurfer.js/src/plugin/markers/index.js'

public class | source

MarkersPlugin

Static Member Summary

Static Public Members
public static	markers: *

Static Method Summary

Static Public Methods
public static	create(params: MarkersPluginParams): PluginDefinition Markers plugin definition factory	since 4.6.0

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	dragging: boolean
public	markerHeight: number
public	markerLineWidth: number
public	markerWidth: number
public	markers: *[]
public	onMouseMove: *
public	onMouseUp: *
public	params: *
public	selectedMarker: *
public	style: *
public	util: *
public	wavesurfer: *
public	wrapper: *

Method Summary

Public Methods
public	add(params: MarkerParams): object Add a marker
public	clear() Remove all markers
public	destroy()
public	init()
public	remove(indexOrMarker: number \| Object) Remove a marker

Static Public Members

public static markers: * source

Static Public Methods

public static create(params: MarkersPluginParams): PluginDefinition since 4.6.0 source

Markers 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	MarkersPluginParams		parameters use to initialise the plugin

Return:

PluginDefinition

an object representing the plugin

Public Constructors

public constructor() source

Public Members

public dragging: boolean source

public markerHeight: number source

public markerLineWidth: number source

public markerWidth: number source

public markers: *[] source

public onMouseMove: * source

public onMouseUp: * source

public params: * source

public selectedMarker: * source

public style: * source

public util: * source

public wavesurfer: * source

public wrapper: * source

Public Methods

public add(params: MarkerParams): object source

Add a marker

Params:

Name	Type	Attribute	Description
params	MarkerParams		Marker definition

Return:

object

The created marker

public clear() source

Remove all markers

public destroy() source

public init() source

public remove(indexOrMarker: number | Object) source

Remove a marker

Params:

Name	Type	Attribute	Description
indexOrMarker	number \| Object		Index of the marker to remove or the marker object itself