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