• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2024-2025 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15/**
16 * @file
17 * @kit ArkUI
18 * @arkts 1.2
19 */
20
21
22// WARNING! THIS FILE IS AUTO-GENERATED, DO NOT MAKE CHANGES, THEY WILL BE LOST ON NEXT GENERATION!
23
24import { memo, ComponentBuilder, __memo_context_type, __memo_id_type } from './../stateManagement/runtime'
25import { BaseEvent, EventTarget, SourceType, SourceTool, Callback } from './common'
26
27export enum PanDirection {
28    NONE = 0,
29    None = 0,
30    HORIZONTAL = 1,
31    Horizontal = 1,
32    LEFT = 2,
33    Left = 2,
34    RIGHT = 3,
35    Right = 3,
36    VERTICAL = 4,
37    Vertical = 4,
38    UP = 5,
39    Up = 5,
40    DOWN = 6,
41    Down = 6,
42    ALL = 7,
43    All = 7
44}
45export enum SwipeDirection {
46    NONE = 0,
47    None = 0,
48    HORIZONTAL = 1,
49    Horizontal = 1,
50    VERTICAL = 2,
51    Vertical = 2,
52    ALL = 3,
53    All = 3
54}
55export enum GestureMode {
56    SEQUENCE = 0,
57    Sequence = 0,
58    PARALLEL = 1,
59    Parallel = 1,
60    EXCLUSIVE = 2,
61    Exclusive = 2
62}
63export enum GestureMask {
64    NORMAL = 0,
65    Normal = 0,
66    IGNORE_INTERNAL = 1,
67    IgnoreInternal = 1
68}
69export enum GestureJudgeResult {
70    CONTINUE = 0,
71    REJECT = 1
72}
73export declare namespace GestureControl {
74    export enum GestureType {
75        TAP_GESTURE = 0,
76        LONG_PRESS_GESTURE = 1,
77        PAN_GESTURE = 2,
78        PINCH_GESTURE = 3,
79        SWIPE_GESTURE = 4,
80        ROTATION_GESTURE = 5,
81        DRAG = 6,
82        CLICK = 7
83    }
84}
85export interface GestureInfo {
86    tag?: string;
87    type: GestureControl.GestureType;
88    isSystemGesture: boolean;
89}
90export interface FingerInfo {
91    id: number;
92    globalX: number;
93    globalY: number;
94    localX: number;
95    localY: number;
96    displayX: number;
97    displayY: number;
98}
99export type GestureType = Gesture | GestureGroup;
100export interface BaseGestureEvent extends BaseEvent {
101    fingerList: Array<FingerInfo>;
102}
103export interface TapGestureEvent extends BaseGestureEvent {
104}
105export interface LongPressGestureEvent extends BaseGestureEvent {
106    repeat: boolean;
107}
108export interface PanGestureEvent extends BaseGestureEvent {
109    offsetX: number;
110    offsetY: number;
111    velocityX: number;
112    velocityY: number;
113    velocity: number;
114}
115export interface PinchGestureEvent extends BaseGestureEvent {
116    scale: number;
117    pinchCenterX: number;
118    pinchCenterY: number;
119}
120export interface RotationGestureEvent extends BaseGestureEvent {
121    angle: number;
122}
123export interface SwipeGestureEvent extends BaseGestureEvent {
124    angle: number;
125    speed: number;
126}
127export interface GestureEvent extends BaseEvent {
128    repeat: boolean;
129    fingerList: Array<FingerInfo>;
130    offsetX: number;
131    offsetY: number;
132    angle: number;
133    speed: number;
134    scale: number;
135    pinchCenterX: number;
136    pinchCenterY: number;
137    velocityX: number;
138    velocityY: number;
139    velocity: number;
140}
141export interface GestureInterface<T> {
142    tag(tag: string): T
143    allowedTypes(types: Array<SourceTool>): T
144}
145export interface TapGestureParameters {
146    count?: number;
147    fingers?: number;
148    distanceThreshold?: number;
149}
150export type Callback_GestureEvent_Void = (event: GestureEvent) => void;
151export interface TapGestureInterface extends GestureInterface<TapGestureInterface> {
152    onAction(event: ((event: GestureEvent) => void)): TapGestureInterface
153    invoke(value?: TapGestureParameters): TapGestureInterface;
154}
155export interface Literal_Number_duration_fingers_Boolean_repeat {
156    fingers?: number;
157    repeat?: boolean;
158    duration?: number;
159}
160export interface LongPressGestureInterface extends GestureInterface<LongPressGestureInterface> {
161    onAction(event: ((event: GestureEvent) => void)): LongPressGestureInterface
162    onActionEnd(event: ((event: GestureEvent) => void)): LongPressGestureInterface
163    onActionCancel(event: (() => void)): LongPressGestureInterface
164    invoke(value?: Literal_Number_duration_fingers_Boolean_repeat): LongPressGestureInterface;
165}
166export interface Literal_Number_distance_fingers_PanDirection_direction {
167    fingers?: number;
168    direction?: PanDirection;
169    distance?: number;
170}
171export interface PanGestureOptions {
172    setDirection(value: PanDirection): undefined
173    setDistance(value: number): undefined
174    setFingers(value: number): undefined
175    getDirection(): PanDirection
176}
177export interface PanGestureInterface extends GestureInterface<PanGestureInterface> {
178    onActionStart(event: ((event: GestureEvent) => void)): PanGestureInterface
179    onActionUpdate(event: ((event: GestureEvent) => void)): PanGestureInterface
180    onActionEnd(event: ((event: GestureEvent) => void)): PanGestureInterface
181    onActionCancel(event: (() => void)): PanGestureInterface
182    invoke(value?: Literal_Number_distance_fingers_PanDirection_direction | PanGestureOptions): PanGestureInterface;
183}
184export interface Literal_Number_fingers_speed_SwipeDirection_direction {
185    fingers?: number;
186    direction?: SwipeDirection;
187    speed?: number;
188}
189export interface SwipeGestureInterface extends GestureInterface<SwipeGestureInterface> {
190    onAction(event: ((event: GestureEvent) => void)): SwipeGestureInterface
191    invoke(value?: Literal_Number_fingers_speed_SwipeDirection_direction): SwipeGestureInterface;
192}
193export interface Literal_Number_distance_fingers {
194    fingers?: number;
195    distance?: number;
196}
197export interface PinchGestureInterface extends GestureInterface<PinchGestureInterface> {
198    onActionStart(event: ((event: GestureEvent) => void)): PinchGestureInterface
199    onActionUpdate(event: ((event: GestureEvent) => void)): PinchGestureInterface
200    onActionEnd(event: ((event: GestureEvent) => void)): PinchGestureInterface
201    onActionCancel(event: (() => void)): PinchGestureInterface
202    invoke(value?: Literal_Number_distance_fingers): PinchGestureInterface;
203}
204export interface Literal_Number_angle_fingers {
205    fingers?: number;
206    angle?: number;
207}
208export interface RotationGestureInterface extends GestureInterface<RotationGestureInterface> {
209    onActionStart(event: ((event: GestureEvent) => void)): RotationGestureInterface
210    onActionUpdate(event: ((event: GestureEvent) => void)): RotationGestureInterface
211    onActionEnd(event: ((event: GestureEvent) => void)): RotationGestureInterface
212    onActionCancel(event: (() => void)): RotationGestureInterface
213    invoke(value?: Literal_Number_angle_fingers): RotationGestureInterface;
214}
215export interface GestureGroupInterface {
216    onCancel(event: (() => void)): GestureGroupInterface
217    invoke(mode: GestureMode, gesture: Array<GestureType>): GestureGroupInterface;
218}
219export interface GestureHandler<T> {
220    tag(tag: string): T
221    allowedTypes(types: Array<SourceTool>): T
222}
223export interface TapGestureHandlerOptions {
224    count?: number;
225    fingers?: number;
226}
227export interface TapGestureHandler extends GestureHandler<TapGestureHandler> {
228    onAction(event: ((event: GestureEvent) => void)): TapGestureHandler
229}
230export interface LongPressGestureHandlerOptions {
231    fingers?: number;
232    repeat?: boolean;
233    duration?: number;
234}
235export interface LongPressGestureHandler extends GestureHandler<LongPressGestureHandler> {
236    onAction(event: ((event: GestureEvent) => void)): LongPressGestureHandler
237    onActionEnd(event: ((event: GestureEvent) => void)): LongPressGestureHandler
238    onActionCancel(event: (() => void)): LongPressGestureHandler
239}
240export interface PanGestureHandlerOptions {
241    fingers?: number;
242    direction?: PanDirection;
243    distance?: number;
244}
245export interface PanGestureHandler extends GestureHandler<PanGestureHandler> {
246    onActionStart(event: ((event: GestureEvent) => void)): PanGestureHandler
247    onActionUpdate(event: ((event: GestureEvent) => void)): PanGestureHandler
248    onActionEnd(event: ((event: GestureEvent) => void)): PanGestureHandler
249    onActionCancel(event: (() => void)): PanGestureHandler
250}
251export interface SwipeGestureHandlerOptions {
252    fingers?: number;
253    direction?: SwipeDirection;
254    speed?: number;
255}
256export interface SwipeGestureHandler extends GestureHandler<SwipeGestureHandler> {
257    onAction(event: ((event: GestureEvent) => void)): SwipeGestureHandler
258}
259export interface PinchGestureHandlerOptions {
260    fingers?: number;
261    distance?: number;
262}
263export interface PinchGestureHandler extends GestureHandler<PinchGestureHandler> {
264    onActionStart(event: ((event: GestureEvent) => void)): PinchGestureHandler
265    onActionUpdate(event: ((event: GestureEvent) => void)): PinchGestureHandler
266    onActionEnd(event: ((event: GestureEvent) => void)): PinchGestureHandler
267    onActionCancel(event: (() => void)): PinchGestureHandler
268}
269export interface RotationGestureHandlerOptions {
270    fingers?: number;
271    angle?: number;
272}
273export interface RotationGestureHandler extends GestureHandler<RotationGestureHandler> {
274    onActionStart(event: ((event: GestureEvent) => void)): RotationGestureHandler
275    onActionUpdate(event: ((event: GestureEvent) => void)): RotationGestureHandler
276    onActionEnd(event: ((event: GestureEvent) => void)): RotationGestureHandler
277    onActionCancel(event: (() => void)): RotationGestureHandler
278}
279export interface GestureGroupGestureHandlerOptions {
280    stub: string;
281}
282export interface GestureGroupHandler extends GestureHandler<GestureGroupHandler> {
283    onCancel(event: (() => void)): GestureGroupHandler
284}
285export enum GesturePriority {
286    NORMAL = 0,
287    PRIORITY = 1
288}
289export enum GestureRecognizerState {
290    READY = 0,
291    DETECTING = 1,
292    PENDING = 2,
293    BLOCKED = 3,
294    SUCCESSFUL = 4,
295    FAILED = 5
296}
297export interface ScrollableTargetInfo extends EventTargetInfo {
298    isBegin(): boolean
299    isEnd(): boolean
300}
301export interface EventTargetInfo {
302    getId(): string
303}
304export interface GestureRecognizer {
305    getTag(): string
306    getType(): GestureControl.GestureType
307    isBuiltIn(): boolean
308    setEnabled(isEnabled: boolean): void
309    isEnabled(): boolean
310    getState(): GestureRecognizerState
311    getEventTargetInfo(): EventTargetInfo
312    isValid(): boolean
313}
314export interface PanRecognizer extends GestureRecognizer {
315    getPanGestureOptions(): PanGestureOptions
316}
317
318/**
319 * Defines Gesture interface.
320 *
321 * @syscap SystemCapability.ArkUI.ArkUI.Full
322 * @crossplatform
323 * @atomicservice
324 * @since 20
325 *
326 */
327export declare class Gesture {
328    /**
329     * Set gesture's tag.
330     *
331     * @param { string } tag
332     * @returns { this }
333     * @syscap SystemCapability.ArkUI.ArkUI.Full
334     * @crossplatform
335     * @atomicservice
336     * @since 20
337     *
338     */
339    tag(tag: string): this;
340    /**
341     * Input source type for gesture response.
342     *
343     * @param { Array<SourceTool> } types - indicate the allowed input source for gesture to response
344     * @returns { this }
345     * @syscap SystemCapability.ArkUI.ArkUI.Full
346     * @crossplatform
347     * @atomicservice
348     * @since 20
349     *
350     */
351    allowedTypes(types: Array<SourceTool>): this;
352}
353/**
354 * Defines TapGesture.
355 *
356 * @extends Gesture
357 * @syscap SystemCapability.ArkUI.ArkUI.Full
358 * @crossplatform
359 * @atomicservice
360 * @since 20
361 *
362 */
363export declare class TapGesture extends Gesture {
364    /**
365     * Set the value.
366     * TapGestureParameters: The parameters of the tapGesture.
367     *
368     * @param { function } factory
369     * @param { TapGestureParameters } value
370     * @returns { TapGesture }
371     * @syscap SystemCapability.ArkUI.ArkUI.Full
372     * @crossplatform
373     * @atomicservice
374     * @since 20
375     *
376     */
377    static $_instantiate(factory: () => TapGesture, value?: TapGestureParameters): TapGesture;
378    /**
379     * Tap gesture recognition success callback.
380     *
381     * @param { function } event
382     * @returns { TapGestureInterface }
383     * @syscap SystemCapability.ArkUI.ArkUI.Full
384     * @crossplatform
385     * @atomicservice
386     * @since 20
387     *
388     */
389    onAction(event: Callback<GestureEvent>): TapGesture;
390}
391/**
392 * Defines LongPressGesture.
393 *
394 * @extends Gesture
395 * @syscap SystemCapability.ArkUI.ArkUI.Full
396 * @crossplatform
397 * @atomicservice
398 *
399 * @since 20
400 */
401export declare class LongPressGesture extends Gesture {
402    /**
403     * Set the value.
404     * fingers: Indicates the hand index that triggers the long press.
405     * repeat: Indicates whether to trigger event callback continuously.
406     * duration: Minimum press and hold time, in milliseconds.
407     *
408     * @param { function } factory
409     * @param { LongPressGestureHandlerOptions } value
410     * @returns { LongPressGesture }
411     * @syscap SystemCapability.ArkUI.ArkUI.Full
412     * @crossplatform
413     * @atomicservice
414     *
415     * @since 11
416     */
417    static $_instantiate(factory: () => LongPressGesture, value?: LongPressGestureHandlerOptions): LongPressGesture;
418    /**
419     * LongPress gesture recognition success callback.
420     *
421     * @param { Callback<GestureEvent> } event
422     * @returns { LongPressGesture }
423     * @syscap SystemCapability.ArkUI.ArkUI.Full
424     * @crossplatform
425     * @atomicservice
426     *
427     * @since 20
428     */
429    onAction(event: Callback<GestureEvent>): LongPressGesture;
430    /**
431     * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered.
432     *
433     * @param { Callback<GestureEvent> } event
434     * @returns { LongPressGesture }
435     * @syscap SystemCapability.ArkUI.ArkUI.Full
436     * @crossplatform
437     * @atomicservice
438     *
439     * @since 20
440     */
441    onActionEnd(event: Callback<GestureEvent>): LongPressGesture;
442    /**
443     * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event
444     * is received.
445     *
446     * @param { Callback<void> } event
447     * @returns { LongPressGesture }
448     * @syscap SystemCapability.ArkUI.ArkUI.Full
449     * @crossplatform
450     * @atomicservice
451     *
452     * @since 20
453     */
454    onActionCancel(event: Callback<void>): LongPressGesture;
455}
456
457/**
458 * Defines PanGesture.
459 *
460 * @extends Gesture
461 * @syscap SystemCapability.ArkUI.ArkUI.Full
462 * @crossplatform
463 * @atomicservice
464 *
465 * @since 20
466 */
467export declare class PanGesture extends Gesture {
468    /**
469     * Set the value.
470     *
471     * @param { function } factory
472     * @param { PanGestureHandlerOptions } value
473     * @returns { PanGesture }
474     * @syscap SystemCapability.ArkUI.ArkUI.Full
475     * @crossplatform
476     * @atomicservice
477     *
478     * @since 20
479     */
480    static $_instantiate(factory: () => PanGesture, value?: PanGestureHandlerOptions): PanGesture;
481    /**
482     * Pan gesture recognition success callback.
483     *
484     * @param { Callback<GestureEvent> } event
485     * @returns { PanGesture }
486     * @syscap SystemCapability.ArkUI.ArkUI.Full
487     * @crossplatform
488     * @atomicservice
489     *
490     * @since 20
491     */
492    onActionStart(event: Callback<GestureEvent>): PanGesture;
493    /**
494     * Callback when the Pan gesture is moving.
495     *
496     * @param { Callback<GestureEvent> } event
497     * @returns { PanGesture }
498     * @syscap SystemCapability.ArkUI.ArkUI.Full
499     * @crossplatform
500     * @atomicservice
501     *
502     * @since 20
503     */
504    onActionUpdate(event: Callback<GestureEvent>): PanGesture;
505    /**
506     * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered.
507     *
508     * @param { Callback<GestureEvent> } event
509     * @returns { PanGesture }
510     * @syscap SystemCapability.ArkUI.ArkUI.Full
511     * @crossplatform
512     * @atomicservice
513     *
514     * @since 20
515     */
516    onActionEnd(event: Callback<GestureEvent>): PanGesture;
517    /**
518     * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event
519     * is received.
520     *
521     * @param { Callback<void> } event
522     * @returns { PanGesture }
523     * @syscap SystemCapability.ArkUI.ArkUI.Full
524     * @crossplatform
525     * @atomicservice
526     *
527     * @since 20
528     */
529    onActionCancel(event: Callback<void>): PanGesture;
530}
531/**
532 * Defines SwipeGesture.
533 *
534 * @extends Gesture
535 * @syscap SystemCapability.ArkUI.ArkUI.Full
536 * @crossplatform
537 * @atomicservice
538 *
539 * @since 20
540 */
541export declare class SwipeGesture extends Gesture {
542    /**
543     * Set the value.
544     *
545     * @param { function } factory
546     * @param { SwipeGestureHandlerOptions } value
547     * @returns { SwipeGesture }
548     * @syscap SystemCapability.ArkUI.ArkUI.Full
549     * @crossplatform
550     * @atomicservice
551     *
552     * @since 20
553     */
554    static $_instantiate(factory: () => SwipeGesture, value?: SwipeGestureHandlerOptions): SwipeGesture;
555    /**
556     * Slide gesture recognition success callback.
557     *
558     * @param { Callback<GestureEvent> } event
559     * @returns { SwipeGesture }
560     * @syscap SystemCapability.ArkUI.ArkUI.Full
561     * @crossplatform
562     * @atomicservice
563     *
564     * @since 20
565     */
566    onAction(event: Callback<GestureEvent>): SwipeGesture;
567}
568/**
569 * Defines PinchGesture.
570 *
571 * @extends Gesture
572 * @syscap SystemCapability.ArkUI.ArkUI.Full
573 * @crossplatform
574 * @atomicservice
575 *
576 * @since 20
577 */
578export declare class PinchGesture extends Gesture {
579    /**
580     * Set the value.
581     *
582     * @param { function } factory
583     * @param { PinchGestureHandlerOptions } value
584     * @returns { PinchGesture }
585     * @syscap SystemCapability.ArkUI.ArkUI.Full
586     * @crossplatform
587     * @atomicservice
588     *
589     * @since 20
590     */
591    static $_instantiate(factory: () => PinchGesture, value?: PinchGestureHandlerOptions): PinchGesture;
592    /**
593     * Pinch gesture recognition success callback.
594     *
595     * @param { Callback<GestureEvent> } event
596     * @returns { PinchGesture }
597     * @syscap SystemCapability.ArkUI.ArkUI.Full
598     * @crossplatform
599     * @atomicservice
600     *
601     * @since 20
602     */
603    onActionStart(event: Callback<GestureEvent>): PinchGesture;
604    /**
605     * Callback when the Pinch gesture is moving.
606     *
607     * @param { Callback<GestureEvent> } event
608     * @returns { PinchGesture }
609     * @syscap SystemCapability.ArkUI.ArkUI.Full
610     * @crossplatform
611     * @atomicservice
612     *
613     * @since 20
614     */
615    onActionUpdate(event: Callback<GestureEvent>): PinchGesture;
616    /**
617     * The Pinch gesture is successfully recognized. When the finger is lifted, the callback is triggered.
618     *
619     * @param { Callback<GestureEvent> } event
620     * @returns { PinchGesture }
621     * @syscap SystemCapability.ArkUI.ArkUI.Full
622     * @crossplatform
623     * @atomicservice
624     *
625     * @since 20
626     */
627    onActionEnd(event: Callback<GestureEvent>): PinchGesture;
628    /**
629     * The Pinch gesture is successfully recognized and a callback is triggered when the touch cancel event
630     * is received.
631     *
632     * @param { Callback<void> } event
633     * @returns { PinchGesture }
634     * @syscap SystemCapability.ArkUI.ArkUI.Full
635     * @crossplatform
636     * @atomicservice
637     *
638     * @since 20
639     */
640    onActionCancel(event: Callback<void>): PinchGesture;
641}
642/**
643 * Defines RotationGesture.
644 *
645 * @extends Gesture
646 * @syscap SystemCapability.ArkUI.ArkUI.Full
647 * @crossplatform
648 * @atomicservice
649 *
650 * @since 20
651 */
652export declare class RotationGesture extends Gesture {
653    /**
654     * Set the value.
655     *
656     * @param { function } factory
657     * @param { RotationGestureHandlerOptions } value
658     * @returns { RotationGesture }
659     * @syscap SystemCapability.ArkUI.ArkUI.Full
660     * @crossplatform
661     * @atomicservice
662     *
663     * @since 20
664     */
665    static $_instantiate(factory: () => RotationGesture, value?: RotationGestureHandlerOptions): RotationGesture;
666    /**
667     * Rotation gesture recognition success callback.
668     *
669     * @param { Callback<GestureEvent> } event
670     * @returns { RotationGesture }
671     * @syscap SystemCapability.ArkUI.ArkUI.Full
672     * @crossplatform
673     * @atomicservice
674     *
675     * @since 20
676     */
677    onActionStart(event: Callback<GestureEvent>): RotationGesture;
678    /**
679     * Callback when the Rotation gesture is moving.
680     *
681     * @param { Callback<GestureEvent> } event
682     * @returns { RotationGesture }
683     * @syscap SystemCapability.ArkUI.ArkUI.Full
684     * @crossplatform
685     * @atomicservice
686     *
687     * @since 20
688     */
689    onActionUpdate(event: Callback<GestureEvent>): RotationGesture;
690    /**
691     * The Rotation gesture is successfully recognized. When the finger is lifted, the callback is triggered.
692     *
693     * @param { Callback<GestureEvent> } event
694     * @returns { RotationGesture }
695     * @syscap SystemCapability.ArkUI.ArkUI.Full
696     * @crossplatform
697     * @atomicservice
698     *
699     * @since 20
700     */
701    onActionEnd(event: Callback<GestureEvent>): RotationGesture;
702    /**
703     * The Rotation gesture is successfully recognized and a callback is triggered when the touch cancel event
704     * is received.
705     *
706     * @param { Callback<void> } event
707     * @returns { RotationGesture }
708     * @syscap SystemCapability.ArkUI.ArkUI.Full
709     * @crossplatform
710     * @atomicservice
711     *
712     * @since 20
713     */
714    onActionCancel(event: Callback<void>): RotationGesture;
715}
716/**
717 * Defines the GestureGroup.
718 *
719 * @syscap SystemCapability.ArkUI.ArkUI.Full
720 * @crossplatform
721 * @atomicservice
722 *
723 * @since 20
724 */
725export declare class GestureGroup {
726    /**
727     * Return to Obtain GestureGroup.
728     *
729     * @param { function } factory
730     * @param { GestureMode } mode
731     * @param { GestureType[] } gesture
732     * @returns { GestureGroup }
733     * @syscap SystemCapability.ArkUI.ArkUI.Full
734     * @crossplatform
735     * @atomicservice
736     *
737     * @since 20
738     */
739    static $_instantiate(factory: () => GestureGroup, mode: GestureMode, ...gesture: GestureType[]): GestureGroup;
740    /**
741     * The Gesture group is successfully recognized and a callback is triggered when the touch cancel event
742     * is received.
743     *
744     * @param { Callback<void> } event
745     * @returns { GestureGroup }
746     * @syscap SystemCapability.ArkUI.ArkUI.Full
747     * @crossplatform
748     * @atomicservice
749     *
750     * @since 20
751     */
752    onCancel(event: Callback<void>): GestureGroup;
753}
754