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 * Input source type for gesture response. 1799 * 1800 * @param { Array<SourceTool> } types - indicate the allowed input source for gesture to response 1801 * @returns { T } 1802 * @syscap SystemCapability.ArkUI.ArkUI.Full 1803 * @crossplatform 1804 * @atomicservice 1805 * @since 14 1806 */ 1807 allowedTypes(types: Array<SourceTool>): T; 1808} 1809 1810/** 1811 * Defines TapGesture parameters. 1812 * 1813 * @interface TapGestureParameters 1814 * @syscap SystemCapability.ArkUI.ArkUI.Full 1815 * @crossplatform 1816 * @atomicservice 1817 * @since 12 1818 */ 1819declare interface TapGestureParameters { 1820 /** 1821 * Number of consecutive clicks recognized. If the value is less than 1, the default value is used. 1822 * 1823 * @type { ?number } 1824 * @syscap SystemCapability.ArkUI.ArkUI.Full 1825 * @crossplatform 1826 * @atomicservice 1827 * @since 11 1828 */ 1829 count?: number; 1830 /** 1831 * The hand index that triggers the click. If the value is less than 1, the default value is used. 1832 * 1833 * @type { ?number } 1834 * @syscap SystemCapability.ArkUI.ArkUI.Full 1835 * @crossplatform 1836 * @atomicservice 1837 * @since 11 1838 */ 1839 fingers?: number; 1840 /** 1841 * The limited move distance of click. If the value is less than 0, the default value is used. 1842 * 1843 * @type { ?number } 1844 * @syscap SystemCapability.ArkUI.ArkUI.Full 1845 * @crossplatform 1846 * @atomicservice 1847 * @since 12 1848 */ 1849 distanceThreshold?: number; 1850} 1851 1852/** 1853 * Defines TapGesture interface. 1854 * 1855 * @interface TapGestureInterface 1856 * @syscap SystemCapability.ArkUI.ArkUI.Full 1857 * @since 7 1858 */ 1859/** 1860 * Defines TapGesture interface. 1861 * 1862 * @interface TapGestureInterface 1863 * @syscap SystemCapability.ArkUI.ArkUI.Full 1864 * @crossplatform 1865 * @since 10 1866 */ 1867/** 1868 * Defines TapGesture interface extends GestureInterface<TapGestureInterface>. 1869 * 1870 * @interface TapGestureInterface 1871 * @syscap SystemCapability.ArkUI.ArkUI.Full 1872 * @crossplatform 1873 * @atomicservice 1874 * @since 11 1875 */ 1876interface TapGestureInterface extends GestureInterface<TapGestureInterface> { 1877 /** 1878 * Set the value. 1879 * count:Number of consecutive clicks recognized. If the value is less than 1, the default value is used. 1880 * fingers:The hand index that triggers the click. If the value is less than 1, the default value is used. 1881 * 1882 * @param { object } value 1883 * @returns { TapGestureInterface } 1884 * @syscap SystemCapability.ArkUI.ArkUI.Full 1885 * @since 7 1886 */ 1887 /** 1888 * Set the value. 1889 * count:Number of consecutive clicks recognized. If the value is less than 1, the default value is used. 1890 * fingers:The hand index that triggers the click. If the value is less than 1, the default value is used. 1891 * 1892 * @param { object } value 1893 * @returns { TapGestureInterface } 1894 * @syscap SystemCapability.ArkUI.ArkUI.Full 1895 * @crossplatform 1896 * @since 10 1897 */ 1898 /** 1899 * Set the value. 1900 * count:Number of consecutive clicks recognized. If the value is less than 1, the default value is used. 1901 * fingers:The hand index that triggers the click. If the value is less than 1, the default value is used. 1902 * 1903 * @param { object } value 1904 * @returns { TapGestureInterface } 1905 * @syscap SystemCapability.ArkUI.ArkUI.Full 1906 * @crossplatform 1907 * @atomicservice 1908 * @since 11 1909 */ 1910 /** 1911 * Set the value. 1912 * TapGestureParameters: The parameters of the tapGesture. 1913 * 1914 * @param { TapGestureParameters } value 1915 * @returns { TapGestureInterface } 1916 * @syscap SystemCapability.ArkUI.ArkUI.Full 1917 * @crossplatform 1918 * @atomicservice 1919 * @since 12 1920 */ 1921 (value?: TapGestureParameters): TapGestureInterface; 1922 1923 /** 1924 * Tap gesture recognition success callback. 1925 * 1926 * @param { function } event 1927 * @returns { TapGestureInterface } 1928 * @syscap SystemCapability.ArkUI.ArkUI.Full 1929 * @since 7 1930 */ 1931 /** 1932 * Tap gesture recognition success callback. 1933 * 1934 * @param { function } event 1935 * @returns { TapGestureInterface } 1936 * @syscap SystemCapability.ArkUI.ArkUI.Full 1937 * @crossplatform 1938 * @since 10 1939 */ 1940 /** 1941 * Tap gesture recognition success callback. 1942 * 1943 * @param { function } event 1944 * @returns { TapGestureInterface } 1945 * @syscap SystemCapability.ArkUI.ArkUI.Full 1946 * @crossplatform 1947 * @atomicservice 1948 * @since 11 1949 */ 1950 onAction(event: (event: GestureEvent) => void): TapGestureInterface; 1951} 1952 1953/** 1954 * Defines LongPressGesture interface. 1955 * 1956 * @interface LongPressGestureInterface 1957 * @syscap SystemCapability.ArkUI.ArkUI.Full 1958 * @since 7 1959 */ 1960/** 1961 * Defines LongPressGesture interface. 1962 * 1963 * @interface LongPressGestureInterface 1964 * @syscap SystemCapability.ArkUI.ArkUI.Full 1965 * @crossplatform 1966 * @since 10 1967 */ 1968/** 1969 * Defines LongPressGesture interface extends GestureInterface<LongPressGestureInterface>. 1970 * 1971 * @interface LongPressGestureInterface 1972 * @syscap SystemCapability.ArkUI.ArkUI.Full 1973 * @crossplatform 1974 * @atomicservice 1975 * @since 11 1976 */ 1977interface LongPressGestureInterface extends GestureInterface<LongPressGestureInterface> { 1978 /** 1979 * Set the value. 1980 * fingers: Indicates the hand index that triggers the long press. 1981 * repeat: Indicates whether to trigger event callback continuously. 1982 * duration: Minimum press and hold time, in milliseconds. 1983 * 1984 * @param { object } value 1985 * @returns { LongPressGestureInterface } 1986 * @syscap SystemCapability.ArkUI.ArkUI.Full 1987 * @since 7 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 * @since 10 2000 */ 2001 /** 2002 * Set the value. 2003 * fingers: Indicates the hand index that triggers the long press. 2004 * repeat: Indicates whether to trigger event callback continuously. 2005 * duration: Minimum press and hold time, in milliseconds. 2006 * 2007 * @param { object } value 2008 * @returns { LongPressGestureInterface } 2009 * @syscap SystemCapability.ArkUI.ArkUI.Full 2010 * @crossplatform 2011 * @atomicservice 2012 * @since 11 2013 */ 2014 (value?: { fingers?: number; repeat?: boolean; duration?: number }): LongPressGestureInterface; 2015 2016 /** 2017 * LongPress gesture recognition success callback. 2018 * 2019 * @param { function } event 2020 * @returns { LongPressGestureInterface } 2021 * @syscap SystemCapability.ArkUI.ArkUI.Full 2022 * @since 7 2023 */ 2024 /** 2025 * LongPress gesture recognition success callback. 2026 * 2027 * @param { function } event 2028 * @returns { LongPressGestureInterface } 2029 * @syscap SystemCapability.ArkUI.ArkUI.Full 2030 * @crossplatform 2031 * @since 10 2032 */ 2033 /** 2034 * LongPress gesture recognition success callback. 2035 * 2036 * @param { function } event 2037 * @returns { LongPressGestureInterface } 2038 * @syscap SystemCapability.ArkUI.ArkUI.Full 2039 * @crossplatform 2040 * @atomicservice 2041 * @since 11 2042 */ 2043 onAction(event: (event: GestureEvent) => void): LongPressGestureInterface; 2044 2045 /** 2046 * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2047 * 2048 * @param { function } event 2049 * @returns { LongPressGestureInterface } 2050 * @syscap SystemCapability.ArkUI.ArkUI.Full 2051 * @since 7 2052 */ 2053 /** 2054 * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2055 * 2056 * @param { function } event 2057 * @returns { LongPressGestureInterface } 2058 * @syscap SystemCapability.ArkUI.ArkUI.Full 2059 * @crossplatform 2060 * @since 10 2061 */ 2062 /** 2063 * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2064 * 2065 * @param { function } event 2066 * @returns { LongPressGestureInterface } 2067 * @syscap SystemCapability.ArkUI.ArkUI.Full 2068 * @crossplatform 2069 * @atomicservice 2070 * @since 11 2071 */ 2072 onActionEnd(event: (event: GestureEvent) => void): LongPressGestureInterface; 2073 2074 /** 2075 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2076 * 2077 * @param { function } event 2078 * @returns { LongPressGestureInterface } 2079 * @syscap SystemCapability.ArkUI.ArkUI.Full 2080 * @since 7 2081 */ 2082 /** 2083 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2084 * 2085 * @param { function } event 2086 * @returns { LongPressGestureInterface } 2087 * @syscap SystemCapability.ArkUI.ArkUI.Full 2088 * @crossplatform 2089 * @since 10 2090 */ 2091 /** 2092 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2093 * 2094 * @param { function } event 2095 * @returns { LongPressGestureInterface } 2096 * @syscap SystemCapability.ArkUI.ArkUI.Full 2097 * @crossplatform 2098 * @atomicservice 2099 * @since 11 2100 */ 2101 onActionCancel(event: () => void): LongPressGestureInterface; 2102} 2103 2104/** 2105 * Defines the PanGesture options. 2106 * 2107 * @syscap SystemCapability.ArkUI.ArkUI.Full 2108 * @since 7 2109 */ 2110/** 2111 * Defines the PanGesture options. 2112 * 2113 * @syscap SystemCapability.ArkUI.ArkUI.Full 2114 * @crossplatform 2115 * @since 10 2116 */ 2117/** 2118 * Defines the PanGesture options. 2119 * 2120 * @syscap SystemCapability.ArkUI.ArkUI.Full 2121 * @crossplatform 2122 * @atomicservice 2123 * @since 11 2124 */ 2125declare class PanGestureOptions { 2126 /** 2127 * Constructor parameters. 2128 * 2129 * @param { object } value 2130 * @syscap SystemCapability.ArkUI.ArkUI.Full 2131 * @since 7 2132 */ 2133 /** 2134 * Constructor parameters. 2135 * 2136 * @param { object } value 2137 * @syscap SystemCapability.ArkUI.ArkUI.Full 2138 * @crossplatform 2139 * @since 10 2140 */ 2141 /** 2142 * Constructor parameters. 2143 * 2144 * @param { object } value 2145 * @syscap SystemCapability.ArkUI.ArkUI.Full 2146 * @crossplatform 2147 * @atomicservice 2148 * @since 11 2149 */ 2150 constructor(value?: { fingers?: number; direction?: PanDirection; distance?: number }); 2151 2152 /** 2153 * Sets the direction attribute. 2154 * 2155 * @param { PanDirection } value 2156 * @syscap SystemCapability.ArkUI.ArkUI.Full 2157 * @since 7 2158 */ 2159 /** 2160 * Sets the direction attribute. 2161 * 2162 * @param { PanDirection } value 2163 * @syscap SystemCapability.ArkUI.ArkUI.Full 2164 * @crossplatform 2165 * @since 10 2166 */ 2167 /** 2168 * Sets the direction attribute. 2169 * 2170 * @param { PanDirection } value 2171 * @syscap SystemCapability.ArkUI.ArkUI.Full 2172 * @crossplatform 2173 * @atomicservice 2174 * @since 11 2175 */ 2176 setDirection(value: PanDirection); 2177 2178 /** 2179 * Sets the setDistance attribute. 2180 * 2181 * @param { number } value 2182 * @syscap SystemCapability.ArkUI.ArkUI.Full 2183 * @since 7 2184 */ 2185 /** 2186 * Sets the setDistance attribute. 2187 * 2188 * @param { number } value 2189 * @syscap SystemCapability.ArkUI.ArkUI.Full 2190 * @crossplatform 2191 * @since 10 2192 */ 2193 /** 2194 * Sets the setDistance attribute. 2195 * 2196 * @param { number } value 2197 * @syscap SystemCapability.ArkUI.ArkUI.Full 2198 * @crossplatform 2199 * @atomicservice 2200 * @since 11 2201 */ 2202 setDistance(value: number); 2203 2204 /** 2205 * Sets the setFingers attribute. 2206 * 2207 * @param { number } value 2208 * @syscap SystemCapability.ArkUI.ArkUI.Full 2209 * @since 7 2210 */ 2211 /** 2212 * Sets the setFingers attribute. 2213 * 2214 * @param { number } value 2215 * @syscap SystemCapability.ArkUI.ArkUI.Full 2216 * @crossplatform 2217 * @since 10 2218 */ 2219 /** 2220 * Sets the setFingers attribute. 2221 * 2222 * @param { number } value 2223 * @syscap SystemCapability.ArkUI.ArkUI.Full 2224 * @crossplatform 2225 * @atomicservice 2226 * @since 11 2227 */ 2228 setFingers(value: number); 2229 2230 /** 2231 * Get the pan direction attribute. 2232 * 2233 * @returns { PanDirection } - Pan gesture direction 2234 * @syscap SystemCapability.ArkUI.ArkUI.Full 2235 * @crossplatform 2236 * @atomicservice 2237 * @since 12 2238 */ 2239 getDirection(): PanDirection; 2240} 2241 2242/** 2243 * Defines the PanGesture interface. 2244 * 2245 * @interface PanGestureInterface 2246 * @syscap SystemCapability.ArkUI.ArkUI.Full 2247 * @since 7 2248 */ 2249/** 2250 * Defines the PanGesture interface. 2251 * 2252 * @interface PanGestureInterface 2253 * @syscap SystemCapability.ArkUI.ArkUI.Full 2254 * @crossplatform 2255 * @since 10 2256 */ 2257/** 2258 * Defines PanGesture interface extends GestureInterface<PanGestureInterface>. 2259 * 2260 * @interface PanGestureInterface 2261 * @syscap SystemCapability.ArkUI.ArkUI.Full 2262 * @crossplatform 2263 * @atomicservice 2264 * @since 11 2265 */ 2266interface PanGestureInterface extends GestureInterface<PanGestureInterface> { 2267 /** 2268 * Set the value. 2269 * 2270 * @param { { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOptions } value 2271 * @returns { PanGestureInterface } 2272 * @syscap SystemCapability.ArkUI.ArkUI.Full 2273 * @since 7 2274 */ 2275 /** 2276 * Set the value. 2277 * 2278 * @param { { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOptions } value 2279 * @returns { PanGestureInterface } 2280 * @syscap SystemCapability.ArkUI.ArkUI.Full 2281 * @crossplatform 2282 * @since 10 2283 */ 2284 /** 2285 * Set the value. 2286 * 2287 * @param { { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOptions } value 2288 * @returns { PanGestureInterface } 2289 * @syscap SystemCapability.ArkUI.ArkUI.Full 2290 * @crossplatform 2291 * @atomicservice 2292 * @since 11 2293 */ 2294 (value?: { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOptions): PanGestureInterface; 2295 2296 /** 2297 * Pan gesture recognition success callback. 2298 * 2299 * @param { function } event 2300 * @returns { PanGestureInterface } 2301 * @syscap SystemCapability.ArkUI.ArkUI.Full 2302 * @since 7 2303 */ 2304 /** 2305 * Pan gesture recognition success callback. 2306 * 2307 * @param { function } event 2308 * @returns { PanGestureInterface } 2309 * @syscap SystemCapability.ArkUI.ArkUI.Full 2310 * @crossplatform 2311 * @since 10 2312 */ 2313 /** 2314 * Pan gesture recognition success callback. 2315 * 2316 * @param { function } event 2317 * @returns { PanGestureInterface } 2318 * @syscap SystemCapability.ArkUI.ArkUI.Full 2319 * @crossplatform 2320 * @atomicservice 2321 * @since 11 2322 */ 2323 onActionStart(event: (event: GestureEvent) => void): PanGestureInterface; 2324 2325 /** 2326 * Callback when the Pan gesture is moving. 2327 * 2328 * @param { function } event 2329 * @returns { PanGestureInterface } 2330 * @syscap SystemCapability.ArkUI.ArkUI.Full 2331 * @since 7 2332 */ 2333 /** 2334 * Callback when the Pan gesture is moving. 2335 * 2336 * @param { function } event 2337 * @returns { PanGestureInterface } 2338 * @syscap SystemCapability.ArkUI.ArkUI.Full 2339 * @crossplatform 2340 * @since 10 2341 */ 2342 /** 2343 * Callback when the Pan gesture is moving. 2344 * 2345 * @param { function } event 2346 * @returns { PanGestureInterface } 2347 * @syscap SystemCapability.ArkUI.ArkUI.Full 2348 * @crossplatform 2349 * @atomicservice 2350 * @since 11 2351 */ 2352 onActionUpdate(event: (event: GestureEvent) => void): PanGestureInterface; 2353 2354 /** 2355 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2356 * 2357 * @param { function } event 2358 * @returns { PanGestureInterface } 2359 * @syscap SystemCapability.ArkUI.ArkUI.Full 2360 * @since 7 2361 */ 2362 /** 2363 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2364 * 2365 * @param { function } event 2366 * @returns { PanGestureInterface } 2367 * @syscap SystemCapability.ArkUI.ArkUI.Full 2368 * @crossplatform 2369 * @since 10 2370 */ 2371 /** 2372 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2373 * 2374 * @param { function } event 2375 * @returns { PanGestureInterface } 2376 * @syscap SystemCapability.ArkUI.ArkUI.Full 2377 * @crossplatform 2378 * @atomicservice 2379 * @since 11 2380 */ 2381 onActionEnd(event: (event: GestureEvent) => void): PanGestureInterface; 2382 2383 /** 2384 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2385 * 2386 * @param { function } event 2387 * @returns { PanGestureInterface } 2388 * @syscap SystemCapability.ArkUI.ArkUI.Full 2389 * @since 7 2390 */ 2391 /** 2392 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2393 * 2394 * @param { function } event 2395 * @returns { PanGestureInterface } 2396 * @syscap SystemCapability.ArkUI.ArkUI.Full 2397 * @crossplatform 2398 * @since 10 2399 */ 2400 /** 2401 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2402 * 2403 * @param { function } event 2404 * @returns { PanGestureInterface } 2405 * @syscap SystemCapability.ArkUI.ArkUI.Full 2406 * @crossplatform 2407 * @atomicservice 2408 * @since 11 2409 */ 2410 onActionCancel(event: () => void): PanGestureInterface; 2411} 2412 2413/** 2414 * Defines the SwipeGesture interface. 2415 * 2416 * @interface SwipeGestureInterface 2417 * @syscap SystemCapability.ArkUI.ArkUI.Full 2418 * @since 8 2419 */ 2420/** 2421 * Defines the SwipeGesture interface. 2422 * 2423 * @interface SwipeGestureInterface 2424 * @syscap SystemCapability.ArkUI.ArkUI.Full 2425 * @crossplatform 2426 * @since 10 2427 */ 2428/** 2429 * Defines SwipeGesture interface extends GestureInterface<SwipeGestureInterface>. 2430 * 2431 * @interface SwipeGestureInterface 2432 * @syscap SystemCapability.ArkUI.ArkUI.Full 2433 * @crossplatform 2434 * @atomicservice 2435 * @since 11 2436 */ 2437interface SwipeGestureInterface extends GestureInterface<SwipeGestureInterface> { 2438 /** 2439 * Set the value. 2440 * 2441 * @param { object } value 2442 * @returns { SwipeGestureInterface } 2443 * @syscap SystemCapability.ArkUI.ArkUI.Full 2444 * @since 8 2445 */ 2446 /** 2447 * Set the value. 2448 * 2449 * @param { object } value 2450 * @returns { SwipeGestureInterface } 2451 * @syscap SystemCapability.ArkUI.ArkUI.Full 2452 * @crossplatform 2453 * @since 10 2454 */ 2455 /** 2456 * Set the value. 2457 * 2458 * @param { object } value 2459 * @returns { SwipeGestureInterface } 2460 * @syscap SystemCapability.ArkUI.ArkUI.Full 2461 * @crossplatform 2462 * @atomicservice 2463 * @since 11 2464 */ 2465 (value?: { fingers?: number; direction?: SwipeDirection; speed?: number }): SwipeGestureInterface; 2466 2467 /** 2468 * Slide gesture recognition success callback. 2469 * 2470 * @param { function } event 2471 * @returns { SwipeGestureInterface } 2472 * @syscap SystemCapability.ArkUI.ArkUI.Full 2473 * @since 8 2474 */ 2475 /** 2476 * Slide gesture recognition success callback. 2477 * 2478 * @param { function } event 2479 * @returns { SwipeGestureInterface } 2480 * @syscap SystemCapability.ArkUI.ArkUI.Full 2481 * @crossplatform 2482 * @since 10 2483 */ 2484 /** 2485 * Slide gesture recognition success callback. 2486 * 2487 * @param { function } event 2488 * @returns { SwipeGestureInterface } 2489 * @syscap SystemCapability.ArkUI.ArkUI.Full 2490 * @crossplatform 2491 * @atomicservice 2492 * @since 11 2493 */ 2494 onAction(event: (event: GestureEvent) => void): SwipeGestureInterface; 2495} 2496 2497/** 2498 * Defines the PinchGesture interface. 2499 * 2500 * @interface PinchGestureInterface 2501 * @syscap SystemCapability.ArkUI.ArkUI.Full 2502 * @since 7 2503 */ 2504/** 2505 * Defines the PinchGesture interface. 2506 * 2507 * @interface PinchGestureInterface 2508 * @syscap SystemCapability.ArkUI.ArkUI.Full 2509 * @crossplatform 2510 * @since 10 2511 */ 2512/** 2513 * Defines PinchGesture interface extends GestureInterface<PinchGestureInterface>. 2514 * 2515 * @interface PinchGestureInterface 2516 * @syscap SystemCapability.ArkUI.ArkUI.Full 2517 * @crossplatform 2518 * @atomicservice 2519 * @since 11 2520 */ 2521interface PinchGestureInterface extends GestureInterface<PinchGestureInterface> { 2522 /** 2523 * Set the value. 2524 * 2525 * @param { object } value 2526 * @returns { PinchGestureInterface } 2527 * @syscap SystemCapability.ArkUI.ArkUI.Full 2528 * @since 7 2529 */ 2530 /** 2531 * Set the value. 2532 * 2533 * @param { object } value 2534 * @returns { PinchGestureInterface } 2535 * @syscap SystemCapability.ArkUI.ArkUI.Full 2536 * @crossplatform 2537 * @since 10 2538 */ 2539 /** 2540 * Set the value. 2541 * 2542 * @param { object } value 2543 * @returns { PinchGestureInterface } 2544 * @syscap SystemCapability.ArkUI.ArkUI.Full 2545 * @crossplatform 2546 * @atomicservice 2547 * @since 11 2548 */ 2549 (value?: { fingers?: number; distance?: number }): PinchGestureInterface; 2550 2551 /** 2552 * Pan gesture recognition success callback. 2553 * 2554 * @param { function } event 2555 * @returns { PinchGestureInterface } 2556 * @syscap SystemCapability.ArkUI.ArkUI.Full 2557 * @since 7 2558 */ 2559 /** 2560 * Pan gesture recognition success callback. 2561 * 2562 * @param { function } event 2563 * @returns { PinchGestureInterface } 2564 * @syscap SystemCapability.ArkUI.ArkUI.Full 2565 * @crossplatform 2566 * @since 10 2567 */ 2568 /** 2569 * Pan gesture recognition success callback. 2570 * 2571 * @param { function } event 2572 * @returns { PinchGestureInterface } 2573 * @syscap SystemCapability.ArkUI.ArkUI.Full 2574 * @crossplatform 2575 * @atomicservice 2576 * @since 11 2577 */ 2578 onActionStart(event: (event: GestureEvent) => void): PinchGestureInterface; 2579 2580 /** 2581 * Callback when the Pan gesture is moving. 2582 * 2583 * @param { function } event 2584 * @returns { PinchGestureInterface } 2585 * @syscap SystemCapability.ArkUI.ArkUI.Full 2586 * @since 7 2587 */ 2588 /** 2589 * Callback when the Pan gesture is moving. 2590 * 2591 * @param { function } event 2592 * @returns { PinchGestureInterface } 2593 * @syscap SystemCapability.ArkUI.ArkUI.Full 2594 * @crossplatform 2595 * @since 10 2596 */ 2597 /** 2598 * Callback when the Pan gesture is moving. 2599 * 2600 * @param { function } event 2601 * @returns { PinchGestureInterface } 2602 * @syscap SystemCapability.ArkUI.ArkUI.Full 2603 * @crossplatform 2604 * @atomicservice 2605 * @since 11 2606 */ 2607 onActionUpdate(event: (event: GestureEvent) => void): PinchGestureInterface; 2608 2609 /** 2610 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2611 * 2612 * @param { function } event 2613 * @returns { PinchGestureInterface } 2614 * @syscap SystemCapability.ArkUI.ArkUI.Full 2615 * @since 7 2616 */ 2617 /** 2618 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2619 * 2620 * @param { function } event 2621 * @returns { PinchGestureInterface } 2622 * @syscap SystemCapability.ArkUI.ArkUI.Full 2623 * @crossplatform 2624 * @since 10 2625 */ 2626 /** 2627 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2628 * 2629 * @param { function } event 2630 * @returns { PinchGestureInterface } 2631 * @syscap SystemCapability.ArkUI.ArkUI.Full 2632 * @crossplatform 2633 * @atomicservice 2634 * @since 11 2635 */ 2636 onActionEnd(event: (event: GestureEvent) => void): PinchGestureInterface; 2637 2638 /** 2639 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2640 * 2641 * @param { function } event 2642 * @returns { PinchGestureInterface } 2643 * @syscap SystemCapability.ArkUI.ArkUI.Full 2644 * @since 7 2645 */ 2646 /** 2647 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2648 * 2649 * @param { function } event 2650 * @returns { PinchGestureInterface } 2651 * @syscap SystemCapability.ArkUI.ArkUI.Full 2652 * @crossplatform 2653 * @since 10 2654 */ 2655 /** 2656 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2657 * 2658 * @param { function } event 2659 * @returns { PinchGestureInterface } 2660 * @syscap SystemCapability.ArkUI.ArkUI.Full 2661 * @crossplatform 2662 * @atomicservice 2663 * @since 11 2664 */ 2665 onActionCancel(event: () => void): PinchGestureInterface; 2666} 2667 2668/** 2669 * Defines the RotationGesture interface. 2670 * 2671 * @interface RotationGestureInterface 2672 * @syscap SystemCapability.ArkUI.ArkUI.Full 2673 * @since 7 2674 */ 2675/** 2676 * Defines the RotationGesture interface. 2677 * 2678 * @interface RotationGestureInterface 2679 * @syscap SystemCapability.ArkUI.ArkUI.Full 2680 * @crossplatform 2681 * @since 10 2682 */ 2683/** 2684 * Defines RotationGesture interface extends GestureInterface<RotationGestureInterface>. 2685 * 2686 * @interface RotationGestureInterface 2687 * @syscap SystemCapability.ArkUI.ArkUI.Full 2688 * @crossplatform 2689 * @atomicservice 2690 * @since 11 2691 */ 2692interface RotationGestureInterface extends GestureInterface<RotationGestureInterface> { 2693 /** 2694 * Set the value. 2695 * 2696 * @param { object } value 2697 * @returns { RotationGestureInterface } 2698 * @syscap SystemCapability.ArkUI.ArkUI.Full 2699 * @since 7 2700 */ 2701 /** 2702 * Set the value. 2703 * 2704 * @param { object } value 2705 * @returns { RotationGestureInterface } 2706 * @syscap SystemCapability.ArkUI.ArkUI.Full 2707 * @crossplatform 2708 * @since 10 2709 */ 2710 /** 2711 * Set the value. 2712 * 2713 * @param { object } value 2714 * @returns { RotationGestureInterface } 2715 * @syscap SystemCapability.ArkUI.ArkUI.Full 2716 * @crossplatform 2717 * @atomicservice 2718 * @since 11 2719 */ 2720 (value?: { fingers?: number; angle?: number }): RotationGestureInterface; 2721 2722 /** 2723 * Pan gesture recognition success callback. 2724 * 2725 * @param { function } event 2726 * @returns { RotationGestureInterface } 2727 * @syscap SystemCapability.ArkUI.ArkUI.Full 2728 * @since 7 2729 */ 2730 /** 2731 * Pan gesture recognition success callback. 2732 * 2733 * @param { function } event 2734 * @returns { RotationGestureInterface } 2735 * @syscap SystemCapability.ArkUI.ArkUI.Full 2736 * @crossplatform 2737 * @since 10 2738 */ 2739 /** 2740 * Pan gesture recognition success callback. 2741 * 2742 * @param { function } event 2743 * @returns { RotationGestureInterface } 2744 * @syscap SystemCapability.ArkUI.ArkUI.Full 2745 * @crossplatform 2746 * @atomicservice 2747 * @since 11 2748 */ 2749 onActionStart(event: (event: GestureEvent) => void): RotationGestureInterface; 2750 2751 /** 2752 * Callback when the Pan gesture is moving. 2753 * 2754 * @param { function } event 2755 * @returns { RotationGestureInterface } 2756 * @syscap SystemCapability.ArkUI.ArkUI.Full 2757 * @since 7 2758 */ 2759 /** 2760 * Callback when the Pan gesture is moving. 2761 * 2762 * @param { function } event 2763 * @returns { RotationGestureInterface } 2764 * @syscap SystemCapability.ArkUI.ArkUI.Full 2765 * @crossplatform 2766 * @since 10 2767 */ 2768 /** 2769 * Callback when the Pan gesture is moving. 2770 * 2771 * @param { function } event 2772 * @returns { RotationGestureInterface } 2773 * @syscap SystemCapability.ArkUI.ArkUI.Full 2774 * @crossplatform 2775 * @atomicservice 2776 * @since 11 2777 */ 2778 onActionUpdate(event: (event: GestureEvent) => void): RotationGestureInterface; 2779 2780 /** 2781 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2782 * 2783 * @param { function } event 2784 * @returns { RotationGestureInterface } 2785 * @syscap SystemCapability.ArkUI.ArkUI.Full 2786 * @since 7 2787 */ 2788 /** 2789 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2790 * 2791 * @param { function } event 2792 * @returns { RotationGestureInterface } 2793 * @syscap SystemCapability.ArkUI.ArkUI.Full 2794 * @crossplatform 2795 * @since 10 2796 */ 2797 /** 2798 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2799 * 2800 * @param { function } event 2801 * @returns { RotationGestureInterface } 2802 * @syscap SystemCapability.ArkUI.ArkUI.Full 2803 * @crossplatform 2804 * @atomicservice 2805 * @since 11 2806 */ 2807 onActionEnd(event: (event: GestureEvent) => void): RotationGestureInterface; 2808 2809 /** 2810 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2811 * 2812 * @param { function } event 2813 * @returns { RotationGestureInterface } 2814 * @syscap SystemCapability.ArkUI.ArkUI.Full 2815 * @since 7 2816 */ 2817 /** 2818 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2819 * 2820 * @param { function } event 2821 * @returns { RotationGestureInterface } 2822 * @syscap SystemCapability.ArkUI.ArkUI.Full 2823 * @crossplatform 2824 * @since 10 2825 */ 2826 /** 2827 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2828 * 2829 * @param { function } event 2830 * @returns { RotationGestureInterface } 2831 * @syscap SystemCapability.ArkUI.ArkUI.Full 2832 * @crossplatform 2833 * @atomicservice 2834 * @since 11 2835 */ 2836 onActionCancel(event: () => void): RotationGestureInterface; 2837} 2838 2839/** 2840 * Defines the GestureGroup interface. 2841 * 2842 * @interface GestureGroupInterface 2843 * @syscap SystemCapability.ArkUI.ArkUI.Full 2844 * @since 7 2845 */ 2846/** 2847 * Defines the GestureGroup interface. 2848 * 2849 * @interface GestureGroupInterface 2850 * @syscap SystemCapability.ArkUI.ArkUI.Full 2851 * @crossplatform 2852 * @since 10 2853 */ 2854/** 2855 * Defines the GestureGroup interface. 2856 * 2857 * @interface GestureGroupInterface 2858 * @syscap SystemCapability.ArkUI.ArkUI.Full 2859 * @crossplatform 2860 * @atomicservice 2861 * @since 11 2862 */ 2863interface GestureGroupInterface { 2864 /** 2865 * Return to Obtain GestureGroup. 2866 * 2867 * @param { GestureMode } mode 2868 * @param { GestureType[] } gesture 2869 * @returns { GestureGroupInterface } 2870 * @syscap SystemCapability.ArkUI.ArkUI.Full 2871 * @since 7 2872 */ 2873 /** 2874 * Return to Obtain GestureGroup. 2875 * 2876 * @param { GestureMode } mode 2877 * @param { GestureType[] } gesture 2878 * @returns { GestureGroupInterface } 2879 * @syscap SystemCapability.ArkUI.ArkUI.Full 2880 * @crossplatform 2881 * @since 10 2882 */ 2883 /** 2884 * Return to Obtain GestureGroup. 2885 * 2886 * @param { GestureMode } mode 2887 * @param { GestureType[] } gesture 2888 * @returns { GestureGroupInterface } 2889 * @syscap SystemCapability.ArkUI.ArkUI.Full 2890 * @crossplatform 2891 * @atomicservice 2892 * @since 11 2893 */ 2894 (mode: GestureMode, ...gesture: GestureType[]): GestureGroupInterface; 2895 2896 /** 2897 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2898 * 2899 * @param { function } event 2900 * @returns { GestureGroupInterface } 2901 * @syscap SystemCapability.ArkUI.ArkUI.Full 2902 * @since 7 2903 */ 2904 /** 2905 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2906 * 2907 * @param { function } event 2908 * @returns { GestureGroupInterface } 2909 * @syscap SystemCapability.ArkUI.ArkUI.Full 2910 * @crossplatform 2911 * @since 10 2912 */ 2913 /** 2914 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2915 * 2916 * @param { function } event 2917 * @returns { GestureGroupInterface } 2918 * @syscap SystemCapability.ArkUI.ArkUI.Full 2919 * @crossplatform 2920 * @atomicservice 2921 * @since 11 2922 */ 2923 onCancel(event: () => void): GestureGroupInterface; 2924} 2925 2926/** 2927 * Defines TapGesture Component. 2928 * 2929 * @syscap SystemCapability.ArkUI.ArkUI.Full 2930 * @since 7 2931 */ 2932/** 2933 * Defines TapGesture Component. 2934 * 2935 * @syscap SystemCapability.ArkUI.ArkUI.Full 2936 * @crossplatform 2937 * @since 10 2938 */ 2939/** 2940 * Defines TapGesture Component. 2941 * 2942 * @syscap SystemCapability.ArkUI.ArkUI.Full 2943 * @crossplatform 2944 * @atomicservice 2945 * @since 11 2946 */ 2947declare const TapGesture: TapGestureInterface; 2948 2949/** 2950 * Defines LongPressGesture Component. 2951 * 2952 * @syscap SystemCapability.ArkUI.ArkUI.Full 2953 * @since 7 2954 */ 2955/** 2956 * Defines LongPressGesture Component. 2957 * 2958 * @syscap SystemCapability.ArkUI.ArkUI.Full 2959 * @crossplatform 2960 * @since 10 2961 */ 2962/** 2963 * Defines LongPressGesture Component. 2964 * 2965 * @syscap SystemCapability.ArkUI.ArkUI.Full 2966 * @crossplatform 2967 * @atomicservice 2968 * @since 11 2969 */ 2970declare const LongPressGesture: LongPressGestureInterface; 2971 2972/** 2973 * Defines PanGesture Component. 2974 * 2975 * @syscap SystemCapability.ArkUI.ArkUI.Full 2976 * @since 7 2977 */ 2978/** 2979 * Defines PanGesture Component. 2980 * 2981 * @syscap SystemCapability.ArkUI.ArkUI.Full 2982 * @crossplatform 2983 * @since 10 2984 */ 2985/** 2986 * Defines PanGesture Component. 2987 * 2988 * @syscap SystemCapability.ArkUI.ArkUI.Full 2989 * @crossplatform 2990 * @atomicservice 2991 * @since 11 2992 */ 2993declare const PanGesture: PanGestureInterface; 2994 2995/** 2996 * Defines SwipeGesture Component. 2997 * 2998 * @syscap SystemCapability.ArkUI.ArkUI.Full 2999 * @since 7 3000 */ 3001/** 3002 * Defines SwipeGesture Component. 3003 * 3004 * @syscap SystemCapability.ArkUI.ArkUI.Full 3005 * @crossplatform 3006 * @since 10 3007 */ 3008/** 3009 * Defines SwipeGesture Component. 3010 * 3011 * @syscap SystemCapability.ArkUI.ArkUI.Full 3012 * @crossplatform 3013 * @atomicservice 3014 * @since 11 3015 */ 3016declare const SwipeGesture: SwipeGestureInterface; 3017 3018/** 3019 * Defines PinchGesture Component. 3020 * 3021 * @syscap SystemCapability.ArkUI.ArkUI.Full 3022 * @since 7 3023 */ 3024/** 3025 * Defines PinchGesture Component. 3026 * 3027 * @syscap SystemCapability.ArkUI.ArkUI.Full 3028 * @crossplatform 3029 * @since 10 3030 */ 3031/** 3032 * Defines PinchGesture Component. 3033 * 3034 * @syscap SystemCapability.ArkUI.ArkUI.Full 3035 * @crossplatform 3036 * @atomicservice 3037 * @since 11 3038 */ 3039declare const PinchGesture: PinchGestureInterface; 3040 3041/** 3042 * Defines RotationGesture Component. 3043 * 3044 * @syscap SystemCapability.ArkUI.ArkUI.Full 3045 * @since 7 3046 */ 3047/** 3048 * Defines RotationGesture Component. 3049 * 3050 * @syscap SystemCapability.ArkUI.ArkUI.Full 3051 * @crossplatform 3052 * @since 10 3053 */ 3054/** 3055 * Defines RotationGesture Component. 3056 * 3057 * @syscap SystemCapability.ArkUI.ArkUI.Full 3058 * @crossplatform 3059 * @atomicservice 3060 * @since 11 3061 */ 3062declare const RotationGesture: RotationGestureInterface; 3063 3064/** 3065 * Defines GestureGroup Component. 3066 * 3067 * @syscap SystemCapability.ArkUI.ArkUI.Full 3068 * @since 7 3069 */ 3070/** 3071 * Defines GestureGroup Component. 3072 * 3073 * @syscap SystemCapability.ArkUI.ArkUI.Full 3074 * @crossplatform 3075 * @since 10 3076 */ 3077/** 3078 * Defines GestureGroup Component. 3079 * 3080 * @syscap SystemCapability.ArkUI.ArkUI.Full 3081 * @crossplatform 3082 * @atomicservice 3083 * @since 11 3084 */ 3085declare const GestureGroup: GestureGroupInterface; 3086 3087/** 3088 * Defines the gesture handler. 3089 * 3090 * @implements GestureInterface<T> 3091 * @syscap SystemCapability.ArkUI.ArkUI.Full 3092 * @crossplatform 3093 * @atomicservice 3094 * @since 12 3095 */ 3096declare class GestureHandler<T> implements GestureInterface<T> { 3097 /** 3098 * Set the GestureHandler's tag. 3099 * 3100 * @param { string } tag 3101 * @returns { T } 3102 * @syscap SystemCapability.ArkUI.ArkUI.Full 3103 * @crossplatform 3104 * @atomicservice 3105 * @since 12 3106 */ 3107 tag(tag: string): T; 3108 3109 /** 3110 * Input source type for gesture response. 3111 * 3112 * @param { Array<SourceTool> } types - indicate the allowed input source for gesture to response 3113 * @returns { T } 3114 * @syscap SystemCapability.ArkUI.ArkUI.Full 3115 * @crossplatform 3116 * @atomicservice 3117 * @since 14 3118 */ 3119 allowedTypes(types: Array<SourceTool>): T; 3120} 3121 3122/** 3123 * Defines the TapGestureHandler options. 3124 * 3125 * @interface TapGestureHandlerOptions 3126 * @syscap SystemCapability.ArkUI.ArkUI.Full 3127 * @crossplatform 3128 * @atomicservice 3129 * @since 12 3130 */ 3131interface TapGestureHandlerOptions { 3132 /** 3133 * Indicates the number of consecutive clicks recognized. If the value is less than 1, the default value is used. 3134 * The default value is 1. 3135 * 3136 * @type { ?number } 3137 * @syscap SystemCapability.ArkUI.ArkUI.Full 3138 * @crossplatform 3139 * @atomicservice 3140 * @since 12 3141 */ 3142 count?: number; 3143 /** 3144 * Indicates the hand index that triggers the click. If the value is less than 1, the default value is used. 3145 * The default value is 1. 3146 * 3147 * @type { ?number } 3148 * @syscap SystemCapability.ArkUI.ArkUI.Full 3149 * @crossplatform 3150 * @atomicservice 3151 * @since 12 3152 */ 3153 fingers?: number; 3154} 3155 3156/** 3157 * Defines the TapGesture handler. 3158 * 3159 * @extends GestureHandler<TapGestureHandler> 3160 * @syscap SystemCapability.ArkUI.ArkUI.Full 3161 * @crossplatform 3162 * @atomicservice 3163 * @since 12 3164 */ 3165declare class TapGestureHandler extends GestureHandler<TapGestureHandler> { 3166 /** 3167 * Constructor parameters. 3168 * 3169 * @param { TapGestureHandlerOptions } options 3170 * @syscap SystemCapability.ArkUI.ArkUI.Full 3171 * @crossplatform 3172 * @atomicservice 3173 * @since 12 3174 */ 3175 constructor(options?: TapGestureHandlerOptions); 3176 /** 3177 * Tap gesture recognition success callback. 3178 * 3179 * @param { Callback<GestureEvent> } event 3180 * @returns { TapGestureHandler } 3181 * @syscap SystemCapability.ArkUI.ArkUI.Full 3182 * @crossplatform 3183 * @atomicservice 3184 * @since 12 3185 */ 3186 onAction(event: Callback<GestureEvent>): TapGestureHandler; 3187} 3188 3189/** 3190 * Defines the LongPressGestureHandler options. 3191 * 3192 * @interface LongPressGestureHandlerOptions 3193 * @syscap SystemCapability.ArkUI.ArkUI.Full 3194 * @crossplatform 3195 * @atomicservice 3196 * @since 12 3197 */ 3198interface LongPressGestureHandlerOptions { 3199 /** 3200 * Indicates the hand index that triggers the long press. If the value is less than 1, the default value is used. 3201 * The default value is 1. 3202 * 3203 * @type { ?number } 3204 * @syscap SystemCapability.ArkUI.ArkUI.Full 3205 * @crossplatform 3206 * @atomicservice 3207 * @since 12 3208 */ 3209 fingers?: number; 3210 /** 3211 * Indicates whether an event is triggered repeatedly. 3212 * The default value is false. 3213 * 3214 * @type { ?boolean } 3215 * @syscap SystemCapability.ArkUI.ArkUI.Full 3216 * @crossplatform 3217 * @atomicservice 3218 * @since 12 3219 */ 3220 repeat?: boolean; 3221 /** 3222 * Indicates minimum press and hold time, in milliseconds. 3223 * The default value is 500ms. 3224 * 3225 * @type { ?number } 3226 * @syscap SystemCapability.ArkUI.ArkUI.Full 3227 * @crossplatform 3228 * @atomicservice 3229 * @since 12 3230 */ 3231 duration?: number; 3232} 3233 3234/** 3235 * Defines the LongPressGesture handler. 3236 * 3237 * @extends GestureHandler<LongPressGestureHandler> 3238 * @syscap SystemCapability.ArkUI.ArkUI.Full 3239 * @crossplatform 3240 * @atomicservice 3241 * @since 12 3242 */ 3243declare class LongPressGestureHandler extends GestureHandler<LongPressGestureHandler> { 3244 /** 3245 * Constructor parameters. 3246 * 3247 * @param { LongPressGestureHandlerOptions } options 3248 * @syscap SystemCapability.ArkUI.ArkUI.Full 3249 * @crossplatform 3250 * @atomicservice 3251 * @since 12 3252 */ 3253 constructor(options?: LongPressGestureHandlerOptions); 3254 /** 3255 * LongPress gesture recognition success callback. 3256 * 3257 * @param { Callback<GestureEvent> } event 3258 * @returns { LongPressGestureHandler } 3259 * @syscap SystemCapability.ArkUI.ArkUI.Full 3260 * @crossplatform 3261 * @atomicservice 3262 * @since 12 3263 */ 3264 onAction(event: Callback<GestureEvent>): LongPressGestureHandler; 3265 /** 3266 * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3267 * 3268 * @param { Callback<GestureEvent> } event 3269 * @returns { LongPressGestureHandler } 3270 * @syscap SystemCapability.ArkUI.ArkUI.Full 3271 * @crossplatform 3272 * @atomicservice 3273 * @since 12 3274 */ 3275 onActionEnd(event: Callback<GestureEvent>): LongPressGestureHandler; 3276 /** 3277 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3278 * 3279 * @param { Callback<void> } event 3280 * @returns { LongPressGestureHandler } 3281 * @syscap SystemCapability.ArkUI.ArkUI.Full 3282 * @crossplatform 3283 * @atomicservice 3284 * @since 12 3285 */ 3286 onActionCancel(event: Callback<void>): LongPressGestureHandler; 3287} 3288 3289/** 3290 * Defines the PanGestureHandler options. 3291 * 3292 * @interface PanGestureHandlerOptions 3293 * @syscap SystemCapability.ArkUI.ArkUI.Full 3294 * @crossplatform 3295 * @atomicservice 3296 * @since 12 3297 */ 3298interface PanGestureHandlerOptions { 3299 /** 3300 * Indicates the hand index that triggers the pan. If the value is less than 1, the default value is used. 3301 * The default value is 1. 3302 * 3303 * @type { ?number } 3304 * @syscap SystemCapability.ArkUI.ArkUI.Full 3305 * @crossplatform 3306 * @atomicservice 3307 * @since 12 3308 */ 3309 fingers?: number; 3310 /** 3311 * Indicates the move direction of the pan gesture. 3312 * The default value is PanDirection.All. 3313 * 3314 * @type { ?PanDirection } 3315 * @syscap SystemCapability.ArkUI.ArkUI.Full 3316 * @crossplatform 3317 * @atomicservice 3318 * @since 12 3319 */ 3320 direction?: PanDirection; 3321 /** 3322 * Indicates minimum move distance. 3323 * The default value is 5vp. 3324 * 3325 * @type { ?number } 3326 * @syscap SystemCapability.ArkUI.ArkUI.Full 3327 * @crossplatform 3328 * @atomicservice 3329 * @since 12 3330 */ 3331 distance?: number; 3332} 3333 3334/** 3335 * Defines the PanGesture handler. 3336 * 3337 * @extends GestureHandler<PanGestureHandler> 3338 * @syscap SystemCapability.ArkUI.ArkUI.Full 3339 * @crossplatform 3340 * @atomicservice 3341 * @since 12 3342 */ 3343declare class PanGestureHandler extends GestureHandler<PanGestureHandler> { 3344 /** 3345 * Constructor parameters. 3346 * 3347 * @param { PanGestureHandlerOptions } options 3348 * @syscap SystemCapability.ArkUI.ArkUI.Full 3349 * @crossplatform 3350 * @atomicservice 3351 * @since 12 3352 */ 3353 constructor(options?: PanGestureHandlerOptions); 3354 /** 3355 * Pan gesture recognition success callback. 3356 * 3357 * @param { Callback<GestureEvent> } event 3358 * @returns { PanGestureHandler } 3359 * @syscap SystemCapability.ArkUI.ArkUI.Full 3360 * @crossplatform 3361 * @atomicservice 3362 * @since 12 3363 */ 3364 onActionStart(event: Callback<GestureEvent>): PanGestureHandler; 3365 /** 3366 * Callback when the Pan gesture is moving. 3367 * 3368 * @param { Callback<GestureEvent> } event 3369 * @returns { PanGestureHandler } 3370 * @syscap SystemCapability.ArkUI.ArkUI.Full 3371 * @crossplatform 3372 * @atomicservice 3373 * @since 12 3374 */ 3375 onActionUpdate(event: Callback<GestureEvent>): PanGestureHandler; 3376 /** 3377 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3378 * 3379 * @param { Callback<GestureEvent> } event 3380 * @returns { PanGestureHandler } 3381 * @syscap SystemCapability.ArkUI.ArkUI.Full 3382 * @crossplatform 3383 * @atomicservice 3384 * @since 12 3385 */ 3386 onActionEnd(event: Callback<GestureEvent>): PanGestureHandler; 3387 /** 3388 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3389 * 3390 * @param { Callback<void> } event 3391 * @returns { PanGestureHandler } 3392 * @syscap SystemCapability.ArkUI.ArkUI.Full 3393 * @crossplatform 3394 * @atomicservice 3395 * @since 12 3396 */ 3397 onActionCancel(event: Callback<void>): PanGestureHandler; 3398} 3399 3400/** 3401 * Defines the SwipeGestureHandler options. 3402 * 3403 * @interface SwipeGestureHandlerOptions 3404 * @syscap SystemCapability.ArkUI.ArkUI.Full 3405 * @crossplatform 3406 * @atomicservice 3407 * @since 12 3408 */ 3409interface SwipeGestureHandlerOptions { 3410 /** 3411 * Indicates the hand index that triggers the swipe. If the value is less than 1, the default value is used. 3412 * The default value is 1. 3413 * 3414 * @type { ?number } 3415 * @syscap SystemCapability.ArkUI.ArkUI.Full 3416 * @crossplatform 3417 * @atomicservice 3418 * @since 12 3419 */ 3420 fingers?: number; 3421 /** 3422 * Indicates the move direction of the swipe gesture. 3423 * The default value is SwipeDirection.All. 3424 * 3425 * @type { ?SwipeDirection } 3426 * @syscap SystemCapability.ArkUI.ArkUI.Full 3427 * @crossplatform 3428 * @atomicservice 3429 * @since 12 3430 */ 3431 direction?: SwipeDirection; 3432 /** 3433 * Indicates minimum move speed. 3434 * The default value is 100vp/s. 3435 * 3436 * @type { ?number } 3437 * @syscap SystemCapability.ArkUI.ArkUI.Full 3438 * @crossplatform 3439 * @atomicservice 3440 * @since 12 3441 */ 3442 speed?: number; 3443} 3444 3445/** 3446 * Defines the SwipeGesture handler. 3447 * 3448 * @extends GestureHandler<SwipeGestureHandler> 3449 * @syscap SystemCapability.ArkUI.ArkUI.Full 3450 * @crossplatform 3451 * @atomicservice 3452 * @since 12 3453 */ 3454declare class SwipeGestureHandler extends GestureHandler<SwipeGestureHandler> { 3455 /** 3456 * Constructor parameters. 3457 * 3458 * @param { SwipeGestureHandlerOptions } options 3459 * @syscap SystemCapability.ArkUI.ArkUI.Full 3460 * @crossplatform 3461 * @atomicservice 3462 * @since 12 3463 */ 3464 constructor(options?: SwipeGestureHandlerOptions); 3465 /** 3466 * Swipe gesture recognition success callback. 3467 * 3468 * @param { Callback<GestureEvent> } event 3469 * @returns { SwipeGestureHandler } 3470 * @syscap SystemCapability.ArkUI.ArkUI.Full 3471 * @crossplatform 3472 * @atomicservice 3473 * @since 12 3474 */ 3475 onAction(event: Callback<GestureEvent>): SwipeGestureHandler; 3476} 3477 3478/** 3479 * Defines the PinchGestureHandler options. 3480 * 3481 * @interface PinchGestureHandlerOptions 3482 * @syscap SystemCapability.ArkUI.ArkUI.Full 3483 * @crossplatform 3484 * @atomicservice 3485 * @since 12 3486 */ 3487interface PinchGestureHandlerOptions { 3488 /** 3489 * Indicates the hand index that triggers the pinch. If the value is less than 1, the default value is used. 3490 * The default value is 1. 3491 * 3492 * @type { ?number } 3493 * @syscap SystemCapability.ArkUI.ArkUI.Full 3494 * @crossplatform 3495 * @atomicservice 3496 * @since 12 3497 */ 3498 fingers?: number; 3499 /** 3500 * Indicates minimum pinch move distance. 3501 * The default value is 5vp. 3502 * 3503 * @type { ?number } 3504 * @syscap SystemCapability.ArkUI.ArkUI.Full 3505 * @crossplatform 3506 * @atomicservice 3507 * @since 12 3508 */ 3509 distance?: number; 3510} 3511 3512/** 3513 * Defines the PinchGesture handler. 3514 * 3515 * @extends GestureHandler<PinchGestureHandler> 3516 * @syscap SystemCapability.ArkUI.ArkUI.Full 3517 * @crossplatform 3518 * @atomicservice 3519 * @since 12 3520 */ 3521declare class PinchGestureHandler extends GestureHandler<PinchGestureHandler> { 3522 /** 3523 * Constructor parameters. 3524 * 3525 * @param { PinchGestureHandlerOptions } options 3526 * @syscap SystemCapability.ArkUI.ArkUI.Full 3527 * @crossplatform 3528 * @atomicservice 3529 * @since 12 3530 */ 3531 constructor(options?: PinchGestureHandlerOptions); 3532 /** 3533 * Pinch gesture recognition success callback. 3534 * 3535 * @param { Callback<GestureEvent> } event 3536 * @returns { PinchGestureHandler } 3537 * @syscap SystemCapability.ArkUI.ArkUI.Full 3538 * @crossplatform 3539 * @atomicservice 3540 * @since 12 3541 */ 3542 onActionStart(event: Callback<GestureEvent>): PinchGestureHandler; 3543 /** 3544 * Callback when the Pinch gesture is moving. 3545 * 3546 * @param { Callback<GestureEvent> } event 3547 * @returns { PinchGestureHandler } 3548 * @syscap SystemCapability.ArkUI.ArkUI.Full 3549 * @crossplatform 3550 * @atomicservice 3551 * @since 12 3552 */ 3553 onActionUpdate(event: Callback<GestureEvent>): PinchGestureHandler; 3554 /** 3555 * The Pinch gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3556 * 3557 * @param { Callback<GestureEvent> } event 3558 * @returns { PinchGestureHandler } 3559 * @syscap SystemCapability.ArkUI.ArkUI.Full 3560 * @crossplatform 3561 * @atomicservice 3562 * @since 12 3563 */ 3564 onActionEnd(event: Callback<GestureEvent>): PinchGestureHandler; 3565 /** 3566 * The Pinch gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3567 * 3568 * @param { Callback<void> } event 3569 * @returns { PinchGestureHandler } 3570 * @syscap SystemCapability.ArkUI.ArkUI.Full 3571 * @crossplatform 3572 * @atomicservice 3573 * @since 12 3574 */ 3575 onActionCancel(event: Callback<void>): PinchGestureHandler; 3576} 3577 3578/** 3579 * Defines the RotationGestureHandler options. 3580 * 3581 * @interface RotationGestureHandlerOptions 3582 * @syscap SystemCapability.ArkUI.ArkUI.Full 3583 * @crossplatform 3584 * @atomicservice 3585 * @since 12 3586 */ 3587interface RotationGestureHandlerOptions { 3588 /** 3589 * Indicates the hand index that triggers the rotation. If the value is less than 1, the default value is used. 3590 * The default value is 1. 3591 * 3592 * @type { ?number } 3593 * @syscap SystemCapability.ArkUI.ArkUI.Full 3594 * @crossplatform 3595 * @atomicservice 3596 * @since 12 3597 */ 3598 fingers?: number; 3599 /** 3600 * Indicates minimum rotate angle. 3601 * The default value is 1deg. 3602 * 3603 * @type { ?number } 3604 * @syscap SystemCapability.ArkUI.ArkUI.Full 3605 * @crossplatform 3606 * @atomicservice 3607 * @since 12 3608 */ 3609 angle?: number; 3610} 3611 3612/** 3613 * Defines the RotationGesture handler. 3614 * 3615 * @extends GestureHandler<RotationGestureHandler> 3616 * @syscap SystemCapability.ArkUI.ArkUI.Full 3617 * @crossplatform 3618 * @atomicservice 3619 * @since 12 3620 */ 3621declare class RotationGestureHandler extends GestureHandler<RotationGestureHandler> { 3622 /** 3623 * Constructor parameters. 3624 * 3625 * @param { RotationGestureHandlerOptions } options 3626 * @syscap SystemCapability.ArkUI.ArkUI.Full 3627 * @crossplatform 3628 * @atomicservice 3629 * @since 12 3630 */ 3631 constructor(options?: RotationGestureHandlerOptions); 3632 /** 3633 * Rotation gesture recognition success callback. 3634 * 3635 * @param { Callback<GestureEvent> } event 3636 * @returns { RotationGestureHandler } 3637 * @syscap SystemCapability.ArkUI.ArkUI.Full 3638 * @crossplatform 3639 * @atomicservice 3640 * @since 12 3641 */ 3642 onActionStart(event: Callback<GestureEvent>): RotationGestureHandler; 3643 /** 3644 * Callback when the Rotation gesture is moving. 3645 * 3646 * @param { Callback<GestureEvent> } event 3647 * @returns { RotationGestureHandler } 3648 * @syscap SystemCapability.ArkUI.ArkUI.Full 3649 * @crossplatform 3650 * @atomicservice 3651 * @since 12 3652 */ 3653 onActionUpdate(event: Callback<GestureEvent>): RotationGestureHandler; 3654 /** 3655 * The Rotation gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3656 * 3657 * @param { Callback<GestureEvent> } event 3658 * @returns { RotationGestureHandler } 3659 * @syscap SystemCapability.ArkUI.ArkUI.Full 3660 * @crossplatform 3661 * @atomicservice 3662 * @since 12 3663 */ 3664 onActionEnd(event: Callback<GestureEvent>): RotationGestureHandler; 3665 /** 3666 * The Rotation gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3667 * 3668 * @param { Callback<void> } event 3669 * @returns { RotationGestureHandler } 3670 * @syscap SystemCapability.ArkUI.ArkUI.Full 3671 * @crossplatform 3672 * @atomicservice 3673 * @since 12 3674 */ 3675 onActionCancel(event: Callback<void>): RotationGestureHandler; 3676} 3677 3678/** 3679 * Defines the GestureGroupGestureHandler options. 3680 * 3681 * @interface GestureGroupGestureHandlerOptions 3682 * @syscap SystemCapability.ArkUI.ArkUI.Full 3683 * @crossplatform 3684 * @atomicservice 3685 * @since 12 3686 */ 3687interface GestureGroupGestureHandlerOptions { 3688 /** 3689 * Indicates the mode of gesture group. 3690 * 3691 * @type { GestureMode } 3692 * @syscap SystemCapability.ArkUI.ArkUI.Full 3693 * @crossplatform 3694 * @atomicservice 3695 * @since 12 3696 */ 3697 mode: GestureMode; 3698 /** 3699 * Indicates the gestures included in the gesture group. 3700 * 3701 * @type { GestureHandler<TapGestureHandler | LongPressGestureHandler | PanGestureHandler | SwipeGestureHandler | PinchGestureHandler | RotationGestureHandler | GestureGroupHandler>[] } 3702 * @syscap SystemCapability.ArkUI.ArkUI.Full 3703 * @crossplatform 3704 * @atomicservice 3705 * @since 12 3706 */ 3707 gestures: GestureHandler<TapGestureHandler | LongPressGestureHandler | PanGestureHandler | SwipeGestureHandler | PinchGestureHandler | RotationGestureHandler | GestureGroupHandler>[]; 3708} 3709 3710/** 3711 * Defines the GestureGroup handler. 3712 * 3713 * @extends GestureHandler<GestureGroupHandler> 3714 * @syscap SystemCapability.ArkUI.ArkUI.Full 3715 * @crossplatform 3716 * @atomicservice 3717 * @since 12 3718 */ 3719declare class GestureGroupHandler extends GestureHandler<GestureGroupHandler> { 3720 /** 3721 * Constructor parameters. 3722 * 3723 * @param { GestureGroupGestureHandlerOptions } options 3724 * @syscap SystemCapability.ArkUI.ArkUI.Full 3725 * @crossplatform 3726 * @atomicservice 3727 * @since 12 3728 */ 3729 constructor(options?: GestureGroupGestureHandlerOptions); 3730 /** 3731 * The GestureGroup gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3732 * 3733 * @param { Callback<void> } event 3734 * @returns { GestureGroupHandler } 3735 * @syscap SystemCapability.ArkUI.ArkUI.Full 3736 * @crossplatform 3737 * @atomicservice 3738 * @since 12 3739 */ 3740 onCancel(event: Callback<void>): GestureGroupHandler; 3741} 3742 3743/** 3744 * Creating an Object 3745 * 3746 * @enum { number } 3747 * @syscap SystemCapability.ArkUI.ArkUI.Full 3748 * @crossplatform 3749 * @atomicservice 3750 * @since 12 3751 */ 3752declare enum GesturePriority { 3753 /** 3754 * The normal gesture priority. 3755 * 3756 * @syscap SystemCapability.ArkUI.ArkUI.Full 3757 * @crossplatform 3758 * @atomicservice 3759 * @since 12 3760 */ 3761 NORMAL = 0, 3762 /** 3763 * The high gesture priority. 3764 * 3765 * @syscap SystemCapability.ArkUI.ArkUI.Full 3766 * @crossplatform 3767 * @atomicservice 3768 * @since 12 3769 */ 3770 PRIORITY = 1, 3771} 3772 3773/** 3774 * Creating an Object 3775 * 3776 * @enum { number } 3777 * @syscap SystemCapability.ArkUI.ArkUI.Full 3778 * @crossplatform 3779 * @atomicservice 3780 * @since 12 3781 */ 3782declare enum GestureRecognizerState { 3783 /** 3784 * Ready state. 3785 * 3786 * @syscap SystemCapability.ArkUI.ArkUI.Full 3787 * @crossplatform 3788 * @atomicservice 3789 * @since 12 3790 */ 3791 READY = 0, 3792 /** 3793 * Detecting state. 3794 * 3795 * @syscap SystemCapability.ArkUI.ArkUI.Full 3796 * @crossplatform 3797 * @atomicservice 3798 * @since 12 3799 */ 3800 DETECTING = 1, 3801 /** 3802 * Pending state. 3803 * 3804 * @syscap SystemCapability.ArkUI.ArkUI.Full 3805 * @crossplatform 3806 * @atomicservice 3807 * @since 12 3808 */ 3809 PENDING = 2, 3810 /** 3811 * Blocked state. 3812 * 3813 * @syscap SystemCapability.ArkUI.ArkUI.Full 3814 * @crossplatform 3815 * @atomicservice 3816 * @since 12 3817 */ 3818 BLOCKED = 3, 3819 /** 3820 * Successful state. 3821 * 3822 * @syscap SystemCapability.ArkUI.ArkUI.Full 3823 * @crossplatform 3824 * @atomicservice 3825 * @since 12 3826 */ 3827 SUCCESSFUL = 4, 3828 /** 3829 * Failed state. 3830 * 3831 * @syscap SystemCapability.ArkUI.ArkUI.Full 3832 * @crossplatform 3833 * @atomicservice 3834 * @since 12 3835 */ 3836 FAILED = 5, 3837} 3838 3839/** 3840 * Defines the scrollable target information. 3841 * 3842 * @extends EventTargetInfo 3843 * @syscap SystemCapability.ArkUI.ArkUI.Full 3844 * @crossplatform 3845 * @atomicservice 3846 * @since 12 3847 */ 3848declare class ScrollableTargetInfo extends EventTargetInfo { 3849 /** 3850 * Returns whether the scrollable component is at begin. 3851 * 3852 * @returns { boolean } - true is at begin, false is not at begin 3853 * @syscap SystemCapability.ArkUI.ArkUI.Full 3854 * @crossplatform 3855 * @atomicservice 3856 * @since 12 3857 */ 3858 isBegin(): boolean; 3859 /** 3860 * Returns whether the scrollable component is at end. 3861 * 3862 * @returns { boolean } - true is at end, false is not at end 3863 * @syscap SystemCapability.ArkUI.ArkUI.Full 3864 * @crossplatform 3865 * @atomicservice 3866 * @since 12 3867 */ 3868 isEnd(): boolean; 3869} 3870 3871/** 3872 * Defines the event target information. 3873 * 3874 * @syscap SystemCapability.ArkUI.ArkUI.Full 3875 * @crossplatform 3876 * @atomicservice 3877 * @since 12 3878 */ 3879declare class EventTargetInfo { 3880 /** 3881 * Returns the component's inspector id. 3882 * 3883 * @returns { string } - the inspector id of the component 3884 * @syscap SystemCapability.ArkUI.ArkUI.Full 3885 * @crossplatform 3886 * @atomicservice 3887 * @since 12 3888 */ 3889 getId(): string; 3890} 3891 3892/** 3893 * Defines the gesture recognizer. 3894 * 3895 * @syscap SystemCapability.ArkUI.ArkUI.Full 3896 * @crossplatform 3897 * @atomicservice 3898 * @since 12 3899 */ 3900declare class GestureRecognizer { 3901 /** 3902 * Returns the gesture's tag. 3903 * 3904 * @returns { string } - the gesture's tag 3905 * @syscap SystemCapability.ArkUI.ArkUI.Full 3906 * @crossplatform 3907 * @atomicservice 3908 * @since 12 3909 */ 3910 getTag(): string; 3911 /** 3912 * Returns the gesture's type. 3913 * 3914 * @returns { GestureControl.GestureType } - the gesture's type 3915 * @syscap SystemCapability.ArkUI.ArkUI.Full 3916 * @crossplatform 3917 * @atomicservice 3918 * @since 12 3919 */ 3920 getType(): GestureControl.GestureType; 3921 /** 3922 * Returns whether the gesture recognizer is built in recognizer. 3923 * 3924 * @returns { boolean } - true is built in recognizer, false is not built in recognizer 3925 * @syscap SystemCapability.ArkUI.ArkUI.Full 3926 * @crossplatform 3927 * @atomicservice 3928 * @since 12 3929 */ 3930 isBuiltIn(): boolean; 3931 /** 3932 * set the enabled state of the gesture recognizer. 3933 * 3934 * @param { boolean } isEnabled - Indicates the enabled state. 3935 * @syscap SystemCapability.ArkUI.ArkUI.Full 3936 * @crossplatform 3937 * @atomicservice 3938 * @since 12 3939 */ 3940 setEnabled(isEnabled: boolean): void; 3941 /** 3942 * Returns whether the gesture recognizer is enabled. 3943 * 3944 * @returns { boolean } - true is enabled, false is not enabled 3945 * @syscap SystemCapability.ArkUI.ArkUI.Full 3946 * @crossplatform 3947 * @atomicservice 3948 * @since 12 3949 */ 3950 isEnabled(): boolean; 3951 /** 3952 * Returns the gesture recognizer's state. 3953 * 3954 * @returns { GestureRecognizerState } - the gesture recognizer's state 3955 * @syscap SystemCapability.ArkUI.ArkUI.Full 3956 * @crossplatform 3957 * @atomicservice 3958 * @since 12 3959 */ 3960 getState(): GestureRecognizerState; 3961 /** 3962 * Returns the event target information of the component. 3963 * 3964 * @returns { EventTargetInfo } - the event target information of the component. 3965 * @syscap SystemCapability.ArkUI.ArkUI.Full 3966 * @crossplatform 3967 * @atomicservice 3968 * @since 12 3969 */ 3970 getEventTargetInfo(): EventTargetInfo; 3971 /** 3972 * Returns whether the gesture recognizer is valid. 3973 * 3974 * @returns { boolean } - true is valid, false is invalid 3975 * @syscap SystemCapability.ArkUI.ArkUI.Full 3976 * @crossplatform 3977 * @since 12 3978 */ 3979 isValid(): boolean; 3980} 3981 3982/** 3983 * Defines the gesture recognizer. 3984 * 3985 * @extends GestureRecognizer 3986 * @syscap SystemCapability.ArkUI.ArkUI.Full 3987 * @crossplatform 3988 * @atomicservice 3989 * @since 12 3990 */ 3991declare class PanRecognizer extends GestureRecognizer { 3992 /** 3993 * Returns the the pan gesture options of the recognizer. 3994 * 3995 * @returns { PanGestureOptions } - Pan gesture options 3996 * @syscap SystemCapability.ArkUI.ArkUI.Full 3997 * @crossplatform 3998 * @atomicservice 3999 * @since 12 4000 */ 4001 getPanGestureOptions(): PanGestureOptions; 4002} 4003 4004