Class Region

Hierarchy

EventEmitter<RegionEvents>
- Region

Index

Constructors

Properties

color content? drag element end id maxLength minLength resize start totalDuration

Methods

_onUpdate _setTotalDuration emit initElement initMouseEvents on onEndMoving onEndResizing onMove onResize onStartMoving once play remove renderPosition setOptions un unAll

Constructors

constructor

new Region(params, totalDuration): Region
Parameters
- params: RegionParams
- totalDuration: number
Returns Region
Overrides EventEmitter<RegionEvents>.constructor
- Defined in plugins/regions.ts:72

Properties

color

color: string

`Optional` content

content?: HTMLElement

drag

drag: boolean

element

element: HTMLElement

end

end: number

id

id: string

maxLength

maxLength: number = Infinity

minLength

minLength: number = 0.01

resize

resize: boolean

start

start: number

`Private` totalDuration

totalDuration: number

Methods

_onUpdate

_onUpdate(dx, side?): void
Parameters
- dx: number
- Optional side: "start" | "end"
Returns void
- Defined in plugins/regions.ts:211

_setTotalDuration

_setTotalDuration(totalDuration): void
Parameters
- totalDuration: number
Returns void
- Defined in plugins/regions.ts:248

`Protected` emit

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

`Private` initElement

initElement(content?): HTMLDivElement
Parameters
- Optional content: string | HTMLElement
Returns HTMLDivElement
- Defined in plugins/regions.ts:88

`Private` initMouseEvents

initMouseEvents(): void
Returns void
- Defined in plugins/regions.ts:165

on

on<EventName>(eventName, listener): (() => void)
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
- EventName extends keyof RegionEvents
Parameters
- eventName: EventName
- listener: EventListener<RegionEvents, EventName>
Returns (() => void)
- - (): void
  - Subscribe to an event. Returns an unsubscribe function.
    
    Returns void
Inherited from EventEmitter.on
- Defined in event-emitter.ts:20

`Private` onEndMoving

onEndMoving(): void
Returns void
- Defined in plugins/regions.ts:205

`Private` onEndResizing

onEndResizing(): void
Returns void
- Defined in plugins/regions.ts:243

`Private` onMove

onMove(dx): void
Parameters
- dx: number
Returns void
- Defined in plugins/regions.ts:233

`Private` onResize

onResize(dx, side): void
Parameters
- dx: number
- side: "start" | "end"
Returns void
- Defined in plugins/regions.ts:238

`Private` onStartMoving

onStartMoving(): void
Returns void
- Defined in plugins/regions.ts:200

once

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

play

play(): void
Play the region from start to end

Returns void
- Defined in plugins/regions.ts:254

remove

remove(): void
Remove the region

Returns void
- Defined in plugins/regions.ts:282

`Private` renderPosition

renderPosition(): void
Returns void
- Defined in plugins/regions.ts:158

setOptions

setOptions(options): void
Update the region's options
Parameters
- options: {
      color?: string;
      drag?: boolean;
      end?: number;
      resize?: boolean;
      start?: number;
  }
  - Optional color?: string
  - Optional drag?: boolean
  - Optional end?: number
  - Optional resize?: boolean
  - Optional start?: number
Returns void
- Defined in plugins/regions.ts:259

un

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

unAll

unAll(): void
Clear all events

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

Generated using TypeDoc