Class ScrubberLane

Hierarchy

BaseTimelineLane<ScrubberLaneConfig, ScrubberLaneStyle>
- ScrubberLane

Implements

ScrubberLaneApi

Index

Constructors

constructor

new ScrubberLane(
configAndStyle?: ConfigAndStyle<ScrubberLaneConfig, ScrubberLaneStyle>,
): ScrubberLane
Parameters
- OptionalconfigAndStyle: ConfigAndStyle<ScrubberLaneConfig, ScrubberLaneStyle>
Returns ScrubberLane
Overrides BaseTimelineLane<ScrubberLaneConfig, ScrubberLaneStyle>.constructor
- Defined in src/timeline/scrubber/scrubber-lane.ts:103

Properties

`Readonly`onClick$

onClick$: Subject<ClickEvent> = ...

Fires on click

`Readonly`onMouseEnter$

onMouseEnter$: Subject<MouseEnterEvent> = ...

Fires on mouse enter

`Readonly`onMouseLeave$

onMouseLeave$: Subject<MouseLeaveEvent> = ...

Fires on mouse leave

`Readonly`onMouseMove$

onMouseMove$: Subject<MouseMoveEvent> = ...

Fires on mouse move

`Readonly`onMouseOut$

onMouseOut$: Subject<MouseOutEvent> = ...

Fires on mouse out

`Readonly`onMouseOver$

onMouseOver$: Subject<MouseOverEvent> = ...

Fires on mouse over

Accessors

id

get id(): string
Returns string
TimelineLane id
Implementation of TimelineLaneApi.id
Inherited from MarkerTrackLane.id
- Defined in src/timeline/timeline-lane.ts:400

style

get style(): S
Returns S
Implementation of TimelineLaneApi.style
Inherited from BaseTimelineLane.style
- Defined in src/timeline/timeline-lane.ts:568

Methods

addTimelineNode

addTimelineNode(config: TimelineLaneComponentConfig): TimelineNode
Adds new timeline node to timeline lane
Parameters
- config: TimelineLaneComponentConfig
Returns TimelineNode
Implementation of ScrubberLaneApi.addTimelineNode
Inherited from BaseTimelineLane.addTimelineNode
- Defined in src/timeline/timeline-lane.ts:412

clearContent

clearContent(): void
Returns void
Implementation of ScrubberLaneApi.clearContent
Overrides BaseTimelineLane.clearContent
- Defined in src/timeline/scrubber/scrubber-lane.ts:245

destroy

destroy(): void
Returns void
Implementation of ScrubberLaneApi.destroy
Overrides BaseTimelineLane.destroy
- Defined in src/timeline/scrubber/scrubber-lane.ts:230

isMinimized

isMinimized(): boolean
Returns boolean
is timeline lane minimized
Implementation of ScrubberLaneApi.isMinimized
Inherited from BaseTimelineLane.isMinimized
- Defined in src/timeline/timeline-lane.ts:433

maximize

maximize(args?: TimelineLaneMinimizeMaximizeArgs): void
Expands the lane back to its configured height.

Pass args.easing: true for an animated transition. When args is provided, args.complete is set to an Observable<void> that completes when the operation finishes (immediately for non-eased, after the animation for eased). Subscribe to args.complete after calling this method.
Parameters
- Optionalargs: TimelineLaneMinimizeMaximizeArgs
Returns void
Implementation of ScrubberLaneApi.maximize
Inherited from BaseTimelineLane.maximize
- Defined in src/timeline/timeline-lane.ts:480

minimize

minimize(args?: TimelineLaneMinimizeMaximizeArgs): void
Collapses the lane to zero height.

Pass args.easing: true for an animated transition. When args is provided, args.complete is set to an Observable<void> that completes when the operation finishes (immediately for non-eased, after the animation for eased). Subscribe to args.complete after calling this method.
Parameters
- Optionalargs: TimelineLaneMinimizeMaximizeArgs
Returns void
Implementation of ScrubberLaneApi.minimize
Inherited from BaseTimelineLane.minimize
- Defined in src/timeline/timeline-lane.ts:463

refreshTimeDivisions

refreshTimeDivisions(forceCreate?: boolean): void
Parameters
- forceCreate: boolean = false
Returns void
- Defined in src/timeline/scrubber/scrubber-lane.ts:249

setStyle

setStyle(style: Partial<S>): void
Parameters
- style: Partial<S>
Returns void
Implementation of ScrubberLaneApi.setStyle
Inherited from BaseTimelineLane.setStyle
- Defined in src/timeline/timeline-lane.ts:573

toggleMinimizeMaximize

toggleMinimizeMaximize(args?: TimelineLaneMinimizeMaximizeArgs): void
Toggles between minimized and maximized states.

Pass args.easing: true for an animated transition. When args is provided, args.complete is set to an Observable<void> that completes when the operation finishes. Subscribe to args.complete after calling this method.
Parameters
- Optionalargs: TimelineLaneMinimizeMaximizeArgs
Returns void
Implementation of ScrubberLaneApi.toggleMinimizeMaximize
Inherited from BaseTimelineLane.toggleMinimizeMaximize
- Defined in src/timeline/timeline-lane.ts:560

updateAttrs

updateAttrs(attrs: TimelineLaneUpdateableAttrs): void
Parameters
- attrs: TimelineLaneUpdateableAttrs
Returns void
Implementation of ScrubberLaneApi.updateAttrs
Inherited from BaseTimelineLane.updateAttrs
- Defined in src/timeline/timeline-lane.ts:584

Class ScrubberLane

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ScrubberLane

Properties

ReadonlyonClick$

ReadonlyonMouseEnter$

ReadonlyonMouseLeave$

ReadonlyonMouseMove$

ReadonlyonMouseOut$

ReadonlyonMouseOver$

Accessors

id

Returns string

style

Returns S

Methods

addTimelineNode

Parameters

Returns TimelineNode

clearContent

Returns void

destroy

Returns void

isMinimized

Returns boolean

maximize

Parameters

Returns void

minimize

Parameters

Returns void

refreshTimeDivisions

Parameters

Returns void

setStyle

Parameters

Returns void

toggleMinimizeMaximize

Parameters

Returns void

updateAttrs

Parameters

Returns void

Settings

On This Page

`Readonly`onClick$

`Readonly`onMouseEnter$

`Readonly`onMouseLeave$

`Readonly`onMouseMove$

`Readonly`onMouseOut$

`Readonly`onMouseOver$