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 2182/** 2183 * Defines the PanGesture options. 2184 * 2185 * @syscap SystemCapability.ArkUI.ArkUI.Full 2186 * @since 7 2187 */ 2188/** 2189 * Defines the PanGesture options. 2190 * 2191 * @syscap SystemCapability.ArkUI.ArkUI.Full 2192 * @crossplatform 2193 * @since 10 2194 */ 2195/** 2196 * Defines the PanGesture options. 2197 * 2198 * @syscap SystemCapability.ArkUI.ArkUI.Full 2199 * @crossplatform 2200 * @atomicservice 2201 * @since 11 2202 */ 2203declare class PanGestureOptions { 2204 /** 2205 * Constructor parameters. 2206 * 2207 * @param { object } value 2208 * @syscap SystemCapability.ArkUI.ArkUI.Full 2209 * @since 7 2210 */ 2211 /** 2212 * Constructor parameters. 2213 * 2214 * @param { object } value 2215 * @syscap SystemCapability.ArkUI.ArkUI.Full 2216 * @crossplatform 2217 * @since 10 2218 */ 2219 /** 2220 * Constructor parameters. 2221 * 2222 * @param { object } value 2223 * @syscap SystemCapability.ArkUI.ArkUI.Full 2224 * @crossplatform 2225 * @atomicservice 2226 * @since 11 2227 */ 2228 constructor(value?: { fingers?: number; direction?: PanDirection; distance?: number }); 2229 2230 /** 2231 * Sets the direction attribute. 2232 * 2233 * @param { PanDirection } value 2234 * @syscap SystemCapability.ArkUI.ArkUI.Full 2235 * @since 7 2236 */ 2237 /** 2238 * Sets the direction attribute. 2239 * 2240 * @param { PanDirection } value 2241 * @syscap SystemCapability.ArkUI.ArkUI.Full 2242 * @crossplatform 2243 * @since 10 2244 */ 2245 /** 2246 * Sets the direction attribute. 2247 * 2248 * @param { PanDirection } value 2249 * @syscap SystemCapability.ArkUI.ArkUI.Full 2250 * @crossplatform 2251 * @atomicservice 2252 * @since 11 2253 */ 2254 setDirection(value: PanDirection); 2255 2256 /** 2257 * Sets the setDistance attribute. 2258 * 2259 * @param { number } value 2260 * @syscap SystemCapability.ArkUI.ArkUI.Full 2261 * @since 7 2262 */ 2263 /** 2264 * Sets the setDistance attribute. 2265 * 2266 * @param { number } value 2267 * @syscap SystemCapability.ArkUI.ArkUI.Full 2268 * @crossplatform 2269 * @since 10 2270 */ 2271 /** 2272 * Sets the setDistance attribute. 2273 * 2274 * @param { number } value 2275 * @syscap SystemCapability.ArkUI.ArkUI.Full 2276 * @crossplatform 2277 * @atomicservice 2278 * @since 11 2279 */ 2280 setDistance(value: number); 2281 2282 /** 2283 * Sets the setFingers attribute. 2284 * 2285 * @param { number } value 2286 * @syscap SystemCapability.ArkUI.ArkUI.Full 2287 * @since 7 2288 */ 2289 /** 2290 * Sets the setFingers attribute. 2291 * 2292 * @param { number } value 2293 * @syscap SystemCapability.ArkUI.ArkUI.Full 2294 * @crossplatform 2295 * @since 10 2296 */ 2297 /** 2298 * Sets the setFingers attribute. 2299 * 2300 * @param { number } value 2301 * @syscap SystemCapability.ArkUI.ArkUI.Full 2302 * @crossplatform 2303 * @atomicservice 2304 * @since 11 2305 */ 2306 setFingers(value: number); 2307 2308 /** 2309 * Get the pan direction attribute. 2310 * 2311 * @returns { PanDirection } - Pan gesture direction 2312 * @syscap SystemCapability.ArkUI.ArkUI.Full 2313 * @crossplatform 2314 * @atomicservice 2315 * @since 12 2316 */ 2317 getDirection(): PanDirection; 2318} 2319 2320/** 2321 * Defines the PanGesture interface. 2322 * 2323 * @extends GestureInterface<PanGestureInterface> 2324 * @interface PanGestureInterface 2325 * @syscap SystemCapability.ArkUI.ArkUI.Full 2326 * @since 7 2327 */ 2328/** 2329 * Defines the PanGesture interface. 2330 * 2331 * @extends GestureInterface<PanGestureInterface> 2332 * @interface PanGestureInterface 2333 * @syscap SystemCapability.ArkUI.ArkUI.Full 2334 * @crossplatform 2335 * @since 10 2336 */ 2337/** 2338 * Defines PanGesture interface extends GestureInterface<PanGestureInterface>. 2339 * 2340 * @extends GestureInterface<PanGestureInterface> 2341 * @interface PanGestureInterface 2342 * @syscap SystemCapability.ArkUI.ArkUI.Full 2343 * @crossplatform 2344 * @atomicservice 2345 * @since 11 2346 */ 2347interface PanGestureInterface extends GestureInterface<PanGestureInterface> { 2348 /** 2349 * Set the value. 2350 * 2351 * @param { { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOptions } value 2352 * @returns { PanGestureInterface } 2353 * @syscap SystemCapability.ArkUI.ArkUI.Full 2354 * @since 7 2355 */ 2356 /** 2357 * Set the value. 2358 * 2359 * @param { { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOptions } value 2360 * @returns { PanGestureInterface } 2361 * @syscap SystemCapability.ArkUI.ArkUI.Full 2362 * @crossplatform 2363 * @since 10 2364 */ 2365 /** 2366 * Set the value. 2367 * 2368 * @param { { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOptions } value 2369 * @returns { PanGestureInterface } 2370 * @syscap SystemCapability.ArkUI.ArkUI.Full 2371 * @crossplatform 2372 * @atomicservice 2373 * @since 11 2374 */ 2375 (value?: { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOptions): PanGestureInterface; 2376 2377 /** 2378 * Set the value. 2379 * 2380 * @param { PanGestureHandlerOptions } options 2381 * @returns { PanGestureInterface } 2382 * @syscap SystemCapability.ArkUI.ArkUI.Full 2383 * @crossplatform 2384 * @atomicservice 2385 * @since 15 2386 */ 2387 (options?: PanGestureHandlerOptions): PanGestureInterface; 2388 2389 /** 2390 * Pan gesture recognition success callback. 2391 * 2392 * @param { function } event 2393 * @returns { PanGestureInterface } 2394 * @syscap SystemCapability.ArkUI.ArkUI.Full 2395 * @since 7 2396 */ 2397 /** 2398 * Pan gesture recognition success callback. 2399 * 2400 * @param { function } event 2401 * @returns { PanGestureInterface } 2402 * @syscap SystemCapability.ArkUI.ArkUI.Full 2403 * @crossplatform 2404 * @since 10 2405 */ 2406 /** 2407 * Pan gesture recognition success callback. 2408 * 2409 * @param { function } event 2410 * @returns { PanGestureInterface } 2411 * @syscap SystemCapability.ArkUI.ArkUI.Full 2412 * @crossplatform 2413 * @atomicservice 2414 * @since 11 2415 */ 2416 onActionStart(event: (event: GestureEvent) => void): PanGestureInterface; 2417 2418 /** 2419 * Callback when the Pan gesture is moving. 2420 * 2421 * @param { function } event 2422 * @returns { PanGestureInterface } 2423 * @syscap SystemCapability.ArkUI.ArkUI.Full 2424 * @since 7 2425 */ 2426 /** 2427 * Callback when the Pan gesture is moving. 2428 * 2429 * @param { function } event 2430 * @returns { PanGestureInterface } 2431 * @syscap SystemCapability.ArkUI.ArkUI.Full 2432 * @crossplatform 2433 * @since 10 2434 */ 2435 /** 2436 * Callback when the Pan gesture is moving. 2437 * 2438 * @param { function } event 2439 * @returns { PanGestureInterface } 2440 * @syscap SystemCapability.ArkUI.ArkUI.Full 2441 * @crossplatform 2442 * @atomicservice 2443 * @since 11 2444 */ 2445 onActionUpdate(event: (event: GestureEvent) => void): PanGestureInterface; 2446 2447 /** 2448 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2449 * 2450 * @param { function } event 2451 * @returns { PanGestureInterface } 2452 * @syscap SystemCapability.ArkUI.ArkUI.Full 2453 * @since 7 2454 */ 2455 /** 2456 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2457 * 2458 * @param { function } event 2459 * @returns { PanGestureInterface } 2460 * @syscap SystemCapability.ArkUI.ArkUI.Full 2461 * @crossplatform 2462 * @since 10 2463 */ 2464 /** 2465 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2466 * 2467 * @param { function } event 2468 * @returns { PanGestureInterface } 2469 * @syscap SystemCapability.ArkUI.ArkUI.Full 2470 * @crossplatform 2471 * @atomicservice 2472 * @since 11 2473 */ 2474 onActionEnd(event: (event: GestureEvent) => void): PanGestureInterface; 2475 2476 /** 2477 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2478 * 2479 * @param { function } event 2480 * @returns { PanGestureInterface } 2481 * @syscap SystemCapability.ArkUI.ArkUI.Full 2482 * @since 7 2483 */ 2484 /** 2485 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2486 * 2487 * @param { function } event 2488 * @returns { PanGestureInterface } 2489 * @syscap SystemCapability.ArkUI.ArkUI.Full 2490 * @crossplatform 2491 * @since 10 2492 */ 2493 /** 2494 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2495 * 2496 * @param { function } event 2497 * @returns { PanGestureInterface } 2498 * @syscap SystemCapability.ArkUI.ArkUI.Full 2499 * @crossplatform 2500 * @atomicservice 2501 * @since 11 2502 */ 2503 onActionCancel(event: () => void): PanGestureInterface; 2504} 2505 2506/** 2507 * Defines the SwipeGesture interface. 2508 * 2509 * @extends GestureInterface<SwipeGestureInterface> 2510 * @interface SwipeGestureInterface 2511 * @syscap SystemCapability.ArkUI.ArkUI.Full 2512 * @since 8 2513 */ 2514/** 2515 * Defines the SwipeGesture interface. 2516 * 2517 * @extends GestureInterface<SwipeGestureInterface> 2518 * @interface SwipeGestureInterface 2519 * @syscap SystemCapability.ArkUI.ArkUI.Full 2520 * @crossplatform 2521 * @since 10 2522 */ 2523/** 2524 * Defines SwipeGesture interface extends GestureInterface<SwipeGestureInterface>. 2525 * 2526 * @extends GestureInterface<SwipeGestureInterface> 2527 * @interface SwipeGestureInterface 2528 * @syscap SystemCapability.ArkUI.ArkUI.Full 2529 * @crossplatform 2530 * @atomicservice 2531 * @since 11 2532 */ 2533interface SwipeGestureInterface extends GestureInterface<SwipeGestureInterface> { 2534 /** 2535 * Set the value. 2536 * 2537 * @param { object } value 2538 * @returns { SwipeGestureInterface } 2539 * @syscap SystemCapability.ArkUI.ArkUI.Full 2540 * @since 8 2541 */ 2542 /** 2543 * Set the value. 2544 * 2545 * @param { object } value 2546 * @returns { SwipeGestureInterface } 2547 * @syscap SystemCapability.ArkUI.ArkUI.Full 2548 * @crossplatform 2549 * @since 10 2550 */ 2551 /** 2552 * Set the value. 2553 * 2554 * @param { object } value 2555 * @returns { SwipeGestureInterface } 2556 * @syscap SystemCapability.ArkUI.ArkUI.Full 2557 * @crossplatform 2558 * @atomicservice 2559 * @since 11 2560 */ 2561 (value?: { fingers?: number; direction?: SwipeDirection; speed?: number }): SwipeGestureInterface; 2562 2563 /** 2564 * Set the options. 2565 * options: The options of the swipe gesture. 2566 * 2567 * @param { SwipeGestureHandlerOptions } options 2568 * @returns { SwipeGestureInterface } 2569 * @syscap SystemCapability.ArkUI.ArkUI.Full 2570 * @crossplatform 2571 * @atomicservice 2572 * @since 15 2573 */ 2574 (options?: SwipeGestureHandlerOptions): SwipeGestureInterface; 2575 2576 /** 2577 * Slide gesture recognition success callback. 2578 * 2579 * @param { function } event 2580 * @returns { SwipeGestureInterface } 2581 * @syscap SystemCapability.ArkUI.ArkUI.Full 2582 * @since 8 2583 */ 2584 /** 2585 * Slide gesture recognition success callback. 2586 * 2587 * @param { function } event 2588 * @returns { SwipeGestureInterface } 2589 * @syscap SystemCapability.ArkUI.ArkUI.Full 2590 * @crossplatform 2591 * @since 10 2592 */ 2593 /** 2594 * Slide gesture recognition success callback. 2595 * 2596 * @param { function } event 2597 * @returns { SwipeGestureInterface } 2598 * @syscap SystemCapability.ArkUI.ArkUI.Full 2599 * @crossplatform 2600 * @atomicservice 2601 * @since 11 2602 */ 2603 onAction(event: (event: GestureEvent) => void): SwipeGestureInterface; 2604} 2605 2606/** 2607 * Defines the PinchGesture interface. 2608 * 2609 * @extends GestureInterface<PinchGestureInterface> 2610 * @interface PinchGestureInterface 2611 * @syscap SystemCapability.ArkUI.ArkUI.Full 2612 * @since 7 2613 */ 2614/** 2615 * Defines the PinchGesture interface. 2616 * 2617 * @extends GestureInterface<PinchGestureInterface> 2618 * @interface PinchGestureInterface 2619 * @syscap SystemCapability.ArkUI.ArkUI.Full 2620 * @crossplatform 2621 * @since 10 2622 */ 2623/** 2624 * Defines PinchGesture interface extends GestureInterface<PinchGestureInterface>. 2625 * 2626 * @extends GestureInterface<PinchGestureInterface> 2627 * @interface PinchGestureInterface 2628 * @syscap SystemCapability.ArkUI.ArkUI.Full 2629 * @crossplatform 2630 * @atomicservice 2631 * @since 11 2632 */ 2633interface PinchGestureInterface extends GestureInterface<PinchGestureInterface> { 2634 /** 2635 * Set the value. 2636 * 2637 * @param { object } value 2638 * @returns { PinchGestureInterface } 2639 * @syscap SystemCapability.ArkUI.ArkUI.Full 2640 * @since 7 2641 */ 2642 /** 2643 * Set the value. 2644 * 2645 * @param { object } value 2646 * @returns { PinchGestureInterface } 2647 * @syscap SystemCapability.ArkUI.ArkUI.Full 2648 * @crossplatform 2649 * @since 10 2650 */ 2651 /** 2652 * Set the value. 2653 * 2654 * @param { object } value 2655 * @returns { PinchGestureInterface } 2656 * @syscap SystemCapability.ArkUI.ArkUI.Full 2657 * @crossplatform 2658 * @atomicservice 2659 * @since 11 2660 */ 2661 (value?: { fingers?: number; distance?: number }): PinchGestureInterface; 2662 2663 /** 2664 * Set the options. 2665 * options: The options of the pinch gesture. 2666 * 2667 * @param { PinchGestureHandlerOptions } options 2668 * @returns { PinchGestureInterface } 2669 * @syscap SystemCapability.ArkUI.ArkUI.Full 2670 * @crossplatform 2671 * @atomicservice 2672 * @since 15 2673 */ 2674 (options?: PinchGestureHandlerOptions): PinchGestureInterface; 2675 2676 /** 2677 * Pan gesture recognition success callback. 2678 * 2679 * @param { function } event 2680 * @returns { PinchGestureInterface } 2681 * @syscap SystemCapability.ArkUI.ArkUI.Full 2682 * @since 7 2683 */ 2684 /** 2685 * Pan gesture recognition success callback. 2686 * 2687 * @param { function } event 2688 * @returns { PinchGestureInterface } 2689 * @syscap SystemCapability.ArkUI.ArkUI.Full 2690 * @crossplatform 2691 * @since 10 2692 */ 2693 /** 2694 * Pan gesture recognition success callback. 2695 * 2696 * @param { function } event 2697 * @returns { PinchGestureInterface } 2698 * @syscap SystemCapability.ArkUI.ArkUI.Full 2699 * @crossplatform 2700 * @atomicservice 2701 * @since 11 2702 */ 2703 onActionStart(event: (event: GestureEvent) => void): PinchGestureInterface; 2704 2705 /** 2706 * Callback when the Pan gesture is moving. 2707 * 2708 * @param { function } event 2709 * @returns { PinchGestureInterface } 2710 * @syscap SystemCapability.ArkUI.ArkUI.Full 2711 * @since 7 2712 */ 2713 /** 2714 * Callback when the Pan gesture is moving. 2715 * 2716 * @param { function } event 2717 * @returns { PinchGestureInterface } 2718 * @syscap SystemCapability.ArkUI.ArkUI.Full 2719 * @crossplatform 2720 * @since 10 2721 */ 2722 /** 2723 * Callback when the Pan gesture is moving. 2724 * 2725 * @param { function } event 2726 * @returns { PinchGestureInterface } 2727 * @syscap SystemCapability.ArkUI.ArkUI.Full 2728 * @crossplatform 2729 * @atomicservice 2730 * @since 11 2731 */ 2732 onActionUpdate(event: (event: GestureEvent) => void): PinchGestureInterface; 2733 2734 /** 2735 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2736 * 2737 * @param { function } event 2738 * @returns { PinchGestureInterface } 2739 * @syscap SystemCapability.ArkUI.ArkUI.Full 2740 * @since 7 2741 */ 2742 /** 2743 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2744 * 2745 * @param { function } event 2746 * @returns { PinchGestureInterface } 2747 * @syscap SystemCapability.ArkUI.ArkUI.Full 2748 * @crossplatform 2749 * @since 10 2750 */ 2751 /** 2752 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2753 * 2754 * @param { function } event 2755 * @returns { PinchGestureInterface } 2756 * @syscap SystemCapability.ArkUI.ArkUI.Full 2757 * @crossplatform 2758 * @atomicservice 2759 * @since 11 2760 */ 2761 onActionEnd(event: (event: GestureEvent) => void): PinchGestureInterface; 2762 2763 /** 2764 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2765 * 2766 * @param { function } event 2767 * @returns { PinchGestureInterface } 2768 * @syscap SystemCapability.ArkUI.ArkUI.Full 2769 * @since 7 2770 */ 2771 /** 2772 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2773 * 2774 * @param { function } event 2775 * @returns { PinchGestureInterface } 2776 * @syscap SystemCapability.ArkUI.ArkUI.Full 2777 * @crossplatform 2778 * @since 10 2779 */ 2780 /** 2781 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2782 * 2783 * @param { function } event 2784 * @returns { PinchGestureInterface } 2785 * @syscap SystemCapability.ArkUI.ArkUI.Full 2786 * @crossplatform 2787 * @atomicservice 2788 * @since 11 2789 */ 2790 onActionCancel(event: () => void): PinchGestureInterface; 2791} 2792 2793/** 2794 * Defines the RotationGesture interface. 2795 * 2796 * @extends GestureInterface<RotationGestureInterface> 2797 * @interface RotationGestureInterface 2798 * @syscap SystemCapability.ArkUI.ArkUI.Full 2799 * @since 7 2800 */ 2801/** 2802 * Defines the RotationGesture interface. 2803 * 2804 * @extends GestureInterface<RotationGestureInterface> 2805 * @interface RotationGestureInterface 2806 * @syscap SystemCapability.ArkUI.ArkUI.Full 2807 * @crossplatform 2808 * @since 10 2809 */ 2810/** 2811 * Defines RotationGesture interface extends GestureInterface<RotationGestureInterface>. 2812 * 2813 * @extends GestureInterface<RotationGestureInterface> 2814 * @interface RotationGestureInterface 2815 * @syscap SystemCapability.ArkUI.ArkUI.Full 2816 * @crossplatform 2817 * @atomicservice 2818 * @since 11 2819 */ 2820interface RotationGestureInterface extends GestureInterface<RotationGestureInterface> { 2821 /** 2822 * Set the value. 2823 * 2824 * @param { object } value 2825 * @returns { RotationGestureInterface } 2826 * @syscap SystemCapability.ArkUI.ArkUI.Full 2827 * @since 7 2828 */ 2829 /** 2830 * Set the value. 2831 * 2832 * @param { object } value 2833 * @returns { RotationGestureInterface } 2834 * @syscap SystemCapability.ArkUI.ArkUI.Full 2835 * @crossplatform 2836 * @since 10 2837 */ 2838 /** 2839 * Set the value. 2840 * 2841 * @param { object } value 2842 * @returns { RotationGestureInterface } 2843 * @syscap SystemCapability.ArkUI.ArkUI.Full 2844 * @crossplatform 2845 * @atomicservice 2846 * @since 11 2847 */ 2848 (value?: { fingers?: number; angle?: number }): RotationGestureInterface; 2849 2850 /** 2851 * Set the options. 2852 * options: The options of the rotation gesture. 2853 * 2854 * @param { RotationGestureHandlerOptions } options 2855 * @returns { RotationGestureInterface } 2856 * @syscap SystemCapability.ArkUI.ArkUI.Full 2857 * @crossplatform 2858 * @atomicservice 2859 * @since 15 2860 */ 2861 (options?: RotationGestureHandlerOptions): RotationGestureInterface; 2862 2863 /** 2864 * Pan gesture recognition success callback. 2865 * 2866 * @param { function } event 2867 * @returns { RotationGestureInterface } 2868 * @syscap SystemCapability.ArkUI.ArkUI.Full 2869 * @since 7 2870 */ 2871 /** 2872 * Pan gesture recognition success callback. 2873 * 2874 * @param { function } event 2875 * @returns { RotationGestureInterface } 2876 * @syscap SystemCapability.ArkUI.ArkUI.Full 2877 * @crossplatform 2878 * @since 10 2879 */ 2880 /** 2881 * Pan gesture recognition success callback. 2882 * 2883 * @param { function } event 2884 * @returns { RotationGestureInterface } 2885 * @syscap SystemCapability.ArkUI.ArkUI.Full 2886 * @crossplatform 2887 * @atomicservice 2888 * @since 11 2889 */ 2890 onActionStart(event: (event: GestureEvent) => void): RotationGestureInterface; 2891 2892 /** 2893 * Callback when the Pan gesture is moving. 2894 * 2895 * @param { function } event 2896 * @returns { RotationGestureInterface } 2897 * @syscap SystemCapability.ArkUI.ArkUI.Full 2898 * @since 7 2899 */ 2900 /** 2901 * Callback when the Pan gesture is moving. 2902 * 2903 * @param { function } event 2904 * @returns { RotationGestureInterface } 2905 * @syscap SystemCapability.ArkUI.ArkUI.Full 2906 * @crossplatform 2907 * @since 10 2908 */ 2909 /** 2910 * Callback when the Pan gesture is moving. 2911 * 2912 * @param { function } event 2913 * @returns { RotationGestureInterface } 2914 * @syscap SystemCapability.ArkUI.ArkUI.Full 2915 * @crossplatform 2916 * @atomicservice 2917 * @since 11 2918 */ 2919 onActionUpdate(event: (event: GestureEvent) => void): RotationGestureInterface; 2920 2921 /** 2922 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2923 * 2924 * @param { function } event 2925 * @returns { RotationGestureInterface } 2926 * @syscap SystemCapability.ArkUI.ArkUI.Full 2927 * @since 7 2928 */ 2929 /** 2930 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2931 * 2932 * @param { function } event 2933 * @returns { RotationGestureInterface } 2934 * @syscap SystemCapability.ArkUI.ArkUI.Full 2935 * @crossplatform 2936 * @since 10 2937 */ 2938 /** 2939 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2940 * 2941 * @param { function } event 2942 * @returns { RotationGestureInterface } 2943 * @syscap SystemCapability.ArkUI.ArkUI.Full 2944 * @crossplatform 2945 * @atomicservice 2946 * @since 11 2947 */ 2948 onActionEnd(event: (event: GestureEvent) => void): RotationGestureInterface; 2949 2950 /** 2951 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2952 * 2953 * @param { function } event 2954 * @returns { RotationGestureInterface } 2955 * @syscap SystemCapability.ArkUI.ArkUI.Full 2956 * @since 7 2957 */ 2958 /** 2959 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2960 * 2961 * @param { function } event 2962 * @returns { RotationGestureInterface } 2963 * @syscap SystemCapability.ArkUI.ArkUI.Full 2964 * @crossplatform 2965 * @since 10 2966 */ 2967 /** 2968 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2969 * 2970 * @param { function } event 2971 * @returns { RotationGestureInterface } 2972 * @syscap SystemCapability.ArkUI.ArkUI.Full 2973 * @crossplatform 2974 * @atomicservice 2975 * @since 11 2976 */ 2977 onActionCancel(event: () => void): RotationGestureInterface; 2978} 2979 2980/** 2981 * Defines the GestureGroup interface. 2982 * 2983 * @interface GestureGroupInterface 2984 * @syscap SystemCapability.ArkUI.ArkUI.Full 2985 * @since 7 2986 */ 2987/** 2988 * Defines the GestureGroup interface. 2989 * 2990 * @interface GestureGroupInterface 2991 * @syscap SystemCapability.ArkUI.ArkUI.Full 2992 * @crossplatform 2993 * @since 10 2994 */ 2995/** 2996 * Defines the GestureGroup interface. 2997 * 2998 * @interface GestureGroupInterface 2999 * @syscap SystemCapability.ArkUI.ArkUI.Full 3000 * @crossplatform 3001 * @atomicservice 3002 * @since 11 3003 */ 3004interface GestureGroupInterface { 3005 /** 3006 * Return to Obtain GestureGroup. 3007 * 3008 * @param { GestureMode } mode 3009 * @param { GestureType[] } gesture 3010 * @returns { GestureGroupInterface } 3011 * @syscap SystemCapability.ArkUI.ArkUI.Full 3012 * @since 7 3013 */ 3014 /** 3015 * Return to Obtain GestureGroup. 3016 * 3017 * @param { GestureMode } mode 3018 * @param { GestureType[] } gesture 3019 * @returns { GestureGroupInterface } 3020 * @syscap SystemCapability.ArkUI.ArkUI.Full 3021 * @crossplatform 3022 * @since 10 3023 */ 3024 /** 3025 * Return to Obtain GestureGroup. 3026 * 3027 * @param { GestureMode } mode 3028 * @param { GestureType[] } gesture 3029 * @returns { GestureGroupInterface } 3030 * @syscap SystemCapability.ArkUI.ArkUI.Full 3031 * @crossplatform 3032 * @atomicservice 3033 * @since 11 3034 */ 3035 (mode: GestureMode, ...gesture: GestureType[]): GestureGroupInterface; 3036 3037 /** 3038 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3039 * 3040 * @param { function } event 3041 * @returns { GestureGroupInterface } 3042 * @syscap SystemCapability.ArkUI.ArkUI.Full 3043 * @since 7 3044 */ 3045 /** 3046 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3047 * 3048 * @param { function } event 3049 * @returns { GestureGroupInterface } 3050 * @syscap SystemCapability.ArkUI.ArkUI.Full 3051 * @crossplatform 3052 * @since 10 3053 */ 3054 /** 3055 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3056 * 3057 * @param { function } event 3058 * @returns { GestureGroupInterface } 3059 * @syscap SystemCapability.ArkUI.ArkUI.Full 3060 * @crossplatform 3061 * @atomicservice 3062 * @since 11 3063 */ 3064 onCancel(event: () => void): GestureGroupInterface; 3065} 3066 3067/** 3068 * Defines TapGesture Component. 3069 * 3070 * @syscap SystemCapability.ArkUI.ArkUI.Full 3071 * @since 7 3072 */ 3073/** 3074 * Defines TapGesture Component. 3075 * 3076 * @syscap SystemCapability.ArkUI.ArkUI.Full 3077 * @crossplatform 3078 * @since 10 3079 */ 3080/** 3081 * Defines TapGesture Component. 3082 * 3083 * @syscap SystemCapability.ArkUI.ArkUI.Full 3084 * @crossplatform 3085 * @atomicservice 3086 * @since 11 3087 */ 3088declare const TapGesture: TapGestureInterface; 3089 3090/** 3091 * Defines LongPressGesture Component. 3092 * 3093 * @syscap SystemCapability.ArkUI.ArkUI.Full 3094 * @since 7 3095 */ 3096/** 3097 * Defines LongPressGesture Component. 3098 * 3099 * @syscap SystemCapability.ArkUI.ArkUI.Full 3100 * @crossplatform 3101 * @since 10 3102 */ 3103/** 3104 * Defines LongPressGesture Component. 3105 * 3106 * @syscap SystemCapability.ArkUI.ArkUI.Full 3107 * @crossplatform 3108 * @atomicservice 3109 * @since 11 3110 */ 3111declare const LongPressGesture: LongPressGestureInterface; 3112 3113/** 3114 * Defines PanGesture Component. 3115 * 3116 * @syscap SystemCapability.ArkUI.ArkUI.Full 3117 * @since 7 3118 */ 3119/** 3120 * Defines PanGesture Component. 3121 * 3122 * @syscap SystemCapability.ArkUI.ArkUI.Full 3123 * @crossplatform 3124 * @since 10 3125 */ 3126/** 3127 * Defines PanGesture Component. 3128 * 3129 * @syscap SystemCapability.ArkUI.ArkUI.Full 3130 * @crossplatform 3131 * @atomicservice 3132 * @since 11 3133 */ 3134declare const PanGesture: PanGestureInterface; 3135 3136/** 3137 * Defines SwipeGesture Component. 3138 * 3139 * @syscap SystemCapability.ArkUI.ArkUI.Full 3140 * @since 7 3141 */ 3142/** 3143 * Defines SwipeGesture Component. 3144 * 3145 * @syscap SystemCapability.ArkUI.ArkUI.Full 3146 * @crossplatform 3147 * @since 10 3148 */ 3149/** 3150 * Defines SwipeGesture Component. 3151 * 3152 * @syscap SystemCapability.ArkUI.ArkUI.Full 3153 * @crossplatform 3154 * @atomicservice 3155 * @since 11 3156 */ 3157declare const SwipeGesture: SwipeGestureInterface; 3158 3159/** 3160 * Defines PinchGesture Component. 3161 * 3162 * @syscap SystemCapability.ArkUI.ArkUI.Full 3163 * @since 7 3164 */ 3165/** 3166 * Defines PinchGesture Component. 3167 * 3168 * @syscap SystemCapability.ArkUI.ArkUI.Full 3169 * @crossplatform 3170 * @since 10 3171 */ 3172/** 3173 * Defines PinchGesture Component. 3174 * 3175 * @syscap SystemCapability.ArkUI.ArkUI.Full 3176 * @crossplatform 3177 * @atomicservice 3178 * @since 11 3179 */ 3180declare const PinchGesture: PinchGestureInterface; 3181 3182/** 3183 * Defines RotationGesture Component. 3184 * 3185 * @syscap SystemCapability.ArkUI.ArkUI.Full 3186 * @since 7 3187 */ 3188/** 3189 * Defines RotationGesture Component. 3190 * 3191 * @syscap SystemCapability.ArkUI.ArkUI.Full 3192 * @crossplatform 3193 * @since 10 3194 */ 3195/** 3196 * Defines RotationGesture Component. 3197 * 3198 * @syscap SystemCapability.ArkUI.ArkUI.Full 3199 * @crossplatform 3200 * @atomicservice 3201 * @since 11 3202 */ 3203declare const RotationGesture: RotationGestureInterface; 3204 3205/** 3206 * Defines GestureGroup Component. 3207 * 3208 * @syscap SystemCapability.ArkUI.ArkUI.Full 3209 * @since 7 3210 */ 3211/** 3212 * Defines GestureGroup Component. 3213 * 3214 * @syscap SystemCapability.ArkUI.ArkUI.Full 3215 * @crossplatform 3216 * @since 10 3217 */ 3218/** 3219 * Defines GestureGroup Component. 3220 * 3221 * @syscap SystemCapability.ArkUI.ArkUI.Full 3222 * @crossplatform 3223 * @atomicservice 3224 * @since 11 3225 */ 3226declare const GestureGroup: GestureGroupInterface; 3227 3228/** 3229 * Defines the gesture handler. 3230 * 3231 * @implements GestureInterface<T> 3232 * @syscap SystemCapability.ArkUI.ArkUI.Full 3233 * @crossplatform 3234 * @atomicservice 3235 * @since 12 3236 */ 3237declare class GestureHandler<T> implements GestureInterface<T> { 3238 /** 3239 * Set the GestureHandler's tag. 3240 * 3241 * @param { string } tag 3242 * @returns { T } 3243 * @syscap SystemCapability.ArkUI.ArkUI.Full 3244 * @crossplatform 3245 * @atomicservice 3246 * @since 12 3247 */ 3248 tag(tag: string): T; 3249 3250 /** 3251 * Input source type for gesture response. 3252 * 3253 * @param { Array<SourceTool> } types - indicate the allowed input source for gesture to response 3254 * @returns { T } 3255 * @syscap SystemCapability.ArkUI.ArkUI.Full 3256 * @crossplatform 3257 * @atomicservice 3258 * @since 14 3259 */ 3260 allowedTypes(types: Array<SourceTool>): T; 3261} 3262 3263/** 3264 * Defines the TapGestureHandler options. 3265 * 3266 * @interface TapGestureHandlerOptions 3267 * @syscap SystemCapability.ArkUI.ArkUI.Full 3268 * @crossplatform 3269 * @atomicservice 3270 * @since 12 3271 */ 3272/** 3273 * Defines the TapGestureHandler options. 3274 * 3275 * @extends BaseHandlerOptions 3276 * @interface TapGestureHandlerOptions 3277 * @syscap SystemCapability.ArkUI.ArkUI.Full 3278 * @crossplatform 3279 * @atomicservice 3280 * @since 15 3281 */ 3282interface TapGestureHandlerOptions extends BaseHandlerOptions { 3283 /** 3284 * Indicates the number of consecutive clicks recognized. If the value is less than 1, the default value is used. 3285 * The default value is 1. 3286 * 3287 * @type { ?number } 3288 * @syscap SystemCapability.ArkUI.ArkUI.Full 3289 * @crossplatform 3290 * @atomicservice 3291 * @since 12 3292 */ 3293 count?: number; 3294 /** 3295 * Indicates the hand index that triggers the click. If the value is less than 1, the default value is used. 3296 * The default value is 1. 3297 * 3298 * @type { ?number } 3299 * @syscap SystemCapability.ArkUI.ArkUI.Full 3300 * @crossplatform 3301 * @atomicservice 3302 * @since 12 3303 */ 3304 fingers?: number; 3305} 3306 3307/** 3308 * Defines the TapGesture handler. 3309 * 3310 * @extends GestureHandler<TapGestureHandler> 3311 * @syscap SystemCapability.ArkUI.ArkUI.Full 3312 * @crossplatform 3313 * @atomicservice 3314 * @since 12 3315 */ 3316declare class TapGestureHandler extends GestureHandler<TapGestureHandler> { 3317 /** 3318 * Constructor parameters. 3319 * 3320 * @param { TapGestureHandlerOptions } options 3321 * @syscap SystemCapability.ArkUI.ArkUI.Full 3322 * @crossplatform 3323 * @atomicservice 3324 * @since 12 3325 */ 3326 constructor(options?: TapGestureHandlerOptions); 3327 /** 3328 * Tap gesture recognition success callback. 3329 * 3330 * @param { Callback<GestureEvent> } event 3331 * @returns { TapGestureHandler } 3332 * @syscap SystemCapability.ArkUI.ArkUI.Full 3333 * @crossplatform 3334 * @atomicservice 3335 * @since 12 3336 */ 3337 onAction(event: Callback<GestureEvent>): TapGestureHandler; 3338} 3339 3340/** 3341 * Defines the LongPressGestureHandler options. 3342 * 3343 * @interface LongPressGestureHandlerOptions 3344 * @syscap SystemCapability.ArkUI.ArkUI.Full 3345 * @crossplatform 3346 * @atomicservice 3347 * @since 12 3348 */ 3349/** 3350 * Defines the LongPressGestureHandler options. 3351 * 3352 * @extends BaseHandlerOptions 3353 * @interface LongPressGestureHandlerOptions 3354 * @syscap SystemCapability.ArkUI.ArkUI.Full 3355 * @crossplatform 3356 * @atomicservice 3357 * @since 15 3358 */ 3359interface LongPressGestureHandlerOptions extends BaseHandlerOptions { 3360 /** 3361 * Indicates the hand index that triggers the long press. If the value is less than 1, the default value is used. 3362 * The default value is 1. 3363 * 3364 * @type { ?number } 3365 * @syscap SystemCapability.ArkUI.ArkUI.Full 3366 * @crossplatform 3367 * @atomicservice 3368 * @since 12 3369 */ 3370 fingers?: number; 3371 /** 3372 * Indicates whether an event is triggered repeatedly. 3373 * The default value is false. 3374 * 3375 * @type { ?boolean } 3376 * @syscap SystemCapability.ArkUI.ArkUI.Full 3377 * @crossplatform 3378 * @atomicservice 3379 * @since 12 3380 */ 3381 repeat?: boolean; 3382 /** 3383 * Indicates minimum press and hold time, in milliseconds. 3384 * The default value is 500ms. 3385 * 3386 * @type { ?number } 3387 * @syscap SystemCapability.ArkUI.ArkUI.Full 3388 * @crossplatform 3389 * @atomicservice 3390 * @since 12 3391 */ 3392 duration?: number; 3393} 3394 3395/** 3396 * Defines the LongPressGesture handler. 3397 * 3398 * @extends GestureHandler<LongPressGestureHandler> 3399 * @syscap SystemCapability.ArkUI.ArkUI.Full 3400 * @crossplatform 3401 * @atomicservice 3402 * @since 12 3403 */ 3404declare class LongPressGestureHandler extends GestureHandler<LongPressGestureHandler> { 3405 /** 3406 * Constructor parameters. 3407 * 3408 * @param { LongPressGestureHandlerOptions } options 3409 * @syscap SystemCapability.ArkUI.ArkUI.Full 3410 * @crossplatform 3411 * @atomicservice 3412 * @since 12 3413 */ 3414 constructor(options?: LongPressGestureHandlerOptions); 3415 /** 3416 * LongPress gesture recognition success callback. 3417 * 3418 * @param { Callback<GestureEvent> } event 3419 * @returns { LongPressGestureHandler } 3420 * @syscap SystemCapability.ArkUI.ArkUI.Full 3421 * @crossplatform 3422 * @atomicservice 3423 * @since 12 3424 */ 3425 onAction(event: Callback<GestureEvent>): LongPressGestureHandler; 3426 /** 3427 * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3428 * 3429 * @param { Callback<GestureEvent> } event 3430 * @returns { LongPressGestureHandler } 3431 * @syscap SystemCapability.ArkUI.ArkUI.Full 3432 * @crossplatform 3433 * @atomicservice 3434 * @since 12 3435 */ 3436 onActionEnd(event: Callback<GestureEvent>): LongPressGestureHandler; 3437 /** 3438 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3439 * 3440 * @param { Callback<void> } event 3441 * @returns { LongPressGestureHandler } 3442 * @syscap SystemCapability.ArkUI.ArkUI.Full 3443 * @crossplatform 3444 * @atomicservice 3445 * @since 12 3446 */ 3447 onActionCancel(event: Callback<void>): LongPressGestureHandler; 3448} 3449 3450/** 3451 * Defines the PanGestureHandler options. 3452 * 3453 * @interface PanGestureHandlerOptions 3454 * @syscap SystemCapability.ArkUI.ArkUI.Full 3455 * @crossplatform 3456 * @atomicservice 3457 * @since 12 3458 */ 3459/** 3460 * Defines the PanGestureHandler options. 3461 * 3462 * @extends BaseHandlerOptions 3463 * @interface PanGestureHandlerOptions 3464 * @syscap SystemCapability.ArkUI.ArkUI.Full 3465 * @crossplatform 3466 * @atomicservice 3467 * @since 15 3468 */ 3469interface PanGestureHandlerOptions extends BaseHandlerOptions { 3470 /** 3471 * Indicates the hand index that triggers the pan. If the value is less than 1, the default value is used. 3472 * The default value is 1. 3473 * 3474 * @type { ?number } 3475 * @syscap SystemCapability.ArkUI.ArkUI.Full 3476 * @crossplatform 3477 * @atomicservice 3478 * @since 12 3479 */ 3480 fingers?: number; 3481 /** 3482 * Indicates the move direction of the pan gesture. 3483 * The default value is PanDirection.All. 3484 * 3485 * @type { ?PanDirection } 3486 * @syscap SystemCapability.ArkUI.ArkUI.Full 3487 * @crossplatform 3488 * @atomicservice 3489 * @since 12 3490 */ 3491 direction?: PanDirection; 3492 /** 3493 * Indicates minimum move distance. 3494 * The default value is 5vp. 3495 * 3496 * @type { ?number } 3497 * @syscap SystemCapability.ArkUI.ArkUI.Full 3498 * @crossplatform 3499 * @atomicservice 3500 * @since 12 3501 */ 3502 distance?: number; 3503} 3504 3505/** 3506 * Defines the PanGesture handler. 3507 * 3508 * @extends GestureHandler<PanGestureHandler> 3509 * @syscap SystemCapability.ArkUI.ArkUI.Full 3510 * @crossplatform 3511 * @atomicservice 3512 * @since 12 3513 */ 3514declare class PanGestureHandler extends GestureHandler<PanGestureHandler> { 3515 /** 3516 * Constructor parameters. 3517 * 3518 * @param { PanGestureHandlerOptions } options 3519 * @syscap SystemCapability.ArkUI.ArkUI.Full 3520 * @crossplatform 3521 * @atomicservice 3522 * @since 12 3523 */ 3524 constructor(options?: PanGestureHandlerOptions); 3525 /** 3526 * Pan gesture recognition success callback. 3527 * 3528 * @param { Callback<GestureEvent> } event 3529 * @returns { PanGestureHandler } 3530 * @syscap SystemCapability.ArkUI.ArkUI.Full 3531 * @crossplatform 3532 * @atomicservice 3533 * @since 12 3534 */ 3535 onActionStart(event: Callback<GestureEvent>): PanGestureHandler; 3536 /** 3537 * Callback when the Pan gesture is moving. 3538 * 3539 * @param { Callback<GestureEvent> } event 3540 * @returns { PanGestureHandler } 3541 * @syscap SystemCapability.ArkUI.ArkUI.Full 3542 * @crossplatform 3543 * @atomicservice 3544 * @since 12 3545 */ 3546 onActionUpdate(event: Callback<GestureEvent>): PanGestureHandler; 3547 /** 3548 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3549 * 3550 * @param { Callback<GestureEvent> } event 3551 * @returns { PanGestureHandler } 3552 * @syscap SystemCapability.ArkUI.ArkUI.Full 3553 * @crossplatform 3554 * @atomicservice 3555 * @since 12 3556 */ 3557 onActionEnd(event: Callback<GestureEvent>): PanGestureHandler; 3558 /** 3559 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3560 * 3561 * @param { Callback<void> } event 3562 * @returns { PanGestureHandler } 3563 * @syscap SystemCapability.ArkUI.ArkUI.Full 3564 * @crossplatform 3565 * @atomicservice 3566 * @since 12 3567 */ 3568 onActionCancel(event: Callback<void>): PanGestureHandler; 3569} 3570 3571/** 3572 * Defines the SwipeGestureHandler options. 3573 * 3574 * @interface SwipeGestureHandlerOptions 3575 * @syscap SystemCapability.ArkUI.ArkUI.Full 3576 * @crossplatform 3577 * @atomicservice 3578 * @since 12 3579 */ 3580/** 3581 * Defines the SwipeGestureHandler options. 3582 * 3583 * @extends BaseHandlerOptions 3584 * @interface SwipeGestureHandlerOptions 3585 * @syscap SystemCapability.ArkUI.ArkUI.Full 3586 * @crossplatform 3587 * @atomicservice 3588 * @since 15 3589 */ 3590interface SwipeGestureHandlerOptions extends BaseHandlerOptions { 3591 /** 3592 * Indicates the hand index that triggers the swipe. If the value is less than 1, the default value is used. 3593 * The default value is 1. 3594 * 3595 * @type { ?number } 3596 * @syscap SystemCapability.ArkUI.ArkUI.Full 3597 * @crossplatform 3598 * @atomicservice 3599 * @since 12 3600 */ 3601 fingers?: number; 3602 /** 3603 * Indicates the move direction of the swipe gesture. 3604 * The default value is SwipeDirection.All. 3605 * 3606 * @type { ?SwipeDirection } 3607 * @syscap SystemCapability.ArkUI.ArkUI.Full 3608 * @crossplatform 3609 * @atomicservice 3610 * @since 12 3611 */ 3612 direction?: SwipeDirection; 3613 /** 3614 * Indicates minimum move speed. 3615 * The default value is 100vp/s. 3616 * 3617 * @type { ?number } 3618 * @syscap SystemCapability.ArkUI.ArkUI.Full 3619 * @crossplatform 3620 * @atomicservice 3621 * @since 12 3622 */ 3623 speed?: number; 3624} 3625 3626/** 3627 * Defines the SwipeGesture handler. 3628 * 3629 * @extends GestureHandler<SwipeGestureHandler> 3630 * @syscap SystemCapability.ArkUI.ArkUI.Full 3631 * @crossplatform 3632 * @atomicservice 3633 * @since 12 3634 */ 3635declare class SwipeGestureHandler extends GestureHandler<SwipeGestureHandler> { 3636 /** 3637 * Constructor parameters. 3638 * 3639 * @param { SwipeGestureHandlerOptions } options 3640 * @syscap SystemCapability.ArkUI.ArkUI.Full 3641 * @crossplatform 3642 * @atomicservice 3643 * @since 12 3644 */ 3645 constructor(options?: SwipeGestureHandlerOptions); 3646 /** 3647 * Swipe gesture recognition success callback. 3648 * 3649 * @param { Callback<GestureEvent> } event 3650 * @returns { SwipeGestureHandler } 3651 * @syscap SystemCapability.ArkUI.ArkUI.Full 3652 * @crossplatform 3653 * @atomicservice 3654 * @since 12 3655 */ 3656 onAction(event: Callback<GestureEvent>): SwipeGestureHandler; 3657} 3658 3659/** 3660 * Defines the PinchGestureHandler options. 3661 * 3662 * @interface PinchGestureHandlerOptions 3663 * @syscap SystemCapability.ArkUI.ArkUI.Full 3664 * @crossplatform 3665 * @atomicservice 3666 * @since 12 3667 */ 3668/** 3669 * Defines the PinchGestureHandler options. 3670 * 3671 * @extends BaseHandlerOptions 3672 * @interface PinchGestureHandlerOptions 3673 * @syscap SystemCapability.ArkUI.ArkUI.Full 3674 * @crossplatform 3675 * @atomicservice 3676 * @since 15 3677 */ 3678interface PinchGestureHandlerOptions extends BaseHandlerOptions { 3679 /** 3680 * Indicates the hand index that triggers the pinch. If the value is less than 1, the default value is used. 3681 * The default value is 1. 3682 * 3683 * @type { ?number } 3684 * @syscap SystemCapability.ArkUI.ArkUI.Full 3685 * @crossplatform 3686 * @atomicservice 3687 * @since 12 3688 */ 3689 fingers?: number; 3690 /** 3691 * Indicates minimum pinch move distance. 3692 * The default value is 5vp. 3693 * 3694 * @type { ?number } 3695 * @syscap SystemCapability.ArkUI.ArkUI.Full 3696 * @crossplatform 3697 * @atomicservice 3698 * @since 12 3699 */ 3700 distance?: number; 3701} 3702 3703/** 3704 * Defines the PinchGesture handler. 3705 * 3706 * @extends GestureHandler<PinchGestureHandler> 3707 * @syscap SystemCapability.ArkUI.ArkUI.Full 3708 * @crossplatform 3709 * @atomicservice 3710 * @since 12 3711 */ 3712declare class PinchGestureHandler extends GestureHandler<PinchGestureHandler> { 3713 /** 3714 * Constructor parameters. 3715 * 3716 * @param { PinchGestureHandlerOptions } options 3717 * @syscap SystemCapability.ArkUI.ArkUI.Full 3718 * @crossplatform 3719 * @atomicservice 3720 * @since 12 3721 */ 3722 constructor(options?: PinchGestureHandlerOptions); 3723 /** 3724 * Pinch gesture recognition success callback. 3725 * 3726 * @param { Callback<GestureEvent> } event 3727 * @returns { PinchGestureHandler } 3728 * @syscap SystemCapability.ArkUI.ArkUI.Full 3729 * @crossplatform 3730 * @atomicservice 3731 * @since 12 3732 */ 3733 onActionStart(event: Callback<GestureEvent>): PinchGestureHandler; 3734 /** 3735 * Callback when the Pinch gesture is moving. 3736 * 3737 * @param { Callback<GestureEvent> } event 3738 * @returns { PinchGestureHandler } 3739 * @syscap SystemCapability.ArkUI.ArkUI.Full 3740 * @crossplatform 3741 * @atomicservice 3742 * @since 12 3743 */ 3744 onActionUpdate(event: Callback<GestureEvent>): PinchGestureHandler; 3745 /** 3746 * The Pinch gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3747 * 3748 * @param { Callback<GestureEvent> } event 3749 * @returns { PinchGestureHandler } 3750 * @syscap SystemCapability.ArkUI.ArkUI.Full 3751 * @crossplatform 3752 * @atomicservice 3753 * @since 12 3754 */ 3755 onActionEnd(event: Callback<GestureEvent>): PinchGestureHandler; 3756 /** 3757 * The Pinch gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3758 * 3759 * @param { Callback<void> } event 3760 * @returns { PinchGestureHandler } 3761 * @syscap SystemCapability.ArkUI.ArkUI.Full 3762 * @crossplatform 3763 * @atomicservice 3764 * @since 12 3765 */ 3766 onActionCancel(event: Callback<void>): PinchGestureHandler; 3767} 3768 3769/** 3770 * Defines the RotationGestureHandler options. 3771 * 3772 * @interface RotationGestureHandlerOptions 3773 * @syscap SystemCapability.ArkUI.ArkUI.Full 3774 * @crossplatform 3775 * @atomicservice 3776 * @since 12 3777 */ 3778/** 3779 * Defines the RotationGestureHandler options. 3780 * 3781 * @extends BaseHandlerOptions 3782 * @interface RotationGestureHandlerOptions 3783 * @syscap SystemCapability.ArkUI.ArkUI.Full 3784 * @crossplatform 3785 * @atomicservice 3786 * @since 15 3787 */ 3788interface RotationGestureHandlerOptions extends BaseHandlerOptions { 3789 /** 3790 * Indicates the hand index that triggers the rotation. If the value is less than 1, the default value is used. 3791 * The default value is 1. 3792 * 3793 * @type { ?number } 3794 * @syscap SystemCapability.ArkUI.ArkUI.Full 3795 * @crossplatform 3796 * @atomicservice 3797 * @since 12 3798 */ 3799 fingers?: number; 3800 /** 3801 * Indicates minimum rotate angle. 3802 * The default value is 1deg. 3803 * 3804 * @type { ?number } 3805 * @syscap SystemCapability.ArkUI.ArkUI.Full 3806 * @crossplatform 3807 * @atomicservice 3808 * @since 12 3809 */ 3810 angle?: number; 3811} 3812 3813/** 3814 * Defines the RotationGesture handler. 3815 * 3816 * @extends GestureHandler<RotationGestureHandler> 3817 * @syscap SystemCapability.ArkUI.ArkUI.Full 3818 * @crossplatform 3819 * @atomicservice 3820 * @since 12 3821 */ 3822declare class RotationGestureHandler extends GestureHandler<RotationGestureHandler> { 3823 /** 3824 * Constructor parameters. 3825 * 3826 * @param { RotationGestureHandlerOptions } options 3827 * @syscap SystemCapability.ArkUI.ArkUI.Full 3828 * @crossplatform 3829 * @atomicservice 3830 * @since 12 3831 */ 3832 constructor(options?: RotationGestureHandlerOptions); 3833 /** 3834 * Rotation gesture recognition success callback. 3835 * 3836 * @param { Callback<GestureEvent> } event 3837 * @returns { RotationGestureHandler } 3838 * @syscap SystemCapability.ArkUI.ArkUI.Full 3839 * @crossplatform 3840 * @atomicservice 3841 * @since 12 3842 */ 3843 onActionStart(event: Callback<GestureEvent>): RotationGestureHandler; 3844 /** 3845 * Callback when the Rotation gesture is moving. 3846 * 3847 * @param { Callback<GestureEvent> } event 3848 * @returns { RotationGestureHandler } 3849 * @syscap SystemCapability.ArkUI.ArkUI.Full 3850 * @crossplatform 3851 * @atomicservice 3852 * @since 12 3853 */ 3854 onActionUpdate(event: Callback<GestureEvent>): RotationGestureHandler; 3855 /** 3856 * The Rotation gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3857 * 3858 * @param { Callback<GestureEvent> } event 3859 * @returns { RotationGestureHandler } 3860 * @syscap SystemCapability.ArkUI.ArkUI.Full 3861 * @crossplatform 3862 * @atomicservice 3863 * @since 12 3864 */ 3865 onActionEnd(event: Callback<GestureEvent>): RotationGestureHandler; 3866 /** 3867 * The Rotation gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3868 * 3869 * @param { Callback<void> } event 3870 * @returns { RotationGestureHandler } 3871 * @syscap SystemCapability.ArkUI.ArkUI.Full 3872 * @crossplatform 3873 * @atomicservice 3874 * @since 12 3875 */ 3876 onActionCancel(event: Callback<void>): RotationGestureHandler; 3877} 3878 3879/** 3880 * Defines the GestureGroupGestureHandler options. 3881 * 3882 * @interface GestureGroupGestureHandlerOptions 3883 * @syscap SystemCapability.ArkUI.ArkUI.Full 3884 * @crossplatform 3885 * @atomicservice 3886 * @since 12 3887 */ 3888interface GestureGroupGestureHandlerOptions { 3889 /** 3890 * Indicates the mode of gesture group. 3891 * 3892 * @type { GestureMode } 3893 * @syscap SystemCapability.ArkUI.ArkUI.Full 3894 * @crossplatform 3895 * @atomicservice 3896 * @since 12 3897 */ 3898 mode: GestureMode; 3899 /** 3900 * Indicates the gestures included in the gesture group. 3901 * 3902 * @type { GestureHandler<TapGestureHandler | LongPressGestureHandler | PanGestureHandler | SwipeGestureHandler | PinchGestureHandler | RotationGestureHandler | GestureGroupHandler>[] } 3903 * @syscap SystemCapability.ArkUI.ArkUI.Full 3904 * @crossplatform 3905 * @atomicservice 3906 * @since 12 3907 */ 3908 gestures: GestureHandler<TapGestureHandler | LongPressGestureHandler | PanGestureHandler | SwipeGestureHandler | PinchGestureHandler | RotationGestureHandler | GestureGroupHandler>[]; 3909} 3910 3911/** 3912 * Defines the GestureGroup handler. 3913 * 3914 * @extends GestureHandler<GestureGroupHandler> 3915 * @syscap SystemCapability.ArkUI.ArkUI.Full 3916 * @crossplatform 3917 * @atomicservice 3918 * @since 12 3919 */ 3920declare class GestureGroupHandler extends GestureHandler<GestureGroupHandler> { 3921 /** 3922 * Constructor parameters. 3923 * 3924 * @param { GestureGroupGestureHandlerOptions } options 3925 * @syscap SystemCapability.ArkUI.ArkUI.Full 3926 * @crossplatform 3927 * @atomicservice 3928 * @since 12 3929 */ 3930 constructor(options?: GestureGroupGestureHandlerOptions); 3931 /** 3932 * The GestureGroup gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3933 * 3934 * @param { Callback<void> } event 3935 * @returns { GestureGroupHandler } 3936 * @syscap SystemCapability.ArkUI.ArkUI.Full 3937 * @crossplatform 3938 * @atomicservice 3939 * @since 12 3940 */ 3941 onCancel(event: Callback<void>): GestureGroupHandler; 3942} 3943 3944/** 3945 * Creating an Object 3946 * 3947 * @enum { number } 3948 * @syscap SystemCapability.ArkUI.ArkUI.Full 3949 * @crossplatform 3950 * @atomicservice 3951 * @since 12 3952 */ 3953declare enum GesturePriority { 3954 /** 3955 * The normal gesture priority. 3956 * 3957 * @syscap SystemCapability.ArkUI.ArkUI.Full 3958 * @crossplatform 3959 * @atomicservice 3960 * @since 12 3961 */ 3962 NORMAL = 0, 3963 /** 3964 * The high gesture priority. 3965 * 3966 * @syscap SystemCapability.ArkUI.ArkUI.Full 3967 * @crossplatform 3968 * @atomicservice 3969 * @since 12 3970 */ 3971 PRIORITY = 1, 3972} 3973 3974/** 3975 * Creating an Object 3976 * 3977 * @enum { number } 3978 * @syscap SystemCapability.ArkUI.ArkUI.Full 3979 * @crossplatform 3980 * @atomicservice 3981 * @since 12 3982 */ 3983declare enum GestureRecognizerState { 3984 /** 3985 * Ready state. 3986 * 3987 * @syscap SystemCapability.ArkUI.ArkUI.Full 3988 * @crossplatform 3989 * @atomicservice 3990 * @since 12 3991 */ 3992 READY = 0, 3993 /** 3994 * Detecting state. 3995 * 3996 * @syscap SystemCapability.ArkUI.ArkUI.Full 3997 * @crossplatform 3998 * @atomicservice 3999 * @since 12 4000 */ 4001 DETECTING = 1, 4002 /** 4003 * Pending state. 4004 * 4005 * @syscap SystemCapability.ArkUI.ArkUI.Full 4006 * @crossplatform 4007 * @atomicservice 4008 * @since 12 4009 */ 4010 PENDING = 2, 4011 /** 4012 * Blocked state. 4013 * 4014 * @syscap SystemCapability.ArkUI.ArkUI.Full 4015 * @crossplatform 4016 * @atomicservice 4017 * @since 12 4018 */ 4019 BLOCKED = 3, 4020 /** 4021 * Successful state. 4022 * 4023 * @syscap SystemCapability.ArkUI.ArkUI.Full 4024 * @crossplatform 4025 * @atomicservice 4026 * @since 12 4027 */ 4028 SUCCESSFUL = 4, 4029 /** 4030 * Failed state. 4031 * 4032 * @syscap SystemCapability.ArkUI.ArkUI.Full 4033 * @crossplatform 4034 * @atomicservice 4035 * @since 12 4036 */ 4037 FAILED = 5, 4038} 4039 4040/** 4041 * Defines the scrollable target information. 4042 * 4043 * @extends EventTargetInfo 4044 * @syscap SystemCapability.ArkUI.ArkUI.Full 4045 * @crossplatform 4046 * @atomicservice 4047 * @since 12 4048 */ 4049declare class ScrollableTargetInfo extends EventTargetInfo { 4050 /** 4051 * Returns whether the scrollable component is at begin. 4052 * 4053 * @returns { boolean } - true is at begin, false is not at begin 4054 * @syscap SystemCapability.ArkUI.ArkUI.Full 4055 * @crossplatform 4056 * @atomicservice 4057 * @since 12 4058 */ 4059 isBegin(): boolean; 4060 /** 4061 * Returns whether the scrollable component is at end. 4062 * 4063 * @returns { boolean } - true is at end, false is not at end 4064 * @syscap SystemCapability.ArkUI.ArkUI.Full 4065 * @crossplatform 4066 * @atomicservice 4067 * @since 12 4068 */ 4069 isEnd(): boolean; 4070} 4071 4072/** 4073 * Defines the event target information. 4074 * 4075 * @syscap SystemCapability.ArkUI.ArkUI.Full 4076 * @crossplatform 4077 * @atomicservice 4078 * @since 12 4079 */ 4080declare class EventTargetInfo { 4081 /** 4082 * Returns the component's inspector id. 4083 * 4084 * @returns { string } - the inspector id of the component 4085 * @syscap SystemCapability.ArkUI.ArkUI.Full 4086 * @crossplatform 4087 * @atomicservice 4088 * @since 12 4089 */ 4090 getId(): string; 4091} 4092 4093/** 4094 * Defines the gesture recognizer. 4095 * 4096 * @syscap SystemCapability.ArkUI.ArkUI.Full 4097 * @crossplatform 4098 * @atomicservice 4099 * @since 12 4100 */ 4101declare class GestureRecognizer { 4102 /** 4103 * Returns the gesture's tag. 4104 * 4105 * @returns { string } - the gesture's tag 4106 * @syscap SystemCapability.ArkUI.ArkUI.Full 4107 * @crossplatform 4108 * @atomicservice 4109 * @since 12 4110 */ 4111 getTag(): string; 4112 /** 4113 * Returns the gesture's type. 4114 * 4115 * @returns { GestureControl.GestureType } - the gesture's type 4116 * @syscap SystemCapability.ArkUI.ArkUI.Full 4117 * @crossplatform 4118 * @atomicservice 4119 * @since 12 4120 */ 4121 getType(): GestureControl.GestureType; 4122 /** 4123 * Returns whether the gesture recognizer is built in recognizer. 4124 * 4125 * @returns { boolean } - true is built in recognizer, false is not built in recognizer 4126 * @syscap SystemCapability.ArkUI.ArkUI.Full 4127 * @crossplatform 4128 * @atomicservice 4129 * @since 12 4130 */ 4131 isBuiltIn(): boolean; 4132 /** 4133 * set the enabled state of the gesture recognizer. 4134 * 4135 * @param { boolean } isEnabled - Indicates the enabled state. 4136 * @syscap SystemCapability.ArkUI.ArkUI.Full 4137 * @crossplatform 4138 * @atomicservice 4139 * @since 12 4140 */ 4141 setEnabled(isEnabled: boolean): void; 4142 /** 4143 * Returns whether the gesture recognizer is enabled. 4144 * 4145 * @returns { boolean } - true is enabled, false is not enabled 4146 * @syscap SystemCapability.ArkUI.ArkUI.Full 4147 * @crossplatform 4148 * @atomicservice 4149 * @since 12 4150 */ 4151 isEnabled(): boolean; 4152 /** 4153 * Returns the gesture recognizer's state. 4154 * 4155 * @returns { GestureRecognizerState } - the gesture recognizer's state 4156 * @syscap SystemCapability.ArkUI.ArkUI.Full 4157 * @crossplatform 4158 * @atomicservice 4159 * @since 12 4160 */ 4161 getState(): GestureRecognizerState; 4162 /** 4163 * Returns the event target information of the component. 4164 * 4165 * @returns { EventTargetInfo } - the event target information of the component. 4166 * @syscap SystemCapability.ArkUI.ArkUI.Full 4167 * @crossplatform 4168 * @atomicservice 4169 * @since 12 4170 */ 4171 getEventTargetInfo(): EventTargetInfo; 4172 /** 4173 * Returns whether the gesture recognizer is valid. 4174 * 4175 * @returns { boolean } - true is valid, false is invalid 4176 * @syscap SystemCapability.ArkUI.ArkUI.Full 4177 * @crossplatform 4178 * @since 12 4179 */ 4180 isValid(): boolean; 4181} 4182 4183/** 4184 * Defines the gesture recognizer. 4185 * 4186 * @extends GestureRecognizer 4187 * @syscap SystemCapability.ArkUI.ArkUI.Full 4188 * @crossplatform 4189 * @atomicservice 4190 * @since 12 4191 */ 4192declare class PanRecognizer extends GestureRecognizer { 4193 /** 4194 * Returns the the pan gesture options of the recognizer. 4195 * 4196 * @returns { PanGestureOptions } - Pan gesture options 4197 * @syscap SystemCapability.ArkUI.ArkUI.Full 4198 * @crossplatform 4199 * @atomicservice 4200 * @since 12 4201 */ 4202 getPanGestureOptions(): PanGestureOptions; 4203} 4204