Skip to main content

Class: Hoverable

Defined in: src/interaction/Hoverable.ts:25

Adds hover effects to a mobject.

Constructors​

Constructor​

new Hoverable(mobject, scene, options?): Hoverable

Defined in: src/interaction/Hoverable.ts:45

Create a new Hoverable behavior.

Parameters​

mobject​

Mobject

The mobject to add hover effects to

scene​

Scene

The scene containing the mobject

options?​

HoverableOptions

Hoverable configuration options

Returns​

Hoverable

Accessors​

isEnabled​

Get Signature​

get isEnabled(): boolean

Defined in: src/interaction/Hoverable.ts:75

Get whether hovering is enabled.

Returns​

boolean


isHovering​

Get Signature​

get isHovering(): boolean

Defined in: src/interaction/Hoverable.ts:68

Get whether the mobject is currently being hovered.

Returns​

boolean


mobject​

Get Signature​

get mobject(): Mobject

Defined in: src/interaction/Hoverable.ts:82

Get the mobject this hoverable is attached to.

Returns​

Mobject

Methods​

disable()​

disable(): void

Defined in: src/interaction/Hoverable.ts:197

Disable hovering and reset to original state.

Returns​

void


dispose()​

dispose(): void

Defined in: src/interaction/Hoverable.ts:207

Clean up event listeners.

Returns​

void


enable()​

enable(): void

Defined in: src/interaction/Hoverable.ts:190

Enable hovering.

Returns​

void