1/* 2 * Copyright (c) 2021-2023 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/** 17 * @file 18 * @kit ArkUI 19 */ 20 21/** 22 * Creating an Object 23 * 24 * @enum { number } 25 * @syscap SystemCapability.ArkUI.ArkUI.Full 26 * @since 7 27 */ 28/** 29 * Creating an Object 30 * 31 * @enum { number } 32 * @syscap SystemCapability.ArkUI.ArkUI.Full 33 * @crossplatform 34 * @since 10 35 */ 36/** 37 * Creating an Object 38 * 39 * @enum { number } 40 * @syscap SystemCapability.ArkUI.ArkUI.Full 41 * @crossplatform 42 * @atomicservice 43 * @since 11 44 */ 45declare enum PanDirection { 46 /** 47 * Default. 48 * 49 * @syscap SystemCapability.ArkUI.ArkUI.Full 50 * @since 7 51 */ 52 /** 53 * Default. 54 * 55 * @syscap SystemCapability.ArkUI.ArkUI.Full 56 * @crossplatform 57 * @since 10 58 */ 59 /** 60 * Default. 61 * 62 * @syscap SystemCapability.ArkUI.ArkUI.Full 63 * @crossplatform 64 * @atomicservice 65 * @since 11 66 */ 67 None, 68 69 /** 70 * Sliding horizontally. 71 * 72 * @syscap SystemCapability.ArkUI.ArkUI.Full 73 * @since 7 74 */ 75 /** 76 * Sliding horizontally. 77 * 78 * @syscap SystemCapability.ArkUI.ArkUI.Full 79 * @crossplatform 80 * @since 10 81 */ 82 /** 83 * Sliding horizontally. 84 * 85 * @syscap SystemCapability.ArkUI.ArkUI.Full 86 * @crossplatform 87 * @atomicservice 88 * @since 11 89 */ 90 Horizontal, 91 92 /** 93 * Sliding left. 94 * 95 * @syscap SystemCapability.ArkUI.ArkUI.Full 96 * @since 7 97 */ 98 /** 99 * Sliding left. 100 * 101 * @syscap SystemCapability.ArkUI.ArkUI.Full 102 * @crossplatform 103 * @since 10 104 */ 105 /** 106 * Sliding left. 107 * 108 * @syscap SystemCapability.ArkUI.ArkUI.Full 109 * @crossplatform 110 * @atomicservice 111 * @since 11 112 */ 113 Left, 114 115 /** 116 * Sliding right. 117 * 118 * @syscap SystemCapability.ArkUI.ArkUI.Full 119 * @since 7 120 */ 121 /** 122 * Sliding right. 123 * 124 * @syscap SystemCapability.ArkUI.ArkUI.Full 125 * @crossplatform 126 * @since 10 127 */ 128 /** 129 * Sliding right. 130 * 131 * @syscap SystemCapability.ArkUI.ArkUI.Full 132 * @crossplatform 133 * @atomicservice 134 * @since 11 135 */ 136 Right, 137 138 /** 139 * Sliding Vertical 140 * 141 * @syscap SystemCapability.ArkUI.ArkUI.Full 142 * @since 7 143 */ 144 /** 145 * Sliding Vertical 146 * 147 * @syscap SystemCapability.ArkUI.ArkUI.Full 148 * @crossplatform 149 * @since 10 150 */ 151 /** 152 * Sliding Vertical 153 * 154 * @syscap SystemCapability.ArkUI.ArkUI.Full 155 * @crossplatform 156 * @atomicservice 157 * @since 11 158 */ 159 Vertical, 160 161 /** 162 * Sliding up. 163 * 164 * @syscap SystemCapability.ArkUI.ArkUI.Full 165 * @since 7 166 */ 167 /** 168 * Sliding up. 169 * 170 * @syscap SystemCapability.ArkUI.ArkUI.Full 171 * @crossplatform 172 * @since 10 173 */ 174 /** 175 * Sliding up. 176 * 177 * @syscap SystemCapability.ArkUI.ArkUI.Full 178 * @crossplatform 179 * @atomicservice 180 * @since 11 181 */ 182 Up, 183 184 /** 185 * Sliding Down. 186 * 187 * @syscap SystemCapability.ArkUI.ArkUI.Full 188 * @since 7 189 */ 190 /** 191 * Sliding Down. 192 * 193 * @syscap SystemCapability.ArkUI.ArkUI.Full 194 * @crossplatform 195 * @since 10 196 */ 197 /** 198 * Sliding Down. 199 * 200 * @syscap SystemCapability.ArkUI.ArkUI.Full 201 * @crossplatform 202 * @atomicservice 203 * @since 11 204 */ 205 Down, 206 207 /** 208 * Sliding in all directions. 209 * 210 * @syscap SystemCapability.ArkUI.ArkUI.Full 211 * @since 7 212 */ 213 /** 214 * Sliding in all directions. 215 * 216 * @syscap SystemCapability.ArkUI.ArkUI.Full 217 * @crossplatform 218 * @since 10 219 */ 220 /** 221 * Sliding in all directions. 222 * 223 * @syscap SystemCapability.ArkUI.ArkUI.Full 224 * @crossplatform 225 * @atomicservice 226 * @since 11 227 */ 228 All, 229} 230 231/** 232 * Creating an Object 233 * 234 * @enum { number } 235 * @syscap SystemCapability.ArkUI.ArkUI.Full 236 * @since 8 237 */ 238/** 239 * Creating an Object 240 * 241 * @enum { number } 242 * @syscap SystemCapability.ArkUI.ArkUI.Full 243 * @crossplatform 244 * @since 10 245 */ 246/** 247 * Creating an Object 248 * 249 * @enum { number } 250 * @syscap SystemCapability.ArkUI.ArkUI.Full 251 * @crossplatform 252 * @atomicservice 253 * @since 11 254 */ 255declare enum SwipeDirection { 256 /** 257 * Default. 258 * 259 * @syscap SystemCapability.ArkUI.ArkUI.Full 260 * @since 8 261 */ 262 /** 263 * Default. 264 * 265 * @syscap SystemCapability.ArkUI.ArkUI.Full 266 * @crossplatform 267 * @since 10 268 */ 269 /** 270 * Default. 271 * 272 * @syscap SystemCapability.ArkUI.ArkUI.Full 273 * @crossplatform 274 * @atomicservice 275 * @since 11 276 */ 277 None, 278 279 /** 280 * Sliding horizontally. 281 * 282 * @syscap SystemCapability.ArkUI.ArkUI.Full 283 * @since 8 284 */ 285 /** 286 * Sliding horizontally. 287 * 288 * @syscap SystemCapability.ArkUI.ArkUI.Full 289 * @crossplatform 290 * @since 10 291 */ 292 /** 293 * Sliding horizontally. 294 * 295 * @syscap SystemCapability.ArkUI.ArkUI.Full 296 * @crossplatform 297 * @atomicservice 298 * @since 11 299 */ 300 Horizontal, 301 302 /** 303 * Sliding Vertical 304 * 305 * @syscap SystemCapability.ArkUI.ArkUI.Full 306 * @since 8 307 */ 308 /** 309 * Sliding Vertical 310 * 311 * @syscap SystemCapability.ArkUI.ArkUI.Full 312 * @crossplatform 313 * @since 10 314 */ 315 /** 316 * Sliding Vertical 317 * 318 * @syscap SystemCapability.ArkUI.ArkUI.Full 319 * @crossplatform 320 * @atomicservice 321 * @since 11 322 */ 323 Vertical, 324 325 /** 326 * Sliding in all directions. 327 * 328 * @syscap SystemCapability.ArkUI.ArkUI.Full 329 * @since 8 330 */ 331 /** 332 * Sliding in all directions. 333 * 334 * @syscap SystemCapability.ArkUI.ArkUI.Full 335 * @crossplatform 336 * @since 10 337 */ 338 /** 339 * Sliding in all directions. 340 * 341 * @syscap SystemCapability.ArkUI.ArkUI.Full 342 * @crossplatform 343 * @atomicservice 344 * @since 11 345 */ 346 All, 347} 348 349/** 350 * Creating an Object 351 * 352 * @enum { number } 353 * @syscap SystemCapability.ArkUI.ArkUI.Full 354 * @since 7 355 */ 356/** 357 * Creating an Object 358 * 359 * @enum { number } 360 * @syscap SystemCapability.ArkUI.ArkUI.Full 361 * @crossplatform 362 * @since 10 363 */ 364/** 365 * Creating an Object 366 * 367 * @enum { number } 368 * @syscap SystemCapability.ArkUI.ArkUI.Full 369 * @crossplatform 370 * @atomicservice 371 * @since 11 372 */ 373declare enum GestureMode { 374 /** 375 * Sequential gesture recognition is performed in sequence according to the gesture registration sequence. 376 * 377 * @syscap SystemCapability.ArkUI.ArkUI.Full 378 * @since 7 379 */ 380 /** 381 * Sequential gesture recognition is performed in sequence according to the gesture registration sequence. 382 * 383 * @syscap SystemCapability.ArkUI.ArkUI.Full 384 * @crossplatform 385 * @since 10 386 */ 387 /** 388 * Sequential gesture recognition is performed in sequence according to the gesture registration sequence. 389 * 390 * @syscap SystemCapability.ArkUI.ArkUI.Full 391 * @crossplatform 392 * @atomicservice 393 * @since 11 394 */ 395 Sequence, 396 397 /** 398 * Simultaneous recognition. Registration gestures participate in recognition. Everything can be triggered. 399 * 400 * @syscap SystemCapability.ArkUI.ArkUI.Full 401 * @since 7 402 */ 403 /** 404 * Simultaneous recognition. Registration gestures participate in recognition. Everything can be triggered. 405 * 406 * @syscap SystemCapability.ArkUI.ArkUI.Full 407 * @crossplatform 408 * @since 10 409 */ 410 /** 411 * Simultaneous recognition. Registration gestures participate in recognition. Everything can be triggered. 412 * 413 * @syscap SystemCapability.ArkUI.ArkUI.Full 414 * @crossplatform 415 * @atomicservice 416 * @since 11 417 */ 418 Parallel, 419 420 /** 421 * Mutually exclusive recognition. Only one gesture is successfully recognized. 422 * 423 * @syscap SystemCapability.ArkUI.ArkUI.Full 424 * @since 7 425 */ 426 /** 427 * Mutually exclusive recognition. Only one gesture is successfully recognized. 428 * 429 * @syscap SystemCapability.ArkUI.ArkUI.Full 430 * @crossplatform 431 * @since 10 432 */ 433 /** 434 * Mutually exclusive recognition. Only one gesture is successfully recognized. 435 * 436 * @syscap SystemCapability.ArkUI.ArkUI.Full 437 * @crossplatform 438 * @atomicservice 439 * @since 11 440 */ 441 Exclusive, 442} 443 444/** 445 * Creating an Object 446 * 447 * @enum { number } 448 * @syscap SystemCapability.ArkUI.ArkUI.Full 449 * @since 7 450 */ 451/** 452 * Creating an Object 453 * 454 * @enum { number } 455 * @syscap SystemCapability.ArkUI.ArkUI.Full 456 * @crossplatform 457 * @since 10 458 */ 459/** 460 * Creating an Object 461 * 462 * @enum { number } 463 * @syscap SystemCapability.ArkUI.ArkUI.Full 464 * @crossplatform 465 * @atomicservice 466 * @since 11 467 */ 468declare enum GestureMask { 469 /** 470 * High-priority response to the current gesture.When the current gesture fails to be recognized, other gesture responses are triggered.For gestures with the same priority, responses are performed based on the recognition sequence. 471 * 472 * @syscap SystemCapability.ArkUI.ArkUI.Full 473 * @since 7 474 */ 475 /** 476 * High-priority response to the current gesture.When the current gesture fails to be recognized, other gesture responses are triggered.For gestures with the same priority, responses are performed based on the recognition sequence. 477 * 478 * @syscap SystemCapability.ArkUI.ArkUI.Full 479 * @crossplatform 480 * @since 10 481 */ 482 /** 483 * High-priority response to the current gesture.When the current gesture fails to be recognized, other gesture responses are triggered.For gestures with the same priority, responses are performed based on the recognition sequence. 484 * 485 * @syscap SystemCapability.ArkUI.ArkUI.Full 486 * @crossplatform 487 * @atomicservice 488 * @since 11 489 */ 490 Normal, 491 492 /** 493 * Ignore internal gestures and recognize the current gesture first. 494 * 495 * @syscap SystemCapability.ArkUI.ArkUI.Full 496 * @since 7 497 */ 498 /** 499 * Ignore internal gestures and recognize the current gesture first. 500 * 501 * @syscap SystemCapability.ArkUI.ArkUI.Full 502 * @crossplatform 503 * @since 10 504 */ 505 /** 506 * Ignore internal gestures and recognize the current gesture first. 507 * 508 * @syscap SystemCapability.ArkUI.ArkUI.Full 509 * @crossplatform 510 * @atomicservice 511 * @since 11 512 */ 513 IgnoreInternal, 514} 515 516/** 517 * Creating an Object 518 * 519 * @enum { number } 520 * @syscap SystemCapability.ArkUI.ArkUI.Full 521 * @crossplatform 522 * @since 11 523 */ 524/** 525 * Creating an Object 526 * 527 * @enum { number } 528 * @syscap SystemCapability.ArkUI.ArkUI.Full 529 * @crossplatform 530 * @atomicservice 531 * @since 12 532 */ 533declare enum GestureJudgeResult { 534 /** 535 * The system gesture determination is not affected. 536 * 537 * @syscap SystemCapability.ArkUI.ArkUI.Full 538 * @crossplatform 539 * @since 11 540 */ 541 /** 542 * The system gesture determination is not affected. 543 * 544 * @syscap SystemCapability.ArkUI.ArkUI.Full 545 * @crossplatform 546 * @atomicservice 547 * @since 12 548 */ 549 CONTINUE = 0, 550 551 /** 552 * The user-defined gesture determination result of the current component is fail. 553 * 554 * @syscap SystemCapability.ArkUI.ArkUI.Full 555 * @crossplatform 556 * @since 11 557 */ 558 /** 559 * The user-defined gesture determination result of the current component is fail. 560 * 561 * @syscap SystemCapability.ArkUI.ArkUI.Full 562 * @crossplatform 563 * @atomicservice 564 * @since 12 565 */ 566 REJECT = 1, 567} 568 569/** 570 * Creating an Object 571 * 572 * @namespace GestureControl 573 * @syscap SystemCapability.ArkUI.ArkUI.Full 574 * @crossplatform 575 * @since 11 576 */ 577/** 578 * Creating an Object 579 * 580 * @namespace GestureControl 581 * @syscap SystemCapability.ArkUI.ArkUI.Full 582 * @crossplatform 583 * @atomicservice 584 * @since 12 585 */ 586declare namespace GestureControl { 587 /** 588 * Creating an Object 589 * 590 * @enum { number } 591 * @syscap SystemCapability.ArkUI.ArkUI.Full 592 * @crossplatform 593 * @since 11 594 */ 595 /** 596 * Creating an Object 597 * 598 * @enum { number } 599 * @syscap SystemCapability.ArkUI.ArkUI.Full 600 * @crossplatform 601 * @atomicservice 602 * @since 12 603 */ 604 enum GestureType { 605 /** 606 * TapGesture. 607 * 608 * @syscap SystemCapability.ArkUI.ArkUI.Full 609 * @crossplatform 610 * @since 11 611 */ 612 /** 613 * TapGesture. 614 * 615 * @syscap SystemCapability.ArkUI.ArkUI.Full 616 * @crossplatform 617 * @atomicservice 618 * @since 12 619 */ 620 TAP_GESTURE = 0, 621 622 /** 623 * LongPressGesture. 624 * 625 * @syscap SystemCapability.ArkUI.ArkUI.Full 626 * @crossplatform 627 * @since 11 628 */ 629 /** 630 * LongPressGesture. 631 * 632 * @syscap SystemCapability.ArkUI.ArkUI.Full 633 * @crossplatform 634 * @atomicservice 635 * @since 12 636 */ 637 LONG_PRESS_GESTURE = 1, 638 639 /** 640 * PanGesture. 641 * 642 * @syscap SystemCapability.ArkUI.ArkUI.Full 643 * @crossplatform 644 * @since 11 645 */ 646 /** 647 * PanGesture. 648 * 649 * @syscap SystemCapability.ArkUI.ArkUI.Full 650 * @crossplatform 651 * @atomicservice 652 * @since 12 653 */ 654 PAN_GESTURE = 2, 655 656 /** 657 * PinchGesture. 658 * 659 * @syscap SystemCapability.ArkUI.ArkUI.Full 660 * @crossplatform 661 * @since 11 662 */ 663 /** 664 * PinchGesture. 665 * 666 * @syscap SystemCapability.ArkUI.ArkUI.Full 667 * @crossplatform 668 * @atomicservice 669 * @since 12 670 */ 671 PINCH_GESTURE = 3, 672 673 /** 674 * SwipeGesture. 675 * 676 * @syscap SystemCapability.ArkUI.ArkUI.Full 677 * @crossplatform 678 * @since 11 679 */ 680 /** 681 * SwipeGesture. 682 * 683 * @syscap SystemCapability.ArkUI.ArkUI.Full 684 * @crossplatform 685 * @atomicservice 686 * @since 12 687 */ 688 SWIPE_GESTURE = 4, 689 690 /** 691 * RotationGesture. 692 * 693 * @syscap SystemCapability.ArkUI.ArkUI.Full 694 * @crossplatform 695 * @since 11 696 */ 697 /** 698 * RotationGesture. 699 * 700 * @syscap SystemCapability.ArkUI.ArkUI.Full 701 * @crossplatform 702 * @atomicservice 703 * @since 12 704 */ 705 ROTATION_GESTURE = 5, 706 707 /** 708 * Drag. 709 * 710 * @syscap SystemCapability.ArkUI.ArkUI.Full 711 * @crossplatform 712 * @since 11 713 */ 714 /** 715 * Drag. 716 * 717 * @syscap SystemCapability.ArkUI.ArkUI.Full 718 * @crossplatform 719 * @atomicservice 720 * @since 12 721 */ 722 DRAG = 6, 723 724 /** 725 * Click. 726 * 727 * @syscap SystemCapability.ArkUI.ArkUI.Full 728 * @crossplatform 729 * @since 11 730 */ 731 /** 732 * Click. 733 * 734 * @syscap SystemCapability.ArkUI.ArkUI.Full 735 * @crossplatform 736 * @atomicservice 737 * @since 12 738 */ 739 CLICK = 7, 740 } 741} 742 743/** 744 * The description of gesture information. 745 * 746 * @interface GestureInfo 747 * @syscap SystemCapability.ArkUI.ArkUI.Full 748 * @crossplatform 749 * @since 11 750 */ 751/** 752 * The description of gesture information. 753 * 754 * @interface GestureInfo 755 * @syscap SystemCapability.ArkUI.ArkUI.Full 756 * @crossplatform 757 * @atomicservice 758 * @since 12 759 */ 760declare interface GestureInfo { 761 /** 762 * The tag of gesture. 763 * 764 * @type { ?string } 765 * @syscap SystemCapability.ArkUI.ArkUI.Full 766 * @crossplatform 767 * @since 11 768 */ 769 /** 770 * The tag of gesture. 771 * 772 * @type { ?string } 773 * @syscap SystemCapability.ArkUI.ArkUI.Full 774 * @crossplatform 775 * @atomicservice 776 * @since 12 777 */ 778 tag?: string; 779 780 /** 781 * The type of gesture. 782 * 783 * @type { GestureControl.GestureType } 784 * @syscap SystemCapability.ArkUI.ArkUI.Full 785 * @crossplatform 786 * @since 11 787 */ 788 /** 789 * The type of gesture. 790 * 791 * @type { GestureControl.GestureType } 792 * @syscap SystemCapability.ArkUI.ArkUI.Full 793 * @crossplatform 794 * @atomicservice 795 * @since 12 796 */ 797 type: GestureControl.GestureType; 798 799 /** 800 * The flag whether it is a system gesture. 801 * 802 * @type { boolean } 803 * @syscap SystemCapability.ArkUI.ArkUI.Full 804 * @crossplatform 805 * @since 11 806 */ 807 /** 808 * The flag whether it is a system gesture. 809 * 810 * @type { boolean } 811 * @syscap SystemCapability.ArkUI.ArkUI.Full 812 * @crossplatform 813 * @atomicservice 814 * @since 12 815 */ 816 isSystemGesture: boolean; 817} 818 819/** 820 * Type of the finger information. 821 * 822 * @interface FingerInfo 823 * @syscap SystemCapability.ArkUI.ArkUI.Full 824 * @since 8 825 */ 826/** 827 * Type of the finger information. 828 * 829 * @interface FingerInfo 830 * @syscap SystemCapability.ArkUI.ArkUI.Full 831 * @crossplatform 832 * @since 10 833 */ 834/** 835 * Type of the finger information. 836 * 837 * @interface FingerInfo 838 * @syscap SystemCapability.ArkUI.ArkUI.Full 839 * @crossplatform 840 * @atomicservice 841 * @since 11 842 */ 843interface FingerInfo { 844 /** 845 * Finger unique identifier. 846 * 847 * @type { number } 848 * @syscap SystemCapability.ArkUI.ArkUI.Full 849 * @since 8 850 */ 851 /** 852 * Finger unique identifier. 853 * 854 * @type { number } 855 * @syscap SystemCapability.ArkUI.ArkUI.Full 856 * @crossplatform 857 * @since 10 858 */ 859 /** 860 * Finger unique identifier. 861 * 862 * @type { number } 863 * @syscap SystemCapability.ArkUI.ArkUI.Full 864 * @crossplatform 865 * @atomicservice 866 * @since 11 867 */ 868 id: number; 869 870 /** 871 * X coordinate of the touch point relative to the left edge of the device screen. 872 * 873 * @type { number } 874 * @syscap SystemCapability.ArkUI.ArkUI.Full 875 * @since 8 876 */ 877 /** 878 * X coordinate of the touch point relative to the left edge of the device screen. 879 * 880 * @type { number } 881 * @syscap SystemCapability.ArkUI.ArkUI.Full 882 * @crossplatform 883 * @since 10 884 */ 885 /** 886 * X coordinate of the touch point relative to the left edge of the device screen. 887 * 888 * @type { number } 889 * @syscap SystemCapability.ArkUI.ArkUI.Full 890 * @crossplatform 891 * @atomicservice 892 * @since 11 893 */ 894 globalX: number; 895 896 /** 897 * The Y coordinate of the touch point relative to the upper edge of the device screen. 898 * 899 * @type { number } 900 * @syscap SystemCapability.ArkUI.ArkUI.Full 901 * @since 8 902 */ 903 /** 904 * The Y coordinate of the touch point relative to the upper edge of the device screen. 905 * 906 * @type { number } 907 * @syscap SystemCapability.ArkUI.ArkUI.Full 908 * @crossplatform 909 * @since 10 910 */ 911 /** 912 * The Y coordinate of the touch point relative to the upper edge of the device screen. 913 * 914 * @type { number } 915 * @syscap SystemCapability.ArkUI.ArkUI.Full 916 * @crossplatform 917 * @atomicservice 918 * @since 11 919 */ 920 globalY: number; 921 922 /** 923 * X coordinate of the touch point relative to the left edge of the touched element. 924 * 925 * @type { number } 926 * @syscap SystemCapability.ArkUI.ArkUI.Full 927 * @since 8 928 */ 929 /** 930 * X coordinate of the touch point relative to the left edge of the touched element. 931 * 932 * @type { number } 933 * @syscap SystemCapability.ArkUI.ArkUI.Full 934 * @crossplatform 935 * @since 10 936 */ 937 /** 938 * X coordinate of the touch point relative to the left edge of the touched element. 939 * 940 * @type { number } 941 * @syscap SystemCapability.ArkUI.ArkUI.Full 942 * @crossplatform 943 * @atomicservice 944 * @since 11 945 */ 946 localX: number; 947 948 /** 949 * Y coordinate of the touch point relative to the upper edge of the touched element. 950 * 951 * @type { number } 952 * @syscap SystemCapability.ArkUI.ArkUI.Full 953 * @since 8 954 */ 955 /** 956 * Y coordinate of the touch point relative to the upper edge of the touched element. 957 * 958 * @type { number } 959 * @syscap SystemCapability.ArkUI.ArkUI.Full 960 * @crossplatform 961 * @since 10 962 */ 963 /** 964 * Y coordinate of the touch point relative to the upper edge of the touched element. 965 * 966 * @type { number } 967 * @syscap SystemCapability.ArkUI.ArkUI.Full 968 * @crossplatform 969 * @atomicservice 970 * @since 11 971 */ 972 localY: number; 973 974 /** 975 * X coordinate of the touch point relative to the left edge of the device screen. 976 * 977 * @type { number } 978 * @syscap SystemCapability.ArkUI.ArkUI.Full 979 * @crossplatform 980 * @atomicservice 981 * @since 12 982 */ 983 displayX: number; 984 985 /** 986 * Y coordinate of the touch point relative to the upper edge of the device screen. 987 * 988 * @type { number } 989 * @syscap SystemCapability.ArkUI.ArkUI.Full 990 * @crossplatform 991 * @atomicservice 992 * @since 12 993 */ 994 displayY: number; 995 996 /** 997 * Type of the touch hand. 998 * 999 * @type { InteractionHand } 1000 * @syscap SystemCapability.ArkUI.ArkUI.Full 1001 * @crossplatform 1002 * @atomicservice 1003 * @since 15 1004 */ 1005 hand?: InteractionHand; 1006} 1007 1008/** 1009 * Defines the Gesture Type. 1010 * 1011 * @typedef { TapGestureInterface | LongPressGestureInterface | PanGestureInterface | PinchGestureInterface | SwipeGestureInterface | RotationGestureInterface | GestureGroupInterface } GestureType 1012 * @syscap SystemCapability.ArkUI.ArkUI.Full 1013 * @since 7 1014 */ 1015/** 1016 * Defines the Gesture Type. 1017 * 1018 * @typedef { TapGestureInterface | LongPressGestureInterface | PanGestureInterface | PinchGestureInterface | SwipeGestureInterface | RotationGestureInterface | GestureGroupInterface } GestureType 1019 * @syscap SystemCapability.ArkUI.ArkUI.Full 1020 * @crossplatform 1021 * @since 10 1022 */ 1023/** 1024 * Defines the Gesture Type. 1025 * 1026 * @typedef { TapGestureInterface | LongPressGestureInterface | PanGestureInterface | PinchGestureInterface | SwipeGestureInterface | RotationGestureInterface | GestureGroupInterface } GestureType 1027 * @syscap SystemCapability.ArkUI.ArkUI.Full 1028 * @crossplatform 1029 * @atomicservice 1030 * @since 11 1031 */ 1032declare type GestureType = 1033 TapGestureInterface 1034 | LongPressGestureInterface 1035 | PanGestureInterface 1036 | PinchGestureInterface 1037 | SwipeGestureInterface 1038 | RotationGestureInterface 1039 | GestureGroupInterface; 1040 1041/** 1042 * Defines the gesture base event. 1043 * 1044 * @extends BaseEvent 1045 * @interface BaseGestureEvent 1046 * @syscap SystemCapability.ArkUI.ArkUI.Full 1047 * @crossplatform 1048 * @since 11 1049 */ 1050/** 1051 * Defines the gesture base event. 1052 * 1053 * @extends BaseEvent 1054 * @interface BaseGestureEvent 1055 * @syscap SystemCapability.ArkUI.ArkUI.Full 1056 * @crossplatform 1057 * @atomicservice 1058 * @since 12 1059 */ 1060interface BaseGestureEvent extends BaseEvent { 1061 /** 1062 * All finger information. 1063 * 1064 * @type { FingerInfo[] } 1065 * @syscap SystemCapability.ArkUI.ArkUI.Full 1066 * @crossplatform 1067 * @since 11 1068 */ 1069 /** 1070 * All finger information. 1071 * 1072 * @type { FingerInfo[] } 1073 * @syscap SystemCapability.ArkUI.ArkUI.Full 1074 * @crossplatform 1075 * @atomicservice 1076 * @since 12 1077 */ 1078 fingerList: FingerInfo[]; 1079} 1080 1081/** 1082 * Defines event info for tap gesture. 1083 * 1084 * @extends BaseGestureEvent 1085 * @interface TapGestureEvent 1086 * @syscap SystemCapability.ArkUI.ArkUI.Full 1087 * @crossplatform 1088 * @since 11 1089 */ 1090/** 1091 * Defines event info for tap gesture. 1092 * 1093 * @extends BaseGestureEvent 1094 * @interface TapGestureEvent 1095 * @syscap SystemCapability.ArkUI.ArkUI.Full 1096 * @crossplatform 1097 * @atomicservice 1098 * @since 12 1099 */ 1100interface TapGestureEvent extends BaseGestureEvent { 1101} 1102 1103/** 1104 * Defines event info for long press gesture. 1105 * 1106 * @extends BaseGestureEvent 1107 * @interface LongPressGestureEvent 1108 * @syscap SystemCapability.ArkUI.ArkUI.Full 1109 * @crossplatform 1110 * @since 11 1111 */ 1112/** 1113 * Defines event info for long press gesture. 1114 * 1115 * @extends BaseGestureEvent 1116 * @interface LongPressGestureEvent 1117 * @syscap SystemCapability.ArkUI.ArkUI.Full 1118 * @crossplatform 1119 * @atomicservice 1120 * @since 12 1121 */ 1122interface LongPressGestureEvent extends BaseGestureEvent { 1123 /** 1124 * Indicates whether an event is triggered repeatedly. 1125 * 1126 * @type { boolean } 1127 * @syscap SystemCapability.ArkUI.ArkUI.Full 1128 * @crossplatform 1129 * @since 11 1130 */ 1131 /** 1132 * Indicates whether an event is triggered repeatedly. 1133 * 1134 * @type { boolean } 1135 * @syscap SystemCapability.ArkUI.ArkUI.Full 1136 * @crossplatform 1137 * @atomicservice 1138 * @since 12 1139 */ 1140 repeat: boolean; 1141} 1142 1143/** 1144 * Defines event info for pan gesture. 1145 * 1146 * @extends BaseGestureEvent 1147 * @interface PanGestureEvent 1148 * @syscap SystemCapability.ArkUI.ArkUI.Full 1149 * @crossplatform 1150 * @since 11 1151 */ 1152/** 1153 * Defines event info for pan gesture. 1154 * 1155 * @extends BaseGestureEvent 1156 * @interface PanGestureEvent 1157 * @syscap SystemCapability.ArkUI.ArkUI.Full 1158 * @crossplatform 1159 * @atomicservice 1160 * @since 12 1161 */ 1162interface PanGestureEvent extends BaseGestureEvent { 1163 /** 1164 * Gesture event offset X. 1165 * The unit is vp. 1166 * 1167 * @type { number } 1168 * @syscap SystemCapability.ArkUI.ArkUI.Full 1169 * @crossplatform 1170 * @since 11 1171 */ 1172 /** 1173 * Gesture event offset X. 1174 * The unit is vp. 1175 * 1176 * @type { number } 1177 * @syscap SystemCapability.ArkUI.ArkUI.Full 1178 * @crossplatform 1179 * @atomicservice 1180 * @since 12 1181 */ 1182 offsetX: number; 1183 1184 /** 1185 * Gesture event offset Y. 1186 * The unit is vp. 1187 * 1188 * @type { number } 1189 * @syscap SystemCapability.ArkUI.ArkUI.Full 1190 * @crossplatform 1191 * @since 11 1192 */ 1193 /** 1194 * Gesture event offset Y. 1195 * The unit is vp. 1196 * 1197 * @type { number } 1198 * @syscap SystemCapability.ArkUI.ArkUI.Full 1199 * @crossplatform 1200 * @atomicservice 1201 * @since 12 1202 */ 1203 offsetY: number; 1204 1205 /** 1206 * X-axis velocity of the gesture. 1207 * @type {number} 1208 * @syscap SystemCapability.ArkUI.ArkUI.Full 1209 * @crossplatform 1210 * @since 11 1211 */ 1212 /** 1213 * X-axis velocity of the gesture. 1214 * @type {number} 1215 * @syscap SystemCapability.ArkUI.ArkUI.Full 1216 * @crossplatform 1217 * @atomicservice 1218 * @since 12 1219 */ 1220 velocityX: number; 1221 1222 /** 1223 * Y-axis velocity of the gesture. 1224 * @type {number} 1225 * @syscap SystemCapability.ArkUI.ArkUI.Full 1226 * @crossplatform 1227 * @since 11 1228 */ 1229 /** 1230 * Y-axis velocity of the gesture. 1231 * @type {number} 1232 * @syscap SystemCapability.ArkUI.ArkUI.Full 1233 * @crossplatform 1234 * @atomicservice 1235 * @since 12 1236 */ 1237 velocityY: number; 1238 1239 /** 1240 * velocity of the gesture. 1241 * @type {number} 1242 * @syscap SystemCapability.ArkUI.ArkUI.Full 1243 * @crossplatform 1244 * @since 11 1245 */ 1246 /** 1247 * velocity of the gesture. 1248 * @type {number} 1249 * @syscap SystemCapability.ArkUI.ArkUI.Full 1250 * @crossplatform 1251 * @atomicservice 1252 * @since 12 1253 */ 1254 velocity: number; 1255} 1256 1257/** 1258 * Defines event info for pinch gesture. 1259 * 1260 * @extends BaseGestureEvent 1261 * @interface PinchGestureEvent 1262 * @syscap SystemCapability.ArkUI.ArkUI.Full 1263 * @crossplatform 1264 * @since 11 1265 */ 1266/** 1267 * Defines event info for pinch gesture. 1268 * 1269 * @extends BaseGestureEvent 1270 * @interface PinchGestureEvent 1271 * @syscap SystemCapability.ArkUI.ArkUI.Full 1272 * @crossplatform 1273 * @atomicservice 1274 * @since 12 1275 */ 1276interface PinchGestureEvent extends BaseGestureEvent { 1277 /** 1278 * Scaling ratio. 1279 * 1280 * @type { number } 1281 * @syscap SystemCapability.ArkUI.ArkUI.Full 1282 * @crossplatform 1283 * @since 11 1284 */ 1285 /** 1286 * Scaling ratio. 1287 * 1288 * @type { number } 1289 * @syscap SystemCapability.ArkUI.ArkUI.Full 1290 * @crossplatform 1291 * @atomicservice 1292 * @since 12 1293 */ 1294 scale: number; 1295 1296 /** 1297 * X-axis coordinate of the kneading center point. 1298 * The unit is vp. 1299 * 1300 * @type { number } 1301 * @syscap SystemCapability.ArkUI.ArkUI.Full 1302 * @crossplatform 1303 * @since 11 1304 */ 1305 /** 1306 * X-axis coordinate of the kneading center point. 1307 * The unit is vp. 1308 * 1309 * @type { number } 1310 * @syscap SystemCapability.ArkUI.ArkUI.Full 1311 * @crossplatform 1312 * @atomicservice 1313 * @since 12 1314 */ 1315 pinchCenterX: number; 1316 1317 /** 1318 * Y-axis coordinate of the kneading center point. 1319 * The unit is vp. 1320 * 1321 * @type { number } 1322 * @syscap SystemCapability.ArkUI.ArkUI.Full 1323 * @crossplatform 1324 * @since 11 1325 */ 1326 /** 1327 * Y-axis coordinate of the kneading center point. 1328 * The unit is vp. 1329 * 1330 * @type { number } 1331 * @syscap SystemCapability.ArkUI.ArkUI.Full 1332 * @crossplatform 1333 * @atomicservice 1334 * @since 12 1335 */ 1336 pinchCenterY: number; 1337} 1338 1339/** 1340 * Defines event info for rotation gesture. 1341 * 1342 * @extends BaseGestureEvent 1343 * @interface RotationGestureEvent 1344 * @syscap SystemCapability.ArkUI.ArkUI.Full 1345 * @crossplatform 1346 * @since 11 1347 */ 1348/** 1349 * Defines event info for rotation gesture. 1350 * 1351 * @extends BaseGestureEvent 1352 * @interface RotationGestureEvent 1353 * @syscap SystemCapability.ArkUI.ArkUI.Full 1354 * @crossplatform 1355 * @atomicservice 1356 * @since 12 1357 */ 1358interface RotationGestureEvent extends BaseGestureEvent { 1359 /** 1360 * Gesture event direction angle. 1361 * The unit is deg. 1362 * 1363 * @type { number } 1364 * @syscap SystemCapability.ArkUI.ArkUI.Full 1365 * @crossplatform 1366 * @since 11 1367 */ 1368 /** 1369 * Gesture event direction angle. 1370 * The unit is deg. 1371 * 1372 * @type { number } 1373 * @syscap SystemCapability.ArkUI.ArkUI.Full 1374 * @crossplatform 1375 * @atomicservice 1376 * @since 12 1377 */ 1378 angle: number; 1379} 1380 1381/** 1382 * Defines event info for swipe gesture. 1383 * 1384 * @extends BaseGestureEvent 1385 * @interface SwipeGestureEvent 1386 * @syscap SystemCapability.ArkUI.ArkUI.Full 1387 * @crossplatform 1388 * @since 11 1389 */ 1390/** 1391 * Defines event info for swipe gesture. 1392 * 1393 * @extends BaseGestureEvent 1394 * @interface SwipeGestureEvent 1395 * @syscap SystemCapability.ArkUI.ArkUI.Full 1396 * @crossplatform 1397 * @atomicservice 1398 * @since 112 1399 */ 1400interface SwipeGestureEvent extends BaseGestureEvent { 1401 /** 1402 * Gesture event direction angle. 1403 * The unit is deg. 1404 * 1405 * @type { number } 1406 * @syscap SystemCapability.ArkUI.ArkUI.Full 1407 * @crossplatform 1408 * @since 11 1409 */ 1410 /** 1411 * Gesture event direction angle. 1412 * The unit is deg. 1413 * 1414 * @type { number } 1415 * @syscap SystemCapability.ArkUI.ArkUI.Full 1416 * @crossplatform 1417 * @atomicservice 1418 * @since 12 1419 */ 1420 angle: number; 1421 1422 /** 1423 * Gesture event slide speed. 1424 * The unit is vp. 1425 * 1426 * @type { number } 1427 * @syscap SystemCapability.ArkUI.ArkUI.Full 1428 * @crossplatform 1429 * @since 11 1430 */ 1431 /** 1432 * Gesture event slide speed. 1433 * The unit is vp. 1434 * 1435 * @type { number } 1436 * @syscap SystemCapability.ArkUI.ArkUI.Full 1437 * @crossplatform 1438 * @atomicservice 1439 * @since 12 1440 */ 1441 speed: number; 1442} 1443 1444/** 1445 * Defines event info for gesture. 1446 * 1447 * @extends BaseEvent 1448 * @interface GestureEvent 1449 * @syscap SystemCapability.ArkUI.ArkUI.Full 1450 * @since 7 1451 */ 1452/** 1453 * Defines event info for gesture. 1454 * 1455 * @extends BaseEvent 1456 * @interface GestureEvent 1457 * @syscap SystemCapability.ArkUI.ArkUI.Full 1458 * @crossplatform 1459 * @since 10 1460 */ 1461/** 1462 * Defines event info for gesture. 1463 * 1464 * @extends BaseEvent 1465 * @interface GestureEvent 1466 * @syscap SystemCapability.ArkUI.ArkUI.Full 1467 * @crossplatform 1468 * @atomicservice 1469 * @since 11 1470 */ 1471interface GestureEvent extends BaseEvent { 1472 /** 1473 * Indicates whether an event is triggered repeatedly. 1474 * Used in LongPressGesture. 1475 * 1476 * @type { boolean } 1477 * @syscap SystemCapability.ArkUI.ArkUI.Full 1478 * @since 7 1479 */ 1480 /** 1481 * Indicates whether an event is triggered repeatedly. 1482 * Used in LongPressGesture. 1483 * 1484 * @type { boolean } 1485 * @syscap SystemCapability.ArkUI.ArkUI.Full 1486 * @crossplatform 1487 * @since 10 1488 */ 1489 /** 1490 * Indicates whether an event is triggered repeatedly. 1491 * Used in LongPressGesture. 1492 * 1493 * @type { boolean } 1494 * @syscap SystemCapability.ArkUI.ArkUI.Full 1495 * @crossplatform 1496 * @atomicservice 1497 * @since 11 1498 */ 1499 repeat: boolean; 1500 1501 /** 1502 * All finger information. 1503 * Used in LongPressGesture and TapGesture. 1504 * 1505 * @type { FingerInfo[] } 1506 * @syscap SystemCapability.ArkUI.ArkUI.Full 1507 * @since 8 1508 */ 1509 /** 1510 * All finger information. 1511 * Used in LongPressGesture and TapGesture. 1512 * 1513 * @type { FingerInfo[] } 1514 * @syscap SystemCapability.ArkUI.ArkUI.Full 1515 * @crossplatform 1516 * @since 10 1517 */ 1518 /** 1519 * All finger information. 1520 * Used in LongPressGesture and TapGesture. 1521 * 1522 * @type { FingerInfo[] } 1523 * @syscap SystemCapability.ArkUI.ArkUI.Full 1524 * @crossplatform 1525 * @atomicservice 1526 * @since 11 1527 */ 1528 fingerList: FingerInfo[]; 1529 1530 /** 1531 * Gesture event offset X. 1532 * The unit is vp. 1533 * Used in PanGesture. 1534 * 1535 * @type { number } 1536 * @syscap SystemCapability.ArkUI.ArkUI.Full 1537 * @since 7 1538 */ 1539 /** 1540 * Gesture event offset X. 1541 * The unit is vp. 1542 * Used in PanGesture. 1543 * 1544 * @type { number } 1545 * @syscap SystemCapability.ArkUI.ArkUI.Full 1546 * @crossplatform 1547 * @since 10 1548 */ 1549 /** 1550 * Gesture event offset X. 1551 * The unit is vp. 1552 * Used in PanGesture. 1553 * 1554 * @type { number } 1555 * @syscap SystemCapability.ArkUI.ArkUI.Full 1556 * @crossplatform 1557 * @atomicservice 1558 * @since 11 1559 */ 1560 offsetX: number; 1561 1562 /** 1563 * Gesture event offset Y. 1564 * The unit is vp. 1565 * Used in PanGesture. 1566 * 1567 * @type { number } 1568 * @syscap SystemCapability.ArkUI.ArkUI.Full 1569 * @since 7 1570 */ 1571 /** 1572 * Gesture event offset Y. 1573 * The unit is vp. 1574 * Used in PanGesture. 1575 * 1576 * @type { number } 1577 * @syscap SystemCapability.ArkUI.ArkUI.Full 1578 * @crossplatform 1579 * @since 10 1580 */ 1581 /** 1582 * Gesture event offset Y. 1583 * The unit is vp. 1584 * Used in PanGesture. 1585 * 1586 * @type { number } 1587 * @syscap SystemCapability.ArkUI.ArkUI.Full 1588 * @crossplatform 1589 * @atomicservice 1590 * @since 11 1591 */ 1592 offsetY: number; 1593 1594 /** 1595 * Gesture event direction angle. 1596 * The unit is deg. 1597 * Used in RotationGesture and SwipeGesture. 1598 * 1599 * @type { number } 1600 * @syscap SystemCapability.ArkUI.ArkUI.Full 1601 * @since 7 1602 */ 1603 /** 1604 * Gesture event direction angle. 1605 * The unit is deg. 1606 * Used in RotationGesture and SwipeGesture. 1607 * 1608 * @type { number } 1609 * @syscap SystemCapability.ArkUI.ArkUI.Full 1610 * @crossplatform 1611 * @since 10 1612 */ 1613 /** 1614 * Gesture event direction angle. 1615 * The unit is deg. 1616 * Used in RotationGesture and SwipeGesture. 1617 * 1618 * @type { number } 1619 * @syscap SystemCapability.ArkUI.ArkUI.Full 1620 * @crossplatform 1621 * @atomicservice 1622 * @since 11 1623 */ 1624 angle: number; 1625 1626 /** 1627 * Gesture event slide speed. 1628 * The unit is vp. 1629 * Used in SwipeGesture. 1630 * 1631 * @type { number } 1632 * @syscap SystemCapability.ArkUI.ArkUI.Full 1633 * @since 8 1634 */ 1635 /** 1636 * Gesture event slide speed. 1637 * The unit is vp. 1638 * Used in SwipeGesture. 1639 * 1640 * @type { number } 1641 * @syscap SystemCapability.ArkUI.ArkUI.Full 1642 * @crossplatform 1643 * @since 10 1644 */ 1645 /** 1646 * Gesture event slide speed. 1647 * The unit is vp. 1648 * Used in SwipeGesture. 1649 * 1650 * @type { number } 1651 * @syscap SystemCapability.ArkUI.ArkUI.Full 1652 * @crossplatform 1653 * @atomicservice 1654 * @since 11 1655 */ 1656 speed: number; 1657 1658 /** 1659 * Scaling ratio. 1660 * Used in PinchGesture. 1661 * 1662 * @type { number } 1663 * @syscap SystemCapability.ArkUI.ArkUI.Full 1664 * @since 7 1665 */ 1666 /** 1667 * Scaling ratio. 1668 * Used in PinchGesture. 1669 * 1670 * @type { number } 1671 * @syscap SystemCapability.ArkUI.ArkUI.Full 1672 * @crossplatform 1673 * @since 10 1674 */ 1675 /** 1676 * Scaling ratio. 1677 * Used in PinchGesture. 1678 * 1679 * @type { number } 1680 * @syscap SystemCapability.ArkUI.ArkUI.Full 1681 * @crossplatform 1682 * @atomicservice 1683 * @since 11 1684 */ 1685 scale: number; 1686 1687 /** 1688 * X-axis coordinate of the kneading center point. 1689 * The unit is vp. 1690 * Used in PinchGesture. 1691 * 1692 * @type { number } 1693 * @syscap SystemCapability.ArkUI.ArkUI.Full 1694 * @since 7 1695 */ 1696 /** 1697 * X-axis coordinate of the kneading center point. 1698 * The unit is vp. 1699 * Used in PinchGesture. 1700 * 1701 * @type { number } 1702 * @syscap SystemCapability.ArkUI.ArkUI.Full 1703 * @crossplatform 1704 * @since 10 1705 */ 1706 /** 1707 * X-axis coordinate of the kneading center point. 1708 * The unit is vp. 1709 * Used in PinchGesture. 1710 * 1711 * @type { number } 1712 * @syscap SystemCapability.ArkUI.ArkUI.Full 1713 * @crossplatform 1714 * @atomicservice 1715 * @since 11 1716 */ 1717 pinchCenterX: number; 1718 1719 /** 1720 * Y-axis coordinate of the kneading center point. 1721 * The unit is vp. 1722 * Used in PinchGesture. 1723 * 1724 * @type { number } 1725 * @syscap SystemCapability.ArkUI.ArkUI.Full 1726 * @since 7 1727 */ 1728 /** 1729 * Y-axis coordinate of the kneading center point. 1730 * The unit is vp. 1731 * Used in PinchGesture. 1732 * 1733 * @type { number } 1734 * @syscap SystemCapability.ArkUI.ArkUI.Full 1735 * @crossplatform 1736 * @since 10 1737 */ 1738 /** 1739 * Y-axis coordinate of the kneading center point. 1740 * The unit is vp. 1741 * Used in PinchGesture. 1742 * 1743 * @type { number } 1744 * @syscap SystemCapability.ArkUI.ArkUI.Full 1745 * @crossplatform 1746 * @atomicservice 1747 * @since 11 1748 */ 1749 pinchCenterY: number; 1750 1751 /** 1752 * X-axis velocity of the gesture. 1753 * @type {number} 1754 * @syscap SystemCapability.ArkUI.ArkUI.Full 1755 * @crossplatform 1756 * @since 10 1757 */ 1758 /** 1759 * X-axis velocity of the gesture. 1760 * @type {number} 1761 * @syscap SystemCapability.ArkUI.ArkUI.Full 1762 * @crossplatform 1763 * @atomicservice 1764 * @since 11 1765 */ 1766 velocityX: number; 1767 1768 /** 1769 * Y-axis velocity of the gesture. 1770 * @type {number} 1771 * @syscap SystemCapability.ArkUI.ArkUI.Full 1772 * @crossplatform 1773 * @since 10 1774 */ 1775 /** 1776 * Y-axis velocity of the gesture. 1777 * @type {number} 1778 * @syscap SystemCapability.ArkUI.ArkUI.Full 1779 * @crossplatform 1780 * @atomicservice 1781 * @since 11 1782 */ 1783 velocityY: number; 1784 1785 /** 1786 * velocity of the gesture. 1787 * @type {number} 1788 * @syscap SystemCapability.ArkUI.ArkUI.Full 1789 * @crossplatform 1790 * @since 10 1791 */ 1792 /** 1793 * velocity of the gesture. 1794 * @type {number} 1795 * @syscap SystemCapability.ArkUI.ArkUI.Full 1796 * @crossplatform 1797 * @atomicservice 1798 * @since 11 1799 */ 1800 velocity: number; 1801} 1802 1803/** 1804 * Defines Gesture interface. 1805 * 1806 * @interface GestureInterface 1807 * @syscap SystemCapability.ArkUI.ArkUI.Full 1808 * @crossplatform 1809 * @atomicservice 1810 * @since 11 1811 */ 1812interface GestureInterface<T> { 1813 /** 1814 * Set gesture's tag. 1815 * 1816 * @param { string } tag 1817 * @returns { T } 1818 * @syscap SystemCapability.ArkUI.ArkUI.Full 1819 * @crossplatform 1820 * @atomicservice 1821 * @since 11 1822 */ 1823 tag(tag: string): T; 1824 1825 /** 1826 * Input source type for gesture response. 1827 * 1828 * @param { Array<SourceTool> } types - indicate the allowed input source for gesture to response 1829 * @returns { T } 1830 * @syscap SystemCapability.ArkUI.ArkUI.Full 1831 * @crossplatform 1832 * @atomicservice 1833 * @since 14 1834 */ 1835 allowedTypes(types: Array<SourceTool>): T; 1836} 1837 1838 /** 1839 * Defines the BaseHandlerOptions options. 1840 * @interface BaseHandlerOptions 1841 * @syscap SystemCapability.ArkUI.ArkUI.Full 1842 * @crossplatform 1843 * @atomicservice 1844 * @since 15 1845 */ 1846 interface BaseHandlerOptions { 1847 /** 1848 * The flag to strict verification fingers, if touch finger size is over or less than fingers, gesture can not be accepted. 1849 * The default value is false. 1850 * 1851 * @type { ?boolean } 1852 * @syscap SystemCapability.ArkUI.ArkUI.Full 1853 * @crossplatform 1854 * @atomicservice 1855 * @since 15 1856 */ 1857 isFingerCountLimited?: boolean; 1858} 1859 1860/** 1861 * Defines TapGesture parameters. 1862 * 1863 * @interface TapGestureParameters 1864 * @syscap SystemCapability.ArkUI.ArkUI.Full 1865 * @crossplatform 1866 * @atomicservice 1867 * @since 12 1868 */ 1869/** 1870 * Defines TapGesture parameters. 1871 * 1872 * @extends BaseHandlerOptions 1873 * @interface TapGestureParameters 1874 * @syscap SystemCapability.ArkUI.ArkUI.Full 1875 * @crossplatform 1876 * @atomicservice 1877 * @since 15 1878 */ 1879declare interface TapGestureParameters extends BaseHandlerOptions { 1880 /** 1881 * Number of consecutive clicks recognized. If the value is less than 1, the default value is used. 1882 * 1883 * @type { ?number } 1884 * @syscap SystemCapability.ArkUI.ArkUI.Full 1885 * @crossplatform 1886 * @atomicservice 1887 * @since 11 1888 */ 1889 count?: number; 1890 /** 1891 * The hand index that triggers the click. If the value is less than 1, the default value is used. 1892 * 1893 * @type { ?number } 1894 * @syscap SystemCapability.ArkUI.ArkUI.Full 1895 * @crossplatform 1896 * @atomicservice 1897 * @since 11 1898 */ 1899 fingers?: number; 1900 /** 1901 * The limited move distance of click. If the value is less than 0, the default value is used. 1902 * 1903 * @type { ?number } 1904 * @syscap SystemCapability.ArkUI.ArkUI.Full 1905 * @crossplatform 1906 * @atomicservice 1907 * @since 12 1908 */ 1909 distanceThreshold?: number; 1910} 1911 1912/** 1913 * Defines TapGesture interface. 1914 * 1915 * @extends GestureInterface<TapGestureInterface> 1916 * @interface TapGestureInterface 1917 * @syscap SystemCapability.ArkUI.ArkUI.Full 1918 * @since 7 1919 */ 1920/** 1921 * Defines TapGesture interface. 1922 * 1923 * @extends GestureInterface<TapGestureInterface> 1924 * @interface TapGestureInterface 1925 * @syscap SystemCapability.ArkUI.ArkUI.Full 1926 * @crossplatform 1927 * @since 10 1928 */ 1929/** 1930 * Defines TapGesture interface extends GestureInterface<TapGestureInterface>. 1931 * 1932 * @extends GestureInterface<TapGestureInterface> 1933 * @interface TapGestureInterface 1934 * @syscap SystemCapability.ArkUI.ArkUI.Full 1935 * @crossplatform 1936 * @atomicservice 1937 * @since 11 1938 */ 1939interface TapGestureInterface extends GestureInterface<TapGestureInterface> { 1940 /** 1941 * Set the value. 1942 * count:Number of consecutive clicks recognized. If the value is less than 1, the default value is used. 1943 * fingers:The hand index that triggers the click. If the value is less than 1, the default value is used. 1944 * 1945 * @param { object } value 1946 * @returns { TapGestureInterface } 1947 * @syscap SystemCapability.ArkUI.ArkUI.Full 1948 * @since 7 1949 */ 1950 /** 1951 * Set the value. 1952 * count:Number of consecutive clicks recognized. If the value is less than 1, the default value is used. 1953 * fingers:The hand index that triggers the click. If the value is less than 1, the default value is used. 1954 * 1955 * @param { object } value 1956 * @returns { TapGestureInterface } 1957 * @syscap SystemCapability.ArkUI.ArkUI.Full 1958 * @crossplatform 1959 * @since 10 1960 */ 1961 /** 1962 * Set the value. 1963 * count:Number of consecutive clicks recognized. If the value is less than 1, the default value is used. 1964 * fingers:The hand index that triggers the click. If the value is less than 1, the default value is used. 1965 * 1966 * @param { object } value 1967 * @returns { TapGestureInterface } 1968 * @syscap SystemCapability.ArkUI.ArkUI.Full 1969 * @crossplatform 1970 * @atomicservice 1971 * @since 11 1972 */ 1973 /** 1974 * Set the value. 1975 * TapGestureParameters: The parameters of the tapGesture. 1976 * 1977 * @param { TapGestureParameters } value 1978 * @returns { TapGestureInterface } 1979 * @syscap SystemCapability.ArkUI.ArkUI.Full 1980 * @crossplatform 1981 * @atomicservice 1982 * @since 12 1983 */ 1984 (value?: TapGestureParameters): TapGestureInterface; 1985 1986 /** 1987 * Tap gesture recognition success callback. 1988 * 1989 * @param { function } event 1990 * @returns { TapGestureInterface } 1991 * @syscap SystemCapability.ArkUI.ArkUI.Full 1992 * @since 7 1993 */ 1994 /** 1995 * Tap gesture recognition success callback. 1996 * 1997 * @param { function } event 1998 * @returns { TapGestureInterface } 1999 * @syscap SystemCapability.ArkUI.ArkUI.Full 2000 * @crossplatform 2001 * @since 10 2002 */ 2003 /** 2004 * Tap gesture recognition success callback. 2005 * 2006 * @param { function } event 2007 * @returns { TapGestureInterface } 2008 * @syscap SystemCapability.ArkUI.ArkUI.Full 2009 * @crossplatform 2010 * @atomicservice 2011 * @since 11 2012 */ 2013 onAction(event: (event: GestureEvent) => void): TapGestureInterface; 2014} 2015 2016/** 2017 * Defines LongPressGesture interface. 2018 * 2019 * @extends GestureInterface<LongPressGestureInterface> 2020 * @interface LongPressGestureInterface 2021 * @syscap SystemCapability.ArkUI.ArkUI.Full 2022 * @since 7 2023 */ 2024/** 2025 * Defines LongPressGesture interface. 2026 * 2027 * @extends GestureInterface<LongPressGestureInterface> 2028 * @interface LongPressGestureInterface 2029 * @syscap SystemCapability.ArkUI.ArkUI.Full 2030 * @crossplatform 2031 * @since 10 2032 */ 2033/** 2034 * Defines LongPressGesture interface extends GestureInterface<LongPressGestureInterface>. 2035 * 2036 * @extends GestureInterface<LongPressGestureInterface> 2037 * @interface LongPressGestureInterface 2038 * @syscap SystemCapability.ArkUI.ArkUI.Full 2039 * @crossplatform 2040 * @atomicservice 2041 * @since 11 2042 */ 2043interface LongPressGestureInterface extends GestureInterface<LongPressGestureInterface> { 2044 /** 2045 * Set the value. 2046 * fingers: Indicates the hand index that triggers the long press. 2047 * repeat: Indicates whether to trigger event callback continuously. 2048 * duration: Minimum press and hold time, in milliseconds. 2049 * 2050 * @param { object } value 2051 * @returns { LongPressGestureInterface } 2052 * @syscap SystemCapability.ArkUI.ArkUI.Full 2053 * @since 7 2054 */ 2055 /** 2056 * Set the value. 2057 * fingers: Indicates the hand index that triggers the long press. 2058 * repeat: Indicates whether to trigger event callback continuously. 2059 * duration: Minimum press and hold time, in milliseconds. 2060 * 2061 * @param { object } value 2062 * @returns { LongPressGestureInterface } 2063 * @syscap SystemCapability.ArkUI.ArkUI.Full 2064 * @crossplatform 2065 * @since 10 2066 */ 2067 /** 2068 * Set the value. 2069 * fingers: Indicates the hand index that triggers the long press. 2070 * repeat: Indicates whether to trigger event callback continuously. 2071 * duration: Minimum press and hold time, in milliseconds. 2072 * 2073 * @param { object } value 2074 * @returns { LongPressGestureInterface } 2075 * @syscap SystemCapability.ArkUI.ArkUI.Full 2076 * @crossplatform 2077 * @atomicservice 2078 * @since 11 2079 */ 2080 (value?: { fingers?: number; repeat?: boolean; duration?: number }): LongPressGestureInterface; 2081 2082 /** 2083 * Set the options. 2084 * options: The options of the long press gesture. 2085 * 2086 * @param { LongPressGestureHandlerOptions } options 2087 * @returns { LongPressGestureInterface } 2088 * @syscap SystemCapability.ArkUI.ArkUI.Full 2089 * @crossplatform 2090 * @atomicservice 2091 * @since 15 2092 */ 2093 (options?: LongPressGestureHandlerOptions): LongPressGestureInterface; 2094 /** 2095 * LongPress gesture recognition success callback. 2096 * 2097 * @param { function } event 2098 * @returns { LongPressGestureInterface } 2099 * @syscap SystemCapability.ArkUI.ArkUI.Full 2100 * @since 7 2101 */ 2102 /** 2103 * LongPress gesture recognition success callback. 2104 * 2105 * @param { function } event 2106 * @returns { LongPressGestureInterface } 2107 * @syscap SystemCapability.ArkUI.ArkUI.Full 2108 * @crossplatform 2109 * @since 10 2110 */ 2111 /** 2112 * LongPress gesture recognition success callback. 2113 * 2114 * @param { function } event 2115 * @returns { LongPressGestureInterface } 2116 * @syscap SystemCapability.ArkUI.ArkUI.Full 2117 * @crossplatform 2118 * @atomicservice 2119 * @since 11 2120 */ 2121 onAction(event: (event: GestureEvent) => void): LongPressGestureInterface; 2122 2123 /** 2124 * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2125 * 2126 * @param { function } event 2127 * @returns { LongPressGestureInterface } 2128 * @syscap SystemCapability.ArkUI.ArkUI.Full 2129 * @since 7 2130 */ 2131 /** 2132 * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2133 * 2134 * @param { function } event 2135 * @returns { LongPressGestureInterface } 2136 * @syscap SystemCapability.ArkUI.ArkUI.Full 2137 * @crossplatform 2138 * @since 10 2139 */ 2140 /** 2141 * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2142 * 2143 * @param { function } event 2144 * @returns { LongPressGestureInterface } 2145 * @syscap SystemCapability.ArkUI.ArkUI.Full 2146 * @crossplatform 2147 * @atomicservice 2148 * @since 11 2149 */ 2150 onActionEnd(event: (event: GestureEvent) => void): LongPressGestureInterface; 2151 2152 /** 2153 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2154 * 2155 * @param { function } event 2156 * @returns { LongPressGestureInterface } 2157 * @syscap SystemCapability.ArkUI.ArkUI.Full 2158 * @since 7 2159 */ 2160 /** 2161 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2162 * 2163 * @param { function } event 2164 * @returns { LongPressGestureInterface } 2165 * @syscap SystemCapability.ArkUI.ArkUI.Full 2166 * @crossplatform 2167 * @since 10 2168 */ 2169 /** 2170 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2171 * 2172 * @param { function } event 2173 * @returns { LongPressGestureInterface } 2174 * @syscap SystemCapability.ArkUI.ArkUI.Full 2175 * @crossplatform 2176 * @atomicservice 2177 * @since 11 2178 */ 2179 onActionCancel(event: () => void): LongPressGestureInterface; 2180 /** 2181 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2182 * 2183 * @param { function } event 2184 * @returns { LongPressGestureInterface } 2185 * @syscap SystemCapability.ArkUI.ArkUI.Full 2186 * @crossplatform 2187 * @atomicservice 2188 * @since 18 2189 */ 2190 onActionCancel(event: Callback<GestureEvent>): LongPressGestureInterface; 2191} 2192 2193/** 2194 * Defines the PanGesture options. 2195 * 2196 * @syscap SystemCapability.ArkUI.ArkUI.Full 2197 * @since 7 2198 */ 2199/** 2200 * Defines the PanGesture options. 2201 * 2202 * @syscap SystemCapability.ArkUI.ArkUI.Full 2203 * @crossplatform 2204 * @since 10 2205 */ 2206/** 2207 * Defines the PanGesture options. 2208 * 2209 * @syscap SystemCapability.ArkUI.ArkUI.Full 2210 * @crossplatform 2211 * @atomicservice 2212 * @since 11 2213 */ 2214declare class PanGestureOptions { 2215 /** 2216 * Constructor parameters. 2217 * 2218 * @param { object } value 2219 * @syscap SystemCapability.ArkUI.ArkUI.Full 2220 * @since 7 2221 */ 2222 /** 2223 * Constructor parameters. 2224 * 2225 * @param { object } value 2226 * @syscap SystemCapability.ArkUI.ArkUI.Full 2227 * @crossplatform 2228 * @since 10 2229 */ 2230 /** 2231 * Constructor parameters. 2232 * 2233 * @param { object } value 2234 * @syscap SystemCapability.ArkUI.ArkUI.Full 2235 * @crossplatform 2236 * @atomicservice 2237 * @since 11 2238 */ 2239 constructor(value?: { fingers?: number; direction?: PanDirection; distance?: number }); 2240 2241 /** 2242 * Sets the direction attribute. 2243 * 2244 * @param { PanDirection } value 2245 * @syscap SystemCapability.ArkUI.ArkUI.Full 2246 * @since 7 2247 */ 2248 /** 2249 * Sets the direction attribute. 2250 * 2251 * @param { PanDirection } value 2252 * @syscap SystemCapability.ArkUI.ArkUI.Full 2253 * @crossplatform 2254 * @since 10 2255 */ 2256 /** 2257 * Sets the direction attribute. 2258 * 2259 * @param { PanDirection } value 2260 * @syscap SystemCapability.ArkUI.ArkUI.Full 2261 * @crossplatform 2262 * @atomicservice 2263 * @since 11 2264 */ 2265 setDirection(value: PanDirection); 2266 2267 /** 2268 * Sets the setDistance attribute. 2269 * 2270 * @param { number } value 2271 * @syscap SystemCapability.ArkUI.ArkUI.Full 2272 * @since 7 2273 */ 2274 /** 2275 * Sets the setDistance attribute. 2276 * 2277 * @param { number } value 2278 * @syscap SystemCapability.ArkUI.ArkUI.Full 2279 * @crossplatform 2280 * @since 10 2281 */ 2282 /** 2283 * Sets the setDistance attribute. 2284 * 2285 * @param { number } value 2286 * @syscap SystemCapability.ArkUI.ArkUI.Full 2287 * @crossplatform 2288 * @atomicservice 2289 * @since 11 2290 */ 2291 setDistance(value: number); 2292 2293 /** 2294 * Sets the setFingers attribute. 2295 * 2296 * @param { number } value 2297 * @syscap SystemCapability.ArkUI.ArkUI.Full 2298 * @since 7 2299 */ 2300 /** 2301 * Sets the setFingers attribute. 2302 * 2303 * @param { number } value 2304 * @syscap SystemCapability.ArkUI.ArkUI.Full 2305 * @crossplatform 2306 * @since 10 2307 */ 2308 /** 2309 * Sets the setFingers attribute. 2310 * 2311 * @param { number } value 2312 * @syscap SystemCapability.ArkUI.ArkUI.Full 2313 * @crossplatform 2314 * @atomicservice 2315 * @since 11 2316 */ 2317 setFingers(value: number); 2318 2319 /** 2320 * Get the pan direction attribute. 2321 * 2322 * @returns { PanDirection } - Pan gesture direction 2323 * @syscap SystemCapability.ArkUI.ArkUI.Full 2324 * @crossplatform 2325 * @atomicservice 2326 * @since 12 2327 */ 2328 getDirection(): PanDirection; 2329 /** 2330 * Returns the pan gesture's distance. 2331 * The unit is vp. 2332 * 2333 * @returns { number } - the distance of the pan gesture. 2334 * @syscap SystemCapability.ArkUI.ArkUI.Full 2335 * @crossplatform 2336 * @atomicservice 2337 * @since 18 2338 */ 2339 getDistance(): number; 2340} 2341 2342/** 2343 * Defines the PanGesture interface. 2344 * 2345 * @extends GestureInterface<PanGestureInterface> 2346 * @interface PanGestureInterface 2347 * @syscap SystemCapability.ArkUI.ArkUI.Full 2348 * @since 7 2349 */ 2350/** 2351 * Defines the PanGesture interface. 2352 * 2353 * @extends GestureInterface<PanGestureInterface> 2354 * @interface PanGestureInterface 2355 * @syscap SystemCapability.ArkUI.ArkUI.Full 2356 * @crossplatform 2357 * @since 10 2358 */ 2359/** 2360 * Defines PanGesture interface extends GestureInterface<PanGestureInterface>. 2361 * 2362 * @extends GestureInterface<PanGestureInterface> 2363 * @interface PanGestureInterface 2364 * @syscap SystemCapability.ArkUI.ArkUI.Full 2365 * @crossplatform 2366 * @atomicservice 2367 * @since 11 2368 */ 2369interface PanGestureInterface extends GestureInterface<PanGestureInterface> { 2370 /** 2371 * Set the value. 2372 * 2373 * @param { { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOptions } value 2374 * @returns { PanGestureInterface } 2375 * @syscap SystemCapability.ArkUI.ArkUI.Full 2376 * @since 7 2377 */ 2378 /** 2379 * Set the value. 2380 * 2381 * @param { { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOptions } value 2382 * @returns { PanGestureInterface } 2383 * @syscap SystemCapability.ArkUI.ArkUI.Full 2384 * @crossplatform 2385 * @since 10 2386 */ 2387 /** 2388 * Set the value. 2389 * 2390 * @param { { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOptions } value 2391 * @returns { PanGestureInterface } 2392 * @syscap SystemCapability.ArkUI.ArkUI.Full 2393 * @crossplatform 2394 * @atomicservice 2395 * @since 11 2396 */ 2397 (value?: { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOptions): PanGestureInterface; 2398 2399 /** 2400 * Set the value. 2401 * 2402 * @param { PanGestureHandlerOptions } options 2403 * @returns { PanGestureInterface } 2404 * @syscap SystemCapability.ArkUI.ArkUI.Full 2405 * @crossplatform 2406 * @atomicservice 2407 * @since 15 2408 */ 2409 (options?: PanGestureHandlerOptions): PanGestureInterface; 2410 2411 /** 2412 * Pan gesture recognition success callback. 2413 * 2414 * @param { function } event 2415 * @returns { PanGestureInterface } 2416 * @syscap SystemCapability.ArkUI.ArkUI.Full 2417 * @since 7 2418 */ 2419 /** 2420 * Pan gesture recognition success callback. 2421 * 2422 * @param { function } event 2423 * @returns { PanGestureInterface } 2424 * @syscap SystemCapability.ArkUI.ArkUI.Full 2425 * @crossplatform 2426 * @since 10 2427 */ 2428 /** 2429 * Pan gesture recognition success callback. 2430 * 2431 * @param { function } event 2432 * @returns { PanGestureInterface } 2433 * @syscap SystemCapability.ArkUI.ArkUI.Full 2434 * @crossplatform 2435 * @atomicservice 2436 * @since 11 2437 */ 2438 onActionStart(event: (event: GestureEvent) => void): PanGestureInterface; 2439 2440 /** 2441 * Callback when the Pan gesture is moving. 2442 * 2443 * @param { function } event 2444 * @returns { PanGestureInterface } 2445 * @syscap SystemCapability.ArkUI.ArkUI.Full 2446 * @since 7 2447 */ 2448 /** 2449 * Callback when the Pan gesture is moving. 2450 * 2451 * @param { function } event 2452 * @returns { PanGestureInterface } 2453 * @syscap SystemCapability.ArkUI.ArkUI.Full 2454 * @crossplatform 2455 * @since 10 2456 */ 2457 /** 2458 * Callback when the Pan gesture is moving. 2459 * 2460 * @param { function } event 2461 * @returns { PanGestureInterface } 2462 * @syscap SystemCapability.ArkUI.ArkUI.Full 2463 * @crossplatform 2464 * @atomicservice 2465 * @since 11 2466 */ 2467 onActionUpdate(event: (event: GestureEvent) => void): PanGestureInterface; 2468 2469 /** 2470 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2471 * 2472 * @param { function } event 2473 * @returns { PanGestureInterface } 2474 * @syscap SystemCapability.ArkUI.ArkUI.Full 2475 * @since 7 2476 */ 2477 /** 2478 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2479 * 2480 * @param { function } event 2481 * @returns { PanGestureInterface } 2482 * @syscap SystemCapability.ArkUI.ArkUI.Full 2483 * @crossplatform 2484 * @since 10 2485 */ 2486 /** 2487 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2488 * 2489 * @param { function } event 2490 * @returns { PanGestureInterface } 2491 * @syscap SystemCapability.ArkUI.ArkUI.Full 2492 * @crossplatform 2493 * @atomicservice 2494 * @since 11 2495 */ 2496 onActionEnd(event: (event: GestureEvent) => void): PanGestureInterface; 2497 2498 /** 2499 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2500 * 2501 * @param { function } event 2502 * @returns { PanGestureInterface } 2503 * @syscap SystemCapability.ArkUI.ArkUI.Full 2504 * @since 7 2505 */ 2506 /** 2507 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2508 * 2509 * @param { function } event 2510 * @returns { PanGestureInterface } 2511 * @syscap SystemCapability.ArkUI.ArkUI.Full 2512 * @crossplatform 2513 * @since 10 2514 */ 2515 /** 2516 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2517 * 2518 * @param { function } event 2519 * @returns { PanGestureInterface } 2520 * @syscap SystemCapability.ArkUI.ArkUI.Full 2521 * @crossplatform 2522 * @atomicservice 2523 * @since 11 2524 */ 2525 onActionCancel(event: () => void): PanGestureInterface; 2526 /** 2527 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2528 * 2529 * @param { function } event 2530 * @returns { PanGestureInterface } 2531 * @syscap SystemCapability.ArkUI.ArkUI.Full 2532 * @crossplatform 2533 * @atomicservice 2534 * @since 18 2535 */ 2536 onActionCancel(event: Callback<GestureEvent>): PanGestureInterface; 2537 2538} 2539 2540/** 2541 * Defines the SwipeGesture interface. 2542 * 2543 * @extends GestureInterface<SwipeGestureInterface> 2544 * @interface SwipeGestureInterface 2545 * @syscap SystemCapability.ArkUI.ArkUI.Full 2546 * @since 8 2547 */ 2548/** 2549 * Defines the SwipeGesture interface. 2550 * 2551 * @extends GestureInterface<SwipeGestureInterface> 2552 * @interface SwipeGestureInterface 2553 * @syscap SystemCapability.ArkUI.ArkUI.Full 2554 * @crossplatform 2555 * @since 10 2556 */ 2557/** 2558 * Defines SwipeGesture interface extends GestureInterface<SwipeGestureInterface>. 2559 * 2560 * @extends GestureInterface<SwipeGestureInterface> 2561 * @interface SwipeGestureInterface 2562 * @syscap SystemCapability.ArkUI.ArkUI.Full 2563 * @crossplatform 2564 * @atomicservice 2565 * @since 11 2566 */ 2567interface SwipeGestureInterface extends GestureInterface<SwipeGestureInterface> { 2568 /** 2569 * Set the value. 2570 * 2571 * @param { object } value 2572 * @returns { SwipeGestureInterface } 2573 * @syscap SystemCapability.ArkUI.ArkUI.Full 2574 * @since 8 2575 */ 2576 /** 2577 * Set the value. 2578 * 2579 * @param { object } value 2580 * @returns { SwipeGestureInterface } 2581 * @syscap SystemCapability.ArkUI.ArkUI.Full 2582 * @crossplatform 2583 * @since 10 2584 */ 2585 /** 2586 * Set the value. 2587 * 2588 * @param { object } value 2589 * @returns { SwipeGestureInterface } 2590 * @syscap SystemCapability.ArkUI.ArkUI.Full 2591 * @crossplatform 2592 * @atomicservice 2593 * @since 11 2594 */ 2595 (value?: { fingers?: number; direction?: SwipeDirection; speed?: number }): SwipeGestureInterface; 2596 2597 /** 2598 * Set the options. 2599 * options: The options of the swipe gesture. 2600 * 2601 * @param { SwipeGestureHandlerOptions } options 2602 * @returns { SwipeGestureInterface } 2603 * @syscap SystemCapability.ArkUI.ArkUI.Full 2604 * @crossplatform 2605 * @atomicservice 2606 * @since 15 2607 */ 2608 (options?: SwipeGestureHandlerOptions): SwipeGestureInterface; 2609 2610 /** 2611 * Slide gesture recognition success callback. 2612 * 2613 * @param { function } event 2614 * @returns { SwipeGestureInterface } 2615 * @syscap SystemCapability.ArkUI.ArkUI.Full 2616 * @since 8 2617 */ 2618 /** 2619 * Slide gesture recognition success callback. 2620 * 2621 * @param { function } event 2622 * @returns { SwipeGestureInterface } 2623 * @syscap SystemCapability.ArkUI.ArkUI.Full 2624 * @crossplatform 2625 * @since 10 2626 */ 2627 /** 2628 * Slide gesture recognition success callback. 2629 * 2630 * @param { function } event 2631 * @returns { SwipeGestureInterface } 2632 * @syscap SystemCapability.ArkUI.ArkUI.Full 2633 * @crossplatform 2634 * @atomicservice 2635 * @since 11 2636 */ 2637 onAction(event: (event: GestureEvent) => void): SwipeGestureInterface; 2638} 2639 2640/** 2641 * Defines the PinchGesture interface. 2642 * 2643 * @extends GestureInterface<PinchGestureInterface> 2644 * @interface PinchGestureInterface 2645 * @syscap SystemCapability.ArkUI.ArkUI.Full 2646 * @since 7 2647 */ 2648/** 2649 * Defines the PinchGesture interface. 2650 * 2651 * @extends GestureInterface<PinchGestureInterface> 2652 * @interface PinchGestureInterface 2653 * @syscap SystemCapability.ArkUI.ArkUI.Full 2654 * @crossplatform 2655 * @since 10 2656 */ 2657/** 2658 * Defines PinchGesture interface extends GestureInterface<PinchGestureInterface>. 2659 * 2660 * @extends GestureInterface<PinchGestureInterface> 2661 * @interface PinchGestureInterface 2662 * @syscap SystemCapability.ArkUI.ArkUI.Full 2663 * @crossplatform 2664 * @atomicservice 2665 * @since 11 2666 */ 2667interface PinchGestureInterface extends GestureInterface<PinchGestureInterface> { 2668 /** 2669 * Set the value. 2670 * 2671 * @param { object } value 2672 * @returns { PinchGestureInterface } 2673 * @syscap SystemCapability.ArkUI.ArkUI.Full 2674 * @since 7 2675 */ 2676 /** 2677 * Set the value. 2678 * 2679 * @param { object } value 2680 * @returns { PinchGestureInterface } 2681 * @syscap SystemCapability.ArkUI.ArkUI.Full 2682 * @crossplatform 2683 * @since 10 2684 */ 2685 /** 2686 * Set the value. 2687 * 2688 * @param { object } value 2689 * @returns { PinchGestureInterface } 2690 * @syscap SystemCapability.ArkUI.ArkUI.Full 2691 * @crossplatform 2692 * @atomicservice 2693 * @since 11 2694 */ 2695 (value?: { fingers?: number; distance?: number }): PinchGestureInterface; 2696 2697 /** 2698 * Set the options. 2699 * options: The options of the pinch gesture. 2700 * 2701 * @param { PinchGestureHandlerOptions } options 2702 * @returns { PinchGestureInterface } 2703 * @syscap SystemCapability.ArkUI.ArkUI.Full 2704 * @crossplatform 2705 * @atomicservice 2706 * @since 15 2707 */ 2708 (options?: PinchGestureHandlerOptions): PinchGestureInterface; 2709 2710 /** 2711 * Pan gesture recognition success callback. 2712 * 2713 * @param { function } event 2714 * @returns { PinchGestureInterface } 2715 * @syscap SystemCapability.ArkUI.ArkUI.Full 2716 * @since 7 2717 */ 2718 /** 2719 * Pan gesture recognition success callback. 2720 * 2721 * @param { function } event 2722 * @returns { PinchGestureInterface } 2723 * @syscap SystemCapability.ArkUI.ArkUI.Full 2724 * @crossplatform 2725 * @since 10 2726 */ 2727 /** 2728 * Pan gesture recognition success callback. 2729 * 2730 * @param { function } event 2731 * @returns { PinchGestureInterface } 2732 * @syscap SystemCapability.ArkUI.ArkUI.Full 2733 * @crossplatform 2734 * @atomicservice 2735 * @since 11 2736 */ 2737 onActionStart(event: (event: GestureEvent) => void): PinchGestureInterface; 2738 2739 /** 2740 * Callback when the Pan gesture is moving. 2741 * 2742 * @param { function } event 2743 * @returns { PinchGestureInterface } 2744 * @syscap SystemCapability.ArkUI.ArkUI.Full 2745 * @since 7 2746 */ 2747 /** 2748 * Callback when the Pan gesture is moving. 2749 * 2750 * @param { function } event 2751 * @returns { PinchGestureInterface } 2752 * @syscap SystemCapability.ArkUI.ArkUI.Full 2753 * @crossplatform 2754 * @since 10 2755 */ 2756 /** 2757 * Callback when the Pan gesture is moving. 2758 * 2759 * @param { function } event 2760 * @returns { PinchGestureInterface } 2761 * @syscap SystemCapability.ArkUI.ArkUI.Full 2762 * @crossplatform 2763 * @atomicservice 2764 * @since 11 2765 */ 2766 onActionUpdate(event: (event: GestureEvent) => void): PinchGestureInterface; 2767 2768 /** 2769 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2770 * 2771 * @param { function } event 2772 * @returns { PinchGestureInterface } 2773 * @syscap SystemCapability.ArkUI.ArkUI.Full 2774 * @since 7 2775 */ 2776 /** 2777 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2778 * 2779 * @param { function } event 2780 * @returns { PinchGestureInterface } 2781 * @syscap SystemCapability.ArkUI.ArkUI.Full 2782 * @crossplatform 2783 * @since 10 2784 */ 2785 /** 2786 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2787 * 2788 * @param { function } event 2789 * @returns { PinchGestureInterface } 2790 * @syscap SystemCapability.ArkUI.ArkUI.Full 2791 * @crossplatform 2792 * @atomicservice 2793 * @since 11 2794 */ 2795 onActionEnd(event: (event: GestureEvent) => void): PinchGestureInterface; 2796 2797 /** 2798 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2799 * 2800 * @param { function } event 2801 * @returns { PinchGestureInterface } 2802 * @syscap SystemCapability.ArkUI.ArkUI.Full 2803 * @since 7 2804 */ 2805 /** 2806 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2807 * 2808 * @param { function } event 2809 * @returns { PinchGestureInterface } 2810 * @syscap SystemCapability.ArkUI.ArkUI.Full 2811 * @crossplatform 2812 * @since 10 2813 */ 2814 /** 2815 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2816 * 2817 * @param { function } event 2818 * @returns { PinchGestureInterface } 2819 * @syscap SystemCapability.ArkUI.ArkUI.Full 2820 * @crossplatform 2821 * @atomicservice 2822 * @since 11 2823 */ 2824 onActionCancel(event: () => void): PinchGestureInterface; 2825 /** 2826 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2827 * 2828 * @param { function } event 2829 * @returns { PinchGestureInterface } 2830 * @syscap SystemCapability.ArkUI.ArkUI.Full 2831 * @crossplatform 2832 * @atomicservice 2833 * @since 18 2834 */ 2835 onActionCancel(event: Callback<GestureEvent>): PinchGestureInterface; 2836} 2837 2838/** 2839 * Defines the RotationGesture interface. 2840 * 2841 * @extends GestureInterface<RotationGestureInterface> 2842 * @interface RotationGestureInterface 2843 * @syscap SystemCapability.ArkUI.ArkUI.Full 2844 * @since 7 2845 */ 2846/** 2847 * Defines the RotationGesture interface. 2848 * 2849 * @extends GestureInterface<RotationGestureInterface> 2850 * @interface RotationGestureInterface 2851 * @syscap SystemCapability.ArkUI.ArkUI.Full 2852 * @crossplatform 2853 * @since 10 2854 */ 2855/** 2856 * Defines RotationGesture interface extends GestureInterface<RotationGestureInterface>. 2857 * 2858 * @extends GestureInterface<RotationGestureInterface> 2859 * @interface RotationGestureInterface 2860 * @syscap SystemCapability.ArkUI.ArkUI.Full 2861 * @crossplatform 2862 * @atomicservice 2863 * @since 11 2864 */ 2865interface RotationGestureInterface extends GestureInterface<RotationGestureInterface> { 2866 /** 2867 * Set the value. 2868 * 2869 * @param { object } value 2870 * @returns { RotationGestureInterface } 2871 * @syscap SystemCapability.ArkUI.ArkUI.Full 2872 * @since 7 2873 */ 2874 /** 2875 * Set the value. 2876 * 2877 * @param { object } value 2878 * @returns { RotationGestureInterface } 2879 * @syscap SystemCapability.ArkUI.ArkUI.Full 2880 * @crossplatform 2881 * @since 10 2882 */ 2883 /** 2884 * Set the value. 2885 * 2886 * @param { object } value 2887 * @returns { RotationGestureInterface } 2888 * @syscap SystemCapability.ArkUI.ArkUI.Full 2889 * @crossplatform 2890 * @atomicservice 2891 * @since 11 2892 */ 2893 (value?: { fingers?: number; angle?: number }): RotationGestureInterface; 2894 2895 /** 2896 * Set the options. 2897 * options: The options of the rotation gesture. 2898 * 2899 * @param { RotationGestureHandlerOptions } options 2900 * @returns { RotationGestureInterface } 2901 * @syscap SystemCapability.ArkUI.ArkUI.Full 2902 * @crossplatform 2903 * @atomicservice 2904 * @since 15 2905 */ 2906 (options?: RotationGestureHandlerOptions): RotationGestureInterface; 2907 2908 /** 2909 * Pan gesture recognition success callback. 2910 * 2911 * @param { function } event 2912 * @returns { RotationGestureInterface } 2913 * @syscap SystemCapability.ArkUI.ArkUI.Full 2914 * @since 7 2915 */ 2916 /** 2917 * Pan gesture recognition success callback. 2918 * 2919 * @param { function } event 2920 * @returns { RotationGestureInterface } 2921 * @syscap SystemCapability.ArkUI.ArkUI.Full 2922 * @crossplatform 2923 * @since 10 2924 */ 2925 /** 2926 * Pan gesture recognition success callback. 2927 * 2928 * @param { function } event 2929 * @returns { RotationGestureInterface } 2930 * @syscap SystemCapability.ArkUI.ArkUI.Full 2931 * @crossplatform 2932 * @atomicservice 2933 * @since 11 2934 */ 2935 onActionStart(event: (event: GestureEvent) => void): RotationGestureInterface; 2936 2937 /** 2938 * Callback when the Pan gesture is moving. 2939 * 2940 * @param { function } event 2941 * @returns { RotationGestureInterface } 2942 * @syscap SystemCapability.ArkUI.ArkUI.Full 2943 * @since 7 2944 */ 2945 /** 2946 * Callback when the Pan gesture is moving. 2947 * 2948 * @param { function } event 2949 * @returns { RotationGestureInterface } 2950 * @syscap SystemCapability.ArkUI.ArkUI.Full 2951 * @crossplatform 2952 * @since 10 2953 */ 2954 /** 2955 * Callback when the Pan gesture is moving. 2956 * 2957 * @param { function } event 2958 * @returns { RotationGestureInterface } 2959 * @syscap SystemCapability.ArkUI.ArkUI.Full 2960 * @crossplatform 2961 * @atomicservice 2962 * @since 11 2963 */ 2964 onActionUpdate(event: (event: GestureEvent) => void): RotationGestureInterface; 2965 2966 /** 2967 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2968 * 2969 * @param { function } event 2970 * @returns { RotationGestureInterface } 2971 * @syscap SystemCapability.ArkUI.ArkUI.Full 2972 * @since 7 2973 */ 2974 /** 2975 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2976 * 2977 * @param { function } event 2978 * @returns { RotationGestureInterface } 2979 * @syscap SystemCapability.ArkUI.ArkUI.Full 2980 * @crossplatform 2981 * @since 10 2982 */ 2983 /** 2984 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2985 * 2986 * @param { function } event 2987 * @returns { RotationGestureInterface } 2988 * @syscap SystemCapability.ArkUI.ArkUI.Full 2989 * @crossplatform 2990 * @atomicservice 2991 * @since 11 2992 */ 2993 onActionEnd(event: (event: GestureEvent) => void): RotationGestureInterface; 2994 2995 /** 2996 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2997 * 2998 * @param { function } event 2999 * @returns { RotationGestureInterface } 3000 * @syscap SystemCapability.ArkUI.ArkUI.Full 3001 * @since 7 3002 */ 3003 /** 3004 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3005 * 3006 * @param { function } event 3007 * @returns { RotationGestureInterface } 3008 * @syscap SystemCapability.ArkUI.ArkUI.Full 3009 * @crossplatform 3010 * @since 10 3011 */ 3012 /** 3013 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3014 * 3015 * @param { function } event 3016 * @returns { RotationGestureInterface } 3017 * @syscap SystemCapability.ArkUI.ArkUI.Full 3018 * @crossplatform 3019 * @atomicservice 3020 * @since 11 3021 */ 3022 onActionCancel(event: () => void): RotationGestureInterface; 3023 /** 3024 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3025 * 3026 * @param { function } event 3027 * @returns { RotationGestureInterface } 3028 * @syscap SystemCapability.ArkUI.ArkUI.Full 3029 * @crossplatform 3030 * @atomicservice 3031 * @since 18 3032 */ 3033 onActionCancel(event: Callback<GestureEvent>): RotationGestureInterface; 3034} 3035 3036/** 3037 * Defines the GestureGroup interface. 3038 * 3039 * @interface GestureGroupInterface 3040 * @syscap SystemCapability.ArkUI.ArkUI.Full 3041 * @since 7 3042 */ 3043/** 3044 * Defines the GestureGroup interface. 3045 * 3046 * @interface GestureGroupInterface 3047 * @syscap SystemCapability.ArkUI.ArkUI.Full 3048 * @crossplatform 3049 * @since 10 3050 */ 3051/** 3052 * Defines the GestureGroup interface. 3053 * 3054 * @interface GestureGroupInterface 3055 * @syscap SystemCapability.ArkUI.ArkUI.Full 3056 * @crossplatform 3057 * @atomicservice 3058 * @since 11 3059 */ 3060interface GestureGroupInterface { 3061 /** 3062 * Return to Obtain GestureGroup. 3063 * 3064 * @param { GestureMode } mode 3065 * @param { GestureType[] } gesture 3066 * @returns { GestureGroupInterface } 3067 * @syscap SystemCapability.ArkUI.ArkUI.Full 3068 * @since 7 3069 */ 3070 /** 3071 * Return to Obtain GestureGroup. 3072 * 3073 * @param { GestureMode } mode 3074 * @param { GestureType[] } gesture 3075 * @returns { GestureGroupInterface } 3076 * @syscap SystemCapability.ArkUI.ArkUI.Full 3077 * @crossplatform 3078 * @since 10 3079 */ 3080 /** 3081 * Return to Obtain GestureGroup. 3082 * 3083 * @param { GestureMode } mode 3084 * @param { GestureType[] } gesture 3085 * @returns { GestureGroupInterface } 3086 * @syscap SystemCapability.ArkUI.ArkUI.Full 3087 * @crossplatform 3088 * @atomicservice 3089 * @since 11 3090 */ 3091 (mode: GestureMode, ...gesture: GestureType[]): GestureGroupInterface; 3092 3093 /** 3094 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3095 * 3096 * @param { function } event 3097 * @returns { GestureGroupInterface } 3098 * @syscap SystemCapability.ArkUI.ArkUI.Full 3099 * @since 7 3100 */ 3101 /** 3102 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3103 * 3104 * @param { function } event 3105 * @returns { GestureGroupInterface } 3106 * @syscap SystemCapability.ArkUI.ArkUI.Full 3107 * @crossplatform 3108 * @since 10 3109 */ 3110 /** 3111 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3112 * 3113 * @param { function } event 3114 * @returns { GestureGroupInterface } 3115 * @syscap SystemCapability.ArkUI.ArkUI.Full 3116 * @crossplatform 3117 * @atomicservice 3118 * @since 11 3119 */ 3120 onCancel(event: () => void): GestureGroupInterface; 3121} 3122 3123/** 3124 * Defines TapGesture Component. 3125 * 3126 * @syscap SystemCapability.ArkUI.ArkUI.Full 3127 * @since 7 3128 */ 3129/** 3130 * Defines TapGesture Component. 3131 * 3132 * @syscap SystemCapability.ArkUI.ArkUI.Full 3133 * @crossplatform 3134 * @since 10 3135 */ 3136/** 3137 * Defines TapGesture Component. 3138 * 3139 * @syscap SystemCapability.ArkUI.ArkUI.Full 3140 * @crossplatform 3141 * @atomicservice 3142 * @since 11 3143 */ 3144declare const TapGesture: TapGestureInterface; 3145 3146/** 3147 * Defines LongPressGesture Component. 3148 * 3149 * @syscap SystemCapability.ArkUI.ArkUI.Full 3150 * @since 7 3151 */ 3152/** 3153 * Defines LongPressGesture Component. 3154 * 3155 * @syscap SystemCapability.ArkUI.ArkUI.Full 3156 * @crossplatform 3157 * @since 10 3158 */ 3159/** 3160 * Defines LongPressGesture Component. 3161 * 3162 * @syscap SystemCapability.ArkUI.ArkUI.Full 3163 * @crossplatform 3164 * @atomicservice 3165 * @since 11 3166 */ 3167declare const LongPressGesture: LongPressGestureInterface; 3168 3169/** 3170 * Defines PanGesture Component. 3171 * 3172 * @syscap SystemCapability.ArkUI.ArkUI.Full 3173 * @since 7 3174 */ 3175/** 3176 * Defines PanGesture Component. 3177 * 3178 * @syscap SystemCapability.ArkUI.ArkUI.Full 3179 * @crossplatform 3180 * @since 10 3181 */ 3182/** 3183 * Defines PanGesture Component. 3184 * 3185 * @syscap SystemCapability.ArkUI.ArkUI.Full 3186 * @crossplatform 3187 * @atomicservice 3188 * @since 11 3189 */ 3190declare const PanGesture: PanGestureInterface; 3191 3192/** 3193 * Defines SwipeGesture Component. 3194 * 3195 * @syscap SystemCapability.ArkUI.ArkUI.Full 3196 * @since 7 3197 */ 3198/** 3199 * Defines SwipeGesture Component. 3200 * 3201 * @syscap SystemCapability.ArkUI.ArkUI.Full 3202 * @crossplatform 3203 * @since 10 3204 */ 3205/** 3206 * Defines SwipeGesture Component. 3207 * 3208 * @syscap SystemCapability.ArkUI.ArkUI.Full 3209 * @crossplatform 3210 * @atomicservice 3211 * @since 11 3212 */ 3213declare const SwipeGesture: SwipeGestureInterface; 3214 3215/** 3216 * Defines PinchGesture Component. 3217 * 3218 * @syscap SystemCapability.ArkUI.ArkUI.Full 3219 * @since 7 3220 */ 3221/** 3222 * Defines PinchGesture Component. 3223 * 3224 * @syscap SystemCapability.ArkUI.ArkUI.Full 3225 * @crossplatform 3226 * @since 10 3227 */ 3228/** 3229 * Defines PinchGesture Component. 3230 * 3231 * @syscap SystemCapability.ArkUI.ArkUI.Full 3232 * @crossplatform 3233 * @atomicservice 3234 * @since 11 3235 */ 3236declare const PinchGesture: PinchGestureInterface; 3237 3238/** 3239 * Defines RotationGesture Component. 3240 * 3241 * @syscap SystemCapability.ArkUI.ArkUI.Full 3242 * @since 7 3243 */ 3244/** 3245 * Defines RotationGesture Component. 3246 * 3247 * @syscap SystemCapability.ArkUI.ArkUI.Full 3248 * @crossplatform 3249 * @since 10 3250 */ 3251/** 3252 * Defines RotationGesture Component. 3253 * 3254 * @syscap SystemCapability.ArkUI.ArkUI.Full 3255 * @crossplatform 3256 * @atomicservice 3257 * @since 11 3258 */ 3259declare const RotationGesture: RotationGestureInterface; 3260 3261/** 3262 * Defines GestureGroup Component. 3263 * 3264 * @syscap SystemCapability.ArkUI.ArkUI.Full 3265 * @since 7 3266 */ 3267/** 3268 * Defines GestureGroup Component. 3269 * 3270 * @syscap SystemCapability.ArkUI.ArkUI.Full 3271 * @crossplatform 3272 * @since 10 3273 */ 3274/** 3275 * Defines GestureGroup Component. 3276 * 3277 * @syscap SystemCapability.ArkUI.ArkUI.Full 3278 * @crossplatform 3279 * @atomicservice 3280 * @since 11 3281 */ 3282declare const GestureGroup: GestureGroupInterface; 3283 3284/** 3285 * Defines the gesture handler. 3286 * 3287 * @implements GestureInterface<T> 3288 * @syscap SystemCapability.ArkUI.ArkUI.Full 3289 * @crossplatform 3290 * @atomicservice 3291 * @since 12 3292 */ 3293declare class GestureHandler<T> implements GestureInterface<T> { 3294 /** 3295 * Set the GestureHandler's tag. 3296 * 3297 * @param { string } tag 3298 * @returns { T } 3299 * @syscap SystemCapability.ArkUI.ArkUI.Full 3300 * @crossplatform 3301 * @atomicservice 3302 * @since 12 3303 */ 3304 tag(tag: string): T; 3305 3306 /** 3307 * Input source type for gesture response. 3308 * 3309 * @param { Array<SourceTool> } types - indicate the allowed input source for gesture to response 3310 * @returns { T } 3311 * @syscap SystemCapability.ArkUI.ArkUI.Full 3312 * @crossplatform 3313 * @atomicservice 3314 * @since 14 3315 */ 3316 allowedTypes(types: Array<SourceTool>): T; 3317} 3318 3319/** 3320 * Defines the TapGestureHandler options. 3321 * 3322 * @interface TapGestureHandlerOptions 3323 * @syscap SystemCapability.ArkUI.ArkUI.Full 3324 * @crossplatform 3325 * @atomicservice 3326 * @since 12 3327 */ 3328/** 3329 * Defines the TapGestureHandler options. 3330 * 3331 * @extends BaseHandlerOptions 3332 * @interface TapGestureHandlerOptions 3333 * @syscap SystemCapability.ArkUI.ArkUI.Full 3334 * @crossplatform 3335 * @atomicservice 3336 * @since 15 3337 */ 3338interface TapGestureHandlerOptions extends BaseHandlerOptions { 3339 /** 3340 * Indicates the number of consecutive clicks recognized. If the value is less than 1, the default value is used. 3341 * The default value is 1. 3342 * 3343 * @type { ?number } 3344 * @syscap SystemCapability.ArkUI.ArkUI.Full 3345 * @crossplatform 3346 * @atomicservice 3347 * @since 12 3348 */ 3349 count?: number; 3350 /** 3351 * Indicates the hand index that triggers the click. If the value is less than 1, the default value is used. 3352 * The default value is 1. 3353 * 3354 * @type { ?number } 3355 * @syscap SystemCapability.ArkUI.ArkUI.Full 3356 * @crossplatform 3357 * @atomicservice 3358 * @since 12 3359 */ 3360 fingers?: number; 3361} 3362 3363/** 3364 * Defines the TapGesture handler. 3365 * 3366 * @extends GestureHandler<TapGestureHandler> 3367 * @syscap SystemCapability.ArkUI.ArkUI.Full 3368 * @crossplatform 3369 * @atomicservice 3370 * @since 12 3371 */ 3372declare class TapGestureHandler extends GestureHandler<TapGestureHandler> { 3373 /** 3374 * Constructor parameters. 3375 * 3376 * @param { TapGestureHandlerOptions } options 3377 * @syscap SystemCapability.ArkUI.ArkUI.Full 3378 * @crossplatform 3379 * @atomicservice 3380 * @since 12 3381 */ 3382 constructor(options?: TapGestureHandlerOptions); 3383 /** 3384 * Tap gesture recognition success callback. 3385 * 3386 * @param { Callback<GestureEvent> } event 3387 * @returns { TapGestureHandler } 3388 * @syscap SystemCapability.ArkUI.ArkUI.Full 3389 * @crossplatform 3390 * @atomicservice 3391 * @since 12 3392 */ 3393 onAction(event: Callback<GestureEvent>): TapGestureHandler; 3394} 3395 3396/** 3397 * Defines the LongPressGestureHandler options. 3398 * 3399 * @interface LongPressGestureHandlerOptions 3400 * @syscap SystemCapability.ArkUI.ArkUI.Full 3401 * @crossplatform 3402 * @atomicservice 3403 * @since 12 3404 */ 3405/** 3406 * Defines the LongPressGestureHandler options. 3407 * 3408 * @extends BaseHandlerOptions 3409 * @interface LongPressGestureHandlerOptions 3410 * @syscap SystemCapability.ArkUI.ArkUI.Full 3411 * @crossplatform 3412 * @atomicservice 3413 * @since 15 3414 */ 3415interface LongPressGestureHandlerOptions extends BaseHandlerOptions { 3416 /** 3417 * Indicates the hand index that triggers the long press. If the value is less than 1, the default value is used. 3418 * The default value is 1. 3419 * 3420 * @type { ?number } 3421 * @syscap SystemCapability.ArkUI.ArkUI.Full 3422 * @crossplatform 3423 * @atomicservice 3424 * @since 12 3425 */ 3426 fingers?: number; 3427 /** 3428 * Indicates whether an event is triggered repeatedly. 3429 * The default value is false. 3430 * 3431 * @type { ?boolean } 3432 * @syscap SystemCapability.ArkUI.ArkUI.Full 3433 * @crossplatform 3434 * @atomicservice 3435 * @since 12 3436 */ 3437 repeat?: boolean; 3438 /** 3439 * Indicates minimum press and hold time, in milliseconds. 3440 * The default value is 500ms. 3441 * 3442 * @type { ?number } 3443 * @syscap SystemCapability.ArkUI.ArkUI.Full 3444 * @crossplatform 3445 * @atomicservice 3446 * @since 12 3447 */ 3448 duration?: number; 3449} 3450 3451/** 3452 * Defines the LongPressGesture handler. 3453 * 3454 * @extends GestureHandler<LongPressGestureHandler> 3455 * @syscap SystemCapability.ArkUI.ArkUI.Full 3456 * @crossplatform 3457 * @atomicservice 3458 * @since 12 3459 */ 3460declare class LongPressGestureHandler extends GestureHandler<LongPressGestureHandler> { 3461 /** 3462 * Constructor parameters. 3463 * 3464 * @param { LongPressGestureHandlerOptions } options 3465 * @syscap SystemCapability.ArkUI.ArkUI.Full 3466 * @crossplatform 3467 * @atomicservice 3468 * @since 12 3469 */ 3470 constructor(options?: LongPressGestureHandlerOptions); 3471 /** 3472 * LongPress gesture recognition success callback. 3473 * 3474 * @param { Callback<GestureEvent> } event 3475 * @returns { LongPressGestureHandler } 3476 * @syscap SystemCapability.ArkUI.ArkUI.Full 3477 * @crossplatform 3478 * @atomicservice 3479 * @since 12 3480 */ 3481 onAction(event: Callback<GestureEvent>): LongPressGestureHandler; 3482 /** 3483 * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3484 * 3485 * @param { Callback<GestureEvent> } event 3486 * @returns { LongPressGestureHandler } 3487 * @syscap SystemCapability.ArkUI.ArkUI.Full 3488 * @crossplatform 3489 * @atomicservice 3490 * @since 12 3491 */ 3492 onActionEnd(event: Callback<GestureEvent>): LongPressGestureHandler; 3493 /** 3494 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3495 * 3496 * @param { Callback<void> } event 3497 * @returns { LongPressGestureHandler } 3498 * @syscap SystemCapability.ArkUI.ArkUI.Full 3499 * @crossplatform 3500 * @atomicservice 3501 * @since 12 3502 */ 3503 onActionCancel(event: Callback<void>): LongPressGestureHandler; 3504 /** 3505 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3506 * Add GestureEvent in cancel callback. 3507 * 3508 * @param { Callback<GestureEvent> } event 3509 * @returns { LongPressGestureHandler } 3510 * @syscap SystemCapability.ArkUI.ArkUI.Full 3511 * @crossplatform 3512 * @atomicservice 3513 * @since 18 3514 */ 3515 onActionCancel(event: Callback<GestureEvent>): LongPressGestureHandler; 3516} 3517 3518/** 3519 * Defines the PanGestureHandler options. 3520 * 3521 * @interface PanGestureHandlerOptions 3522 * @syscap SystemCapability.ArkUI.ArkUI.Full 3523 * @crossplatform 3524 * @atomicservice 3525 * @since 12 3526 */ 3527/** 3528 * Defines the PanGestureHandler options. 3529 * 3530 * @extends BaseHandlerOptions 3531 * @interface PanGestureHandlerOptions 3532 * @syscap SystemCapability.ArkUI.ArkUI.Full 3533 * @crossplatform 3534 * @atomicservice 3535 * @since 15 3536 */ 3537interface PanGestureHandlerOptions extends BaseHandlerOptions { 3538 /** 3539 * Indicates the hand index that triggers the pan. If the value is less than 1, the default value is used. 3540 * The default value is 1. 3541 * 3542 * @type { ?number } 3543 * @syscap SystemCapability.ArkUI.ArkUI.Full 3544 * @crossplatform 3545 * @atomicservice 3546 * @since 12 3547 */ 3548 fingers?: number; 3549 /** 3550 * Indicates the move direction of the pan gesture. 3551 * The default value is PanDirection.All. 3552 * 3553 * @type { ?PanDirection } 3554 * @syscap SystemCapability.ArkUI.ArkUI.Full 3555 * @crossplatform 3556 * @atomicservice 3557 * @since 12 3558 */ 3559 direction?: PanDirection; 3560 /** 3561 * Indicates minimum move distance. 3562 * The default value is 5vp. 3563 * 3564 * @type { ?number } 3565 * @syscap SystemCapability.ArkUI.ArkUI.Full 3566 * @crossplatform 3567 * @atomicservice 3568 * @since 12 3569 */ 3570 distance?: number; 3571} 3572 3573/** 3574 * Defines the PanGesture handler. 3575 * 3576 * @extends GestureHandler<PanGestureHandler> 3577 * @syscap SystemCapability.ArkUI.ArkUI.Full 3578 * @crossplatform 3579 * @atomicservice 3580 * @since 12 3581 */ 3582declare class PanGestureHandler extends GestureHandler<PanGestureHandler> { 3583 /** 3584 * Constructor parameters. 3585 * 3586 * @param { PanGestureHandlerOptions } options 3587 * @syscap SystemCapability.ArkUI.ArkUI.Full 3588 * @crossplatform 3589 * @atomicservice 3590 * @since 12 3591 */ 3592 constructor(options?: PanGestureHandlerOptions); 3593 /** 3594 * Pan gesture recognition success callback. 3595 * 3596 * @param { Callback<GestureEvent> } event 3597 * @returns { PanGestureHandler } 3598 * @syscap SystemCapability.ArkUI.ArkUI.Full 3599 * @crossplatform 3600 * @atomicservice 3601 * @since 12 3602 */ 3603 onActionStart(event: Callback<GestureEvent>): PanGestureHandler; 3604 /** 3605 * Callback when the Pan gesture is moving. 3606 * 3607 * @param { Callback<GestureEvent> } event 3608 * @returns { PanGestureHandler } 3609 * @syscap SystemCapability.ArkUI.ArkUI.Full 3610 * @crossplatform 3611 * @atomicservice 3612 * @since 12 3613 */ 3614 onActionUpdate(event: Callback<GestureEvent>): PanGestureHandler; 3615 /** 3616 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3617 * 3618 * @param { Callback<GestureEvent> } event 3619 * @returns { PanGestureHandler } 3620 * @syscap SystemCapability.ArkUI.ArkUI.Full 3621 * @crossplatform 3622 * @atomicservice 3623 * @since 12 3624 */ 3625 onActionEnd(event: Callback<GestureEvent>): PanGestureHandler; 3626 /** 3627 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3628 * 3629 * @param { Callback<void> } event 3630 * @returns { PanGestureHandler } 3631 * @syscap SystemCapability.ArkUI.ArkUI.Full 3632 * @crossplatform 3633 * @atomicservice 3634 * @since 12 3635 */ 3636 onActionCancel(event: Callback<void>): PanGestureHandler; 3637 /** 3638 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3639 * Add GestureEvent in cancel callback. 3640 * 3641 * @param { Callback<GestureEvent> } event 3642 * @returns { PanGestureHandler } 3643 * @syscap SystemCapability.ArkUI.ArkUI.Full 3644 * @crossplatform 3645 * @atomicservice 3646 * @since 18 3647 */ 3648 onActionCancel(event: Callback<GestureEvent>): PanGestureHandler; 3649} 3650 3651/** 3652 * Defines the SwipeGestureHandler options. 3653 * 3654 * @interface SwipeGestureHandlerOptions 3655 * @syscap SystemCapability.ArkUI.ArkUI.Full 3656 * @crossplatform 3657 * @atomicservice 3658 * @since 12 3659 */ 3660/** 3661 * Defines the SwipeGestureHandler options. 3662 * 3663 * @extends BaseHandlerOptions 3664 * @interface SwipeGestureHandlerOptions 3665 * @syscap SystemCapability.ArkUI.ArkUI.Full 3666 * @crossplatform 3667 * @atomicservice 3668 * @since 15 3669 */ 3670interface SwipeGestureHandlerOptions extends BaseHandlerOptions { 3671 /** 3672 * Indicates the hand index that triggers the swipe. If the value is less than 1, the default value is used. 3673 * The default value is 1. 3674 * 3675 * @type { ?number } 3676 * @syscap SystemCapability.ArkUI.ArkUI.Full 3677 * @crossplatform 3678 * @atomicservice 3679 * @since 12 3680 */ 3681 fingers?: number; 3682 /** 3683 * Indicates the move direction of the swipe gesture. 3684 * The default value is SwipeDirection.All. 3685 * 3686 * @type { ?SwipeDirection } 3687 * @syscap SystemCapability.ArkUI.ArkUI.Full 3688 * @crossplatform 3689 * @atomicservice 3690 * @since 12 3691 */ 3692 direction?: SwipeDirection; 3693 /** 3694 * Indicates minimum move speed. 3695 * The default value is 100vp/s. 3696 * 3697 * @type { ?number } 3698 * @syscap SystemCapability.ArkUI.ArkUI.Full 3699 * @crossplatform 3700 * @atomicservice 3701 * @since 12 3702 */ 3703 speed?: number; 3704} 3705 3706/** 3707 * Defines the SwipeGesture handler. 3708 * 3709 * @extends GestureHandler<SwipeGestureHandler> 3710 * @syscap SystemCapability.ArkUI.ArkUI.Full 3711 * @crossplatform 3712 * @atomicservice 3713 * @since 12 3714 */ 3715declare class SwipeGestureHandler extends GestureHandler<SwipeGestureHandler> { 3716 /** 3717 * Constructor parameters. 3718 * 3719 * @param { SwipeGestureHandlerOptions } options 3720 * @syscap SystemCapability.ArkUI.ArkUI.Full 3721 * @crossplatform 3722 * @atomicservice 3723 * @since 12 3724 */ 3725 constructor(options?: SwipeGestureHandlerOptions); 3726 /** 3727 * Swipe gesture recognition success callback. 3728 * 3729 * @param { Callback<GestureEvent> } event 3730 * @returns { SwipeGestureHandler } 3731 * @syscap SystemCapability.ArkUI.ArkUI.Full 3732 * @crossplatform 3733 * @atomicservice 3734 * @since 12 3735 */ 3736 onAction(event: Callback<GestureEvent>): SwipeGestureHandler; 3737} 3738 3739/** 3740 * Defines the PinchGestureHandler options. 3741 * 3742 * @interface PinchGestureHandlerOptions 3743 * @syscap SystemCapability.ArkUI.ArkUI.Full 3744 * @crossplatform 3745 * @atomicservice 3746 * @since 12 3747 */ 3748/** 3749 * Defines the PinchGestureHandler options. 3750 * 3751 * @extends BaseHandlerOptions 3752 * @interface PinchGestureHandlerOptions 3753 * @syscap SystemCapability.ArkUI.ArkUI.Full 3754 * @crossplatform 3755 * @atomicservice 3756 * @since 15 3757 */ 3758interface PinchGestureHandlerOptions extends BaseHandlerOptions { 3759 /** 3760 * Indicates the hand index that triggers the pinch. If the value is less than 1, the default value is used. 3761 * The default value is 1. 3762 * 3763 * @type { ?number } 3764 * @syscap SystemCapability.ArkUI.ArkUI.Full 3765 * @crossplatform 3766 * @atomicservice 3767 * @since 12 3768 */ 3769 fingers?: number; 3770 /** 3771 * Indicates minimum pinch move distance. 3772 * The default value is 5vp. 3773 * 3774 * @type { ?number } 3775 * @syscap SystemCapability.ArkUI.ArkUI.Full 3776 * @crossplatform 3777 * @atomicservice 3778 * @since 12 3779 */ 3780 distance?: number; 3781} 3782 3783/** 3784 * Defines the PinchGesture handler. 3785 * 3786 * @extends GestureHandler<PinchGestureHandler> 3787 * @syscap SystemCapability.ArkUI.ArkUI.Full 3788 * @crossplatform 3789 * @atomicservice 3790 * @since 12 3791 */ 3792declare class PinchGestureHandler extends GestureHandler<PinchGestureHandler> { 3793 /** 3794 * Constructor parameters. 3795 * 3796 * @param { PinchGestureHandlerOptions } options 3797 * @syscap SystemCapability.ArkUI.ArkUI.Full 3798 * @crossplatform 3799 * @atomicservice 3800 * @since 12 3801 */ 3802 constructor(options?: PinchGestureHandlerOptions); 3803 /** 3804 * Pinch gesture recognition success callback. 3805 * 3806 * @param { Callback<GestureEvent> } event 3807 * @returns { PinchGestureHandler } 3808 * @syscap SystemCapability.ArkUI.ArkUI.Full 3809 * @crossplatform 3810 * @atomicservice 3811 * @since 12 3812 */ 3813 onActionStart(event: Callback<GestureEvent>): PinchGestureHandler; 3814 /** 3815 * Callback when the Pinch gesture is moving. 3816 * 3817 * @param { Callback<GestureEvent> } event 3818 * @returns { PinchGestureHandler } 3819 * @syscap SystemCapability.ArkUI.ArkUI.Full 3820 * @crossplatform 3821 * @atomicservice 3822 * @since 12 3823 */ 3824 onActionUpdate(event: Callback<GestureEvent>): PinchGestureHandler; 3825 /** 3826 * The Pinch gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3827 * 3828 * @param { Callback<GestureEvent> } event 3829 * @returns { PinchGestureHandler } 3830 * @syscap SystemCapability.ArkUI.ArkUI.Full 3831 * @crossplatform 3832 * @atomicservice 3833 * @since 12 3834 */ 3835 onActionEnd(event: Callback<GestureEvent>): PinchGestureHandler; 3836 /** 3837 * The Pinch gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3838 * 3839 * @param { Callback<void> } event 3840 * @returns { PinchGestureHandler } 3841 * @syscap SystemCapability.ArkUI.ArkUI.Full 3842 * @crossplatform 3843 * @atomicservice 3844 * @since 12 3845 */ 3846 onActionCancel(event: Callback<void>): PinchGestureHandler; 3847 /** 3848 * The Pinch gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3849 * Add GestureEvent in cancel callback. 3850 * 3851 * @param { Callback<GestureEvent> } event 3852 * @returns { PinchGestureHandler } 3853 * @syscap SystemCapability.ArkUI.ArkUI.Full 3854 * @crossplatform 3855 * @atomicservice 3856 * @since 18 3857 */ 3858 onActionCancel(event: Callback<GestureEvent>): PinchGestureHandler; 3859} 3860 3861/** 3862 * Defines the RotationGestureHandler options. 3863 * 3864 * @interface RotationGestureHandlerOptions 3865 * @syscap SystemCapability.ArkUI.ArkUI.Full 3866 * @crossplatform 3867 * @atomicservice 3868 * @since 12 3869 */ 3870/** 3871 * Defines the RotationGestureHandler options. 3872 * 3873 * @extends BaseHandlerOptions 3874 * @interface RotationGestureHandlerOptions 3875 * @syscap SystemCapability.ArkUI.ArkUI.Full 3876 * @crossplatform 3877 * @atomicservice 3878 * @since 15 3879 */ 3880interface RotationGestureHandlerOptions extends BaseHandlerOptions { 3881 /** 3882 * Indicates the hand index that triggers the rotation. If the value is less than 1, the default value is used. 3883 * The default value is 1. 3884 * 3885 * @type { ?number } 3886 * @syscap SystemCapability.ArkUI.ArkUI.Full 3887 * @crossplatform 3888 * @atomicservice 3889 * @since 12 3890 */ 3891 fingers?: number; 3892 /** 3893 * Indicates minimum rotate angle. 3894 * The default value is 1deg. 3895 * 3896 * @type { ?number } 3897 * @syscap SystemCapability.ArkUI.ArkUI.Full 3898 * @crossplatform 3899 * @atomicservice 3900 * @since 12 3901 */ 3902 angle?: number; 3903} 3904 3905/** 3906 * Defines the RotationGesture handler. 3907 * 3908 * @extends GestureHandler<RotationGestureHandler> 3909 * @syscap SystemCapability.ArkUI.ArkUI.Full 3910 * @crossplatform 3911 * @atomicservice 3912 * @since 12 3913 */ 3914declare class RotationGestureHandler extends GestureHandler<RotationGestureHandler> { 3915 /** 3916 * Constructor parameters. 3917 * 3918 * @param { RotationGestureHandlerOptions } options 3919 * @syscap SystemCapability.ArkUI.ArkUI.Full 3920 * @crossplatform 3921 * @atomicservice 3922 * @since 12 3923 */ 3924 constructor(options?: RotationGestureHandlerOptions); 3925 /** 3926 * Rotation gesture recognition success callback. 3927 * 3928 * @param { Callback<GestureEvent> } event 3929 * @returns { RotationGestureHandler } 3930 * @syscap SystemCapability.ArkUI.ArkUI.Full 3931 * @crossplatform 3932 * @atomicservice 3933 * @since 12 3934 */ 3935 onActionStart(event: Callback<GestureEvent>): RotationGestureHandler; 3936 /** 3937 * Callback when the Rotation gesture is moving. 3938 * 3939 * @param { Callback<GestureEvent> } event 3940 * @returns { RotationGestureHandler } 3941 * @syscap SystemCapability.ArkUI.ArkUI.Full 3942 * @crossplatform 3943 * @atomicservice 3944 * @since 12 3945 */ 3946 onActionUpdate(event: Callback<GestureEvent>): RotationGestureHandler; 3947 /** 3948 * The Rotation gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3949 * 3950 * @param { Callback<GestureEvent> } event 3951 * @returns { RotationGestureHandler } 3952 * @syscap SystemCapability.ArkUI.ArkUI.Full 3953 * @crossplatform 3954 * @atomicservice 3955 * @since 12 3956 */ 3957 onActionEnd(event: Callback<GestureEvent>): RotationGestureHandler; 3958 /** 3959 * The Rotation gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3960 * 3961 * @param { Callback<void> } event 3962 * @returns { RotationGestureHandler } 3963 * @syscap SystemCapability.ArkUI.ArkUI.Full 3964 * @crossplatform 3965 * @atomicservice 3966 * @since 12 3967 */ 3968 onActionCancel(event: Callback<void>): RotationGestureHandler; 3969 /** 3970 * The Rotation gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3971 * Add GestureEvent in cancel callback. 3972 * 3973 * @param { Callback<GestureEvent> } event 3974 * @returns { RotationGestureHandler } 3975 * @syscap SystemCapability.ArkUI.ArkUI.Full 3976 * @crossplatform 3977 * @atomicservice 3978 * @since 18 3979 */ 3980 onActionCancel(event: Callback<GestureEvent>): RotationGestureHandler; 3981} 3982 3983/** 3984 * Defines the GestureGroupGestureHandler options. 3985 * 3986 * @interface GestureGroupGestureHandlerOptions 3987 * @syscap SystemCapability.ArkUI.ArkUI.Full 3988 * @crossplatform 3989 * @atomicservice 3990 * @since 12 3991 */ 3992interface GestureGroupGestureHandlerOptions { 3993 /** 3994 * Indicates the mode of gesture group. 3995 * 3996 * @type { GestureMode } 3997 * @syscap SystemCapability.ArkUI.ArkUI.Full 3998 * @crossplatform 3999 * @atomicservice 4000 * @since 12 4001 */ 4002 mode: GestureMode; 4003 /** 4004 * Indicates the gestures included in the gesture group. 4005 * 4006 * @type { GestureHandler<TapGestureHandler | LongPressGestureHandler | PanGestureHandler | SwipeGestureHandler | PinchGestureHandler | RotationGestureHandler | GestureGroupHandler>[] } 4007 * @syscap SystemCapability.ArkUI.ArkUI.Full 4008 * @crossplatform 4009 * @atomicservice 4010 * @since 12 4011 */ 4012 gestures: GestureHandler<TapGestureHandler | LongPressGestureHandler | PanGestureHandler | SwipeGestureHandler | PinchGestureHandler | RotationGestureHandler | GestureGroupHandler>[]; 4013} 4014 4015/** 4016 * Defines the GestureGroup handler. 4017 * 4018 * @extends GestureHandler<GestureGroupHandler> 4019 * @syscap SystemCapability.ArkUI.ArkUI.Full 4020 * @crossplatform 4021 * @atomicservice 4022 * @since 12 4023 */ 4024declare class GestureGroupHandler extends GestureHandler<GestureGroupHandler> { 4025 /** 4026 * Constructor parameters. 4027 * 4028 * @param { GestureGroupGestureHandlerOptions } options 4029 * @syscap SystemCapability.ArkUI.ArkUI.Full 4030 * @crossplatform 4031 * @atomicservice 4032 * @since 12 4033 */ 4034 constructor(options?: GestureGroupGestureHandlerOptions); 4035 /** 4036 * The GestureGroup gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 4037 * 4038 * @param { Callback<void> } event 4039 * @returns { GestureGroupHandler } 4040 * @syscap SystemCapability.ArkUI.ArkUI.Full 4041 * @crossplatform 4042 * @atomicservice 4043 * @since 12 4044 */ 4045 onCancel(event: Callback<void>): GestureGroupHandler; 4046} 4047 4048/** 4049 * Creating an Object 4050 * 4051 * @enum { number } 4052 * @syscap SystemCapability.ArkUI.ArkUI.Full 4053 * @crossplatform 4054 * @atomicservice 4055 * @since 12 4056 */ 4057declare enum GesturePriority { 4058 /** 4059 * The normal gesture priority. 4060 * 4061 * @syscap SystemCapability.ArkUI.ArkUI.Full 4062 * @crossplatform 4063 * @atomicservice 4064 * @since 12 4065 */ 4066 NORMAL = 0, 4067 /** 4068 * The high gesture priority. 4069 * 4070 * @syscap SystemCapability.ArkUI.ArkUI.Full 4071 * @crossplatform 4072 * @atomicservice 4073 * @since 12 4074 */ 4075 PRIORITY = 1, 4076} 4077 4078/** 4079 * Creating an Object 4080 * 4081 * @enum { number } 4082 * @syscap SystemCapability.ArkUI.ArkUI.Full 4083 * @crossplatform 4084 * @atomicservice 4085 * @since 12 4086 */ 4087declare enum GestureRecognizerState { 4088 /** 4089 * Ready state. 4090 * 4091 * @syscap SystemCapability.ArkUI.ArkUI.Full 4092 * @crossplatform 4093 * @atomicservice 4094 * @since 12 4095 */ 4096 READY = 0, 4097 /** 4098 * Detecting state. 4099 * 4100 * @syscap SystemCapability.ArkUI.ArkUI.Full 4101 * @crossplatform 4102 * @atomicservice 4103 * @since 12 4104 */ 4105 DETECTING = 1, 4106 /** 4107 * Pending state. 4108 * 4109 * @syscap SystemCapability.ArkUI.ArkUI.Full 4110 * @crossplatform 4111 * @atomicservice 4112 * @since 12 4113 */ 4114 PENDING = 2, 4115 /** 4116 * Blocked state. 4117 * 4118 * @syscap SystemCapability.ArkUI.ArkUI.Full 4119 * @crossplatform 4120 * @atomicservice 4121 * @since 12 4122 */ 4123 BLOCKED = 3, 4124 /** 4125 * Successful state. 4126 * 4127 * @syscap SystemCapability.ArkUI.ArkUI.Full 4128 * @crossplatform 4129 * @atomicservice 4130 * @since 12 4131 */ 4132 SUCCESSFUL = 4, 4133 /** 4134 * Failed state. 4135 * 4136 * @syscap SystemCapability.ArkUI.ArkUI.Full 4137 * @crossplatform 4138 * @atomicservice 4139 * @since 12 4140 */ 4141 FAILED = 5, 4142} 4143 4144/** 4145 * Defines the scrollable target information. 4146 * 4147 * @extends EventTargetInfo 4148 * @syscap SystemCapability.ArkUI.ArkUI.Full 4149 * @crossplatform 4150 * @atomicservice 4151 * @since 12 4152 */ 4153declare class ScrollableTargetInfo extends EventTargetInfo { 4154 /** 4155 * Returns whether the scrollable component is at begin. 4156 * 4157 * @returns { boolean } - true is at begin, false is not at begin 4158 * @syscap SystemCapability.ArkUI.ArkUI.Full 4159 * @crossplatform 4160 * @atomicservice 4161 * @since 12 4162 */ 4163 isBegin(): boolean; 4164 /** 4165 * Returns whether the scrollable component is at end. 4166 * 4167 * @returns { boolean } - true is at end, false is not at end 4168 * @syscap SystemCapability.ArkUI.ArkUI.Full 4169 * @crossplatform 4170 * @atomicservice 4171 * @since 12 4172 */ 4173 isEnd(): boolean; 4174} 4175 4176/** 4177 * Defines the event target information. 4178 * 4179 * @syscap SystemCapability.ArkUI.ArkUI.Full 4180 * @crossplatform 4181 * @atomicservice 4182 * @since 12 4183 */ 4184declare class EventTargetInfo { 4185 /** 4186 * Returns the component's inspector id. 4187 * 4188 * @returns { string } - the inspector id of the component 4189 * @syscap SystemCapability.ArkUI.ArkUI.Full 4190 * @crossplatform 4191 * @atomicservice 4192 * @since 12 4193 */ 4194 getId(): string; 4195} 4196 4197/** 4198 * Defines the gesture recognizer. 4199 * 4200 * @syscap SystemCapability.ArkUI.ArkUI.Full 4201 * @crossplatform 4202 * @atomicservice 4203 * @since 12 4204 */ 4205declare class GestureRecognizer { 4206 /** 4207 * Returns the gesture's tag. 4208 * 4209 * @returns { string } - the gesture's tag 4210 * @syscap SystemCapability.ArkUI.ArkUI.Full 4211 * @crossplatform 4212 * @atomicservice 4213 * @since 12 4214 */ 4215 getTag(): string; 4216 /** 4217 * Returns the gesture's type. 4218 * 4219 * @returns { GestureControl.GestureType } - the gesture's type 4220 * @syscap SystemCapability.ArkUI.ArkUI.Full 4221 * @crossplatform 4222 * @atomicservice 4223 * @since 12 4224 */ 4225 getType(): GestureControl.GestureType; 4226 /** 4227 * Returns whether the gesture recognizer is built in recognizer. 4228 * 4229 * @returns { boolean } - true is built in recognizer, false is not built in recognizer 4230 * @syscap SystemCapability.ArkUI.ArkUI.Full 4231 * @crossplatform 4232 * @atomicservice 4233 * @since 12 4234 */ 4235 isBuiltIn(): boolean; 4236 /** 4237 * set the enabled state of the gesture recognizer. 4238 * 4239 * @param { boolean } isEnabled - Indicates the enabled state. 4240 * @syscap SystemCapability.ArkUI.ArkUI.Full 4241 * @crossplatform 4242 * @atomicservice 4243 * @since 12 4244 */ 4245 setEnabled(isEnabled: boolean): void; 4246 /** 4247 * Returns whether the gesture recognizer is enabled. 4248 * 4249 * @returns { boolean } - true is enabled, false is not enabled 4250 * @syscap SystemCapability.ArkUI.ArkUI.Full 4251 * @crossplatform 4252 * @atomicservice 4253 * @since 12 4254 */ 4255 isEnabled(): boolean; 4256 /** 4257 * Returns the gesture recognizer's state. 4258 * 4259 * @returns { GestureRecognizerState } - the gesture recognizer's state 4260 * @syscap SystemCapability.ArkUI.ArkUI.Full 4261 * @crossplatform 4262 * @atomicservice 4263 * @since 12 4264 */ 4265 getState(): GestureRecognizerState; 4266 /** 4267 * Returns the event target information of the component. 4268 * 4269 * @returns { EventTargetInfo } - the event target information of the component. 4270 * @syscap SystemCapability.ArkUI.ArkUI.Full 4271 * @crossplatform 4272 * @atomicservice 4273 * @since 12 4274 */ 4275 getEventTargetInfo(): EventTargetInfo; 4276 /** 4277 * Returns whether the gesture recognizer is valid. 4278 * 4279 * @returns { boolean } - true is valid, false is invalid 4280 * @syscap SystemCapability.ArkUI.ArkUI.Full 4281 * @crossplatform 4282 * @since 12 4283 */ 4284 isValid(): boolean; 4285 /** 4286 * Returns the tap gesture's finger count. 4287 * 4288 * @returns { number } - the finger count of the tap gesture. 4289 * @syscap SystemCapability.ArkUI.ArkUI.Full 4290 * @crossplatform 4291 * @atomicservice 4292 * @since 18 4293 */ 4294 getFingerCount(): number; 4295 /** 4296 * Returns the tap gesture's limitFingerCount. 4297 * 4298 * @returns { boolean } - the limitFingerCount of the tap gesture. 4299 * @syscap SystemCapability.ArkUI.ArkUI.Full 4300 * @crossplatform 4301 * @atomicservice 4302 * @since 18 4303 */ 4304 isFingerCountLimit(): boolean; 4305} 4306 4307/** 4308 * Defines the tap gesture recognizer. 4309 * 4310 * @extends GestureRecognizer 4311 * @syscap SystemCapability.ArkUI.ArkUI.Full 4312 * @crossplatform 4313 * @atomicservice 4314 * @since 18 4315 */ 4316declare class TapRecognizer extends GestureRecognizer { 4317 /** 4318 * Returns the tap gesture's count. 4319 * 4320 * @returns { number } - the count of the tap gesture. 4321 * @syscap SystemCapability.ArkUI.ArkUI.Full 4322 * @crossplatform 4323 * @atomicservice 4324 * @since 18 4325 */ 4326 getTapCount(): number; 4327} 4328 4329/** 4330 * Defines the long press gesture recognizer. 4331 * 4332 * @extends GestureRecognizer 4333 * @syscap SystemCapability.ArkUI.ArkUI.Full 4334 * @crossplatform 4335 * @atomicservice 4336 * @since 18 4337 */ 4338declare class LongPressRecognizer extends GestureRecognizer { 4339 /** 4340 * Returns the long press gesture's repeat state. 4341 * 4342 * @returns { boolean } - the repeat state of the long press gesture. 4343 * @syscap SystemCapability.ArkUI.ArkUI.Full 4344 * @crossplatform 4345 * @atomicservice 4346 * @since 18 4347 */ 4348 isRepeat(): boolean; 4349 /** 4350 * Returns the long press gesture's duration. 4351 * The unit is ms. 4352 * 4353 * @returns { number } - the duration of the long press gesture. 4354 * @syscap SystemCapability.ArkUI.ArkUI.Full 4355 * @crossplatform 4356 * @atomicservice 4357 * @since 18 4358 */ 4359 getDuration(): number; 4360} 4361 4362/** 4363 * Defines the swipe gesture recognizer. 4364 * 4365 * @extends GestureRecognizer 4366 * @syscap SystemCapability.ArkUI.ArkUI.Full 4367 * @crossplatform 4368 * @atomicservice 4369 * @since 18 4370 */ 4371declare class SwipeRecognizer extends GestureRecognizer { 4372 /** 4373 * Returns the swipe gesture's speed. 4374 * The unit is vp/s. 4375 * 4376 * @returns { number } - the velocity threshold of the swipe gesture. 4377 * @syscap SystemCapability.ArkUI.ArkUI.Full 4378 * @crossplatform 4379 * @atomicservice 4380 * @since 18 4381 */ 4382 getVelocityThreshold(): number; 4383 /** 4384 * Returns the swipe gesture's direction. 4385 * 4386 * @returns { SwipeDirection } - the direction of the swipe gesture. 4387 * @syscap SystemCapability.ArkUI.ArkUI.Full 4388 * @crossplatform 4389 * @atomicservice 4390 * @since 18 4391 */ 4392 getDirection(): SwipeDirection; 4393} 4394 4395/** 4396 * Defines the pinch gesture recognizer. 4397 * 4398 * @extends GestureRecognizer 4399 * @syscap SystemCapability.ArkUI.ArkUI.Full 4400 * @crossplatform 4401 * @atomicservice 4402 * @since 18 4403 */ 4404declare class PinchRecognizer extends GestureRecognizer { 4405 /** 4406 * Returns the pinch gesture's distance. 4407 * The unit is vp. 4408 * 4409 * @returns { number } - the distance of the pinch gesture. 4410 * @syscap SystemCapability.ArkUI.ArkUI.Full 4411 * @crossplatform 4412 * @atomicservice 4413 * @since 18 4414 */ 4415 getDistance(): number; 4416} 4417 4418/** 4419 * Defines the rotation gesture recognizer. 4420 * 4421 * @extends GestureRecognizer 4422 * @syscap SystemCapability.ArkUI.ArkUI.Full 4423 * @crossplatform 4424 * @atomicservice 4425 * @since 18 4426 */ 4427declare class RotationRecognizer extends GestureRecognizer { 4428 /** 4429 * Returns the rotation gesture's angle. 4430 * 4431 * @returns { number } - the angle of the rotation gesture. 4432 * @syscap SystemCapability.ArkUI.ArkUI.Full 4433 * @crossplatform 4434 * @atomicservice 4435 * @since 18 4436 */ 4437 getAngle(): number; 4438} 4439 4440/** 4441 * Defines the gesture recognizer. 4442 * 4443 * @extends GestureRecognizer 4444 * @syscap SystemCapability.ArkUI.ArkUI.Full 4445 * @crossplatform 4446 * @atomicservice 4447 * @since 12 4448 */ 4449declare class PanRecognizer extends GestureRecognizer { 4450 /** 4451 * Returns the the pan gesture options of the recognizer. 4452 * 4453 * @returns { PanGestureOptions } - Pan gesture options 4454 * @syscap SystemCapability.ArkUI.ArkUI.Full 4455 * @crossplatform 4456 * @atomicservice 4457 * @since 12 4458 */ 4459 getPanGestureOptions(): PanGestureOptions; 4460} 4461