Class ImageButton

Timeline image button. Can be added to timeline lane. TimelineLaneApi

Hierarchy (View Summary)

BaseTimelineNode<ImageButtonConfig, ImageButtonStyle>
- ImageButton

Index

Constructors

Properties

onClick$ onMouseEnter$ onMouseLeave$

Accessors

config konvaNode style

Methods

destroy getImage onMeasurementsChange setImage

Constructors

constructor

new ImageButton(config: ConfigWithOptionalStyle<ImageButtonConfig>): ImageButton
Parameters
- config: ConfigWithOptionalStyle<ImageButtonConfig>
Returns ImageButton
Overrides BaseTimelineNode<ImageButtonConfig, ImageButtonStyle>.constructor
- Defined in project/src/timeline/timeline-component.ts:317

Properties

`Readonly`onClick$

onClick$: Subject<ClickEvent> = ...

Fires on mouse click

`Readonly`onMouseEnter$

onMouseEnter$: Subject<MouseEnterEvent> = ...

Fires on mouse enter

`Readonly`onMouseLeave$

onMouseLeave$: Subject<MouseLeaveEvent> = ...

Fires on mouse leave

Accessors

config

get config(): C
Returns C
Inherited from BaseTimelineNode.config
- Defined in project/src/layout/konva-component.ts:65

konvaNode

get konvaNode(): T
Returns T
Inherited from BaseTimelineNode.konvaNode
- Defined in project/src/layout/konva-component.ts:69

style

get style(): S
Returns S
Inherited from BaseTimelineNode.style
- Defined in project/src/layout/konva-component.ts:76
set style(value: Partial<S>): void
Parameters
- value: Partial<S>
Returns void
Inherited from BaseTimelineNode.style
- Defined in project/src/layout/konva-component.ts:80

Methods

destroy

destroy(): void
Returns void
Inherited from BaseTimelineNode.destroy
- Defined in project/src/timeline/timeline-component.ts:143

getImage

getImage(): { height?: number; src: string; width?: number } | undefined
Gets current image config

Returns { height?: number; src: string; width?: number } | undefined
ImageButtonImageConfig
- { height?: number; src: string; width?: number }
  - Optionalheight?: number
    Image height
  - src: string
    Image source
  - Optionalwidth?: number
    Image width
- undefined
- Defined in project/src/timeline/timeline-component.ts:382

onMeasurementsChange

onMeasurementsChange(): void
Returns void
Inherited from BaseTimelineNode.onMeasurementsChange
- Defined in project/src/timeline/timeline-component.ts:127

setImage

setImage(config: ImageButtonImageConfig): void
Sets new image to display
Parameters
- config: ImageButtonImageConfig
Returns void
- Defined in project/src/timeline/timeline-component.ts:374