Skip to main content

Interface: ChangeGestureInstance

Defined in: dom/src/input/change-gesture.ts:19

Properties​

active​

active: () => boolean;

Defined in: dom/src/input/change-gesture.ts:39

Whether a gesture is in progress.

Returns​

boolean


destroy​

destroy: () => void;

Defined in: dom/src/input/change-gesture.ts:43

End a gesture in progress, so that nothing is left touched.

Returns​

void


end​

end: () => void;

Defined in: dom/src/input/change-gesture.ts:37

End the gesture in progress, if any.

Returns​

void


hold​

hold: (source) => void;

Defined in: dom/src/input/change-gesture.ts:24

Start a gesture that lasts until end, such as a drag. A gesture of another kind in progress ends first.

Parameters​

ParameterType
sourceChangeSource

Returns​

void


instant​

instant: (source, change) => void;

Defined in: dom/src/input/change-gesture.ts:35

A gesture that starts and ends around a single change, such as a reset: change runs between the two.

Parameters​

ParameterType
sourceChangeSource
change() => void

Returns​

void


pulse​

pulse: (source) => void;

Defined in: dom/src/input/change-gesture.ts:30

One step of a gesture with no end of its own, such as a wheel notch: starts one if none is in progress, and ends it endDelay after the last step. While a held gesture is in progress the step belongs to it.

Parameters​

ParameterType
sourceChangeSource

Returns​

void


update​

update: (options) => void;

Defined in: dom/src/input/change-gesture.ts:41

Replace the given options. A gesture in progress picks them up.

Parameters​

ParameterType
optionsPartial<ChangeGestureOptions>

Returns​

void