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/** 998 * Defines the Gesture Type. 999 * 1000 * @typedef { TapGestureInterface | LongPressGestureInterface | PanGestureInterface | PinchGestureInterface | SwipeGestureInterface | RotationGestureInterface | GestureGroupInterface } GestureType 1001 * @syscap SystemCapability.ArkUI.ArkUI.Full 1002 * @since 7 1003 */ 1004/** 1005 * Defines the Gesture Type. 1006 * 1007 * @typedef { TapGestureInterface | LongPressGestureInterface | PanGestureInterface | PinchGestureInterface | SwipeGestureInterface | RotationGestureInterface | GestureGroupInterface } GestureType 1008 * @syscap SystemCapability.ArkUI.ArkUI.Full 1009 * @crossplatform 1010 * @since 10 1011 */ 1012/** 1013 * Defines the Gesture Type. 1014 * 1015 * @typedef { TapGestureInterface | LongPressGestureInterface | PanGestureInterface | PinchGestureInterface | SwipeGestureInterface | RotationGestureInterface | GestureGroupInterface } GestureType 1016 * @syscap SystemCapability.ArkUI.ArkUI.Full 1017 * @crossplatform 1018 * @atomicservice 1019 * @since 11 1020 */ 1021declare type GestureType = 1022 TapGestureInterface 1023 | LongPressGestureInterface 1024 | PanGestureInterface 1025 | PinchGestureInterface 1026 | SwipeGestureInterface 1027 | RotationGestureInterface 1028 | GestureGroupInterface; 1029 1030/** 1031 * Defines the gesture base event. 1032 * 1033 * @extends BaseEvent 1034 * @interface BaseGestureEvent 1035 * @syscap SystemCapability.ArkUI.ArkUI.Full 1036 * @crossplatform 1037 * @since 11 1038 */ 1039/** 1040 * Defines the gesture base event. 1041 * 1042 * @extends BaseEvent 1043 * @interface BaseGestureEvent 1044 * @syscap SystemCapability.ArkUI.ArkUI.Full 1045 * @crossplatform 1046 * @atomicservice 1047 * @since 12 1048 */ 1049interface BaseGestureEvent extends BaseEvent { 1050 /** 1051 * All finger information. 1052 * 1053 * @type { FingerInfo[] } 1054 * @syscap SystemCapability.ArkUI.ArkUI.Full 1055 * @crossplatform 1056 * @since 11 1057 */ 1058 /** 1059 * All finger information. 1060 * 1061 * @type { FingerInfo[] } 1062 * @syscap SystemCapability.ArkUI.ArkUI.Full 1063 * @crossplatform 1064 * @atomicservice 1065 * @since 12 1066 */ 1067 fingerList: FingerInfo[]; 1068} 1069 1070/** 1071 * Defines event info for tap gesture. 1072 * 1073 * @extends BaseGestureEvent 1074 * @interface TapGestureEvent 1075 * @syscap SystemCapability.ArkUI.ArkUI.Full 1076 * @crossplatform 1077 * @since 11 1078 */ 1079/** 1080 * Defines event info for tap gesture. 1081 * 1082 * @extends BaseGestureEvent 1083 * @interface TapGestureEvent 1084 * @syscap SystemCapability.ArkUI.ArkUI.Full 1085 * @crossplatform 1086 * @atomicservice 1087 * @since 12 1088 */ 1089interface TapGestureEvent extends BaseGestureEvent { 1090} 1091 1092/** 1093 * Defines event info for long press gesture. 1094 * 1095 * @extends BaseGestureEvent 1096 * @interface LongPressGestureEvent 1097 * @syscap SystemCapability.ArkUI.ArkUI.Full 1098 * @crossplatform 1099 * @since 11 1100 */ 1101/** 1102 * Defines event info for long press gesture. 1103 * 1104 * @extends BaseGestureEvent 1105 * @interface LongPressGestureEvent 1106 * @syscap SystemCapability.ArkUI.ArkUI.Full 1107 * @crossplatform 1108 * @atomicservice 1109 * @since 12 1110 */ 1111interface LongPressGestureEvent extends BaseGestureEvent { 1112 /** 1113 * Indicates whether an event is triggered repeatedly. 1114 * 1115 * @type { boolean } 1116 * @syscap SystemCapability.ArkUI.ArkUI.Full 1117 * @crossplatform 1118 * @since 11 1119 */ 1120 /** 1121 * Indicates whether an event is triggered repeatedly. 1122 * 1123 * @type { boolean } 1124 * @syscap SystemCapability.ArkUI.ArkUI.Full 1125 * @crossplatform 1126 * @atomicservice 1127 * @since 12 1128 */ 1129 repeat: boolean; 1130} 1131 1132/** 1133 * Defines event info for pan gesture. 1134 * 1135 * @extends BaseGestureEvent 1136 * @interface PanGestureEvent 1137 * @syscap SystemCapability.ArkUI.ArkUI.Full 1138 * @crossplatform 1139 * @since 11 1140 */ 1141/** 1142 * Defines event info for pan gesture. 1143 * 1144 * @extends BaseGestureEvent 1145 * @interface PanGestureEvent 1146 * @syscap SystemCapability.ArkUI.ArkUI.Full 1147 * @crossplatform 1148 * @atomicservice 1149 * @since 12 1150 */ 1151interface PanGestureEvent extends BaseGestureEvent { 1152 /** 1153 * Gesture event offset X. 1154 * The unit is vp. 1155 * 1156 * @type { number } 1157 * @syscap SystemCapability.ArkUI.ArkUI.Full 1158 * @crossplatform 1159 * @since 11 1160 */ 1161 /** 1162 * Gesture event offset X. 1163 * The unit is vp. 1164 * 1165 * @type { number } 1166 * @syscap SystemCapability.ArkUI.ArkUI.Full 1167 * @crossplatform 1168 * @atomicservice 1169 * @since 12 1170 */ 1171 offsetX: number; 1172 1173 /** 1174 * Gesture event offset Y. 1175 * The unit is vp. 1176 * 1177 * @type { number } 1178 * @syscap SystemCapability.ArkUI.ArkUI.Full 1179 * @crossplatform 1180 * @since 11 1181 */ 1182 /** 1183 * Gesture event offset Y. 1184 * The unit is vp. 1185 * 1186 * @type { number } 1187 * @syscap SystemCapability.ArkUI.ArkUI.Full 1188 * @crossplatform 1189 * @atomicservice 1190 * @since 12 1191 */ 1192 offsetY: number; 1193 1194 /** 1195 * X-axis velocity of the gesture. 1196 * @type {number} 1197 * @syscap SystemCapability.ArkUI.ArkUI.Full 1198 * @crossplatform 1199 * @since 11 1200 */ 1201 /** 1202 * X-axis velocity of the gesture. 1203 * @type {number} 1204 * @syscap SystemCapability.ArkUI.ArkUI.Full 1205 * @crossplatform 1206 * @atomicservice 1207 * @since 12 1208 */ 1209 velocityX: number; 1210 1211 /** 1212 * Y-axis velocity of the gesture. 1213 * @type {number} 1214 * @syscap SystemCapability.ArkUI.ArkUI.Full 1215 * @crossplatform 1216 * @since 11 1217 */ 1218 /** 1219 * Y-axis velocity of the gesture. 1220 * @type {number} 1221 * @syscap SystemCapability.ArkUI.ArkUI.Full 1222 * @crossplatform 1223 * @atomicservice 1224 * @since 12 1225 */ 1226 velocityY: number; 1227 1228 /** 1229 * velocity of the gesture. 1230 * @type {number} 1231 * @syscap SystemCapability.ArkUI.ArkUI.Full 1232 * @crossplatform 1233 * @since 11 1234 */ 1235 /** 1236 * velocity of the gesture. 1237 * @type {number} 1238 * @syscap SystemCapability.ArkUI.ArkUI.Full 1239 * @crossplatform 1240 * @atomicservice 1241 * @since 12 1242 */ 1243 velocity: number; 1244} 1245 1246/** 1247 * Defines event info for pinch gesture. 1248 * 1249 * @extends BaseGestureEvent 1250 * @interface PinchGestureEvent 1251 * @syscap SystemCapability.ArkUI.ArkUI.Full 1252 * @crossplatform 1253 * @since 11 1254 */ 1255/** 1256 * Defines event info for pinch gesture. 1257 * 1258 * @extends BaseGestureEvent 1259 * @interface PinchGestureEvent 1260 * @syscap SystemCapability.ArkUI.ArkUI.Full 1261 * @crossplatform 1262 * @atomicservice 1263 * @since 12 1264 */ 1265interface PinchGestureEvent extends BaseGestureEvent { 1266 /** 1267 * Scaling ratio. 1268 * 1269 * @type { number } 1270 * @syscap SystemCapability.ArkUI.ArkUI.Full 1271 * @crossplatform 1272 * @since 11 1273 */ 1274 /** 1275 * Scaling ratio. 1276 * 1277 * @type { number } 1278 * @syscap SystemCapability.ArkUI.ArkUI.Full 1279 * @crossplatform 1280 * @atomicservice 1281 * @since 12 1282 */ 1283 scale: number; 1284 1285 /** 1286 * X-axis coordinate of the kneading center point. 1287 * The unit is vp. 1288 * 1289 * @type { number } 1290 * @syscap SystemCapability.ArkUI.ArkUI.Full 1291 * @crossplatform 1292 * @since 11 1293 */ 1294 /** 1295 * X-axis coordinate of the kneading center point. 1296 * The unit is vp. 1297 * 1298 * @type { number } 1299 * @syscap SystemCapability.ArkUI.ArkUI.Full 1300 * @crossplatform 1301 * @atomicservice 1302 * @since 12 1303 */ 1304 pinchCenterX: number; 1305 1306 /** 1307 * Y-axis coordinate of the kneading center point. 1308 * The unit is vp. 1309 * 1310 * @type { number } 1311 * @syscap SystemCapability.ArkUI.ArkUI.Full 1312 * @crossplatform 1313 * @since 11 1314 */ 1315 /** 1316 * Y-axis coordinate of the kneading center point. 1317 * The unit is vp. 1318 * 1319 * @type { number } 1320 * @syscap SystemCapability.ArkUI.ArkUI.Full 1321 * @crossplatform 1322 * @atomicservice 1323 * @since 12 1324 */ 1325 pinchCenterY: number; 1326} 1327 1328/** 1329 * Defines event info for rotation gesture. 1330 * 1331 * @extends BaseGestureEvent 1332 * @interface RotationGestureEvent 1333 * @syscap SystemCapability.ArkUI.ArkUI.Full 1334 * @crossplatform 1335 * @since 11 1336 */ 1337/** 1338 * Defines event info for rotation gesture. 1339 * 1340 * @extends BaseGestureEvent 1341 * @interface RotationGestureEvent 1342 * @syscap SystemCapability.ArkUI.ArkUI.Full 1343 * @crossplatform 1344 * @atomicservice 1345 * @since 12 1346 */ 1347interface RotationGestureEvent extends BaseGestureEvent { 1348 /** 1349 * Gesture event direction angle. 1350 * The unit is deg. 1351 * 1352 * @type { number } 1353 * @syscap SystemCapability.ArkUI.ArkUI.Full 1354 * @crossplatform 1355 * @since 11 1356 */ 1357 /** 1358 * Gesture event direction angle. 1359 * The unit is deg. 1360 * 1361 * @type { number } 1362 * @syscap SystemCapability.ArkUI.ArkUI.Full 1363 * @crossplatform 1364 * @atomicservice 1365 * @since 12 1366 */ 1367 angle: number; 1368} 1369 1370/** 1371 * Defines event info for swipe gesture. 1372 * 1373 * @extends BaseGestureEvent 1374 * @interface SwipeGestureEvent 1375 * @syscap SystemCapability.ArkUI.ArkUI.Full 1376 * @crossplatform 1377 * @since 11 1378 */ 1379/** 1380 * Defines event info for swipe gesture. 1381 * 1382 * @extends BaseGestureEvent 1383 * @interface SwipeGestureEvent 1384 * @syscap SystemCapability.ArkUI.ArkUI.Full 1385 * @crossplatform 1386 * @atomicservice 1387 * @since 112 1388 */ 1389interface SwipeGestureEvent extends BaseGestureEvent { 1390 /** 1391 * Gesture event direction angle. 1392 * The unit is deg. 1393 * 1394 * @type { number } 1395 * @syscap SystemCapability.ArkUI.ArkUI.Full 1396 * @crossplatform 1397 * @since 11 1398 */ 1399 /** 1400 * Gesture event direction angle. 1401 * The unit is deg. 1402 * 1403 * @type { number } 1404 * @syscap SystemCapability.ArkUI.ArkUI.Full 1405 * @crossplatform 1406 * @atomicservice 1407 * @since 12 1408 */ 1409 angle: number; 1410 1411 /** 1412 * Gesture event slide speed. 1413 * The unit is vp. 1414 * 1415 * @type { number } 1416 * @syscap SystemCapability.ArkUI.ArkUI.Full 1417 * @crossplatform 1418 * @since 11 1419 */ 1420 /** 1421 * Gesture event slide speed. 1422 * The unit is vp. 1423 * 1424 * @type { number } 1425 * @syscap SystemCapability.ArkUI.ArkUI.Full 1426 * @crossplatform 1427 * @atomicservice 1428 * @since 12 1429 */ 1430 speed: number; 1431} 1432 1433/** 1434 * Defines event info for gesture. 1435 * 1436 * @extends BaseEvent 1437 * @interface GestureEvent 1438 * @syscap SystemCapability.ArkUI.ArkUI.Full 1439 * @since 7 1440 */ 1441/** 1442 * Defines event info for gesture. 1443 * 1444 * @extends BaseEvent 1445 * @interface GestureEvent 1446 * @syscap SystemCapability.ArkUI.ArkUI.Full 1447 * @crossplatform 1448 * @since 10 1449 */ 1450/** 1451 * Defines event info for gesture. 1452 * 1453 * @extends BaseEvent 1454 * @interface GestureEvent 1455 * @syscap SystemCapability.ArkUI.ArkUI.Full 1456 * @crossplatform 1457 * @atomicservice 1458 * @since 11 1459 */ 1460interface GestureEvent extends BaseEvent { 1461 /** 1462 * Indicates whether an event is triggered repeatedly. 1463 * Used in LongPressGesture. 1464 * 1465 * @type { boolean } 1466 * @syscap SystemCapability.ArkUI.ArkUI.Full 1467 * @since 7 1468 */ 1469 /** 1470 * Indicates whether an event is triggered repeatedly. 1471 * Used in LongPressGesture. 1472 * 1473 * @type { boolean } 1474 * @syscap SystemCapability.ArkUI.ArkUI.Full 1475 * @crossplatform 1476 * @since 10 1477 */ 1478 /** 1479 * Indicates whether an event is triggered repeatedly. 1480 * Used in LongPressGesture. 1481 * 1482 * @type { boolean } 1483 * @syscap SystemCapability.ArkUI.ArkUI.Full 1484 * @crossplatform 1485 * @atomicservice 1486 * @since 11 1487 */ 1488 repeat: boolean; 1489 1490 /** 1491 * All finger information. 1492 * Used in LongPressGesture and TapGesture. 1493 * 1494 * @type { FingerInfo[] } 1495 * @syscap SystemCapability.ArkUI.ArkUI.Full 1496 * @since 8 1497 */ 1498 /** 1499 * All finger information. 1500 * Used in LongPressGesture and TapGesture. 1501 * 1502 * @type { FingerInfo[] } 1503 * @syscap SystemCapability.ArkUI.ArkUI.Full 1504 * @crossplatform 1505 * @since 10 1506 */ 1507 /** 1508 * All finger information. 1509 * Used in LongPressGesture and TapGesture. 1510 * 1511 * @type { FingerInfo[] } 1512 * @syscap SystemCapability.ArkUI.ArkUI.Full 1513 * @crossplatform 1514 * @atomicservice 1515 * @since 11 1516 */ 1517 fingerList: FingerInfo[]; 1518 1519 /** 1520 * Gesture event offset X. 1521 * The unit is vp. 1522 * Used in PanGesture. 1523 * 1524 * @type { number } 1525 * @syscap SystemCapability.ArkUI.ArkUI.Full 1526 * @since 7 1527 */ 1528 /** 1529 * Gesture event offset X. 1530 * The unit is vp. 1531 * Used in PanGesture. 1532 * 1533 * @type { number } 1534 * @syscap SystemCapability.ArkUI.ArkUI.Full 1535 * @crossplatform 1536 * @since 10 1537 */ 1538 /** 1539 * Gesture event offset X. 1540 * The unit is vp. 1541 * Used in PanGesture. 1542 * 1543 * @type { number } 1544 * @syscap SystemCapability.ArkUI.ArkUI.Full 1545 * @crossplatform 1546 * @atomicservice 1547 * @since 11 1548 */ 1549 offsetX: number; 1550 1551 /** 1552 * Gesture event offset Y. 1553 * The unit is vp. 1554 * Used in PanGesture. 1555 * 1556 * @type { number } 1557 * @syscap SystemCapability.ArkUI.ArkUI.Full 1558 * @since 7 1559 */ 1560 /** 1561 * Gesture event offset Y. 1562 * The unit is vp. 1563 * Used in PanGesture. 1564 * 1565 * @type { number } 1566 * @syscap SystemCapability.ArkUI.ArkUI.Full 1567 * @crossplatform 1568 * @since 10 1569 */ 1570 /** 1571 * Gesture event offset Y. 1572 * The unit is vp. 1573 * Used in PanGesture. 1574 * 1575 * @type { number } 1576 * @syscap SystemCapability.ArkUI.ArkUI.Full 1577 * @crossplatform 1578 * @atomicservice 1579 * @since 11 1580 */ 1581 offsetY: number; 1582 1583 /** 1584 * Gesture event direction angle. 1585 * The unit is deg. 1586 * Used in RotationGesture and SwipeGesture. 1587 * 1588 * @type { number } 1589 * @syscap SystemCapability.ArkUI.ArkUI.Full 1590 * @since 7 1591 */ 1592 /** 1593 * Gesture event direction angle. 1594 * The unit is deg. 1595 * Used in RotationGesture and SwipeGesture. 1596 * 1597 * @type { number } 1598 * @syscap SystemCapability.ArkUI.ArkUI.Full 1599 * @crossplatform 1600 * @since 10 1601 */ 1602 /** 1603 * Gesture event direction angle. 1604 * The unit is deg. 1605 * Used in RotationGesture and SwipeGesture. 1606 * 1607 * @type { number } 1608 * @syscap SystemCapability.ArkUI.ArkUI.Full 1609 * @crossplatform 1610 * @atomicservice 1611 * @since 11 1612 */ 1613 angle: number; 1614 1615 /** 1616 * Gesture event slide speed. 1617 * The unit is vp. 1618 * Used in SwipeGesture. 1619 * 1620 * @type { number } 1621 * @syscap SystemCapability.ArkUI.ArkUI.Full 1622 * @since 8 1623 */ 1624 /** 1625 * Gesture event slide speed. 1626 * The unit is vp. 1627 * Used in SwipeGesture. 1628 * 1629 * @type { number } 1630 * @syscap SystemCapability.ArkUI.ArkUI.Full 1631 * @crossplatform 1632 * @since 10 1633 */ 1634 /** 1635 * Gesture event slide speed. 1636 * The unit is vp. 1637 * Used in SwipeGesture. 1638 * 1639 * @type { number } 1640 * @syscap SystemCapability.ArkUI.ArkUI.Full 1641 * @crossplatform 1642 * @atomicservice 1643 * @since 11 1644 */ 1645 speed: number; 1646 1647 /** 1648 * Scaling ratio. 1649 * Used in PinchGesture. 1650 * 1651 * @type { number } 1652 * @syscap SystemCapability.ArkUI.ArkUI.Full 1653 * @since 7 1654 */ 1655 /** 1656 * Scaling ratio. 1657 * Used in PinchGesture. 1658 * 1659 * @type { number } 1660 * @syscap SystemCapability.ArkUI.ArkUI.Full 1661 * @crossplatform 1662 * @since 10 1663 */ 1664 /** 1665 * Scaling ratio. 1666 * Used in PinchGesture. 1667 * 1668 * @type { number } 1669 * @syscap SystemCapability.ArkUI.ArkUI.Full 1670 * @crossplatform 1671 * @atomicservice 1672 * @since 11 1673 */ 1674 scale: number; 1675 1676 /** 1677 * X-axis coordinate of the kneading center point. 1678 * The unit is vp. 1679 * Used in PinchGesture. 1680 * 1681 * @type { number } 1682 * @syscap SystemCapability.ArkUI.ArkUI.Full 1683 * @since 7 1684 */ 1685 /** 1686 * X-axis coordinate of the kneading center point. 1687 * The unit is vp. 1688 * Used in PinchGesture. 1689 * 1690 * @type { number } 1691 * @syscap SystemCapability.ArkUI.ArkUI.Full 1692 * @crossplatform 1693 * @since 10 1694 */ 1695 /** 1696 * X-axis coordinate of the kneading center point. 1697 * The unit is vp. 1698 * Used in PinchGesture. 1699 * 1700 * @type { number } 1701 * @syscap SystemCapability.ArkUI.ArkUI.Full 1702 * @crossplatform 1703 * @atomicservice 1704 * @since 11 1705 */ 1706 pinchCenterX: number; 1707 1708 /** 1709 * Y-axis coordinate of the kneading center point. 1710 * The unit is vp. 1711 * Used in PinchGesture. 1712 * 1713 * @type { number } 1714 * @syscap SystemCapability.ArkUI.ArkUI.Full 1715 * @since 7 1716 */ 1717 /** 1718 * Y-axis coordinate of the kneading center point. 1719 * The unit is vp. 1720 * Used in PinchGesture. 1721 * 1722 * @type { number } 1723 * @syscap SystemCapability.ArkUI.ArkUI.Full 1724 * @crossplatform 1725 * @since 10 1726 */ 1727 /** 1728 * Y-axis coordinate of the kneading center point. 1729 * The unit is vp. 1730 * Used in PinchGesture. 1731 * 1732 * @type { number } 1733 * @syscap SystemCapability.ArkUI.ArkUI.Full 1734 * @crossplatform 1735 * @atomicservice 1736 * @since 11 1737 */ 1738 pinchCenterY: number; 1739 1740 /** 1741 * X-axis velocity of the gesture. 1742 * @type {number} 1743 * @syscap SystemCapability.ArkUI.ArkUI.Full 1744 * @crossplatform 1745 * @since 10 1746 */ 1747 /** 1748 * X-axis velocity of the gesture. 1749 * @type {number} 1750 * @syscap SystemCapability.ArkUI.ArkUI.Full 1751 * @crossplatform 1752 * @atomicservice 1753 * @since 11 1754 */ 1755 velocityX: number; 1756 1757 /** 1758 * Y-axis velocity of the gesture. 1759 * @type {number} 1760 * @syscap SystemCapability.ArkUI.ArkUI.Full 1761 * @crossplatform 1762 * @since 10 1763 */ 1764 /** 1765 * Y-axis velocity of the gesture. 1766 * @type {number} 1767 * @syscap SystemCapability.ArkUI.ArkUI.Full 1768 * @crossplatform 1769 * @atomicservice 1770 * @since 11 1771 */ 1772 velocityY: number; 1773 1774 /** 1775 * velocity of the gesture. 1776 * @type {number} 1777 * @syscap SystemCapability.ArkUI.ArkUI.Full 1778 * @crossplatform 1779 * @since 10 1780 */ 1781 /** 1782 * velocity of the gesture. 1783 * @type {number} 1784 * @syscap SystemCapability.ArkUI.ArkUI.Full 1785 * @crossplatform 1786 * @atomicservice 1787 * @since 11 1788 */ 1789 velocity: number; 1790} 1791 1792/** 1793 * Defines Gesture interface. 1794 * 1795 * @interface GestureInterface 1796 * @syscap SystemCapability.ArkUI.ArkUI.Full 1797 * @crossplatform 1798 * @atomicservice 1799 * @since 11 1800 */ 1801interface GestureInterface<T> { 1802 /** 1803 * Set gesture's tag. 1804 * 1805 * @param { string } tag 1806 * @returns { T } 1807 * @syscap SystemCapability.ArkUI.ArkUI.Full 1808 * @crossplatform 1809 * @atomicservice 1810 * @since 11 1811 */ 1812 tag(tag: string): T; 1813 1814 /** 1815 * Input source type for gesture response. 1816 * 1817 * @param { Array<SourceTool> } types - indicate the allowed input source for gesture to response 1818 * @returns { T } 1819 * @syscap SystemCapability.ArkUI.ArkUI.Full 1820 * @crossplatform 1821 * @atomicservice 1822 * @since 14 1823 */ 1824 allowedTypes(types: Array<SourceTool>): T; 1825} 1826 1827/** 1828 * Defines TapGesture parameters. 1829 * 1830 * @interface TapGestureParameters 1831 * @syscap SystemCapability.ArkUI.ArkUI.Full 1832 * @crossplatform 1833 * @atomicservice 1834 * @since 12 1835 */ 1836declare interface TapGestureParameters { 1837 /** 1838 * Number of consecutive clicks recognized. If the value is less than 1, the default value is used. 1839 * 1840 * @type { ?number } 1841 * @syscap SystemCapability.ArkUI.ArkUI.Full 1842 * @crossplatform 1843 * @atomicservice 1844 * @since 11 1845 */ 1846 count?: number; 1847 /** 1848 * The hand index that triggers the click. If the value is less than 1, the default value is used. 1849 * 1850 * @type { ?number } 1851 * @syscap SystemCapability.ArkUI.ArkUI.Full 1852 * @crossplatform 1853 * @atomicservice 1854 * @since 11 1855 */ 1856 fingers?: number; 1857 /** 1858 * The limited move distance of click. If the value is less than 0, the default value is used. 1859 * 1860 * @type { ?number } 1861 * @syscap SystemCapability.ArkUI.ArkUI.Full 1862 * @crossplatform 1863 * @atomicservice 1864 * @since 12 1865 */ 1866 distanceThreshold?: number; 1867} 1868 1869/** 1870 * Defines TapGesture interface. 1871 * 1872 * @extends GestureInterface<TapGestureInterface> 1873 * @interface TapGestureInterface 1874 * @syscap SystemCapability.ArkUI.ArkUI.Full 1875 * @since 7 1876 */ 1877/** 1878 * Defines TapGesture interface. 1879 * 1880 * @extends GestureInterface<TapGestureInterface> 1881 * @interface TapGestureInterface 1882 * @syscap SystemCapability.ArkUI.ArkUI.Full 1883 * @crossplatform 1884 * @since 10 1885 */ 1886/** 1887 * Defines TapGesture interface extends GestureInterface<TapGestureInterface>. 1888 * 1889 * @extends GestureInterface<TapGestureInterface> 1890 * @interface TapGestureInterface 1891 * @syscap SystemCapability.ArkUI.ArkUI.Full 1892 * @crossplatform 1893 * @atomicservice 1894 * @since 11 1895 */ 1896interface TapGestureInterface extends GestureInterface<TapGestureInterface> { 1897 /** 1898 * Set the value. 1899 * count:Number of consecutive clicks recognized. If the value is less than 1, the default value is used. 1900 * fingers:The hand index that triggers the click. If the value is less than 1, the default value is used. 1901 * 1902 * @param { object } value 1903 * @returns { TapGestureInterface } 1904 * @syscap SystemCapability.ArkUI.ArkUI.Full 1905 * @since 7 1906 */ 1907 /** 1908 * Set the value. 1909 * count:Number of consecutive clicks recognized. If the value is less than 1, the default value is used. 1910 * fingers:The hand index that triggers the click. If the value is less than 1, the default value is used. 1911 * 1912 * @param { object } value 1913 * @returns { TapGestureInterface } 1914 * @syscap SystemCapability.ArkUI.ArkUI.Full 1915 * @crossplatform 1916 * @since 10 1917 */ 1918 /** 1919 * Set the value. 1920 * count:Number of consecutive clicks recognized. If the value is less than 1, the default value is used. 1921 * fingers:The hand index that triggers the click. If the value is less than 1, the default value is used. 1922 * 1923 * @param { object } value 1924 * @returns { TapGestureInterface } 1925 * @syscap SystemCapability.ArkUI.ArkUI.Full 1926 * @crossplatform 1927 * @atomicservice 1928 * @since 11 1929 */ 1930 /** 1931 * Set the value. 1932 * TapGestureParameters: The parameters of the tapGesture. 1933 * 1934 * @param { TapGestureParameters } value 1935 * @returns { TapGestureInterface } 1936 * @syscap SystemCapability.ArkUI.ArkUI.Full 1937 * @crossplatform 1938 * @atomicservice 1939 * @since 12 1940 */ 1941 (value?: TapGestureParameters): TapGestureInterface; 1942 1943 /** 1944 * Tap gesture recognition success callback. 1945 * 1946 * @param { function } event 1947 * @returns { TapGestureInterface } 1948 * @syscap SystemCapability.ArkUI.ArkUI.Full 1949 * @since 7 1950 */ 1951 /** 1952 * Tap gesture recognition success callback. 1953 * 1954 * @param { function } event 1955 * @returns { TapGestureInterface } 1956 * @syscap SystemCapability.ArkUI.ArkUI.Full 1957 * @crossplatform 1958 * @since 10 1959 */ 1960 /** 1961 * Tap gesture recognition success callback. 1962 * 1963 * @param { function } event 1964 * @returns { TapGestureInterface } 1965 * @syscap SystemCapability.ArkUI.ArkUI.Full 1966 * @crossplatform 1967 * @atomicservice 1968 * @since 11 1969 */ 1970 onAction(event: (event: GestureEvent) => void): TapGestureInterface; 1971} 1972 1973/** 1974 * Defines LongPressGesture interface. 1975 * 1976 * @extends GestureInterface<LongPressGestureInterface> 1977 * @interface LongPressGestureInterface 1978 * @syscap SystemCapability.ArkUI.ArkUI.Full 1979 * @since 7 1980 */ 1981/** 1982 * Defines LongPressGesture interface. 1983 * 1984 * @extends GestureInterface<LongPressGestureInterface> 1985 * @interface LongPressGestureInterface 1986 * @syscap SystemCapability.ArkUI.ArkUI.Full 1987 * @crossplatform 1988 * @since 10 1989 */ 1990/** 1991 * Defines LongPressGesture interface extends GestureInterface<LongPressGestureInterface>. 1992 * 1993 * @extends GestureInterface<LongPressGestureInterface> 1994 * @interface LongPressGestureInterface 1995 * @syscap SystemCapability.ArkUI.ArkUI.Full 1996 * @crossplatform 1997 * @atomicservice 1998 * @since 11 1999 */ 2000interface LongPressGestureInterface extends GestureInterface<LongPressGestureInterface> { 2001 /** 2002 * Set the value. 2003 * fingers: Indicates the hand index that triggers the long press. 2004 * repeat: Indicates whether to trigger event callback continuously. 2005 * duration: Minimum press and hold time, in milliseconds. 2006 * 2007 * @param { object } value 2008 * @returns { LongPressGestureInterface } 2009 * @syscap SystemCapability.ArkUI.ArkUI.Full 2010 * @since 7 2011 */ 2012 /** 2013 * Set the value. 2014 * fingers: Indicates the hand index that triggers the long press. 2015 * repeat: Indicates whether to trigger event callback continuously. 2016 * duration: Minimum press and hold time, in milliseconds. 2017 * 2018 * @param { object } value 2019 * @returns { LongPressGestureInterface } 2020 * @syscap SystemCapability.ArkUI.ArkUI.Full 2021 * @crossplatform 2022 * @since 10 2023 */ 2024 /** 2025 * Set the value. 2026 * fingers: Indicates the hand index that triggers the long press. 2027 * repeat: Indicates whether to trigger event callback continuously. 2028 * duration: Minimum press and hold time, in milliseconds. 2029 * 2030 * @param { object } value 2031 * @returns { LongPressGestureInterface } 2032 * @syscap SystemCapability.ArkUI.ArkUI.Full 2033 * @crossplatform 2034 * @atomicservice 2035 * @since 11 2036 */ 2037 (value?: { fingers?: number; repeat?: boolean; duration?: number }): LongPressGestureInterface; 2038 2039 /** 2040 * LongPress gesture recognition success callback. 2041 * 2042 * @param { function } event 2043 * @returns { LongPressGestureInterface } 2044 * @syscap SystemCapability.ArkUI.ArkUI.Full 2045 * @since 7 2046 */ 2047 /** 2048 * LongPress gesture recognition success callback. 2049 * 2050 * @param { function } event 2051 * @returns { LongPressGestureInterface } 2052 * @syscap SystemCapability.ArkUI.ArkUI.Full 2053 * @crossplatform 2054 * @since 10 2055 */ 2056 /** 2057 * LongPress gesture recognition success callback. 2058 * 2059 * @param { function } event 2060 * @returns { LongPressGestureInterface } 2061 * @syscap SystemCapability.ArkUI.ArkUI.Full 2062 * @crossplatform 2063 * @atomicservice 2064 * @since 11 2065 */ 2066 onAction(event: (event: GestureEvent) => void): LongPressGestureInterface; 2067 2068 /** 2069 * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2070 * 2071 * @param { function } event 2072 * @returns { LongPressGestureInterface } 2073 * @syscap SystemCapability.ArkUI.ArkUI.Full 2074 * @since 7 2075 */ 2076 /** 2077 * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2078 * 2079 * @param { function } event 2080 * @returns { LongPressGestureInterface } 2081 * @syscap SystemCapability.ArkUI.ArkUI.Full 2082 * @crossplatform 2083 * @since 10 2084 */ 2085 /** 2086 * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2087 * 2088 * @param { function } event 2089 * @returns { LongPressGestureInterface } 2090 * @syscap SystemCapability.ArkUI.ArkUI.Full 2091 * @crossplatform 2092 * @atomicservice 2093 * @since 11 2094 */ 2095 onActionEnd(event: (event: GestureEvent) => void): LongPressGestureInterface; 2096 2097 /** 2098 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2099 * 2100 * @param { function } event 2101 * @returns { LongPressGestureInterface } 2102 * @syscap SystemCapability.ArkUI.ArkUI.Full 2103 * @since 7 2104 */ 2105 /** 2106 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2107 * 2108 * @param { function } event 2109 * @returns { LongPressGestureInterface } 2110 * @syscap SystemCapability.ArkUI.ArkUI.Full 2111 * @crossplatform 2112 * @since 10 2113 */ 2114 /** 2115 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2116 * 2117 * @param { function } event 2118 * @returns { LongPressGestureInterface } 2119 * @syscap SystemCapability.ArkUI.ArkUI.Full 2120 * @crossplatform 2121 * @atomicservice 2122 * @since 11 2123 */ 2124 onActionCancel(event: () => void): LongPressGestureInterface; 2125} 2126 2127/** 2128 * Defines the PanGesture options. 2129 * 2130 * @syscap SystemCapability.ArkUI.ArkUI.Full 2131 * @since 7 2132 */ 2133/** 2134 * Defines the PanGesture options. 2135 * 2136 * @syscap SystemCapability.ArkUI.ArkUI.Full 2137 * @crossplatform 2138 * @since 10 2139 */ 2140/** 2141 * Defines the PanGesture options. 2142 * 2143 * @syscap SystemCapability.ArkUI.ArkUI.Full 2144 * @crossplatform 2145 * @atomicservice 2146 * @since 11 2147 */ 2148declare class PanGestureOptions { 2149 /** 2150 * Constructor parameters. 2151 * 2152 * @param { object } value 2153 * @syscap SystemCapability.ArkUI.ArkUI.Full 2154 * @since 7 2155 */ 2156 /** 2157 * Constructor parameters. 2158 * 2159 * @param { object } value 2160 * @syscap SystemCapability.ArkUI.ArkUI.Full 2161 * @crossplatform 2162 * @since 10 2163 */ 2164 /** 2165 * Constructor parameters. 2166 * 2167 * @param { object } value 2168 * @syscap SystemCapability.ArkUI.ArkUI.Full 2169 * @crossplatform 2170 * @atomicservice 2171 * @since 11 2172 */ 2173 constructor(value?: { fingers?: number; direction?: PanDirection; distance?: number }); 2174 2175 /** 2176 * Sets the direction attribute. 2177 * 2178 * @param { PanDirection } value 2179 * @syscap SystemCapability.ArkUI.ArkUI.Full 2180 * @since 7 2181 */ 2182 /** 2183 * Sets the direction attribute. 2184 * 2185 * @param { PanDirection } value 2186 * @syscap SystemCapability.ArkUI.ArkUI.Full 2187 * @crossplatform 2188 * @since 10 2189 */ 2190 /** 2191 * Sets the direction attribute. 2192 * 2193 * @param { PanDirection } value 2194 * @syscap SystemCapability.ArkUI.ArkUI.Full 2195 * @crossplatform 2196 * @atomicservice 2197 * @since 11 2198 */ 2199 setDirection(value: PanDirection); 2200 2201 /** 2202 * Sets the setDistance attribute. 2203 * 2204 * @param { number } value 2205 * @syscap SystemCapability.ArkUI.ArkUI.Full 2206 * @since 7 2207 */ 2208 /** 2209 * Sets the setDistance attribute. 2210 * 2211 * @param { number } value 2212 * @syscap SystemCapability.ArkUI.ArkUI.Full 2213 * @crossplatform 2214 * @since 10 2215 */ 2216 /** 2217 * Sets the setDistance attribute. 2218 * 2219 * @param { number } value 2220 * @syscap SystemCapability.ArkUI.ArkUI.Full 2221 * @crossplatform 2222 * @atomicservice 2223 * @since 11 2224 */ 2225 setDistance(value: number); 2226 2227 /** 2228 * Sets the setFingers attribute. 2229 * 2230 * @param { number } value 2231 * @syscap SystemCapability.ArkUI.ArkUI.Full 2232 * @since 7 2233 */ 2234 /** 2235 * Sets the setFingers attribute. 2236 * 2237 * @param { number } value 2238 * @syscap SystemCapability.ArkUI.ArkUI.Full 2239 * @crossplatform 2240 * @since 10 2241 */ 2242 /** 2243 * Sets the setFingers attribute. 2244 * 2245 * @param { number } value 2246 * @syscap SystemCapability.ArkUI.ArkUI.Full 2247 * @crossplatform 2248 * @atomicservice 2249 * @since 11 2250 */ 2251 setFingers(value: number); 2252 2253 /** 2254 * Get the pan direction attribute. 2255 * 2256 * @returns { PanDirection } - Pan gesture direction 2257 * @syscap SystemCapability.ArkUI.ArkUI.Full 2258 * @crossplatform 2259 * @atomicservice 2260 * @since 12 2261 */ 2262 getDirection(): PanDirection; 2263} 2264 2265/** 2266 * Defines the PanGesture interface. 2267 * 2268 * @extends GestureInterface<PanGestureInterface> 2269 * @interface PanGestureInterface 2270 * @syscap SystemCapability.ArkUI.ArkUI.Full 2271 * @since 7 2272 */ 2273/** 2274 * Defines the PanGesture interface. 2275 * 2276 * @extends GestureInterface<PanGestureInterface> 2277 * @interface PanGestureInterface 2278 * @syscap SystemCapability.ArkUI.ArkUI.Full 2279 * @crossplatform 2280 * @since 10 2281 */ 2282/** 2283 * Defines PanGesture interface extends GestureInterface<PanGestureInterface>. 2284 * 2285 * @extends GestureInterface<PanGestureInterface> 2286 * @interface PanGestureInterface 2287 * @syscap SystemCapability.ArkUI.ArkUI.Full 2288 * @crossplatform 2289 * @atomicservice 2290 * @since 11 2291 */ 2292interface PanGestureInterface extends GestureInterface<PanGestureInterface> { 2293 /** 2294 * Set the value. 2295 * 2296 * @param { { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOptions } value 2297 * @returns { PanGestureInterface } 2298 * @syscap SystemCapability.ArkUI.ArkUI.Full 2299 * @since 7 2300 */ 2301 /** 2302 * Set the value. 2303 * 2304 * @param { { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOptions } value 2305 * @returns { PanGestureInterface } 2306 * @syscap SystemCapability.ArkUI.ArkUI.Full 2307 * @crossplatform 2308 * @since 10 2309 */ 2310 /** 2311 * Set the value. 2312 * 2313 * @param { { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOptions } value 2314 * @returns { PanGestureInterface } 2315 * @syscap SystemCapability.ArkUI.ArkUI.Full 2316 * @crossplatform 2317 * @atomicservice 2318 * @since 11 2319 */ 2320 (value?: { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOptions): PanGestureInterface; 2321 2322 /** 2323 * Pan gesture recognition success callback. 2324 * 2325 * @param { function } event 2326 * @returns { PanGestureInterface } 2327 * @syscap SystemCapability.ArkUI.ArkUI.Full 2328 * @since 7 2329 */ 2330 /** 2331 * Pan gesture recognition success callback. 2332 * 2333 * @param { function } event 2334 * @returns { PanGestureInterface } 2335 * @syscap SystemCapability.ArkUI.ArkUI.Full 2336 * @crossplatform 2337 * @since 10 2338 */ 2339 /** 2340 * Pan gesture recognition success callback. 2341 * 2342 * @param { function } event 2343 * @returns { PanGestureInterface } 2344 * @syscap SystemCapability.ArkUI.ArkUI.Full 2345 * @crossplatform 2346 * @atomicservice 2347 * @since 11 2348 */ 2349 onActionStart(event: (event: GestureEvent) => void): PanGestureInterface; 2350 2351 /** 2352 * Callback when the Pan gesture is moving. 2353 * 2354 * @param { function } event 2355 * @returns { PanGestureInterface } 2356 * @syscap SystemCapability.ArkUI.ArkUI.Full 2357 * @since 7 2358 */ 2359 /** 2360 * Callback when the Pan gesture is moving. 2361 * 2362 * @param { function } event 2363 * @returns { PanGestureInterface } 2364 * @syscap SystemCapability.ArkUI.ArkUI.Full 2365 * @crossplatform 2366 * @since 10 2367 */ 2368 /** 2369 * Callback when the Pan gesture is moving. 2370 * 2371 * @param { function } event 2372 * @returns { PanGestureInterface } 2373 * @syscap SystemCapability.ArkUI.ArkUI.Full 2374 * @crossplatform 2375 * @atomicservice 2376 * @since 11 2377 */ 2378 onActionUpdate(event: (event: GestureEvent) => void): PanGestureInterface; 2379 2380 /** 2381 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2382 * 2383 * @param { function } event 2384 * @returns { PanGestureInterface } 2385 * @syscap SystemCapability.ArkUI.ArkUI.Full 2386 * @since 7 2387 */ 2388 /** 2389 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2390 * 2391 * @param { function } event 2392 * @returns { PanGestureInterface } 2393 * @syscap SystemCapability.ArkUI.ArkUI.Full 2394 * @crossplatform 2395 * @since 10 2396 */ 2397 /** 2398 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2399 * 2400 * @param { function } event 2401 * @returns { PanGestureInterface } 2402 * @syscap SystemCapability.ArkUI.ArkUI.Full 2403 * @crossplatform 2404 * @atomicservice 2405 * @since 11 2406 */ 2407 onActionEnd(event: (event: GestureEvent) => void): PanGestureInterface; 2408 2409 /** 2410 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2411 * 2412 * @param { function } event 2413 * @returns { PanGestureInterface } 2414 * @syscap SystemCapability.ArkUI.ArkUI.Full 2415 * @since 7 2416 */ 2417 /** 2418 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2419 * 2420 * @param { function } event 2421 * @returns { PanGestureInterface } 2422 * @syscap SystemCapability.ArkUI.ArkUI.Full 2423 * @crossplatform 2424 * @since 10 2425 */ 2426 /** 2427 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2428 * 2429 * @param { function } event 2430 * @returns { PanGestureInterface } 2431 * @syscap SystemCapability.ArkUI.ArkUI.Full 2432 * @crossplatform 2433 * @atomicservice 2434 * @since 11 2435 */ 2436 onActionCancel(event: () => void): PanGestureInterface; 2437} 2438 2439/** 2440 * Defines the SwipeGesture interface. 2441 * 2442 * @extends GestureInterface<SwipeGestureInterface> 2443 * @interface SwipeGestureInterface 2444 * @syscap SystemCapability.ArkUI.ArkUI.Full 2445 * @since 8 2446 */ 2447/** 2448 * Defines the SwipeGesture interface. 2449 * 2450 * @extends GestureInterface<SwipeGestureInterface> 2451 * @interface SwipeGestureInterface 2452 * @syscap SystemCapability.ArkUI.ArkUI.Full 2453 * @crossplatform 2454 * @since 10 2455 */ 2456/** 2457 * Defines SwipeGesture interface extends GestureInterface<SwipeGestureInterface>. 2458 * 2459 * @extends GestureInterface<SwipeGestureInterface> 2460 * @interface SwipeGestureInterface 2461 * @syscap SystemCapability.ArkUI.ArkUI.Full 2462 * @crossplatform 2463 * @atomicservice 2464 * @since 11 2465 */ 2466interface SwipeGestureInterface extends GestureInterface<SwipeGestureInterface> { 2467 /** 2468 * Set the value. 2469 * 2470 * @param { object } value 2471 * @returns { SwipeGestureInterface } 2472 * @syscap SystemCapability.ArkUI.ArkUI.Full 2473 * @since 8 2474 */ 2475 /** 2476 * Set the value. 2477 * 2478 * @param { object } value 2479 * @returns { SwipeGestureInterface } 2480 * @syscap SystemCapability.ArkUI.ArkUI.Full 2481 * @crossplatform 2482 * @since 10 2483 */ 2484 /** 2485 * Set the value. 2486 * 2487 * @param { object } value 2488 * @returns { SwipeGestureInterface } 2489 * @syscap SystemCapability.ArkUI.ArkUI.Full 2490 * @crossplatform 2491 * @atomicservice 2492 * @since 11 2493 */ 2494 (value?: { fingers?: number; direction?: SwipeDirection; speed?: number }): SwipeGestureInterface; 2495 2496 /** 2497 * Slide gesture recognition success callback. 2498 * 2499 * @param { function } event 2500 * @returns { SwipeGestureInterface } 2501 * @syscap SystemCapability.ArkUI.ArkUI.Full 2502 * @since 8 2503 */ 2504 /** 2505 * Slide gesture recognition success callback. 2506 * 2507 * @param { function } event 2508 * @returns { SwipeGestureInterface } 2509 * @syscap SystemCapability.ArkUI.ArkUI.Full 2510 * @crossplatform 2511 * @since 10 2512 */ 2513 /** 2514 * Slide gesture recognition success callback. 2515 * 2516 * @param { function } event 2517 * @returns { SwipeGestureInterface } 2518 * @syscap SystemCapability.ArkUI.ArkUI.Full 2519 * @crossplatform 2520 * @atomicservice 2521 * @since 11 2522 */ 2523 onAction(event: (event: GestureEvent) => void): SwipeGestureInterface; 2524} 2525 2526/** 2527 * Defines the PinchGesture interface. 2528 * 2529 * @extends GestureInterface<PinchGestureInterface> 2530 * @interface PinchGestureInterface 2531 * @syscap SystemCapability.ArkUI.ArkUI.Full 2532 * @since 7 2533 */ 2534/** 2535 * Defines the PinchGesture interface. 2536 * 2537 * @extends GestureInterface<PinchGestureInterface> 2538 * @interface PinchGestureInterface 2539 * @syscap SystemCapability.ArkUI.ArkUI.Full 2540 * @crossplatform 2541 * @since 10 2542 */ 2543/** 2544 * Defines PinchGesture interface extends GestureInterface<PinchGestureInterface>. 2545 * 2546 * @extends GestureInterface<PinchGestureInterface> 2547 * @interface PinchGestureInterface 2548 * @syscap SystemCapability.ArkUI.ArkUI.Full 2549 * @crossplatform 2550 * @atomicservice 2551 * @since 11 2552 */ 2553interface PinchGestureInterface extends GestureInterface<PinchGestureInterface> { 2554 /** 2555 * Set the value. 2556 * 2557 * @param { object } value 2558 * @returns { PinchGestureInterface } 2559 * @syscap SystemCapability.ArkUI.ArkUI.Full 2560 * @since 7 2561 */ 2562 /** 2563 * Set the value. 2564 * 2565 * @param { object } value 2566 * @returns { PinchGestureInterface } 2567 * @syscap SystemCapability.ArkUI.ArkUI.Full 2568 * @crossplatform 2569 * @since 10 2570 */ 2571 /** 2572 * Set the value. 2573 * 2574 * @param { object } value 2575 * @returns { PinchGestureInterface } 2576 * @syscap SystemCapability.ArkUI.ArkUI.Full 2577 * @crossplatform 2578 * @atomicservice 2579 * @since 11 2580 */ 2581 (value?: { fingers?: number; distance?: number }): PinchGestureInterface; 2582 2583 /** 2584 * Pan gesture recognition success callback. 2585 * 2586 * @param { function } event 2587 * @returns { PinchGestureInterface } 2588 * @syscap SystemCapability.ArkUI.ArkUI.Full 2589 * @since 7 2590 */ 2591 /** 2592 * Pan gesture recognition success callback. 2593 * 2594 * @param { function } event 2595 * @returns { PinchGestureInterface } 2596 * @syscap SystemCapability.ArkUI.ArkUI.Full 2597 * @crossplatform 2598 * @since 10 2599 */ 2600 /** 2601 * Pan gesture recognition success callback. 2602 * 2603 * @param { function } event 2604 * @returns { PinchGestureInterface } 2605 * @syscap SystemCapability.ArkUI.ArkUI.Full 2606 * @crossplatform 2607 * @atomicservice 2608 * @since 11 2609 */ 2610 onActionStart(event: (event: GestureEvent) => void): PinchGestureInterface; 2611 2612 /** 2613 * Callback when the Pan gesture is moving. 2614 * 2615 * @param { function } event 2616 * @returns { PinchGestureInterface } 2617 * @syscap SystemCapability.ArkUI.ArkUI.Full 2618 * @since 7 2619 */ 2620 /** 2621 * Callback when the Pan gesture is moving. 2622 * 2623 * @param { function } event 2624 * @returns { PinchGestureInterface } 2625 * @syscap SystemCapability.ArkUI.ArkUI.Full 2626 * @crossplatform 2627 * @since 10 2628 */ 2629 /** 2630 * Callback when the Pan gesture is moving. 2631 * 2632 * @param { function } event 2633 * @returns { PinchGestureInterface } 2634 * @syscap SystemCapability.ArkUI.ArkUI.Full 2635 * @crossplatform 2636 * @atomicservice 2637 * @since 11 2638 */ 2639 onActionUpdate(event: (event: GestureEvent) => void): PinchGestureInterface; 2640 2641 /** 2642 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2643 * 2644 * @param { function } event 2645 * @returns { PinchGestureInterface } 2646 * @syscap SystemCapability.ArkUI.ArkUI.Full 2647 * @since 7 2648 */ 2649 /** 2650 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2651 * 2652 * @param { function } event 2653 * @returns { PinchGestureInterface } 2654 * @syscap SystemCapability.ArkUI.ArkUI.Full 2655 * @crossplatform 2656 * @since 10 2657 */ 2658 /** 2659 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2660 * 2661 * @param { function } event 2662 * @returns { PinchGestureInterface } 2663 * @syscap SystemCapability.ArkUI.ArkUI.Full 2664 * @crossplatform 2665 * @atomicservice 2666 * @since 11 2667 */ 2668 onActionEnd(event: (event: GestureEvent) => void): PinchGestureInterface; 2669 2670 /** 2671 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2672 * 2673 * @param { function } event 2674 * @returns { PinchGestureInterface } 2675 * @syscap SystemCapability.ArkUI.ArkUI.Full 2676 * @since 7 2677 */ 2678 /** 2679 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2680 * 2681 * @param { function } event 2682 * @returns { PinchGestureInterface } 2683 * @syscap SystemCapability.ArkUI.ArkUI.Full 2684 * @crossplatform 2685 * @since 10 2686 */ 2687 /** 2688 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2689 * 2690 * @param { function } event 2691 * @returns { PinchGestureInterface } 2692 * @syscap SystemCapability.ArkUI.ArkUI.Full 2693 * @crossplatform 2694 * @atomicservice 2695 * @since 11 2696 */ 2697 onActionCancel(event: () => void): PinchGestureInterface; 2698} 2699 2700/** 2701 * Defines the RotationGesture interface. 2702 * 2703 * @extends GestureInterface<RotationGestureInterface> 2704 * @interface RotationGestureInterface 2705 * @syscap SystemCapability.ArkUI.ArkUI.Full 2706 * @since 7 2707 */ 2708/** 2709 * Defines the RotationGesture interface. 2710 * 2711 * @extends GestureInterface<RotationGestureInterface> 2712 * @interface RotationGestureInterface 2713 * @syscap SystemCapability.ArkUI.ArkUI.Full 2714 * @crossplatform 2715 * @since 10 2716 */ 2717/** 2718 * Defines RotationGesture interface extends GestureInterface<RotationGestureInterface>. 2719 * 2720 * @extends GestureInterface<RotationGestureInterface> 2721 * @interface RotationGestureInterface 2722 * @syscap SystemCapability.ArkUI.ArkUI.Full 2723 * @crossplatform 2724 * @atomicservice 2725 * @since 11 2726 */ 2727interface RotationGestureInterface extends GestureInterface<RotationGestureInterface> { 2728 /** 2729 * Set the value. 2730 * 2731 * @param { object } value 2732 * @returns { RotationGestureInterface } 2733 * @syscap SystemCapability.ArkUI.ArkUI.Full 2734 * @since 7 2735 */ 2736 /** 2737 * Set the value. 2738 * 2739 * @param { object } value 2740 * @returns { RotationGestureInterface } 2741 * @syscap SystemCapability.ArkUI.ArkUI.Full 2742 * @crossplatform 2743 * @since 10 2744 */ 2745 /** 2746 * Set the value. 2747 * 2748 * @param { object } value 2749 * @returns { RotationGestureInterface } 2750 * @syscap SystemCapability.ArkUI.ArkUI.Full 2751 * @crossplatform 2752 * @atomicservice 2753 * @since 11 2754 */ 2755 (value?: { fingers?: number; angle?: number }): RotationGestureInterface; 2756 2757 /** 2758 * Pan gesture recognition success callback. 2759 * 2760 * @param { function } event 2761 * @returns { RotationGestureInterface } 2762 * @syscap SystemCapability.ArkUI.ArkUI.Full 2763 * @since 7 2764 */ 2765 /** 2766 * Pan gesture recognition success callback. 2767 * 2768 * @param { function } event 2769 * @returns { RotationGestureInterface } 2770 * @syscap SystemCapability.ArkUI.ArkUI.Full 2771 * @crossplatform 2772 * @since 10 2773 */ 2774 /** 2775 * Pan gesture recognition success callback. 2776 * 2777 * @param { function } event 2778 * @returns { RotationGestureInterface } 2779 * @syscap SystemCapability.ArkUI.ArkUI.Full 2780 * @crossplatform 2781 * @atomicservice 2782 * @since 11 2783 */ 2784 onActionStart(event: (event: GestureEvent) => void): RotationGestureInterface; 2785 2786 /** 2787 * Callback when the Pan gesture is moving. 2788 * 2789 * @param { function } event 2790 * @returns { RotationGestureInterface } 2791 * @syscap SystemCapability.ArkUI.ArkUI.Full 2792 * @since 7 2793 */ 2794 /** 2795 * Callback when the Pan gesture is moving. 2796 * 2797 * @param { function } event 2798 * @returns { RotationGestureInterface } 2799 * @syscap SystemCapability.ArkUI.ArkUI.Full 2800 * @crossplatform 2801 * @since 10 2802 */ 2803 /** 2804 * Callback when the Pan gesture is moving. 2805 * 2806 * @param { function } event 2807 * @returns { RotationGestureInterface } 2808 * @syscap SystemCapability.ArkUI.ArkUI.Full 2809 * @crossplatform 2810 * @atomicservice 2811 * @since 11 2812 */ 2813 onActionUpdate(event: (event: GestureEvent) => void): RotationGestureInterface; 2814 2815 /** 2816 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2817 * 2818 * @param { function } event 2819 * @returns { RotationGestureInterface } 2820 * @syscap SystemCapability.ArkUI.ArkUI.Full 2821 * @since 7 2822 */ 2823 /** 2824 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2825 * 2826 * @param { function } event 2827 * @returns { RotationGestureInterface } 2828 * @syscap SystemCapability.ArkUI.ArkUI.Full 2829 * @crossplatform 2830 * @since 10 2831 */ 2832 /** 2833 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2834 * 2835 * @param { function } event 2836 * @returns { RotationGestureInterface } 2837 * @syscap SystemCapability.ArkUI.ArkUI.Full 2838 * @crossplatform 2839 * @atomicservice 2840 * @since 11 2841 */ 2842 onActionEnd(event: (event: GestureEvent) => void): RotationGestureInterface; 2843 2844 /** 2845 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2846 * 2847 * @param { function } event 2848 * @returns { RotationGestureInterface } 2849 * @syscap SystemCapability.ArkUI.ArkUI.Full 2850 * @since 7 2851 */ 2852 /** 2853 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2854 * 2855 * @param { function } event 2856 * @returns { RotationGestureInterface } 2857 * @syscap SystemCapability.ArkUI.ArkUI.Full 2858 * @crossplatform 2859 * @since 10 2860 */ 2861 /** 2862 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2863 * 2864 * @param { function } event 2865 * @returns { RotationGestureInterface } 2866 * @syscap SystemCapability.ArkUI.ArkUI.Full 2867 * @crossplatform 2868 * @atomicservice 2869 * @since 11 2870 */ 2871 onActionCancel(event: () => void): RotationGestureInterface; 2872} 2873 2874/** 2875 * Defines the GestureGroup interface. 2876 * 2877 * @interface GestureGroupInterface 2878 * @syscap SystemCapability.ArkUI.ArkUI.Full 2879 * @since 7 2880 */ 2881/** 2882 * Defines the GestureGroup interface. 2883 * 2884 * @interface GestureGroupInterface 2885 * @syscap SystemCapability.ArkUI.ArkUI.Full 2886 * @crossplatform 2887 * @since 10 2888 */ 2889/** 2890 * Defines the GestureGroup interface. 2891 * 2892 * @interface GestureGroupInterface 2893 * @syscap SystemCapability.ArkUI.ArkUI.Full 2894 * @crossplatform 2895 * @atomicservice 2896 * @since 11 2897 */ 2898interface GestureGroupInterface { 2899 /** 2900 * Return to Obtain GestureGroup. 2901 * 2902 * @param { GestureMode } mode 2903 * @param { GestureType[] } gesture 2904 * @returns { GestureGroupInterface } 2905 * @syscap SystemCapability.ArkUI.ArkUI.Full 2906 * @since 7 2907 */ 2908 /** 2909 * Return to Obtain GestureGroup. 2910 * 2911 * @param { GestureMode } mode 2912 * @param { GestureType[] } gesture 2913 * @returns { GestureGroupInterface } 2914 * @syscap SystemCapability.ArkUI.ArkUI.Full 2915 * @crossplatform 2916 * @since 10 2917 */ 2918 /** 2919 * Return to Obtain GestureGroup. 2920 * 2921 * @param { GestureMode } mode 2922 * @param { GestureType[] } gesture 2923 * @returns { GestureGroupInterface } 2924 * @syscap SystemCapability.ArkUI.ArkUI.Full 2925 * @crossplatform 2926 * @atomicservice 2927 * @since 11 2928 */ 2929 (mode: GestureMode, ...gesture: GestureType[]): GestureGroupInterface; 2930 2931 /** 2932 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2933 * 2934 * @param { function } event 2935 * @returns { GestureGroupInterface } 2936 * @syscap SystemCapability.ArkUI.ArkUI.Full 2937 * @since 7 2938 */ 2939 /** 2940 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2941 * 2942 * @param { function } event 2943 * @returns { GestureGroupInterface } 2944 * @syscap SystemCapability.ArkUI.ArkUI.Full 2945 * @crossplatform 2946 * @since 10 2947 */ 2948 /** 2949 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2950 * 2951 * @param { function } event 2952 * @returns { GestureGroupInterface } 2953 * @syscap SystemCapability.ArkUI.ArkUI.Full 2954 * @crossplatform 2955 * @atomicservice 2956 * @since 11 2957 */ 2958 onCancel(event: () => void): GestureGroupInterface; 2959} 2960 2961/** 2962 * Defines TapGesture Component. 2963 * 2964 * @syscap SystemCapability.ArkUI.ArkUI.Full 2965 * @since 7 2966 */ 2967/** 2968 * Defines TapGesture Component. 2969 * 2970 * @syscap SystemCapability.ArkUI.ArkUI.Full 2971 * @crossplatform 2972 * @since 10 2973 */ 2974/** 2975 * Defines TapGesture Component. 2976 * 2977 * @syscap SystemCapability.ArkUI.ArkUI.Full 2978 * @crossplatform 2979 * @atomicservice 2980 * @since 11 2981 */ 2982declare const TapGesture: TapGestureInterface; 2983 2984/** 2985 * Defines LongPressGesture Component. 2986 * 2987 * @syscap SystemCapability.ArkUI.ArkUI.Full 2988 * @since 7 2989 */ 2990/** 2991 * Defines LongPressGesture Component. 2992 * 2993 * @syscap SystemCapability.ArkUI.ArkUI.Full 2994 * @crossplatform 2995 * @since 10 2996 */ 2997/** 2998 * Defines LongPressGesture Component. 2999 * 3000 * @syscap SystemCapability.ArkUI.ArkUI.Full 3001 * @crossplatform 3002 * @atomicservice 3003 * @since 11 3004 */ 3005declare const LongPressGesture: LongPressGestureInterface; 3006 3007/** 3008 * Defines PanGesture Component. 3009 * 3010 * @syscap SystemCapability.ArkUI.ArkUI.Full 3011 * @since 7 3012 */ 3013/** 3014 * Defines PanGesture Component. 3015 * 3016 * @syscap SystemCapability.ArkUI.ArkUI.Full 3017 * @crossplatform 3018 * @since 10 3019 */ 3020/** 3021 * Defines PanGesture Component. 3022 * 3023 * @syscap SystemCapability.ArkUI.ArkUI.Full 3024 * @crossplatform 3025 * @atomicservice 3026 * @since 11 3027 */ 3028declare const PanGesture: PanGestureInterface; 3029 3030/** 3031 * Defines SwipeGesture Component. 3032 * 3033 * @syscap SystemCapability.ArkUI.ArkUI.Full 3034 * @since 7 3035 */ 3036/** 3037 * Defines SwipeGesture Component. 3038 * 3039 * @syscap SystemCapability.ArkUI.ArkUI.Full 3040 * @crossplatform 3041 * @since 10 3042 */ 3043/** 3044 * Defines SwipeGesture Component. 3045 * 3046 * @syscap SystemCapability.ArkUI.ArkUI.Full 3047 * @crossplatform 3048 * @atomicservice 3049 * @since 11 3050 */ 3051declare const SwipeGesture: SwipeGestureInterface; 3052 3053/** 3054 * Defines PinchGesture Component. 3055 * 3056 * @syscap SystemCapability.ArkUI.ArkUI.Full 3057 * @since 7 3058 */ 3059/** 3060 * Defines PinchGesture Component. 3061 * 3062 * @syscap SystemCapability.ArkUI.ArkUI.Full 3063 * @crossplatform 3064 * @since 10 3065 */ 3066/** 3067 * Defines PinchGesture Component. 3068 * 3069 * @syscap SystemCapability.ArkUI.ArkUI.Full 3070 * @crossplatform 3071 * @atomicservice 3072 * @since 11 3073 */ 3074declare const PinchGesture: PinchGestureInterface; 3075 3076/** 3077 * Defines RotationGesture Component. 3078 * 3079 * @syscap SystemCapability.ArkUI.ArkUI.Full 3080 * @since 7 3081 */ 3082/** 3083 * Defines RotationGesture Component. 3084 * 3085 * @syscap SystemCapability.ArkUI.ArkUI.Full 3086 * @crossplatform 3087 * @since 10 3088 */ 3089/** 3090 * Defines RotationGesture Component. 3091 * 3092 * @syscap SystemCapability.ArkUI.ArkUI.Full 3093 * @crossplatform 3094 * @atomicservice 3095 * @since 11 3096 */ 3097declare const RotationGesture: RotationGestureInterface; 3098 3099/** 3100 * Defines GestureGroup Component. 3101 * 3102 * @syscap SystemCapability.ArkUI.ArkUI.Full 3103 * @since 7 3104 */ 3105/** 3106 * Defines GestureGroup Component. 3107 * 3108 * @syscap SystemCapability.ArkUI.ArkUI.Full 3109 * @crossplatform 3110 * @since 10 3111 */ 3112/** 3113 * Defines GestureGroup Component. 3114 * 3115 * @syscap SystemCapability.ArkUI.ArkUI.Full 3116 * @crossplatform 3117 * @atomicservice 3118 * @since 11 3119 */ 3120declare const GestureGroup: GestureGroupInterface; 3121 3122/** 3123 * Defines the gesture handler. 3124 * 3125 * @implements GestureInterface<T> 3126 * @syscap SystemCapability.ArkUI.ArkUI.Full 3127 * @crossplatform 3128 * @atomicservice 3129 * @since 12 3130 */ 3131declare class GestureHandler<T> implements GestureInterface<T> { 3132 /** 3133 * Set the GestureHandler's tag. 3134 * 3135 * @param { string } tag 3136 * @returns { T } 3137 * @syscap SystemCapability.ArkUI.ArkUI.Full 3138 * @crossplatform 3139 * @atomicservice 3140 * @since 12 3141 */ 3142 tag(tag: string): T; 3143 3144 /** 3145 * Input source type for gesture response. 3146 * 3147 * @param { Array<SourceTool> } types - indicate the allowed input source for gesture to response 3148 * @returns { T } 3149 * @syscap SystemCapability.ArkUI.ArkUI.Full 3150 * @crossplatform 3151 * @atomicservice 3152 * @since 14 3153 */ 3154 allowedTypes(types: Array<SourceTool>): T; 3155} 3156 3157/** 3158 * Defines the TapGestureHandler options. 3159 * 3160 * @interface TapGestureHandlerOptions 3161 * @syscap SystemCapability.ArkUI.ArkUI.Full 3162 * @crossplatform 3163 * @atomicservice 3164 * @since 12 3165 */ 3166interface TapGestureHandlerOptions { 3167 /** 3168 * Indicates the number of consecutive clicks recognized. If the value is less than 1, the default value is used. 3169 * The default value is 1. 3170 * 3171 * @type { ?number } 3172 * @syscap SystemCapability.ArkUI.ArkUI.Full 3173 * @crossplatform 3174 * @atomicservice 3175 * @since 12 3176 */ 3177 count?: number; 3178 /** 3179 * Indicates the hand index that triggers the click. If the value is less than 1, the default value is used. 3180 * The default value is 1. 3181 * 3182 * @type { ?number } 3183 * @syscap SystemCapability.ArkUI.ArkUI.Full 3184 * @crossplatform 3185 * @atomicservice 3186 * @since 12 3187 */ 3188 fingers?: number; 3189} 3190 3191/** 3192 * Defines the TapGesture handler. 3193 * 3194 * @extends GestureHandler<TapGestureHandler> 3195 * @syscap SystemCapability.ArkUI.ArkUI.Full 3196 * @crossplatform 3197 * @atomicservice 3198 * @since 12 3199 */ 3200declare class TapGestureHandler extends GestureHandler<TapGestureHandler> { 3201 /** 3202 * Constructor parameters. 3203 * 3204 * @param { TapGestureHandlerOptions } options 3205 * @syscap SystemCapability.ArkUI.ArkUI.Full 3206 * @crossplatform 3207 * @atomicservice 3208 * @since 12 3209 */ 3210 constructor(options?: TapGestureHandlerOptions); 3211 /** 3212 * Tap gesture recognition success callback. 3213 * 3214 * @param { Callback<GestureEvent> } event 3215 * @returns { TapGestureHandler } 3216 * @syscap SystemCapability.ArkUI.ArkUI.Full 3217 * @crossplatform 3218 * @atomicservice 3219 * @since 12 3220 */ 3221 onAction(event: Callback<GestureEvent>): TapGestureHandler; 3222} 3223 3224/** 3225 * Defines the LongPressGestureHandler options. 3226 * 3227 * @interface LongPressGestureHandlerOptions 3228 * @syscap SystemCapability.ArkUI.ArkUI.Full 3229 * @crossplatform 3230 * @atomicservice 3231 * @since 12 3232 */ 3233interface LongPressGestureHandlerOptions { 3234 /** 3235 * Indicates the hand index that triggers the long press. If the value is less than 1, the default value is used. 3236 * The default value is 1. 3237 * 3238 * @type { ?number } 3239 * @syscap SystemCapability.ArkUI.ArkUI.Full 3240 * @crossplatform 3241 * @atomicservice 3242 * @since 12 3243 */ 3244 fingers?: number; 3245 /** 3246 * Indicates whether an event is triggered repeatedly. 3247 * The default value is false. 3248 * 3249 * @type { ?boolean } 3250 * @syscap SystemCapability.ArkUI.ArkUI.Full 3251 * @crossplatform 3252 * @atomicservice 3253 * @since 12 3254 */ 3255 repeat?: boolean; 3256 /** 3257 * Indicates minimum press and hold time, in milliseconds. 3258 * The default value is 500ms. 3259 * 3260 * @type { ?number } 3261 * @syscap SystemCapability.ArkUI.ArkUI.Full 3262 * @crossplatform 3263 * @atomicservice 3264 * @since 12 3265 */ 3266 duration?: number; 3267} 3268 3269/** 3270 * Defines the LongPressGesture handler. 3271 * 3272 * @extends GestureHandler<LongPressGestureHandler> 3273 * @syscap SystemCapability.ArkUI.ArkUI.Full 3274 * @crossplatform 3275 * @atomicservice 3276 * @since 12 3277 */ 3278declare class LongPressGestureHandler extends GestureHandler<LongPressGestureHandler> { 3279 /** 3280 * Constructor parameters. 3281 * 3282 * @param { LongPressGestureHandlerOptions } options 3283 * @syscap SystemCapability.ArkUI.ArkUI.Full 3284 * @crossplatform 3285 * @atomicservice 3286 * @since 12 3287 */ 3288 constructor(options?: LongPressGestureHandlerOptions); 3289 /** 3290 * LongPress gesture recognition success callback. 3291 * 3292 * @param { Callback<GestureEvent> } event 3293 * @returns { LongPressGestureHandler } 3294 * @syscap SystemCapability.ArkUI.ArkUI.Full 3295 * @crossplatform 3296 * @atomicservice 3297 * @since 12 3298 */ 3299 onAction(event: Callback<GestureEvent>): LongPressGestureHandler; 3300 /** 3301 * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3302 * 3303 * @param { Callback<GestureEvent> } event 3304 * @returns { LongPressGestureHandler } 3305 * @syscap SystemCapability.ArkUI.ArkUI.Full 3306 * @crossplatform 3307 * @atomicservice 3308 * @since 12 3309 */ 3310 onActionEnd(event: Callback<GestureEvent>): LongPressGestureHandler; 3311 /** 3312 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3313 * 3314 * @param { Callback<void> } event 3315 * @returns { LongPressGestureHandler } 3316 * @syscap SystemCapability.ArkUI.ArkUI.Full 3317 * @crossplatform 3318 * @atomicservice 3319 * @since 12 3320 */ 3321 onActionCancel(event: Callback<void>): LongPressGestureHandler; 3322} 3323 3324/** 3325 * Defines the PanGestureHandler options. 3326 * 3327 * @interface PanGestureHandlerOptions 3328 * @syscap SystemCapability.ArkUI.ArkUI.Full 3329 * @crossplatform 3330 * @atomicservice 3331 * @since 12 3332 */ 3333interface PanGestureHandlerOptions { 3334 /** 3335 * Indicates the hand index that triggers the pan. If the value is less than 1, the default value is used. 3336 * The default value is 1. 3337 * 3338 * @type { ?number } 3339 * @syscap SystemCapability.ArkUI.ArkUI.Full 3340 * @crossplatform 3341 * @atomicservice 3342 * @since 12 3343 */ 3344 fingers?: number; 3345 /** 3346 * Indicates the move direction of the pan gesture. 3347 * The default value is PanDirection.All. 3348 * 3349 * @type { ?PanDirection } 3350 * @syscap SystemCapability.ArkUI.ArkUI.Full 3351 * @crossplatform 3352 * @atomicservice 3353 * @since 12 3354 */ 3355 direction?: PanDirection; 3356 /** 3357 * Indicates minimum move distance. 3358 * The default value is 5vp. 3359 * 3360 * @type { ?number } 3361 * @syscap SystemCapability.ArkUI.ArkUI.Full 3362 * @crossplatform 3363 * @atomicservice 3364 * @since 12 3365 */ 3366 distance?: number; 3367} 3368 3369/** 3370 * Defines the PanGesture handler. 3371 * 3372 * @extends GestureHandler<PanGestureHandler> 3373 * @syscap SystemCapability.ArkUI.ArkUI.Full 3374 * @crossplatform 3375 * @atomicservice 3376 * @since 12 3377 */ 3378declare class PanGestureHandler extends GestureHandler<PanGestureHandler> { 3379 /** 3380 * Constructor parameters. 3381 * 3382 * @param { PanGestureHandlerOptions } options 3383 * @syscap SystemCapability.ArkUI.ArkUI.Full 3384 * @crossplatform 3385 * @atomicservice 3386 * @since 12 3387 */ 3388 constructor(options?: PanGestureHandlerOptions); 3389 /** 3390 * Pan gesture recognition success callback. 3391 * 3392 * @param { Callback<GestureEvent> } event 3393 * @returns { PanGestureHandler } 3394 * @syscap SystemCapability.ArkUI.ArkUI.Full 3395 * @crossplatform 3396 * @atomicservice 3397 * @since 12 3398 */ 3399 onActionStart(event: Callback<GestureEvent>): PanGestureHandler; 3400 /** 3401 * Callback when the Pan gesture is moving. 3402 * 3403 * @param { Callback<GestureEvent> } event 3404 * @returns { PanGestureHandler } 3405 * @syscap SystemCapability.ArkUI.ArkUI.Full 3406 * @crossplatform 3407 * @atomicservice 3408 * @since 12 3409 */ 3410 onActionUpdate(event: Callback<GestureEvent>): PanGestureHandler; 3411 /** 3412 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3413 * 3414 * @param { Callback<GestureEvent> } event 3415 * @returns { PanGestureHandler } 3416 * @syscap SystemCapability.ArkUI.ArkUI.Full 3417 * @crossplatform 3418 * @atomicservice 3419 * @since 12 3420 */ 3421 onActionEnd(event: Callback<GestureEvent>): PanGestureHandler; 3422 /** 3423 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3424 * 3425 * @param { Callback<void> } event 3426 * @returns { PanGestureHandler } 3427 * @syscap SystemCapability.ArkUI.ArkUI.Full 3428 * @crossplatform 3429 * @atomicservice 3430 * @since 12 3431 */ 3432 onActionCancel(event: Callback<void>): PanGestureHandler; 3433} 3434 3435/** 3436 * Defines the SwipeGestureHandler options. 3437 * 3438 * @interface SwipeGestureHandlerOptions 3439 * @syscap SystemCapability.ArkUI.ArkUI.Full 3440 * @crossplatform 3441 * @atomicservice 3442 * @since 12 3443 */ 3444interface SwipeGestureHandlerOptions { 3445 /** 3446 * Indicates the hand index that triggers the swipe. If the value is less than 1, the default value is used. 3447 * The default value is 1. 3448 * 3449 * @type { ?number } 3450 * @syscap SystemCapability.ArkUI.ArkUI.Full 3451 * @crossplatform 3452 * @atomicservice 3453 * @since 12 3454 */ 3455 fingers?: number; 3456 /** 3457 * Indicates the move direction of the swipe gesture. 3458 * The default value is SwipeDirection.All. 3459 * 3460 * @type { ?SwipeDirection } 3461 * @syscap SystemCapability.ArkUI.ArkUI.Full 3462 * @crossplatform 3463 * @atomicservice 3464 * @since 12 3465 */ 3466 direction?: SwipeDirection; 3467 /** 3468 * Indicates minimum move speed. 3469 * The default value is 100vp/s. 3470 * 3471 * @type { ?number } 3472 * @syscap SystemCapability.ArkUI.ArkUI.Full 3473 * @crossplatform 3474 * @atomicservice 3475 * @since 12 3476 */ 3477 speed?: number; 3478} 3479 3480/** 3481 * Defines the SwipeGesture handler. 3482 * 3483 * @extends GestureHandler<SwipeGestureHandler> 3484 * @syscap SystemCapability.ArkUI.ArkUI.Full 3485 * @crossplatform 3486 * @atomicservice 3487 * @since 12 3488 */ 3489declare class SwipeGestureHandler extends GestureHandler<SwipeGestureHandler> { 3490 /** 3491 * Constructor parameters. 3492 * 3493 * @param { SwipeGestureHandlerOptions } options 3494 * @syscap SystemCapability.ArkUI.ArkUI.Full 3495 * @crossplatform 3496 * @atomicservice 3497 * @since 12 3498 */ 3499 constructor(options?: SwipeGestureHandlerOptions); 3500 /** 3501 * Swipe gesture recognition success callback. 3502 * 3503 * @param { Callback<GestureEvent> } event 3504 * @returns { SwipeGestureHandler } 3505 * @syscap SystemCapability.ArkUI.ArkUI.Full 3506 * @crossplatform 3507 * @atomicservice 3508 * @since 12 3509 */ 3510 onAction(event: Callback<GestureEvent>): SwipeGestureHandler; 3511} 3512 3513/** 3514 * Defines the PinchGestureHandler options. 3515 * 3516 * @interface PinchGestureHandlerOptions 3517 * @syscap SystemCapability.ArkUI.ArkUI.Full 3518 * @crossplatform 3519 * @atomicservice 3520 * @since 12 3521 */ 3522interface PinchGestureHandlerOptions { 3523 /** 3524 * Indicates the hand index that triggers the pinch. If the value is less than 1, the default value is used. 3525 * The default value is 1. 3526 * 3527 * @type { ?number } 3528 * @syscap SystemCapability.ArkUI.ArkUI.Full 3529 * @crossplatform 3530 * @atomicservice 3531 * @since 12 3532 */ 3533 fingers?: number; 3534 /** 3535 * Indicates minimum pinch move distance. 3536 * The default value is 5vp. 3537 * 3538 * @type { ?number } 3539 * @syscap SystemCapability.ArkUI.ArkUI.Full 3540 * @crossplatform 3541 * @atomicservice 3542 * @since 12 3543 */ 3544 distance?: number; 3545} 3546 3547/** 3548 * Defines the PinchGesture handler. 3549 * 3550 * @extends GestureHandler<PinchGestureHandler> 3551 * @syscap SystemCapability.ArkUI.ArkUI.Full 3552 * @crossplatform 3553 * @atomicservice 3554 * @since 12 3555 */ 3556declare class PinchGestureHandler extends GestureHandler<PinchGestureHandler> { 3557 /** 3558 * Constructor parameters. 3559 * 3560 * @param { PinchGestureHandlerOptions } options 3561 * @syscap SystemCapability.ArkUI.ArkUI.Full 3562 * @crossplatform 3563 * @atomicservice 3564 * @since 12 3565 */ 3566 constructor(options?: PinchGestureHandlerOptions); 3567 /** 3568 * Pinch gesture recognition success callback. 3569 * 3570 * @param { Callback<GestureEvent> } event 3571 * @returns { PinchGestureHandler } 3572 * @syscap SystemCapability.ArkUI.ArkUI.Full 3573 * @crossplatform 3574 * @atomicservice 3575 * @since 12 3576 */ 3577 onActionStart(event: Callback<GestureEvent>): PinchGestureHandler; 3578 /** 3579 * Callback when the Pinch gesture is moving. 3580 * 3581 * @param { Callback<GestureEvent> } event 3582 * @returns { PinchGestureHandler } 3583 * @syscap SystemCapability.ArkUI.ArkUI.Full 3584 * @crossplatform 3585 * @atomicservice 3586 * @since 12 3587 */ 3588 onActionUpdate(event: Callback<GestureEvent>): PinchGestureHandler; 3589 /** 3590 * The Pinch gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3591 * 3592 * @param { Callback<GestureEvent> } event 3593 * @returns { PinchGestureHandler } 3594 * @syscap SystemCapability.ArkUI.ArkUI.Full 3595 * @crossplatform 3596 * @atomicservice 3597 * @since 12 3598 */ 3599 onActionEnd(event: Callback<GestureEvent>): PinchGestureHandler; 3600 /** 3601 * The Pinch gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3602 * 3603 * @param { Callback<void> } event 3604 * @returns { PinchGestureHandler } 3605 * @syscap SystemCapability.ArkUI.ArkUI.Full 3606 * @crossplatform 3607 * @atomicservice 3608 * @since 12 3609 */ 3610 onActionCancel(event: Callback<void>): PinchGestureHandler; 3611} 3612 3613/** 3614 * Defines the RotationGestureHandler options. 3615 * 3616 * @interface RotationGestureHandlerOptions 3617 * @syscap SystemCapability.ArkUI.ArkUI.Full 3618 * @crossplatform 3619 * @atomicservice 3620 * @since 12 3621 */ 3622interface RotationGestureHandlerOptions { 3623 /** 3624 * Indicates the hand index that triggers the rotation. If the value is less than 1, the default value is used. 3625 * The default value is 1. 3626 * 3627 * @type { ?number } 3628 * @syscap SystemCapability.ArkUI.ArkUI.Full 3629 * @crossplatform 3630 * @atomicservice 3631 * @since 12 3632 */ 3633 fingers?: number; 3634 /** 3635 * Indicates minimum rotate angle. 3636 * The default value is 1deg. 3637 * 3638 * @type { ?number } 3639 * @syscap SystemCapability.ArkUI.ArkUI.Full 3640 * @crossplatform 3641 * @atomicservice 3642 * @since 12 3643 */ 3644 angle?: number; 3645} 3646 3647/** 3648 * Defines the RotationGesture handler. 3649 * 3650 * @extends GestureHandler<RotationGestureHandler> 3651 * @syscap SystemCapability.ArkUI.ArkUI.Full 3652 * @crossplatform 3653 * @atomicservice 3654 * @since 12 3655 */ 3656declare class RotationGestureHandler extends GestureHandler<RotationGestureHandler> { 3657 /** 3658 * Constructor parameters. 3659 * 3660 * @param { RotationGestureHandlerOptions } options 3661 * @syscap SystemCapability.ArkUI.ArkUI.Full 3662 * @crossplatform 3663 * @atomicservice 3664 * @since 12 3665 */ 3666 constructor(options?: RotationGestureHandlerOptions); 3667 /** 3668 * Rotation gesture recognition success callback. 3669 * 3670 * @param { Callback<GestureEvent> } event 3671 * @returns { RotationGestureHandler } 3672 * @syscap SystemCapability.ArkUI.ArkUI.Full 3673 * @crossplatform 3674 * @atomicservice 3675 * @since 12 3676 */ 3677 onActionStart(event: Callback<GestureEvent>): RotationGestureHandler; 3678 /** 3679 * Callback when the Rotation gesture is moving. 3680 * 3681 * @param { Callback<GestureEvent> } event 3682 * @returns { RotationGestureHandler } 3683 * @syscap SystemCapability.ArkUI.ArkUI.Full 3684 * @crossplatform 3685 * @atomicservice 3686 * @since 12 3687 */ 3688 onActionUpdate(event: Callback<GestureEvent>): RotationGestureHandler; 3689 /** 3690 * The Rotation gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3691 * 3692 * @param { Callback<GestureEvent> } event 3693 * @returns { RotationGestureHandler } 3694 * @syscap SystemCapability.ArkUI.ArkUI.Full 3695 * @crossplatform 3696 * @atomicservice 3697 * @since 12 3698 */ 3699 onActionEnd(event: Callback<GestureEvent>): RotationGestureHandler; 3700 /** 3701 * The Rotation gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3702 * 3703 * @param { Callback<void> } event 3704 * @returns { RotationGestureHandler } 3705 * @syscap SystemCapability.ArkUI.ArkUI.Full 3706 * @crossplatform 3707 * @atomicservice 3708 * @since 12 3709 */ 3710 onActionCancel(event: Callback<void>): RotationGestureHandler; 3711} 3712 3713/** 3714 * Defines the GestureGroupGestureHandler options. 3715 * 3716 * @interface GestureGroupGestureHandlerOptions 3717 * @syscap SystemCapability.ArkUI.ArkUI.Full 3718 * @crossplatform 3719 * @atomicservice 3720 * @since 12 3721 */ 3722interface GestureGroupGestureHandlerOptions { 3723 /** 3724 * Indicates the mode of gesture group. 3725 * 3726 * @type { GestureMode } 3727 * @syscap SystemCapability.ArkUI.ArkUI.Full 3728 * @crossplatform 3729 * @atomicservice 3730 * @since 12 3731 */ 3732 mode: GestureMode; 3733 /** 3734 * Indicates the gestures included in the gesture group. 3735 * 3736 * @type { GestureHandler<TapGestureHandler | LongPressGestureHandler | PanGestureHandler | SwipeGestureHandler | PinchGestureHandler | RotationGestureHandler | GestureGroupHandler>[] } 3737 * @syscap SystemCapability.ArkUI.ArkUI.Full 3738 * @crossplatform 3739 * @atomicservice 3740 * @since 12 3741 */ 3742 gestures: GestureHandler<TapGestureHandler | LongPressGestureHandler | PanGestureHandler | SwipeGestureHandler | PinchGestureHandler | RotationGestureHandler | GestureGroupHandler>[]; 3743} 3744 3745/** 3746 * Defines the GestureGroup handler. 3747 * 3748 * @extends GestureHandler<GestureGroupHandler> 3749 * @syscap SystemCapability.ArkUI.ArkUI.Full 3750 * @crossplatform 3751 * @atomicservice 3752 * @since 12 3753 */ 3754declare class GestureGroupHandler extends GestureHandler<GestureGroupHandler> { 3755 /** 3756 * Constructor parameters. 3757 * 3758 * @param { GestureGroupGestureHandlerOptions } options 3759 * @syscap SystemCapability.ArkUI.ArkUI.Full 3760 * @crossplatform 3761 * @atomicservice 3762 * @since 12 3763 */ 3764 constructor(options?: GestureGroupGestureHandlerOptions); 3765 /** 3766 * The GestureGroup gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3767 * 3768 * @param { Callback<void> } event 3769 * @returns { GestureGroupHandler } 3770 * @syscap SystemCapability.ArkUI.ArkUI.Full 3771 * @crossplatform 3772 * @atomicservice 3773 * @since 12 3774 */ 3775 onCancel(event: Callback<void>): GestureGroupHandler; 3776} 3777 3778/** 3779 * Creating an Object 3780 * 3781 * @enum { number } 3782 * @syscap SystemCapability.ArkUI.ArkUI.Full 3783 * @crossplatform 3784 * @atomicservice 3785 * @since 12 3786 */ 3787declare enum GesturePriority { 3788 /** 3789 * The normal gesture priority. 3790 * 3791 * @syscap SystemCapability.ArkUI.ArkUI.Full 3792 * @crossplatform 3793 * @atomicservice 3794 * @since 12 3795 */ 3796 NORMAL = 0, 3797 /** 3798 * The high gesture priority. 3799 * 3800 * @syscap SystemCapability.ArkUI.ArkUI.Full 3801 * @crossplatform 3802 * @atomicservice 3803 * @since 12 3804 */ 3805 PRIORITY = 1, 3806} 3807 3808/** 3809 * Creating an Object 3810 * 3811 * @enum { number } 3812 * @syscap SystemCapability.ArkUI.ArkUI.Full 3813 * @crossplatform 3814 * @atomicservice 3815 * @since 12 3816 */ 3817declare enum GestureRecognizerState { 3818 /** 3819 * Ready state. 3820 * 3821 * @syscap SystemCapability.ArkUI.ArkUI.Full 3822 * @crossplatform 3823 * @atomicservice 3824 * @since 12 3825 */ 3826 READY = 0, 3827 /** 3828 * Detecting state. 3829 * 3830 * @syscap SystemCapability.ArkUI.ArkUI.Full 3831 * @crossplatform 3832 * @atomicservice 3833 * @since 12 3834 */ 3835 DETECTING = 1, 3836 /** 3837 * Pending state. 3838 * 3839 * @syscap SystemCapability.ArkUI.ArkUI.Full 3840 * @crossplatform 3841 * @atomicservice 3842 * @since 12 3843 */ 3844 PENDING = 2, 3845 /** 3846 * Blocked state. 3847 * 3848 * @syscap SystemCapability.ArkUI.ArkUI.Full 3849 * @crossplatform 3850 * @atomicservice 3851 * @since 12 3852 */ 3853 BLOCKED = 3, 3854 /** 3855 * Successful state. 3856 * 3857 * @syscap SystemCapability.ArkUI.ArkUI.Full 3858 * @crossplatform 3859 * @atomicservice 3860 * @since 12 3861 */ 3862 SUCCESSFUL = 4, 3863 /** 3864 * Failed state. 3865 * 3866 * @syscap SystemCapability.ArkUI.ArkUI.Full 3867 * @crossplatform 3868 * @atomicservice 3869 * @since 12 3870 */ 3871 FAILED = 5, 3872} 3873 3874/** 3875 * Defines the scrollable target information. 3876 * 3877 * @extends EventTargetInfo 3878 * @syscap SystemCapability.ArkUI.ArkUI.Full 3879 * @crossplatform 3880 * @atomicservice 3881 * @since 12 3882 */ 3883declare class ScrollableTargetInfo extends EventTargetInfo { 3884 /** 3885 * Returns whether the scrollable component is at begin. 3886 * 3887 * @returns { boolean } - true is at begin, false is not at begin 3888 * @syscap SystemCapability.ArkUI.ArkUI.Full 3889 * @crossplatform 3890 * @atomicservice 3891 * @since 12 3892 */ 3893 isBegin(): boolean; 3894 /** 3895 * Returns whether the scrollable component is at end. 3896 * 3897 * @returns { boolean } - true is at end, false is not at end 3898 * @syscap SystemCapability.ArkUI.ArkUI.Full 3899 * @crossplatform 3900 * @atomicservice 3901 * @since 12 3902 */ 3903 isEnd(): boolean; 3904} 3905 3906/** 3907 * Defines the event target information. 3908 * 3909 * @syscap SystemCapability.ArkUI.ArkUI.Full 3910 * @crossplatform 3911 * @atomicservice 3912 * @since 12 3913 */ 3914declare class EventTargetInfo { 3915 /** 3916 * Returns the component's inspector id. 3917 * 3918 * @returns { string } - the inspector id of the component 3919 * @syscap SystemCapability.ArkUI.ArkUI.Full 3920 * @crossplatform 3921 * @atomicservice 3922 * @since 12 3923 */ 3924 getId(): string; 3925} 3926 3927/** 3928 * Defines the gesture recognizer. 3929 * 3930 * @syscap SystemCapability.ArkUI.ArkUI.Full 3931 * @crossplatform 3932 * @atomicservice 3933 * @since 12 3934 */ 3935declare class GestureRecognizer { 3936 /** 3937 * Returns the gesture's tag. 3938 * 3939 * @returns { string } - the gesture's tag 3940 * @syscap SystemCapability.ArkUI.ArkUI.Full 3941 * @crossplatform 3942 * @atomicservice 3943 * @since 12 3944 */ 3945 getTag(): string; 3946 /** 3947 * Returns the gesture's type. 3948 * 3949 * @returns { GestureControl.GestureType } - the gesture's type 3950 * @syscap SystemCapability.ArkUI.ArkUI.Full 3951 * @crossplatform 3952 * @atomicservice 3953 * @since 12 3954 */ 3955 getType(): GestureControl.GestureType; 3956 /** 3957 * Returns whether the gesture recognizer is built in recognizer. 3958 * 3959 * @returns { boolean } - true is built in recognizer, false is not built in recognizer 3960 * @syscap SystemCapability.ArkUI.ArkUI.Full 3961 * @crossplatform 3962 * @atomicservice 3963 * @since 12 3964 */ 3965 isBuiltIn(): boolean; 3966 /** 3967 * set the enabled state of the gesture recognizer. 3968 * 3969 * @param { boolean } isEnabled - Indicates the enabled state. 3970 * @syscap SystemCapability.ArkUI.ArkUI.Full 3971 * @crossplatform 3972 * @atomicservice 3973 * @since 12 3974 */ 3975 setEnabled(isEnabled: boolean): void; 3976 /** 3977 * Returns whether the gesture recognizer is enabled. 3978 * 3979 * @returns { boolean } - true is enabled, false is not enabled 3980 * @syscap SystemCapability.ArkUI.ArkUI.Full 3981 * @crossplatform 3982 * @atomicservice 3983 * @since 12 3984 */ 3985 isEnabled(): boolean; 3986 /** 3987 * Returns the gesture recognizer's state. 3988 * 3989 * @returns { GestureRecognizerState } - the gesture recognizer's state 3990 * @syscap SystemCapability.ArkUI.ArkUI.Full 3991 * @crossplatform 3992 * @atomicservice 3993 * @since 12 3994 */ 3995 getState(): GestureRecognizerState; 3996 /** 3997 * Returns the event target information of the component. 3998 * 3999 * @returns { EventTargetInfo } - the event target information of the component. 4000 * @syscap SystemCapability.ArkUI.ArkUI.Full 4001 * @crossplatform 4002 * @atomicservice 4003 * @since 12 4004 */ 4005 getEventTargetInfo(): EventTargetInfo; 4006 /** 4007 * Returns whether the gesture recognizer is valid. 4008 * 4009 * @returns { boolean } - true is valid, false is invalid 4010 * @syscap SystemCapability.ArkUI.ArkUI.Full 4011 * @crossplatform 4012 * @since 12 4013 */ 4014 isValid(): boolean; 4015} 4016 4017/** 4018 * Defines the gesture recognizer. 4019 * 4020 * @extends GestureRecognizer 4021 * @syscap SystemCapability.ArkUI.ArkUI.Full 4022 * @crossplatform 4023 * @atomicservice 4024 * @since 12 4025 */ 4026declare class PanRecognizer extends GestureRecognizer { 4027 /** 4028 * Returns the the pan gesture options of the recognizer. 4029 * 4030 * @returns { PanGestureOptions } - Pan gesture options 4031 * @syscap SystemCapability.ArkUI.ArkUI.Full 4032 * @crossplatform 4033 * @atomicservice 4034 * @since 12 4035 */ 4036 getPanGestureOptions(): PanGestureOptions; 4037} 4038 4039