Skip to main content

Detecting

@types IPublicModelDetecting
> @since v1.0.0

Overview

Canvas node hover model

Properties

current

Currently hovered node

@type {IPublicModelNode | null}

Related types: IPublicModelNode

@since v1.0.16

enable

Whether hover detection is enabled

@type {boolean}

Methods

capture

Hover the specified node

/**
* Hover the specified node
* capture node with nodeId
* @param id node id
*/
capture(id: string): void;

release

Leave hover on the specified node

/**
* Leave hover on the specified node
* release node with nodeId
* @param id node id
*/
release(id: string): void;

leave

Clear all hover state

/**
* Clear hover state
* clear all hover state
*/
leave(): void;

Events

onDetectingChange

Event fired when the hovered node changes

/**
* Hover node change event
* set callback which will be called when hovering object changed.
* @since v1.1.0
*/
onDetectingChange(fn: (node: IPublicModelNode | null) => void): IPublicTypeDisposable;

Related types:

@since v1.1.0