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/*** if arkts 1.2 */ 22import { BaseEvent, SourceTool, Callback } from './common' 23import { InteractionHand } from './enums' 24/*** endif */ 25 26/** 27 * Creating an Object 28 * 29 * @enum { number } 30 * @syscap SystemCapability.ArkUI.ArkUI.Full 31 * @since 7 32 */ 33/** 34 * Creating an Object 35 * 36 * @enum { number } 37 * @syscap SystemCapability.ArkUI.ArkUI.Full 38 * @crossplatform 39 * @since 10 40 */ 41/** 42 * Creating an Object 43 * 44 * @enum { number } 45 * @syscap SystemCapability.ArkUI.ArkUI.Full 46 * @crossplatform 47 * @atomicservice 48 * @since arkts {'1.1':'11','1.2':'20'} 49 * @arkts 1.1&1.2 50 */ 51declare enum PanDirection { 52 /** 53 * Default. 54 * 55 * @syscap SystemCapability.ArkUI.ArkUI.Full 56 * @since 7 57 */ 58 /** 59 * Default. 60 * 61 * @syscap SystemCapability.ArkUI.ArkUI.Full 62 * @crossplatform 63 * @since 10 64 */ 65 /** 66 * Default. 67 * 68 * @syscap SystemCapability.ArkUI.ArkUI.Full 69 * @crossplatform 70 * @atomicservice 71 * @since arkts {'1.1':'11','1.2':'20'} 72 * @arkts 1.1&1.2 73 */ 74 None, 75 76 /** 77 * Sliding horizontally. 78 * 79 * @syscap SystemCapability.ArkUI.ArkUI.Full 80 * @since 7 81 */ 82 /** 83 * Sliding horizontally. 84 * 85 * @syscap SystemCapability.ArkUI.ArkUI.Full 86 * @crossplatform 87 * @since 10 88 */ 89 /** 90 * Sliding horizontally. 91 * 92 * @syscap SystemCapability.ArkUI.ArkUI.Full 93 * @crossplatform 94 * @atomicservice 95 * @since arkts {'1.1':'11','1.2':'20'} 96 * @arkts 1.1&1.2 97 */ 98 Horizontal, 99 100 /** 101 * Sliding left. 102 * 103 * @syscap SystemCapability.ArkUI.ArkUI.Full 104 * @since 7 105 */ 106 /** 107 * Sliding left. 108 * 109 * @syscap SystemCapability.ArkUI.ArkUI.Full 110 * @crossplatform 111 * @since 10 112 */ 113 /** 114 * Sliding left. 115 * 116 * @syscap SystemCapability.ArkUI.ArkUI.Full 117 * @crossplatform 118 * @atomicservice 119 * @since arkts {'1.1':'11','1.2':'20'} 120 * @arkts 1.1&1.2 121 */ 122 Left, 123 124 /** 125 * Sliding right. 126 * 127 * @syscap SystemCapability.ArkUI.ArkUI.Full 128 * @since 7 129 */ 130 /** 131 * Sliding right. 132 * 133 * @syscap SystemCapability.ArkUI.ArkUI.Full 134 * @crossplatform 135 * @since 10 136 */ 137 /** 138 * Sliding right. 139 * 140 * @syscap SystemCapability.ArkUI.ArkUI.Full 141 * @crossplatform 142 * @atomicservice 143 * @since arkts {'1.1':'11','1.2':'20'} 144 * @arkts 1.1&1.2 145 */ 146 Right, 147 148 /** 149 * Sliding Vertical 150 * 151 * @syscap SystemCapability.ArkUI.ArkUI.Full 152 * @since 7 153 */ 154 /** 155 * Sliding Vertical 156 * 157 * @syscap SystemCapability.ArkUI.ArkUI.Full 158 * @crossplatform 159 * @since 10 160 */ 161 /** 162 * Sliding Vertical 163 * 164 * @syscap SystemCapability.ArkUI.ArkUI.Full 165 * @crossplatform 166 * @atomicservice 167 * @since arkts {'1.1':'11','1.2':'20'} 168 * @arkts 1.1&1.2 169 */ 170 Vertical, 171 172 /** 173 * Sliding up. 174 * 175 * @syscap SystemCapability.ArkUI.ArkUI.Full 176 * @since 7 177 */ 178 /** 179 * Sliding up. 180 * 181 * @syscap SystemCapability.ArkUI.ArkUI.Full 182 * @crossplatform 183 * @since 10 184 */ 185 /** 186 * Sliding up. 187 * 188 * @syscap SystemCapability.ArkUI.ArkUI.Full 189 * @crossplatform 190 * @atomicservice 191 * @since arkts {'1.1':'11','1.2':'20'} 192 * @arkts 1.1&1.2 193 */ 194 Up, 195 196 /** 197 * Sliding Down. 198 * 199 * @syscap SystemCapability.ArkUI.ArkUI.Full 200 * @since 7 201 */ 202 /** 203 * Sliding Down. 204 * 205 * @syscap SystemCapability.ArkUI.ArkUI.Full 206 * @crossplatform 207 * @since 10 208 */ 209 /** 210 * Sliding Down. 211 * 212 * @syscap SystemCapability.ArkUI.ArkUI.Full 213 * @crossplatform 214 * @atomicservice 215 * @since arkts {'1.1':'11','1.2':'20'} 216 * @arkts 1.1&1.2 217 */ 218 Down, 219 220 /** 221 * Sliding in all directions. 222 * 223 * @syscap SystemCapability.ArkUI.ArkUI.Full 224 * @since 7 225 */ 226 /** 227 * Sliding in all directions. 228 * 229 * @syscap SystemCapability.ArkUI.ArkUI.Full 230 * @crossplatform 231 * @since 10 232 */ 233 /** 234 * Sliding in all directions. 235 * 236 * @syscap SystemCapability.ArkUI.ArkUI.Full 237 * @crossplatform 238 * @atomicservice 239 * @since arkts {'1.1':'11','1.2':'20'} 240 * @arkts 1.1&1.2 241 */ 242 All, 243} 244 245/** 246 * Creating an Object 247 * 248 * @enum { number } 249 * @syscap SystemCapability.ArkUI.ArkUI.Full 250 * @since 8 251 */ 252/** 253 * Creating an Object 254 * 255 * @enum { number } 256 * @syscap SystemCapability.ArkUI.ArkUI.Full 257 * @crossplatform 258 * @since 10 259 */ 260/** 261 * Creating an Object 262 * 263 * @enum { number } 264 * @syscap SystemCapability.ArkUI.ArkUI.Full 265 * @crossplatform 266 * @atomicservice 267 * @since arkts {'1.1':'11','1.2':'20'} 268 * @arkts 1.1&1.2 269 */ 270declare enum SwipeDirection { 271 /** 272 * Default. 273 * 274 * @syscap SystemCapability.ArkUI.ArkUI.Full 275 * @since 8 276 */ 277 /** 278 * Default. 279 * 280 * @syscap SystemCapability.ArkUI.ArkUI.Full 281 * @crossplatform 282 * @since 10 283 */ 284 /** 285 * Default. 286 * 287 * @syscap SystemCapability.ArkUI.ArkUI.Full 288 * @crossplatform 289 * @atomicservice 290 * @since arkts {'1.1':'11','1.2':'20'} 291 * @arkts 1.1&1.2 292 */ 293 None, 294 295 /** 296 * Sliding horizontally. 297 * 298 * @syscap SystemCapability.ArkUI.ArkUI.Full 299 * @since 8 300 */ 301 /** 302 * Sliding horizontally. 303 * 304 * @syscap SystemCapability.ArkUI.ArkUI.Full 305 * @crossplatform 306 * @since 10 307 */ 308 /** 309 * Sliding horizontally. 310 * 311 * @syscap SystemCapability.ArkUI.ArkUI.Full 312 * @crossplatform 313 * @atomicservice 314 * @since arkts {'1.1':'11','1.2':'20'} 315 * @arkts 1.1&1.2 316 */ 317 Horizontal, 318 319 /** 320 * Sliding Vertical 321 * 322 * @syscap SystemCapability.ArkUI.ArkUI.Full 323 * @since 8 324 */ 325 /** 326 * Sliding Vertical 327 * 328 * @syscap SystemCapability.ArkUI.ArkUI.Full 329 * @crossplatform 330 * @since 10 331 */ 332 /** 333 * Sliding Vertical 334 * 335 * @syscap SystemCapability.ArkUI.ArkUI.Full 336 * @crossplatform 337 * @atomicservice 338 * @since arkts {'1.1':'11','1.2':'20'} 339 * @arkts 1.1&1.2 340 */ 341 Vertical, 342 343 /** 344 * Sliding in all directions. 345 * 346 * @syscap SystemCapability.ArkUI.ArkUI.Full 347 * @since 8 348 */ 349 /** 350 * Sliding in all directions. 351 * 352 * @syscap SystemCapability.ArkUI.ArkUI.Full 353 * @crossplatform 354 * @since 10 355 */ 356 /** 357 * Sliding in all directions. 358 * 359 * @syscap SystemCapability.ArkUI.ArkUI.Full 360 * @crossplatform 361 * @atomicservice 362 * @since arkts {'1.1':'11','1.2':'20'} 363 * @arkts 1.1&1.2 364 */ 365 All, 366} 367 368/** 369 * Creating an Object 370 * 371 * @enum { number } 372 * @syscap SystemCapability.ArkUI.ArkUI.Full 373 * @since 7 374 */ 375/** 376 * Creating an Object 377 * 378 * @enum { number } 379 * @syscap SystemCapability.ArkUI.ArkUI.Full 380 * @crossplatform 381 * @since 10 382 */ 383/** 384 * Creating an Object 385 * 386 * @enum { number } 387 * @syscap SystemCapability.ArkUI.ArkUI.Full 388 * @crossplatform 389 * @atomicservice 390 * @since arkts {'1.1':'11','1.2':'20'} 391 * @arkts 1.1&1.2 392 */ 393declare enum GestureMode { 394 /** 395 * Sequential gesture recognition is performed in sequence according to the gesture registration sequence. 396 * 397 * @syscap SystemCapability.ArkUI.ArkUI.Full 398 * @since 7 399 */ 400 /** 401 * Sequential gesture recognition is performed in sequence according to the gesture registration sequence. 402 * 403 * @syscap SystemCapability.ArkUI.ArkUI.Full 404 * @crossplatform 405 * @since 10 406 */ 407 /** 408 * Sequential gesture recognition is performed in sequence according to the gesture registration sequence. 409 * 410 * @syscap SystemCapability.ArkUI.ArkUI.Full 411 * @crossplatform 412 * @atomicservice 413 * @since arkts {'1.1':'11','1.2':'20'} 414 * @arkts 1.1&1.2 415 */ 416 Sequence, 417 418 /** 419 * Simultaneous recognition. Registration gestures participate in recognition. Everything can be triggered. 420 * 421 * @syscap SystemCapability.ArkUI.ArkUI.Full 422 * @since 7 423 */ 424 /** 425 * Simultaneous recognition. Registration gestures participate in recognition. Everything can be triggered. 426 * 427 * @syscap SystemCapability.ArkUI.ArkUI.Full 428 * @crossplatform 429 * @since 10 430 */ 431 /** 432 * Simultaneous recognition. Registration gestures participate in recognition. Everything can be triggered. 433 * 434 * @syscap SystemCapability.ArkUI.ArkUI.Full 435 * @crossplatform 436 * @atomicservice 437 * @since arkts {'1.1':'11','1.2':'20'} 438 * @arkts 1.1&1.2 439 */ 440 Parallel, 441 442 /** 443 * Mutually exclusive recognition. Only one gesture is successfully recognized. 444 * 445 * @syscap SystemCapability.ArkUI.ArkUI.Full 446 * @since 7 447 */ 448 /** 449 * Mutually exclusive recognition. Only one gesture is successfully recognized. 450 * 451 * @syscap SystemCapability.ArkUI.ArkUI.Full 452 * @crossplatform 453 * @since 10 454 */ 455 /** 456 * Mutually exclusive recognition. Only one gesture is successfully recognized. 457 * 458 * @syscap SystemCapability.ArkUI.ArkUI.Full 459 * @crossplatform 460 * @atomicservice 461 * @since arkts {'1.1':'11','1.2':'20'} 462 * @arkts 1.1&1.2 463 */ 464 Exclusive, 465} 466 467/** 468 * Creating an Object 469 * 470 * @enum { number } 471 * @syscap SystemCapability.ArkUI.ArkUI.Full 472 * @since 7 473 */ 474/** 475 * Creating an Object 476 * 477 * @enum { number } 478 * @syscap SystemCapability.ArkUI.ArkUI.Full 479 * @crossplatform 480 * @since 10 481 */ 482/** 483 * Creating an Object 484 * 485 * @enum { number } 486 * @syscap SystemCapability.ArkUI.ArkUI.Full 487 * @crossplatform 488 * @atomicservice 489 * @since arkts {'1.1':'11','1.2':'20'} 490 * @arkts 1.1&1.2 491 */ 492declare enum GestureMask { 493 /** 494 * 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. 495 * 496 * @syscap SystemCapability.ArkUI.ArkUI.Full 497 * @since 7 498 */ 499 /** 500 * 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. 501 * 502 * @syscap SystemCapability.ArkUI.ArkUI.Full 503 * @crossplatform 504 * @since 10 505 */ 506 /** 507 * 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. 508 * 509 * @syscap SystemCapability.ArkUI.ArkUI.Full 510 * @crossplatform 511 * @atomicservice 512 * @since arkts {'1.1':'11','1.2':'20'} 513 * @arkts 1.1&1.2 514 */ 515 Normal, 516 517 /** 518 * Ignore internal gestures and recognize the current gesture first. 519 * 520 * @syscap SystemCapability.ArkUI.ArkUI.Full 521 * @since 7 522 */ 523 /** 524 * Ignore internal gestures and recognize the current gesture first. 525 * 526 * @syscap SystemCapability.ArkUI.ArkUI.Full 527 * @crossplatform 528 * @since 10 529 */ 530 /** 531 * Ignore internal gestures and recognize the current gesture first. 532 * 533 * @syscap SystemCapability.ArkUI.ArkUI.Full 534 * @crossplatform 535 * @atomicservice 536 * @since arkts {'1.1':'11','1.2':'20'} 537 * @arkts 1.1&1.2 538 */ 539 IgnoreInternal, 540} 541 542/** 543 * Creating an Object 544 * 545 * @enum { number } 546 * @syscap SystemCapability.ArkUI.ArkUI.Full 547 * @crossplatform 548 * @since 11 549 */ 550/** 551 * Creating an Object 552 * 553 * @enum { number } 554 * @syscap SystemCapability.ArkUI.ArkUI.Full 555 * @crossplatform 556 * @atomicservice 557 * @since arkts {'1.1':'12','1.2':'20'} 558 * @arkts 1.1&1.2 559 */ 560declare enum GestureJudgeResult { 561 /** 562 * The system gesture determination is not affected. 563 * 564 * @syscap SystemCapability.ArkUI.ArkUI.Full 565 * @crossplatform 566 * @since 11 567 */ 568 /** 569 * The system gesture determination is not affected. 570 * 571 * @syscap SystemCapability.ArkUI.ArkUI.Full 572 * @crossplatform 573 * @atomicservice 574 * @since arkts {'1.1':'12','1.2':'20'} 575 * @arkts 1.1&1.2 576 */ 577 CONTINUE = 0, 578 579 /** 580 * The user-defined gesture determination result of the current component is fail. 581 * 582 * @syscap SystemCapability.ArkUI.ArkUI.Full 583 * @crossplatform 584 * @since 11 585 */ 586 /** 587 * The user-defined gesture determination result of the current component is fail. 588 * 589 * @syscap SystemCapability.ArkUI.ArkUI.Full 590 * @crossplatform 591 * @atomicservice 592 * @since arkts {'1.1':'12','1.2':'20'} 593 * @arkts 1.1&1.2 594 */ 595 REJECT = 1, 596} 597 598/** 599 * Creating an Object 600 * 601 * @namespace GestureControl 602 * @syscap SystemCapability.ArkUI.ArkUI.Full 603 * @crossplatform 604 * @since 11 605 */ 606/** 607 * Creating an Object 608 * 609 * @namespace GestureControl 610 * @syscap SystemCapability.ArkUI.ArkUI.Full 611 * @crossplatform 612 * @atomicservice 613 * @since arkts {'1.1':'12','1.2':'20'} 614 * @arkts 1.1&1.2 615 */ 616declare namespace GestureControl { 617 /** 618 * Creating an Object 619 * 620 * @enum { number } 621 * @syscap SystemCapability.ArkUI.ArkUI.Full 622 * @crossplatform 623 * @since 11 624 */ 625 /** 626 * Creating an Object 627 * 628 * @enum { number } 629 * @syscap SystemCapability.ArkUI.ArkUI.Full 630 * @crossplatform 631 * @atomicservice 632 * @since arkts {'1.1':'12','1.2':'20'} 633 * @arkts 1.1&1.2 634 */ 635 enum GestureType { 636 /** 637 * TapGesture. 638 * 639 * @syscap SystemCapability.ArkUI.ArkUI.Full 640 * @crossplatform 641 * @since 11 642 */ 643 /** 644 * TapGesture. 645 * 646 * @syscap SystemCapability.ArkUI.ArkUI.Full 647 * @crossplatform 648 * @atomicservice 649 * @since arkts {'1.1':'12','1.2':'20'} 650 * @arkts 1.1&1.2 651 */ 652 TAP_GESTURE = 0, 653 654 /** 655 * LongPressGesture. 656 * 657 * @syscap SystemCapability.ArkUI.ArkUI.Full 658 * @crossplatform 659 * @since 11 660 */ 661 /** 662 * LongPressGesture. 663 * 664 * @syscap SystemCapability.ArkUI.ArkUI.Full 665 * @crossplatform 666 * @atomicservice 667 * @since arkts {'1.1':'12','1.2':'20'} 668 * @arkts 1.1&1.2 669 */ 670 LONG_PRESS_GESTURE = 1, 671 672 /** 673 * PanGesture. 674 * 675 * @syscap SystemCapability.ArkUI.ArkUI.Full 676 * @crossplatform 677 * @since 11 678 */ 679 /** 680 * PanGesture. 681 * 682 * @syscap SystemCapability.ArkUI.ArkUI.Full 683 * @crossplatform 684 * @atomicservice 685 * @since arkts {'1.1':'12','1.2':'20'} 686 * @arkts 1.1&1.2 687 */ 688 PAN_GESTURE = 2, 689 690 /** 691 * PinchGesture. 692 * 693 * @syscap SystemCapability.ArkUI.ArkUI.Full 694 * @crossplatform 695 * @since 11 696 */ 697 /** 698 * PinchGesture. 699 * 700 * @syscap SystemCapability.ArkUI.ArkUI.Full 701 * @crossplatform 702 * @atomicservice 703 * @since arkts {'1.1':'12','1.2':'20'} 704 * @arkts 1.1&1.2 705 */ 706 PINCH_GESTURE = 3, 707 708 /** 709 * SwipeGesture. 710 * 711 * @syscap SystemCapability.ArkUI.ArkUI.Full 712 * @crossplatform 713 * @since 11 714 */ 715 /** 716 * SwipeGesture. 717 * 718 * @syscap SystemCapability.ArkUI.ArkUI.Full 719 * @crossplatform 720 * @atomicservice 721 * @since arkts {'1.1':'12','1.2':'20'} 722 * @arkts 1.1&1.2 723 */ 724 SWIPE_GESTURE = 4, 725 726 /** 727 * RotationGesture. 728 * 729 * @syscap SystemCapability.ArkUI.ArkUI.Full 730 * @crossplatform 731 * @since 11 732 */ 733 /** 734 * RotationGesture. 735 * 736 * @syscap SystemCapability.ArkUI.ArkUI.Full 737 * @crossplatform 738 * @atomicservice 739 * @since arkts {'1.1':'12','1.2':'20'} 740 * @arkts 1.1&1.2 741 */ 742 ROTATION_GESTURE = 5, 743 744 /** 745 * Drag. 746 * 747 * @syscap SystemCapability.ArkUI.ArkUI.Full 748 * @crossplatform 749 * @since 11 750 */ 751 /** 752 * Drag. 753 * 754 * @syscap SystemCapability.ArkUI.ArkUI.Full 755 * @crossplatform 756 * @atomicservice 757 * @since arkts {'1.1':'12','1.2':'20'} 758 * @arkts 1.1&1.2 759 */ 760 DRAG = 6, 761 762 /** 763 * Click. 764 * 765 * @syscap SystemCapability.ArkUI.ArkUI.Full 766 * @crossplatform 767 * @since 11 768 */ 769 /** 770 * Click. 771 * 772 * @syscap SystemCapability.ArkUI.ArkUI.Full 773 * @crossplatform 774 * @atomicservice 775 * @since arkts {'1.1':'12','1.2':'20'} 776 * @arkts 1.1&1.2 777 */ 778 CLICK = 7, 779 } 780} 781 782/** 783 * The description of gesture information. 784 * 785 * @interface GestureInfo 786 * @syscap SystemCapability.ArkUI.ArkUI.Full 787 * @crossplatform 788 * @since 11 789 */ 790/** 791 * The description of gesture information. 792 * 793 * @interface GestureInfo 794 * @syscap SystemCapability.ArkUI.ArkUI.Full 795 * @crossplatform 796 * @atomicservice 797 * @since arkts {'1.1':'12','1.2':'20'} 798 * @arkts 1.1&1.2 799 */ 800declare interface GestureInfo { 801 /** 802 * The tag of gesture. 803 * 804 * @type { ?string } 805 * @syscap SystemCapability.ArkUI.ArkUI.Full 806 * @crossplatform 807 * @since 11 808 */ 809 /** 810 * The tag of gesture. 811 * 812 * @type { ?string } 813 * @syscap SystemCapability.ArkUI.ArkUI.Full 814 * @crossplatform 815 * @atomicservice 816 * @since arkts {'1.1':'12','1.2':'20'} 817 * @arkts 1.1&1.2 818 */ 819 tag?: string; 820 821 /** 822 * The type of gesture. 823 * 824 * @type { GestureControl.GestureType } 825 * @syscap SystemCapability.ArkUI.ArkUI.Full 826 * @crossplatform 827 * @since 11 828 */ 829 /** 830 * The type of gesture. 831 * 832 * @type { GestureControl.GestureType } 833 * @syscap SystemCapability.ArkUI.ArkUI.Full 834 * @crossplatform 835 * @atomicservice 836 * @since arkts {'1.1':'12','1.2':'20'} 837 * @arkts 1.1&1.2 838 */ 839 type: GestureControl.GestureType; 840 841 /** 842 * The flag whether it is a system gesture. 843 * 844 * @type { boolean } 845 * @syscap SystemCapability.ArkUI.ArkUI.Full 846 * @crossplatform 847 * @since 11 848 */ 849 /** 850 * The flag whether it is a system gesture. 851 * 852 * @type { boolean } 853 * @syscap SystemCapability.ArkUI.ArkUI.Full 854 * @crossplatform 855 * @atomicservice 856 * @since arkts {'1.1':'12','1.2':'20'} 857 * @arkts 1.1&1.2 858 */ 859 isSystemGesture: boolean; 860} 861 862/** 863 * The location info used in gesture event. 864 * 865 * @interface EventLocationInfo 866 * @syscap SystemCapability.ArkUI.ArkUI.Full 867 * @crossplatform 868 * @atomicservice 869 * @since 20 870 */ 871declare interface EventLocationInfo { 872 /** 873 * X-axis coordinates relative to the upper left corner of the component. 874 * 875 * @type { number } 876 * @syscap SystemCapability.ArkUI.ArkUI.Full 877 * @crossplatform 878 * @atomicservice 879 * @since 20 880 */ 881 x: number; 882 883 /** 884 * Y-axis coordinates relative to the upper left corner of the component. 885 * 886 * @type { number } 887 * @syscap SystemCapability.ArkUI.ArkUI.Full 888 * @crossplatform 889 * @atomicservice 890 * @since 20 891 */ 892 y: number; 893 894 /** 895 * X-axis coordinates relative to the upper left corner of the window. 896 * 897 * @type { number } 898 * @syscap SystemCapability.ArkUI.ArkUI.Full 899 * @crossplatform 900 * @atomicservice 901 * @since 20 902 */ 903 windowX: number; 904 905 /** 906 * Y-axis coordinates relative to the upper left corner of the window. 907 * 908 * @type { number } 909 * @syscap SystemCapability.ArkUI.ArkUI.Full 910 * @crossplatform 911 * @atomicservice 912 * @since 20 913 */ 914 windowY: number; 915 916 /** 917 * X-axis coordinates relative to the upper left corner of the screen. 918 * 919 * @type { number } 920 * @syscap SystemCapability.ArkUI.ArkUI.Full 921 * @crossplatform 922 * @atomicservice 923 * @since 20 924 */ 925 displayX: number; 926 927 /** 928 * Y-axis coordinates relative to the upper left corner of the screen. 929 * 930 * @type { number } 931 * @syscap SystemCapability.ArkUI.ArkUI.Full 932 * @crossplatform 933 * @atomicservice 934 * @since 20 935 */ 936 displayY: number; 937} 938 939/** 940 * Type of the finger information. 941 * 942 * @interface FingerInfo 943 * @syscap SystemCapability.ArkUI.ArkUI.Full 944 * @since 8 945 */ 946/** 947 * Type of the finger information. 948 * 949 * @interface FingerInfo 950 * @syscap SystemCapability.ArkUI.ArkUI.Full 951 * @crossplatform 952 * @since 10 953 */ 954/** 955 * Type of the finger information. 956 * 957 * @interface FingerInfo 958 * @syscap SystemCapability.ArkUI.ArkUI.Full 959 * @crossplatform 960 * @atomicservice 961 * @since arkts {'1.1':'11','1.2':'20'} 962 * @arkts 1.1&1.2 963 */ 964interface FingerInfo { 965 /** 966 * Finger unique identifier. 967 * 968 * @type { number } 969 * @syscap SystemCapability.ArkUI.ArkUI.Full 970 * @since 8 971 */ 972 /** 973 * Finger unique identifier. 974 * 975 * @type { number } 976 * @syscap SystemCapability.ArkUI.ArkUI.Full 977 * @crossplatform 978 * @since 10 979 */ 980 /** 981 * Finger unique identifier. 982 * 983 * @type { number } 984 * @syscap SystemCapability.ArkUI.ArkUI.Full 985 * @crossplatform 986 * @atomicservice 987 * @since arkts {'1.1':'11','1.2':'20'} 988 * @arkts 1.1&1.2 989 */ 990 id: number; 991 992 /** 993 * X position of the click point relative to the global display coordinate. 994 * 995 * @type { ?number } 996 * @syscap SystemCapability.ArkUI.ArkUI.Full 997 * @crossplatform 998 * @atomicservice 999 * @since 20 1000 */ 1001 globalDisplayX?: number; 1002 1003 /** 1004 * Y position of the click point relative to the global display coordinate. 1005 * 1006 * @type { ?number } 1007 * @syscap SystemCapability.ArkUI.ArkUI.Full 1008 * @crossplatform 1009 * @atomicservice 1010 * @since 20 1011 */ 1012 globalDisplayY?: number; 1013 1014 /** 1015 * X coordinate of the touch point relative to the left edge of the device screen. 1016 * 1017 * @type { number } 1018 * @syscap SystemCapability.ArkUI.ArkUI.Full 1019 * @since 8 1020 */ 1021 /** 1022 * X coordinate of the touch point relative to the left edge of the device screen. 1023 * 1024 * @type { number } 1025 * @syscap SystemCapability.ArkUI.ArkUI.Full 1026 * @crossplatform 1027 * @since 10 1028 */ 1029 /** 1030 * X coordinate of the touch point relative to the left edge of the device screen. 1031 * 1032 * @type { number } 1033 * @syscap SystemCapability.ArkUI.ArkUI.Full 1034 * @crossplatform 1035 * @atomicservice 1036 * @since arkts {'1.1':'11','1.2':'20'} 1037 * @arkts 1.1&1.2 1038 */ 1039 globalX: number; 1040 1041 /** 1042 * The Y coordinate of the touch point relative to the upper edge of the device screen. 1043 * 1044 * @type { number } 1045 * @syscap SystemCapability.ArkUI.ArkUI.Full 1046 * @since 8 1047 */ 1048 /** 1049 * The Y coordinate of the touch point relative to the upper edge of the device screen. 1050 * 1051 * @type { number } 1052 * @syscap SystemCapability.ArkUI.ArkUI.Full 1053 * @crossplatform 1054 * @since 10 1055 */ 1056 /** 1057 * The Y coordinate of the touch point relative to the upper edge of the device screen. 1058 * 1059 * @type { number } 1060 * @syscap SystemCapability.ArkUI.ArkUI.Full 1061 * @crossplatform 1062 * @atomicservice 1063 * @since arkts {'1.1':'11','1.2':'20'} 1064 * @arkts 1.1&1.2 1065 */ 1066 globalY: number; 1067 1068 /** 1069 * X coordinate of the touch point relative to the left edge of the touched element. 1070 * 1071 * @type { number } 1072 * @syscap SystemCapability.ArkUI.ArkUI.Full 1073 * @since 8 1074 */ 1075 /** 1076 * X coordinate of the touch point relative to the left edge of the touched element. 1077 * 1078 * @type { number } 1079 * @syscap SystemCapability.ArkUI.ArkUI.Full 1080 * @crossplatform 1081 * @since 10 1082 */ 1083 /** 1084 * X coordinate of the touch point relative to the left edge of the touched element. 1085 * 1086 * @type { number } 1087 * @syscap SystemCapability.ArkUI.ArkUI.Full 1088 * @crossplatform 1089 * @atomicservice 1090 * @since arkts {'1.1':'11','1.2':'20'} 1091 * @arkts 1.1&1.2 1092 */ 1093 localX: number; 1094 1095 /** 1096 * Y coordinate of the touch point relative to the upper edge of the touched element. 1097 * 1098 * @type { number } 1099 * @syscap SystemCapability.ArkUI.ArkUI.Full 1100 * @since 8 1101 */ 1102 /** 1103 * Y coordinate of the touch point relative to the upper edge of the touched element. 1104 * 1105 * @type { number } 1106 * @syscap SystemCapability.ArkUI.ArkUI.Full 1107 * @crossplatform 1108 * @since 10 1109 */ 1110 /** 1111 * Y coordinate of the touch point relative to the upper edge of the touched element. 1112 * 1113 * @type { number } 1114 * @syscap SystemCapability.ArkUI.ArkUI.Full 1115 * @crossplatform 1116 * @atomicservice 1117 * @since arkts {'1.1':'11','1.2':'20'} 1118 * @arkts 1.1&1.2 1119 */ 1120 localY: number; 1121 1122 /** 1123 * X coordinate of the touch point relative to the left edge of the device screen. 1124 * 1125 * @type { number } 1126 * @syscap SystemCapability.ArkUI.ArkUI.Full 1127 * @crossplatform 1128 * @atomicservice 1129 * @since arkts {'1.1':'12','1.2':'20'} 1130 * @arkts 1.1&1.2 1131 */ 1132 displayX: number; 1133 1134 /** 1135 * Y coordinate of the touch point relative to the upper edge of the device screen. 1136 * 1137 * @type { number } 1138 * @syscap SystemCapability.ArkUI.ArkUI.Full 1139 * @crossplatform 1140 * @atomicservice 1141 * @since arkts {'1.1':'12','1.2':'20'} 1142 * @arkts 1.1&1.2 1143 */ 1144 displayY: number; 1145 1146 /** 1147 * Type of the touch hand. 1148 * 1149 * @type { InteractionHand } 1150 * @syscap SystemCapability.ArkUI.ArkUI.Full 1151 * @crossplatform 1152 * @atomicservice 1153 * @since arkts {'1.1':'15','1.2':'20'} 1154 * @arkts 1.1&1.2 1155 */ 1156 hand?: InteractionHand; 1157} 1158 1159/** 1160 * Defines the Gesture Type. 1161 * 1162 * @typedef { TapGestureInterface | LongPressGestureInterface | PanGestureInterface | PinchGestureInterface | SwipeGestureInterface | RotationGestureInterface | GestureGroupInterface } GestureType 1163 * @syscap SystemCapability.ArkUI.ArkUI.Full 1164 * @since 7 1165 */ 1166/** 1167 * Defines the Gesture Type. 1168 * 1169 * @typedef { TapGestureInterface | LongPressGestureInterface | PanGestureInterface | PinchGestureInterface | SwipeGestureInterface | RotationGestureInterface | GestureGroupInterface } GestureType 1170 * @syscap SystemCapability.ArkUI.ArkUI.Full 1171 * @crossplatform 1172 * @since 10 1173 */ 1174/** 1175 * Defines the Gesture Type. 1176 * 1177 * @typedef { TapGestureInterface | LongPressGestureInterface | PanGestureInterface | PinchGestureInterface | SwipeGestureInterface | RotationGestureInterface | GestureGroupInterface } GestureType 1178 * @syscap SystemCapability.ArkUI.ArkUI.Full 1179 * @crossplatform 1180 * @atomicservice 1181 * @since 11 1182 */ 1183declare type GestureType = 1184 TapGestureInterface 1185 | LongPressGestureInterface 1186 | PanGestureInterface 1187 | PinchGestureInterface 1188 | SwipeGestureInterface 1189 | RotationGestureInterface 1190 | GestureGroupInterface; 1191 1192/** 1193 * Defines the Gesture Type. 1194 * 1195 * @typedef { Gesture | GestureGroup } GestureType 1196 * @syscap SystemCapability.ArkUI.ArkUI.Full 1197 * @crossplatform 1198 * @atomicservice 1199 * @since 20 1200 * @arkts 1.2 1201 */ 1202export type GestureType = Gesture | GestureGroup; 1203 1204/** 1205 * Defines the gesture base event. 1206 * 1207 * @extends BaseEvent 1208 * @interface BaseGestureEvent 1209 * @syscap SystemCapability.ArkUI.ArkUI.Full 1210 * @crossplatform 1211 * @since 11 1212 */ 1213/** 1214 * Defines the gesture base event. 1215 * 1216 * @extends BaseEvent 1217 * @interface BaseGestureEvent 1218 * @syscap SystemCapability.ArkUI.ArkUI.Full 1219 * @crossplatform 1220 * @atomicservice 1221 * @since arkts {'1.1':'12','1.2':'20'} 1222 * @arkts 1.1&1.2 1223 */ 1224interface BaseGestureEvent extends BaseEvent { 1225 /** 1226 * All finger information. 1227 * 1228 * @type { FingerInfo[] } 1229 * @syscap SystemCapability.ArkUI.ArkUI.Full 1230 * @crossplatform 1231 * @since 11 1232 */ 1233 /** 1234 * All finger information. 1235 * 1236 * @type { FingerInfo[] } 1237 * @syscap SystemCapability.ArkUI.ArkUI.Full 1238 * @crossplatform 1239 * @atomicservice 1240 * @since arkts {'1.1':'12','1.2':'20'} 1241 * @arkts 1.1&1.2 1242 */ 1243 fingerList: FingerInfo[]; 1244 1245 /** 1246 * All finger information when the gesture event is triggered, the return value 1247 * is one array, and the array length is just the total fingers count. 1248 * 1249 * @type { ?FingerInfo[] } 1250 * @syscap SystemCapability.ArkUI.ArkUI.Full 1251 * @crossplatform 1252 * @atomicservice 1253 * @since 20 1254 */ 1255 fingerInfos?: FingerInfo[]; 1256} 1257 1258/** 1259 * Defines event info for tap gesture. 1260 * 1261 * @extends BaseGestureEvent 1262 * @interface TapGestureEvent 1263 * @syscap SystemCapability.ArkUI.ArkUI.Full 1264 * @crossplatform 1265 * @since 11 1266 */ 1267/** 1268 * Defines event info for tap gesture. 1269 * 1270 * @extends BaseGestureEvent 1271 * @interface TapGestureEvent 1272 * @syscap SystemCapability.ArkUI.ArkUI.Full 1273 * @crossplatform 1274 * @atomicservice 1275 * @since arkts {'1.1':'12','1.2':'20'} 1276 * @arkts 1.1&1.2 1277 */ 1278interface TapGestureEvent extends BaseGestureEvent { 1279 /** 1280 * The tap location info used in tap gesture. 1281 * 1282 * @type {?EventLocationInfo} 1283 * @syscap SystemCapability.ArkUI.ArkUI.Full 1284 * @crossplatform 1285 * @atomicservice 1286 * @since 20 1287 */ 1288 tapLocation?: EventLocationInfo; 1289} 1290 1291/** 1292 * Defines event info for long press gesture. 1293 * 1294 * @extends BaseGestureEvent 1295 * @interface LongPressGestureEvent 1296 * @syscap SystemCapability.ArkUI.ArkUI.Full 1297 * @crossplatform 1298 * @since 11 1299 */ 1300/** 1301 * Defines event info for long press gesture. 1302 * 1303 * @extends BaseGestureEvent 1304 * @interface LongPressGestureEvent 1305 * @syscap SystemCapability.ArkUI.ArkUI.Full 1306 * @crossplatform 1307 * @atomicservice 1308 * @since arkts {'1.1':'12','1.2':'20'} 1309 * @arkts 1.1&1.2 1310 */ 1311interface LongPressGestureEvent extends BaseGestureEvent { 1312 /** 1313 * Indicates whether an event is triggered repeatedly. 1314 * 1315 * @type { boolean } 1316 * @syscap SystemCapability.ArkUI.ArkUI.Full 1317 * @crossplatform 1318 * @since 11 1319 */ 1320 /** 1321 * Indicates whether an event is triggered repeatedly. 1322 * 1323 * @type { boolean } 1324 * @syscap SystemCapability.ArkUI.ArkUI.Full 1325 * @crossplatform 1326 * @atomicservice 1327 * @since arkts {'1.1':'12','1.2':'20'} 1328 * @arkts 1.1&1.2 1329 */ 1330 repeat: boolean; 1331} 1332 1333/** 1334 * Defines event info for pan gesture. 1335 * 1336 * @extends BaseGestureEvent 1337 * @interface PanGestureEvent 1338 * @syscap SystemCapability.ArkUI.ArkUI.Full 1339 * @crossplatform 1340 * @since 11 1341 */ 1342/** 1343 * Defines event info for pan gesture. 1344 * 1345 * @extends BaseGestureEvent 1346 * @interface PanGestureEvent 1347 * @syscap SystemCapability.ArkUI.ArkUI.Full 1348 * @crossplatform 1349 * @atomicservice 1350 * @since arkts {'1.1':'12','1.2':'20'} 1351 * @arkts 1.1&1.2 1352 */ 1353interface PanGestureEvent extends BaseGestureEvent { 1354 /** 1355 * Gesture event offset X. 1356 * The unit is vp. 1357 * 1358 * @type { number } 1359 * @syscap SystemCapability.ArkUI.ArkUI.Full 1360 * @crossplatform 1361 * @since 11 1362 */ 1363 /** 1364 * Gesture event offset X. 1365 * The unit is vp. 1366 * 1367 * @type { number } 1368 * @syscap SystemCapability.ArkUI.ArkUI.Full 1369 * @crossplatform 1370 * @atomicservice 1371 * @since arkts {'1.1':'12','1.2':'20'} 1372 * @arkts 1.1&1.2 1373 */ 1374 offsetX: number; 1375 1376 /** 1377 * Gesture event offset Y. 1378 * The unit is vp. 1379 * 1380 * @type { number } 1381 * @syscap SystemCapability.ArkUI.ArkUI.Full 1382 * @crossplatform 1383 * @since 11 1384 */ 1385 /** 1386 * Gesture event offset Y. 1387 * The unit is vp. 1388 * 1389 * @type { number } 1390 * @syscap SystemCapability.ArkUI.ArkUI.Full 1391 * @crossplatform 1392 * @atomicservice 1393 * @since arkts {'1.1':'12','1.2':'20'} 1394 * @arkts 1.1&1.2 1395 */ 1396 offsetY: number; 1397 1398 /** 1399 * X-axis velocity of the gesture. 1400 * @type {number} 1401 * @syscap SystemCapability.ArkUI.ArkUI.Full 1402 * @crossplatform 1403 * @since 11 1404 */ 1405 /** 1406 * X-axis velocity of the gesture. 1407 * @type {number} 1408 * @syscap SystemCapability.ArkUI.ArkUI.Full 1409 * @crossplatform 1410 * @atomicservice 1411 * @since arkts {'1.1':'12','1.2':'20'} 1412 * @arkts 1.1&1.2 1413 */ 1414 velocityX: number; 1415 1416 /** 1417 * Y-axis velocity of the gesture. 1418 * @type {number} 1419 * @syscap SystemCapability.ArkUI.ArkUI.Full 1420 * @crossplatform 1421 * @since 11 1422 */ 1423 /** 1424 * Y-axis velocity of the gesture. 1425 * @type {number} 1426 * @syscap SystemCapability.ArkUI.ArkUI.Full 1427 * @crossplatform 1428 * @atomicservice 1429 * @since arkts {'1.1':'12','1.2':'20'} 1430 * @arkts 1.1&1.2 1431 */ 1432 velocityY: number; 1433 1434 /** 1435 * velocity of the gesture. 1436 * @type {number} 1437 * @syscap SystemCapability.ArkUI.ArkUI.Full 1438 * @crossplatform 1439 * @since 11 1440 */ 1441 /** 1442 * velocity of the gesture. 1443 * @type {number} 1444 * @syscap SystemCapability.ArkUI.ArkUI.Full 1445 * @crossplatform 1446 * @atomicservice 1447 * @since arkts {'1.1':'12','1.2':'20'} 1448 * @arkts 1.1&1.2 1449 */ 1450 velocity: number; 1451} 1452 1453/** 1454 * Defines event info for pinch gesture. 1455 * 1456 * @extends BaseGestureEvent 1457 * @interface PinchGestureEvent 1458 * @syscap SystemCapability.ArkUI.ArkUI.Full 1459 * @crossplatform 1460 * @since 11 1461 */ 1462/** 1463 * Defines event info for pinch gesture. 1464 * 1465 * @extends BaseGestureEvent 1466 * @interface PinchGestureEvent 1467 * @syscap SystemCapability.ArkUI.ArkUI.Full 1468 * @crossplatform 1469 * @atomicservice 1470 * @since arkts {'1.1':'12','1.2':'20'} 1471 * @arkts 1.1&1.2 1472 */ 1473interface PinchGestureEvent extends BaseGestureEvent { 1474 /** 1475 * Scaling ratio. 1476 * 1477 * @type { number } 1478 * @syscap SystemCapability.ArkUI.ArkUI.Full 1479 * @crossplatform 1480 * @since 11 1481 */ 1482 /** 1483 * Scaling ratio. 1484 * 1485 * @type { number } 1486 * @syscap SystemCapability.ArkUI.ArkUI.Full 1487 * @crossplatform 1488 * @atomicservice 1489 * @since arkts {'1.1':'12','1.2':'20'} 1490 * @arkts 1.1&1.2 1491 */ 1492 scale: number; 1493 1494 /** 1495 * X-axis coordinate of the kneading center point. 1496 * The unit is vp. 1497 * 1498 * @type { number } 1499 * @syscap SystemCapability.ArkUI.ArkUI.Full 1500 * @crossplatform 1501 * @since 11 1502 */ 1503 /** 1504 * X-axis coordinate of the kneading center point. 1505 * The unit is vp. 1506 * 1507 * @type { number } 1508 * @syscap SystemCapability.ArkUI.ArkUI.Full 1509 * @crossplatform 1510 * @atomicservice 1511 * @since arkts {'1.1':'12','1.2':'20'} 1512 * @arkts 1.1&1.2 1513 */ 1514 pinchCenterX: number; 1515 1516 /** 1517 * Y-axis coordinate of the kneading center point. 1518 * The unit is vp. 1519 * 1520 * @type { number } 1521 * @syscap SystemCapability.ArkUI.ArkUI.Full 1522 * @crossplatform 1523 * @since 11 1524 */ 1525 /** 1526 * Y-axis coordinate of the kneading center point. 1527 * The unit is vp. 1528 * 1529 * @type { number } 1530 * @syscap SystemCapability.ArkUI.ArkUI.Full 1531 * @crossplatform 1532 * @atomicservice 1533 * @since arkts {'1.1':'12','1.2':'20'} 1534 * @arkts 1.1&1.2 1535 */ 1536 pinchCenterY: number; 1537} 1538 1539/** 1540 * Defines event info for rotation gesture. 1541 * 1542 * @extends BaseGestureEvent 1543 * @interface RotationGestureEvent 1544 * @syscap SystemCapability.ArkUI.ArkUI.Full 1545 * @crossplatform 1546 * @since 11 1547 */ 1548/** 1549 * Defines event info for rotation gesture. 1550 * 1551 * @extends BaseGestureEvent 1552 * @interface RotationGestureEvent 1553 * @syscap SystemCapability.ArkUI.ArkUI.Full 1554 * @crossplatform 1555 * @atomicservice 1556 * @since arkts {'1.1':'12','1.2':'20'} 1557 * @arkts 1.1&1.2 1558 */ 1559interface RotationGestureEvent extends BaseGestureEvent { 1560 /** 1561 * Gesture event direction angle. 1562 * The unit is deg. 1563 * 1564 * @type { number } 1565 * @syscap SystemCapability.ArkUI.ArkUI.Full 1566 * @crossplatform 1567 * @since 11 1568 */ 1569 /** 1570 * Gesture event direction angle. 1571 * The unit is deg. 1572 * 1573 * @type { number } 1574 * @syscap SystemCapability.ArkUI.ArkUI.Full 1575 * @crossplatform 1576 * @atomicservice 1577 * @since arkts {'1.1':'12','1.2':'20'} 1578 * @arkts 1.1&1.2 1579 */ 1580 angle: number; 1581} 1582 1583/** 1584 * Defines event info for swipe gesture. 1585 * 1586 * @extends BaseGestureEvent 1587 * @interface SwipeGestureEvent 1588 * @syscap SystemCapability.ArkUI.ArkUI.Full 1589 * @crossplatform 1590 * @since 11 1591 */ 1592/** 1593 * Defines event info for swipe gesture. 1594 * 1595 * @extends BaseGestureEvent 1596 * @interface SwipeGestureEvent 1597 * @syscap SystemCapability.ArkUI.ArkUI.Full 1598 * @crossplatform 1599 * @atomicservice 1600 * @since arkts {'1.1':'12','1.2':'20'} 1601 * @arkts 1.1&1.2 1602 */ 1603interface SwipeGestureEvent extends BaseGestureEvent { 1604 /** 1605 * Gesture event direction angle. 1606 * The unit is deg. 1607 * 1608 * @type { number } 1609 * @syscap SystemCapability.ArkUI.ArkUI.Full 1610 * @crossplatform 1611 * @since 11 1612 */ 1613 /** 1614 * Gesture event direction angle. 1615 * The unit is deg. 1616 * 1617 * @type { number } 1618 * @syscap SystemCapability.ArkUI.ArkUI.Full 1619 * @crossplatform 1620 * @atomicservice 1621 * @since arkts {'1.1':'12','1.2':'20'} 1622 * @arkts 1.1&1.2 1623 */ 1624 angle: number; 1625 1626 /** 1627 * Gesture event slide speed. 1628 * The unit is vp. 1629 * 1630 * @type { number } 1631 * @syscap SystemCapability.ArkUI.ArkUI.Full 1632 * @crossplatform 1633 * @since 11 1634 */ 1635 /** 1636 * Gesture event slide speed. 1637 * The unit is vp. 1638 * 1639 * @type { number } 1640 * @syscap SystemCapability.ArkUI.ArkUI.Full 1641 * @crossplatform 1642 * @atomicservice 1643 * @since arkts {'1.1':'12','1.2':'20'} 1644 * @arkts 1.1&1.2 1645 */ 1646 speed: number; 1647} 1648 1649/** 1650 * Defines event info for gesture. 1651 * 1652 * @extends BaseEvent 1653 * @interface GestureEvent 1654 * @syscap SystemCapability.ArkUI.ArkUI.Full 1655 * @since 7 1656 */ 1657/** 1658 * Defines event info for gesture. 1659 * 1660 * @extends BaseEvent 1661 * @interface GestureEvent 1662 * @syscap SystemCapability.ArkUI.ArkUI.Full 1663 * @crossplatform 1664 * @since 10 1665 */ 1666/** 1667 * Defines event info for gesture. 1668 * 1669 * @extends BaseEvent 1670 * @interface GestureEvent 1671 * @syscap SystemCapability.ArkUI.ArkUI.Full 1672 * @crossplatform 1673 * @atomicservice 1674 * @since arkts {'1.1':'11','1.2':'20'} 1675 * @arkts 1.1&1.2 1676 */ 1677interface GestureEvent extends BaseEvent { 1678 /** 1679 * Indicates whether an event is triggered repeatedly. 1680 * Used in LongPressGesture. 1681 * 1682 * @type { boolean } 1683 * @syscap SystemCapability.ArkUI.ArkUI.Full 1684 * @since 7 1685 */ 1686 /** 1687 * Indicates whether an event is triggered repeatedly. 1688 * Used in LongPressGesture. 1689 * 1690 * @type { boolean } 1691 * @syscap SystemCapability.ArkUI.ArkUI.Full 1692 * @crossplatform 1693 * @since 10 1694 */ 1695 /** 1696 * Indicates whether an event is triggered repeatedly. 1697 * Used in LongPressGesture. 1698 * 1699 * @type { boolean } 1700 * @syscap SystemCapability.ArkUI.ArkUI.Full 1701 * @crossplatform 1702 * @atomicservice 1703 * @since arkts {'1.1':'11','1.2':'20'} 1704 * @arkts 1.1&1.2 1705 */ 1706 repeat: boolean; 1707 1708 /** 1709 * All finger information. 1710 * Used in LongPressGesture and TapGesture. 1711 * 1712 * @type { FingerInfo[] } 1713 * @syscap SystemCapability.ArkUI.ArkUI.Full 1714 * @since 8 1715 */ 1716 /** 1717 * All finger information. 1718 * Used in LongPressGesture and TapGesture. 1719 * 1720 * @type { FingerInfo[] } 1721 * @syscap SystemCapability.ArkUI.ArkUI.Full 1722 * @crossplatform 1723 * @since 10 1724 */ 1725 /** 1726 * All finger information. 1727 * Used in LongPressGesture and TapGesture. 1728 * 1729 * @type { FingerInfo[] } 1730 * @syscap SystemCapability.ArkUI.ArkUI.Full 1731 * @crossplatform 1732 * @atomicservice 1733 * @since arkts {'1.1':'11','1.2':'20'} 1734 * @arkts 1.1&1.2 1735 */ 1736 fingerList: FingerInfo[]; 1737 1738 /** 1739 * All finger information when the gesture event is triggered, the return value 1740 * is one array, and the array length is just the total fingers count. 1741 * 1742 * @type { ?FingerInfo[] } 1743 * @syscap SystemCapability.ArkUI.ArkUI.Full 1744 * @crossplatform 1745 * @atomicservice 1746 * @since 20 1747 */ 1748 fingerInfos?: FingerInfo[]; 1749 1750 /** 1751 * Gesture event offset X. 1752 * The unit is vp. 1753 * Used in PanGesture. 1754 * 1755 * @type { number } 1756 * @syscap SystemCapability.ArkUI.ArkUI.Full 1757 * @since 7 1758 */ 1759 /** 1760 * Gesture event offset X. 1761 * The unit is vp. 1762 * Used in PanGesture. 1763 * 1764 * @type { number } 1765 * @syscap SystemCapability.ArkUI.ArkUI.Full 1766 * @crossplatform 1767 * @since 10 1768 */ 1769 /** 1770 * Gesture event offset X. 1771 * The unit is vp. 1772 * Used in PanGesture. 1773 * 1774 * @type { number } 1775 * @syscap SystemCapability.ArkUI.ArkUI.Full 1776 * @crossplatform 1777 * @atomicservice 1778 * @since arkts {'1.1':'11','1.2':'20'} 1779 * @arkts 1.1&1.2 1780 */ 1781 offsetX: number; 1782 1783 /** 1784 * Gesture event offset Y. 1785 * The unit is vp. 1786 * Used in PanGesture. 1787 * 1788 * @type { number } 1789 * @syscap SystemCapability.ArkUI.ArkUI.Full 1790 * @since 7 1791 */ 1792 /** 1793 * Gesture event offset Y. 1794 * The unit is vp. 1795 * Used in PanGesture. 1796 * 1797 * @type { number } 1798 * @syscap SystemCapability.ArkUI.ArkUI.Full 1799 * @crossplatform 1800 * @since 10 1801 */ 1802 /** 1803 * Gesture event offset Y. 1804 * The unit is vp. 1805 * Used in PanGesture. 1806 * 1807 * @type { number } 1808 * @syscap SystemCapability.ArkUI.ArkUI.Full 1809 * @crossplatform 1810 * @atomicservice 1811 * @since arkts {'1.1':'11','1.2':'20'} 1812 * @arkts 1.1&1.2 1813 */ 1814 offsetY: number; 1815 1816 /** 1817 * Gesture event direction angle. 1818 * The unit is deg. 1819 * Used in RotationGesture and SwipeGesture. 1820 * 1821 * @type { number } 1822 * @syscap SystemCapability.ArkUI.ArkUI.Full 1823 * @since 7 1824 */ 1825 /** 1826 * Gesture event direction angle. 1827 * The unit is deg. 1828 * Used in RotationGesture and SwipeGesture. 1829 * 1830 * @type { number } 1831 * @syscap SystemCapability.ArkUI.ArkUI.Full 1832 * @crossplatform 1833 * @since 10 1834 */ 1835 /** 1836 * Gesture event direction angle. 1837 * The unit is deg. 1838 * Used in RotationGesture and SwipeGesture. 1839 * 1840 * @type { number } 1841 * @syscap SystemCapability.ArkUI.ArkUI.Full 1842 * @crossplatform 1843 * @atomicservice 1844 * @since arkts {'1.1':'11','1.2':'20'} 1845 * @arkts 1.1&1.2 1846 */ 1847 angle: number; 1848 1849 /** 1850 * Gesture event slide speed. 1851 * The unit is vp. 1852 * Used in SwipeGesture. 1853 * 1854 * @type { number } 1855 * @syscap SystemCapability.ArkUI.ArkUI.Full 1856 * @since 8 1857 */ 1858 /** 1859 * Gesture event slide speed. 1860 * The unit is vp. 1861 * Used in SwipeGesture. 1862 * 1863 * @type { number } 1864 * @syscap SystemCapability.ArkUI.ArkUI.Full 1865 * @crossplatform 1866 * @since 10 1867 */ 1868 /** 1869 * Gesture event slide speed. 1870 * The unit is vp. 1871 * Used in SwipeGesture. 1872 * 1873 * @type { number } 1874 * @syscap SystemCapability.ArkUI.ArkUI.Full 1875 * @crossplatform 1876 * @atomicservice 1877 * @since arkts {'1.1':'11','1.2':'20'} 1878 * @arkts 1.1&1.2 1879 */ 1880 speed: number; 1881 1882 /** 1883 * Scaling ratio. 1884 * Used in PinchGesture. 1885 * 1886 * @type { number } 1887 * @syscap SystemCapability.ArkUI.ArkUI.Full 1888 * @since 7 1889 */ 1890 /** 1891 * Scaling ratio. 1892 * Used in PinchGesture. 1893 * 1894 * @type { number } 1895 * @syscap SystemCapability.ArkUI.ArkUI.Full 1896 * @crossplatform 1897 * @since 10 1898 */ 1899 /** 1900 * Scaling ratio. 1901 * Used in PinchGesture. 1902 * 1903 * @type { number } 1904 * @syscap SystemCapability.ArkUI.ArkUI.Full 1905 * @crossplatform 1906 * @atomicservice 1907 * @since arkts {'1.1':'11','1.2':'20'} 1908 * @arkts 1.1&1.2 1909 */ 1910 scale: number; 1911 1912 /** 1913 * X-axis coordinate of the kneading center point. 1914 * The unit is vp. 1915 * Used in PinchGesture. 1916 * 1917 * @type { number } 1918 * @syscap SystemCapability.ArkUI.ArkUI.Full 1919 * @since 7 1920 */ 1921 /** 1922 * X-axis coordinate of the kneading center point. 1923 * The unit is vp. 1924 * Used in PinchGesture. 1925 * 1926 * @type { number } 1927 * @syscap SystemCapability.ArkUI.ArkUI.Full 1928 * @crossplatform 1929 * @since 10 1930 */ 1931 /** 1932 * X-axis coordinate of the kneading center point. 1933 * The unit is vp. 1934 * Used in PinchGesture. 1935 * 1936 * @type { number } 1937 * @syscap SystemCapability.ArkUI.ArkUI.Full 1938 * @crossplatform 1939 * @atomicservice 1940 * @since arkts {'1.1':'11','1.2':'20'} 1941 * @arkts 1.1&1.2 1942 */ 1943 pinchCenterX: number; 1944 1945 /** 1946 * Y-axis coordinate of the kneading center point. 1947 * The unit is vp. 1948 * Used in PinchGesture. 1949 * 1950 * @type { number } 1951 * @syscap SystemCapability.ArkUI.ArkUI.Full 1952 * @since 7 1953 */ 1954 /** 1955 * Y-axis coordinate of the kneading center point. 1956 * The unit is vp. 1957 * Used in PinchGesture. 1958 * 1959 * @type { number } 1960 * @syscap SystemCapability.ArkUI.ArkUI.Full 1961 * @crossplatform 1962 * @since 10 1963 */ 1964 /** 1965 * Y-axis coordinate of the kneading center point. 1966 * The unit is vp. 1967 * Used in PinchGesture. 1968 * 1969 * @type { number } 1970 * @syscap SystemCapability.ArkUI.ArkUI.Full 1971 * @crossplatform 1972 * @atomicservice 1973 * @since arkts {'1.1':'11','1.2':'20'} 1974 * @arkts 1.1&1.2 1975 */ 1976 pinchCenterY: number; 1977 1978 /** 1979 * X-axis velocity of the gesture. 1980 * @type {number} 1981 * @syscap SystemCapability.ArkUI.ArkUI.Full 1982 * @crossplatform 1983 * @since 10 1984 */ 1985 /** 1986 * X-axis velocity of the gesture. 1987 * @type {number} 1988 * @syscap SystemCapability.ArkUI.ArkUI.Full 1989 * @crossplatform 1990 * @atomicservice 1991 * @since arkts {'1.1':'11','1.2':'20'} 1992 * @arkts 1.1&1.2 1993 */ 1994 velocityX: number; 1995 1996 /** 1997 * Y-axis velocity of the gesture. 1998 * @type {number} 1999 * @syscap SystemCapability.ArkUI.ArkUI.Full 2000 * @crossplatform 2001 * @since 10 2002 */ 2003 /** 2004 * Y-axis velocity of the gesture. 2005 * @type {number} 2006 * @syscap SystemCapability.ArkUI.ArkUI.Full 2007 * @crossplatform 2008 * @atomicservice 2009 * @since arkts {'1.1':'11','1.2':'20'} 2010 * @arkts 1.1&1.2 2011 */ 2012 velocityY: number; 2013 2014 /** 2015 * velocity of the gesture. 2016 * @type {number} 2017 * @syscap SystemCapability.ArkUI.ArkUI.Full 2018 * @crossplatform 2019 * @since 10 2020 */ 2021 /** 2022 * velocity of the gesture. 2023 * @type {number} 2024 * @syscap SystemCapability.ArkUI.ArkUI.Full 2025 * @crossplatform 2026 * @atomicservice 2027 * @since arkts {'1.1':'11','1.2':'20'} 2028 * @arkts 1.1&1.2 2029 */ 2030 velocity: number; 2031 2032 /** 2033 * The tap location info used in tap gesture. 2034 * 2035 * @type {?EventLocationInfo} 2036 * @syscap SystemCapability.ArkUI.ArkUI.Full 2037 * @crossplatform 2038 * @atomicservice 2039 * @since 20 2040 */ 2041 tapLocation?: EventLocationInfo; 2042} 2043 2044/** 2045 * Defines Gesture interface. 2046 * 2047 * @interface GestureInterface 2048 * @syscap SystemCapability.ArkUI.ArkUI.Full 2049 * @crossplatform 2050 * @atomicservice 2051 * @since 11 2052 */ 2053interface GestureInterface<T> { 2054 /** 2055 * Set gesture's tag. 2056 * 2057 * @param { string } tag 2058 * @returns { T } 2059 * @syscap SystemCapability.ArkUI.ArkUI.Full 2060 * @crossplatform 2061 * @atomicservice 2062 * @since 11 2063 */ 2064 tag(tag: string): T; 2065 2066 /** 2067 * Input source type for gesture response. 2068 * 2069 * @param { Array<SourceTool> } types - indicate the allowed input source for gesture to response 2070 * @returns { T } 2071 * @syscap SystemCapability.ArkUI.ArkUI.Full 2072 * @crossplatform 2073 * @atomicservice 2074 * @since 14 2075 */ 2076 allowedTypes(types: Array<SourceTool>): T; 2077} 2078 2079 /** 2080 * Defines the BaseHandlerOptions options. 2081 * @interface BaseHandlerOptions 2082 * @syscap SystemCapability.ArkUI.ArkUI.Full 2083 * @crossplatform 2084 * @atomicservice 2085 * @since arkts {'1.1':'15','1.2':'20'} 2086 * @arkts 1.1&1.2 2087 */ 2088 interface BaseHandlerOptions { 2089 /** 2090 * The flag to strict verification fingers, if touch finger size is over or less than fingers, gesture can not be accepted. 2091 * The default value is false. 2092 * 2093 * @type { ?boolean } 2094 * @syscap SystemCapability.ArkUI.ArkUI.Full 2095 * @crossplatform 2096 * @atomicservice 2097 * @since arkts {'1.1':'15','1.2':'20'} 2098 * @arkts 1.1&1.2 2099 */ 2100 isFingerCountLimited?: boolean; 2101} 2102 2103/** 2104 * Defines Gesture interface. 2105 * 2106 * @syscap SystemCapability.ArkUI.ArkUI.Full 2107 * @crossplatform 2108 * @atomicservice 2109 * @since 20 2110 * @arkts 1.2 2111 */ 2112export declare class Gesture { 2113 /** 2114 * Set gesture's tag. 2115 * 2116 * @param { string } tag 2117 * @returns { this } 2118 * @syscap SystemCapability.ArkUI.ArkUI.Full 2119 * @crossplatform 2120 * @atomicservice 2121 * @since 20 2122 * @arkts 1.2 2123 */ 2124 tag(tag: string): this; 2125 2126 /** 2127 * Input source type for gesture response. 2128 * 2129 * @param { Array<SourceTool> } types - indicate the allowed input source for gesture to response 2130 * @returns { this } 2131 * @syscap SystemCapability.ArkUI.ArkUI.Full 2132 * @crossplatform 2133 * @atomicservice 2134 * @since 20 2135 * @arkts 1.2 2136 */ 2137 allowedTypes(types: Array<SourceTool>): this; 2138} 2139 2140/** 2141 * Defines TapGesture parameters. 2142 * 2143 * @interface TapGestureParameters 2144 * @syscap SystemCapability.ArkUI.ArkUI.Full 2145 * @crossplatform 2146 * @atomicservice 2147 * @since 12 2148 */ 2149/** 2150 * Defines TapGesture parameters. 2151 * 2152 * @extends BaseHandlerOptions 2153 * @interface TapGestureParameters 2154 * @syscap SystemCapability.ArkUI.ArkUI.Full 2155 * @crossplatform 2156 * @atomicservice 2157 * @since arkts {'1.1':'15','1.2':'20'} 2158 * @arkts 1.1&1.2 2159 */ 2160declare interface TapGestureParameters extends BaseHandlerOptions { 2161 /** 2162 * Number of consecutive clicks recognized. If the value is less than 1 or null, the default value is used. 2163 * 2164 * @type { ?number } 2165 * @syscap SystemCapability.ArkUI.ArkUI.Full 2166 * @crossplatform 2167 * @atomicservice 2168 * @since arkts {'1.1':'11','1.2':'20'} 2169 * @arkts 1.1&1.2 2170 */ 2171 count?: number; 2172 /** 2173 * The hand index that triggers the click. If the value is less than 1, the default value is used. 2174 * 2175 * @type { ?number } 2176 * @syscap SystemCapability.ArkUI.ArkUI.Full 2177 * @crossplatform 2178 * @atomicservice 2179 * @since arkts {'1.1':'11','1.2':'20'} 2180 * @arkts 1.1&1.2 2181 */ 2182 fingers?: number; 2183 /** 2184 * The limited move distance of click. If the value is less than 0, the default value is used. 2185 * 2186 * @type { ?number } 2187 * @syscap SystemCapability.ArkUI.ArkUI.Full 2188 * @crossplatform 2189 * @atomicservice 2190 * @since arkts {'1.1':'12','1.2':'20'} 2191 * @arkts 1.1&1.2 2192 */ 2193 distanceThreshold?: number; 2194} 2195 2196/** 2197 * Defines TapGesture interface. 2198 * 2199 * @extends GestureInterface<TapGestureInterface> 2200 * @interface TapGestureInterface 2201 * @syscap SystemCapability.ArkUI.ArkUI.Full 2202 * @since 7 2203 */ 2204/** 2205 * Defines TapGesture interface. 2206 * 2207 * @extends GestureInterface<TapGestureInterface> 2208 * @interface TapGestureInterface 2209 * @syscap SystemCapability.ArkUI.ArkUI.Full 2210 * @crossplatform 2211 * @since 10 2212 */ 2213/** 2214 * Defines TapGesture interface extends GestureInterface<TapGestureInterface>. 2215 * 2216 * @extends GestureInterface<TapGestureInterface> 2217 * @interface TapGestureInterface 2218 * @syscap SystemCapability.ArkUI.ArkUI.Full 2219 * @crossplatform 2220 * @atomicservice 2221 * @since 11 2222 */ 2223interface TapGestureInterface extends GestureInterface<TapGestureInterface> { 2224 /** 2225 * Set the value. 2226 * count:Number of consecutive clicks recognized. If the value is less than 1, the default value is used. 2227 * fingers:The hand index that triggers the click. If the value is less than 1, the default value is used. 2228 * 2229 * @param { object } value 2230 * @returns { TapGestureInterface } 2231 * @syscap SystemCapability.ArkUI.ArkUI.Full 2232 * @since 7 2233 */ 2234 /** 2235 * Set the value. 2236 * count:Number of consecutive clicks recognized. If the value is less than 1, the default value is used. 2237 * fingers:The hand index that triggers the click. If the value is less than 1, the default value is used. 2238 * 2239 * @param { object } value 2240 * @returns { TapGestureInterface } 2241 * @syscap SystemCapability.ArkUI.ArkUI.Full 2242 * @crossplatform 2243 * @since 10 2244 */ 2245 /** 2246 * Set the value. 2247 * count:Number of consecutive clicks recognized. If the value is less than 1, the default value is used. 2248 * fingers:The hand index that triggers the click. If the value is less than 1, the default value is used. 2249 * 2250 * @param { object } value 2251 * @returns { TapGestureInterface } 2252 * @syscap SystemCapability.ArkUI.ArkUI.Full 2253 * @crossplatform 2254 * @atomicservice 2255 * @since 11 2256 */ 2257 /** 2258 * Set the value. 2259 * TapGestureParameters: The parameters of the tapGesture. 2260 * 2261 * @param { TapGestureParameters } value 2262 * @returns { TapGestureInterface } 2263 * @syscap SystemCapability.ArkUI.ArkUI.Full 2264 * @crossplatform 2265 * @atomicservice 2266 * @since 12 2267 */ 2268 (value?: TapGestureParameters): TapGestureInterface; 2269 2270 /** 2271 * Tap gesture recognition success callback. 2272 * 2273 * @param { function } event 2274 * @returns { TapGestureInterface } 2275 * @syscap SystemCapability.ArkUI.ArkUI.Full 2276 * @since 7 2277 */ 2278 /** 2279 * Tap gesture recognition success callback. 2280 * 2281 * @param { function } event 2282 * @returns { TapGestureInterface } 2283 * @syscap SystemCapability.ArkUI.ArkUI.Full 2284 * @crossplatform 2285 * @since 10 2286 */ 2287 /** 2288 * Tap gesture recognition success callback. 2289 * 2290 * @param { function } event 2291 * @returns { TapGestureInterface } 2292 * @syscap SystemCapability.ArkUI.ArkUI.Full 2293 * @crossplatform 2294 * @atomicservice 2295 * @since 11 2296 */ 2297 onAction(event: (event: GestureEvent) => void): TapGestureInterface; 2298} 2299 2300/*** if arkts 1.2 */ 2301/** 2302 * Defines TapGesture. 2303 * 2304 * @extends Gesture 2305 * @syscap SystemCapability.ArkUI.ArkUI.Full 2306 * @crossplatform 2307 * @atomicservice 2308 * @since 20 2309 */ 2310export declare class TapGesture extends Gesture { 2311 /** 2312 * Set the value. 2313 * TapGestureParameters: The parameters of the tapGesture. 2314 * 2315 * @param { function } factory 2316 * @param { TapGestureParameters } value 2317 * @returns { TapGesture } 2318 * @static 2319 * @syscap SystemCapability.ArkUI.ArkUI.Full 2320 * @crossplatform 2321 * @atomicservice 2322 * @since 20 2323 */ 2324 static $_instantiate(factory: () => TapGesture, value?: TapGestureParameters): TapGesture 2325 2326 /** 2327 * Tap gesture recognition success callback. 2328 * 2329 * @param { Callback<GestureEvent> } event 2330 * @returns { this } 2331 * @syscap SystemCapability.ArkUI.ArkUI.Full 2332 * @crossplatform 2333 * @atomicservice 2334 * @since 20 2335 */ 2336 onAction(event: Callback<GestureEvent>): this; 2337} 2338/*** endif */ 2339 2340/** 2341 * Defines LongPressGesture interface. 2342 * 2343 * @extends GestureInterface<LongPressGestureInterface> 2344 * @interface LongPressGestureInterface 2345 * @syscap SystemCapability.ArkUI.ArkUI.Full 2346 * @since 7 2347 */ 2348/** 2349 * Defines LongPressGesture interface. 2350 * 2351 * @extends GestureInterface<LongPressGestureInterface> 2352 * @interface LongPressGestureInterface 2353 * @syscap SystemCapability.ArkUI.ArkUI.Full 2354 * @crossplatform 2355 * @since 10 2356 */ 2357/** 2358 * Defines LongPressGesture interface extends GestureInterface<LongPressGestureInterface>. 2359 * 2360 * @extends GestureInterface<LongPressGestureInterface> 2361 * @interface LongPressGestureInterface 2362 * @syscap SystemCapability.ArkUI.ArkUI.Full 2363 * @crossplatform 2364 * @atomicservice 2365 * @since 11 2366 */ 2367interface LongPressGestureInterface extends GestureInterface<LongPressGestureInterface> { 2368 /** 2369 * Set the value. 2370 * fingers: Indicates the hand index that triggers the long press. 2371 * repeat: Indicates whether to trigger event callback continuously. 2372 * duration: Minimum press and hold time, in milliseconds. 2373 * 2374 * @param { object } value 2375 * @returns { LongPressGestureInterface } 2376 * @syscap SystemCapability.ArkUI.ArkUI.Full 2377 * @since 7 2378 */ 2379 /** 2380 * Set the value. 2381 * fingers: Indicates the hand index that triggers the long press. 2382 * repeat: Indicates whether to trigger event callback continuously. 2383 * duration: Minimum press and hold time, in milliseconds. 2384 * 2385 * @param { object } value 2386 * @returns { LongPressGestureInterface } 2387 * @syscap SystemCapability.ArkUI.ArkUI.Full 2388 * @crossplatform 2389 * @since 10 2390 */ 2391 /** 2392 * Set the value. 2393 * fingers: Indicates the hand index that triggers the long press. 2394 * repeat: Indicates whether to trigger event callback continuously. 2395 * duration: Minimum press and hold time, in milliseconds. 2396 * 2397 * @param { object } value 2398 * @returns { LongPressGestureInterface } 2399 * @syscap SystemCapability.ArkUI.ArkUI.Full 2400 * @crossplatform 2401 * @atomicservice 2402 * @since 11 2403 */ 2404 (value?: { fingers?: number; repeat?: boolean; duration?: number }): LongPressGestureInterface; 2405 2406 /** 2407 * Set the options. 2408 * options: The options of the long press gesture. 2409 * 2410 * @param { LongPressGestureHandlerOptions } options 2411 * @returns { LongPressGestureInterface } 2412 * @syscap SystemCapability.ArkUI.ArkUI.Full 2413 * @crossplatform 2414 * @atomicservice 2415 * @since 15 2416 */ 2417 (options?: LongPressGestureHandlerOptions): LongPressGestureInterface; 2418 /** 2419 * LongPress gesture recognition success callback. 2420 * 2421 * @param { function } event 2422 * @returns { LongPressGestureInterface } 2423 * @syscap SystemCapability.ArkUI.ArkUI.Full 2424 * @since 7 2425 */ 2426 /** 2427 * LongPress gesture recognition success callback. 2428 * 2429 * @param { function } event 2430 * @returns { LongPressGestureInterface } 2431 * @syscap SystemCapability.ArkUI.ArkUI.Full 2432 * @crossplatform 2433 * @since 10 2434 */ 2435 /** 2436 * LongPress gesture recognition success callback. 2437 * 2438 * @param { function } event 2439 * @returns { LongPressGestureInterface } 2440 * @syscap SystemCapability.ArkUI.ArkUI.Full 2441 * @crossplatform 2442 * @atomicservice 2443 * @since 11 2444 */ 2445 onAction(event: (event: GestureEvent) => void): LongPressGestureInterface; 2446 2447 /** 2448 * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2449 * 2450 * @param { function } event 2451 * @returns { LongPressGestureInterface } 2452 * @syscap SystemCapability.ArkUI.ArkUI.Full 2453 * @since 7 2454 */ 2455 /** 2456 * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2457 * 2458 * @param { function } event 2459 * @returns { LongPressGestureInterface } 2460 * @syscap SystemCapability.ArkUI.ArkUI.Full 2461 * @crossplatform 2462 * @since 10 2463 */ 2464 /** 2465 * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2466 * 2467 * @param { function } event 2468 * @returns { LongPressGestureInterface } 2469 * @syscap SystemCapability.ArkUI.ArkUI.Full 2470 * @crossplatform 2471 * @atomicservice 2472 * @since 11 2473 */ 2474 onActionEnd(event: (event: GestureEvent) => void): LongPressGestureInterface; 2475 2476 /** 2477 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2478 * 2479 * @param { function } event 2480 * @returns { LongPressGestureInterface } 2481 * @syscap SystemCapability.ArkUI.ArkUI.Full 2482 * @since 7 2483 */ 2484 /** 2485 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2486 * 2487 * @param { function } event 2488 * @returns { LongPressGestureInterface } 2489 * @syscap SystemCapability.ArkUI.ArkUI.Full 2490 * @crossplatform 2491 * @since 10 2492 */ 2493 /** 2494 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2495 * 2496 * @param { function } event 2497 * @returns { LongPressGestureInterface } 2498 * @syscap SystemCapability.ArkUI.ArkUI.Full 2499 * @crossplatform 2500 * @atomicservice 2501 * @since 11 2502 */ 2503 onActionCancel(event: () => void): LongPressGestureInterface; 2504 /** 2505 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2506 * 2507 * @param { function } event 2508 * @returns { LongPressGestureInterface } 2509 * @syscap SystemCapability.ArkUI.ArkUI.Full 2510 * @crossplatform 2511 * @atomicservice 2512 * @since 18 2513 */ 2514 onActionCancel(event: Callback<GestureEvent>): LongPressGestureInterface; 2515} 2516 2517/*** if arkts 1.2 */ 2518/** 2519 * Defines LongPressGesture. 2520 * 2521 * @extends Gesture 2522 * @syscap SystemCapability.ArkUI.ArkUI.Full 2523 * @crossplatform 2524 * @atomicservice 2525 * @since 20 2526 */ 2527export declare class LongPressGesture extends Gesture { 2528 /** 2529 * Set the value. 2530 * fingers: Indicates the hand index that triggers the long press. 2531 * repeat: Indicates whether to trigger event callback continuously. 2532 * duration: Minimum press and hold time, in milliseconds. 2533 * 2534 * @param { function } factory 2535 * @param { LongPressGestureHandlerOptions } value 2536 * @returns { LongPressGesture } 2537 * @static 2538 * @syscap SystemCapability.ArkUI.ArkUI.Full 2539 * @crossplatform 2540 * @atomicservice 2541 * @since 20 2542 */ 2543 static $_instantiate(factory: () => LongPressGesture, value?: LongPressGestureHandlerOptions): LongPressGesture 2544 2545 /** 2546 * LongPress gesture recognition success callback. 2547 * 2548 * @param { Callback<GestureEvent> } event 2549 * @returns { this } 2550 * @syscap SystemCapability.ArkUI.ArkUI.Full 2551 * @crossplatform 2552 * @atomicservice 2553 * @since 20 2554 */ 2555 onAction(event: Callback<GestureEvent>): this; 2556 2557 /** 2558 * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2559 * 2560 * @param { Callback<GestureEvent> } event 2561 * @returns { this } 2562 * @syscap SystemCapability.ArkUI.ArkUI.Full 2563 * @crossplatform 2564 * @atomicservice 2565 * @since 20 2566 */ 2567 onActionEnd(event: Callback<GestureEvent>): this; 2568 2569 /** 2570 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2571 * 2572 * @param { Callback<GestureEvent> } event 2573 * @returns { this } 2574 * @syscap SystemCapability.ArkUI.ArkUI.Full 2575 * @crossplatform 2576 * @atomicservice 2577 * @since 20 2578 */ 2579 onActionCancel(event: Callback<GestureEvent>): this; 2580} 2581/*** endif */ 2582 2583/** 2584 * Defines the PanGesture options. 2585 * 2586 * @syscap SystemCapability.ArkUI.ArkUI.Full 2587 * @since 7 2588 */ 2589/** 2590 * Defines the PanGesture options. 2591 * 2592 * @syscap SystemCapability.ArkUI.ArkUI.Full 2593 * @crossplatform 2594 * @since 10 2595 */ 2596/** 2597 * Defines the PanGesture options. 2598 * 2599 * @syscap SystemCapability.ArkUI.ArkUI.Full 2600 * @crossplatform 2601 * @atomicservice 2602 * @since arkts {'1.1':'11','1.2':'20'} 2603 * @arkts 1.1&1.2 2604 */ 2605declare class PanGestureOptions { 2606 /** 2607 * Constructor parameters. 2608 * 2609 * @param { object } value 2610 * @syscap SystemCapability.ArkUI.ArkUI.Full 2611 * @since 7 2612 */ 2613 /** 2614 * Constructor parameters. 2615 * 2616 * @param { object } value 2617 * @syscap SystemCapability.ArkUI.ArkUI.Full 2618 * @crossplatform 2619 * @since 10 2620 */ 2621 /** 2622 * Constructor parameters. 2623 * 2624 * @param { object } value 2625 * @syscap SystemCapability.ArkUI.ArkUI.Full 2626 * @crossplatform 2627 * @atomicservice 2628 * @since 11 2629 */ 2630 constructor(value?: { fingers?: number; direction?: PanDirection; distance?: number }); 2631 2632 /** 2633 * Constructor parameters. 2634 * 2635 * @param { PanGestureHandlerOptions } value 2636 * @syscap SystemCapability.ArkUI.ArkUI.Full 2637 * @crossplatform 2638 * @atomicservice 2639 * @since 20 2640 * @arkts 1.2 2641 */ 2642 constructor(value?: PanGestureHandlerOptions); 2643 2644 /** 2645 * Sets the direction attribute. 2646 * 2647 * @param { PanDirection } value 2648 * @syscap SystemCapability.ArkUI.ArkUI.Full 2649 * @since 7 2650 */ 2651 /** 2652 * Sets the direction attribute. 2653 * 2654 * @param { PanDirection } value 2655 * @syscap SystemCapability.ArkUI.ArkUI.Full 2656 * @crossplatform 2657 * @since 10 2658 */ 2659 /** 2660 * Sets the direction attribute. 2661 * 2662 * @param { PanDirection } value 2663 * @syscap SystemCapability.ArkUI.ArkUI.Full 2664 * @crossplatform 2665 * @atomicservice 2666 * @since 11 2667 */ 2668 setDirection(value: PanDirection); 2669 2670 /** 2671 * Sets the direction attribute. 2672 * 2673 * @param { PanDirection } value 2674 * @syscap SystemCapability.ArkUI.ArkUI.Full 2675 * @crossplatform 2676 * @atomicservice 2677 * @since 20 2678 * @arkts 1.2 2679 */ 2680 setDirection(value: PanDirection): void; 2681 2682 /** 2683 * Sets the setDistance attribute. 2684 * 2685 * @param { number } value 2686 * @syscap SystemCapability.ArkUI.ArkUI.Full 2687 * @since 7 2688 */ 2689 /** 2690 * Sets the setDistance attribute. 2691 * 2692 * @param { number } value 2693 * @syscap SystemCapability.ArkUI.ArkUI.Full 2694 * @crossplatform 2695 * @since 10 2696 */ 2697 /** 2698 * Sets the setDistance attribute. 2699 * 2700 * @param { number } value 2701 * @syscap SystemCapability.ArkUI.ArkUI.Full 2702 * @crossplatform 2703 * @atomicservice 2704 * @since 11 2705 */ 2706 setDistance(value: number); 2707 2708 /** 2709 * Sets the setDistance attribute. 2710 * 2711 * @param { number } value 2712 * @syscap SystemCapability.ArkUI.ArkUI.Full 2713 * @crossplatform 2714 * @atomicservice 2715 * @since 20 2716 * @arkts 1.2 2717 */ 2718 setDistance(value: number): void; 2719 2720 /** 2721 * Sets the setFingers attribute. 2722 * 2723 * @param { number } value 2724 * @syscap SystemCapability.ArkUI.ArkUI.Full 2725 * @since 7 2726 */ 2727 /** 2728 * Sets the setFingers attribute. 2729 * 2730 * @param { number } value 2731 * @syscap SystemCapability.ArkUI.ArkUI.Full 2732 * @crossplatform 2733 * @since 10 2734 */ 2735 /** 2736 * Sets the setFingers attribute. 2737 * 2738 * @param { number } value 2739 * @syscap SystemCapability.ArkUI.ArkUI.Full 2740 * @crossplatform 2741 * @atomicservice 2742 * @since 11 2743 */ 2744 setFingers(value: number); 2745 2746 /** 2747 * Sets the setFingers attribute. 2748 * 2749 * @param { number } value 2750 * @syscap SystemCapability.ArkUI.ArkUI.Full 2751 * @crossplatform 2752 * @atomicservice 2753 * @since 20 2754 * @arkts 1.2 2755 */ 2756 setFingers(value: number): void; 2757 2758 /** 2759 * Get the pan direction attribute. 2760 * 2761 * @returns { PanDirection } - Pan gesture direction 2762 * @syscap SystemCapability.ArkUI.ArkUI.Full 2763 * @crossplatform 2764 * @atomicservice 2765 * @since arkts {'1.1':'12','1.2':'20'} 2766 * @arkts 1.1&1.2 2767 */ 2768 getDirection(): PanDirection; 2769 /** 2770 * Returns the pan gesture's distance. 2771 * The unit is vp. 2772 * 2773 * @returns { number } - the distance of the pan gesture. 2774 * @syscap SystemCapability.ArkUI.ArkUI.Full 2775 * @crossplatform 2776 * @atomicservice 2777 * @since arkts {'1.1':'18','1.2':'20'} 2778 * @arkts 1.1&1.2 2779 */ 2780 getDistance(): number; 2781} 2782 2783/** 2784 * Defines the PanGesture interface. 2785 * 2786 * @extends GestureInterface<PanGestureInterface> 2787 * @interface PanGestureInterface 2788 * @syscap SystemCapability.ArkUI.ArkUI.Full 2789 * @since 7 2790 */ 2791/** 2792 * Defines the PanGesture interface. 2793 * 2794 * @extends GestureInterface<PanGestureInterface> 2795 * @interface PanGestureInterface 2796 * @syscap SystemCapability.ArkUI.ArkUI.Full 2797 * @crossplatform 2798 * @since 10 2799 */ 2800/** 2801 * Defines PanGesture interface extends GestureInterface<PanGestureInterface>. 2802 * 2803 * @extends GestureInterface<PanGestureInterface> 2804 * @interface PanGestureInterface 2805 * @syscap SystemCapability.ArkUI.ArkUI.Full 2806 * @crossplatform 2807 * @atomicservice 2808 * @since 11 2809 */ 2810interface PanGestureInterface extends GestureInterface<PanGestureInterface> { 2811 /** 2812 * Set the value. 2813 * fingers: Indicates the hand index that triggers the pangesture. 2814 * direction: Indicates the direction that triggers the pangesture. 2815 * distance: Indicates the distance that triggers the pangesture. 2816 * 2817 * @param { { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOptions } value 2818 * @returns { PanGestureInterface } 2819 * @syscap SystemCapability.ArkUI.ArkUI.Full 2820 * @since 7 2821 */ 2822 /** 2823 * Set the value. 2824 * fingers: Indicates the hand index that triggers the pangesture. 2825 * direction: Indicates the direction that triggers the pangesture. 2826 * distance: Indicates the distance that triggers the pangesture. 2827 * 2828 * @param { { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOptions } value 2829 * @returns { PanGestureInterface } 2830 * @syscap SystemCapability.ArkUI.ArkUI.Full 2831 * @crossplatform 2832 * @since 10 2833 */ 2834 /** 2835 * Set the value. 2836 * fingers: Indicates the hand index that triggers the pangesture. 2837 * direction: Indicates the direction that triggers the pangesture. 2838 * distance: Indicates the distance that triggers the pangesture. 2839 * 2840 * @param { { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOptions } value 2841 * @returns { PanGestureInterface } 2842 * @syscap SystemCapability.ArkUI.ArkUI.Full 2843 * @crossplatform 2844 * @atomicservice 2845 * @since 11 2846 */ 2847 (value?: { fingers?: number; direction?: PanDirection; distance?: number } | PanGestureOptions): PanGestureInterface; 2848 2849 /** 2850 * Set the value. 2851 * 2852 * @param { PanGestureHandlerOptions } options 2853 * @returns { PanGestureInterface } 2854 * @syscap SystemCapability.ArkUI.ArkUI.Full 2855 * @crossplatform 2856 * @atomicservice 2857 * @since 15 2858 */ 2859 (options?: PanGestureHandlerOptions): PanGestureInterface; 2860 2861 /** 2862 * Pan gesture recognition success callback. 2863 * 2864 * @param { function } event 2865 * @returns { PanGestureInterface } 2866 * @syscap SystemCapability.ArkUI.ArkUI.Full 2867 * @since 7 2868 */ 2869 /** 2870 * Pan gesture recognition success callback. 2871 * 2872 * @param { function } event 2873 * @returns { PanGestureInterface } 2874 * @syscap SystemCapability.ArkUI.ArkUI.Full 2875 * @crossplatform 2876 * @since 10 2877 */ 2878 /** 2879 * Pan gesture recognition success callback. 2880 * 2881 * @param { function } event 2882 * @returns { PanGestureInterface } 2883 * @syscap SystemCapability.ArkUI.ArkUI.Full 2884 * @crossplatform 2885 * @atomicservice 2886 * @since 11 2887 */ 2888 onActionStart(event: (event: GestureEvent) => void): PanGestureInterface; 2889 2890 /** 2891 * Callback when the Pan gesture is moving. 2892 * 2893 * @param { function } event 2894 * @returns { PanGestureInterface } 2895 * @syscap SystemCapability.ArkUI.ArkUI.Full 2896 * @since 7 2897 */ 2898 /** 2899 * Callback when the Pan gesture is moving. 2900 * 2901 * @param { function } event 2902 * @returns { PanGestureInterface } 2903 * @syscap SystemCapability.ArkUI.ArkUI.Full 2904 * @crossplatform 2905 * @since 10 2906 */ 2907 /** 2908 * Callback when the Pan gesture is moving. 2909 * 2910 * @param { function } event 2911 * @returns { PanGestureInterface } 2912 * @syscap SystemCapability.ArkUI.ArkUI.Full 2913 * @crossplatform 2914 * @atomicservice 2915 * @since 11 2916 */ 2917 onActionUpdate(event: (event: GestureEvent) => void): PanGestureInterface; 2918 2919 /** 2920 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2921 * 2922 * @param { function } event 2923 * @returns { PanGestureInterface } 2924 * @syscap SystemCapability.ArkUI.ArkUI.Full 2925 * @since 7 2926 */ 2927 /** 2928 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2929 * 2930 * @param { function } event 2931 * @returns { PanGestureInterface } 2932 * @syscap SystemCapability.ArkUI.ArkUI.Full 2933 * @crossplatform 2934 * @since 10 2935 */ 2936 /** 2937 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 2938 * 2939 * @param { function } event 2940 * @returns { PanGestureInterface } 2941 * @syscap SystemCapability.ArkUI.ArkUI.Full 2942 * @crossplatform 2943 * @atomicservice 2944 * @since 11 2945 */ 2946 onActionEnd(event: (event: GestureEvent) => void): PanGestureInterface; 2947 2948 /** 2949 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2950 * 2951 * @param { function } event 2952 * @returns { PanGestureInterface } 2953 * @syscap SystemCapability.ArkUI.ArkUI.Full 2954 * @since 7 2955 */ 2956 /** 2957 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2958 * 2959 * @param { function } event 2960 * @returns { PanGestureInterface } 2961 * @syscap SystemCapability.ArkUI.ArkUI.Full 2962 * @crossplatform 2963 * @since 10 2964 */ 2965 /** 2966 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2967 * 2968 * @param { function } event 2969 * @returns { PanGestureInterface } 2970 * @syscap SystemCapability.ArkUI.ArkUI.Full 2971 * @crossplatform 2972 * @atomicservice 2973 * @since 11 2974 */ 2975 onActionCancel(event: () => void): PanGestureInterface; 2976 /** 2977 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 2978 * 2979 * @param { function } event 2980 * @returns { PanGestureInterface } 2981 * @syscap SystemCapability.ArkUI.ArkUI.Full 2982 * @crossplatform 2983 * @atomicservice 2984 * @since 18 2985 */ 2986 onActionCancel(event: Callback<GestureEvent>): PanGestureInterface; 2987 2988} 2989 2990/*** if arkts 1.2 */ 2991/** 2992 * Defines PanGesture. 2993 * 2994 * @extends Gesture 2995 * @syscap SystemCapability.ArkUI.ArkUI.Full 2996 * @crossplatform 2997 * @atomicservice 2998 * @since 20 2999 */ 3000export declare class PanGesture extends Gesture { 3001 /** 3002 * Set the value. 3003 * 3004 * @param { function } factory 3005 * @param { PanGestureHandlerOptions | PanGestureOptions } value 3006 * @returns { PanGesture } 3007 * @static 3008 * @syscap SystemCapability.ArkUI.ArkUI.Full 3009 * @crossplatform 3010 * @atomicservice 3011 * @since 20 3012 */ 3013 static $_instantiate(factory: () => PanGesture, value?: PanGestureHandlerOptions | PanGestureOptions): PanGesture 3014 3015 /** 3016 * Pan gesture recognition success callback. 3017 * 3018 * @param { Callback<GestureEvent> } event 3019 * @returns { this } 3020 * @syscap SystemCapability.ArkUI.ArkUI.Full 3021 * @crossplatform 3022 * @atomicservice 3023 * @since 20 3024 */ 3025 onActionStart(event: Callback<GestureEvent>): this; 3026 3027 /** 3028 * Callback when the Pan gesture is moving. 3029 * 3030 * @param { Callback<GestureEvent> } event 3031 * @returns { this } 3032 * @syscap SystemCapability.ArkUI.ArkUI.Full 3033 * @crossplatform 3034 * @atomicservice 3035 * @since 20 3036 */ 3037 onActionUpdate(event: Callback<GestureEvent>): this; 3038 3039 /** 3040 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3041 * 3042 * @param { Callback<GestureEvent> } event 3043 * @returns { this } 3044 * @syscap SystemCapability.ArkUI.ArkUI.Full 3045 * @crossplatform 3046 * @atomicservice 3047 * @since 20 3048 */ 3049 onActionEnd(event: Callback<GestureEvent>): this; 3050 3051 /** 3052 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3053 * 3054 * @param { Callback<GestureEvent> } event 3055 * @returns { this } 3056 * @syscap SystemCapability.ArkUI.ArkUI.Full 3057 * @crossplatform 3058 * @atomicservice 3059 * @since 20 3060 */ 3061 onActionCancel(event: Callback<GestureEvent>): this; 3062} 3063/*** endif */ 3064 3065/** 3066 * Defines the SwipeGesture interface. 3067 * 3068 * @extends GestureInterface<SwipeGestureInterface> 3069 * @interface SwipeGestureInterface 3070 * @syscap SystemCapability.ArkUI.ArkUI.Full 3071 * @since 8 3072 */ 3073/** 3074 * Defines the SwipeGesture interface. 3075 * 3076 * @extends GestureInterface<SwipeGestureInterface> 3077 * @interface SwipeGestureInterface 3078 * @syscap SystemCapability.ArkUI.ArkUI.Full 3079 * @crossplatform 3080 * @since 10 3081 */ 3082/** 3083 * Defines SwipeGesture interface extends GestureInterface<SwipeGestureInterface>. 3084 * 3085 * @extends GestureInterface<SwipeGestureInterface> 3086 * @interface SwipeGestureInterface 3087 * @syscap SystemCapability.ArkUI.ArkUI.Full 3088 * @crossplatform 3089 * @atomicservice 3090 * @since 11 3091 */ 3092interface SwipeGestureInterface extends GestureInterface<SwipeGestureInterface> { 3093 /** 3094 * Set the value. 3095 * fingers: Indicates the hand index that triggers the swipegesture. 3096 * direction: Indicates the direction that triggers the swipegesture. 3097 * speed: Indicates the speed that triggers the swipegesture. 3098 * 3099 * @param { object } value 3100 * @returns { SwipeGestureInterface } 3101 * @syscap SystemCapability.ArkUI.ArkUI.Full 3102 * @since 8 3103 */ 3104 /** 3105 * Set the value. 3106 * fingers: Indicates the hand index that triggers the swipegesture. 3107 * direction: Indicates the direction that triggers the swipegesture. 3108 * speed: Indicates the speed that triggers the swipegesture. 3109 * 3110 * @param { object } value 3111 * @returns { SwipeGestureInterface } 3112 * @syscap SystemCapability.ArkUI.ArkUI.Full 3113 * @crossplatform 3114 * @since 10 3115 */ 3116 /** 3117 * Set the value. 3118 * fingers: Indicates the hand index that triggers the swipegesture. 3119 * direction: Indicates the direction that triggers the swipegesture. 3120 * speed: Indicates the speed that triggers the swipegesture. 3121 * 3122 * @param { object } value 3123 * @returns { SwipeGestureInterface } 3124 * @syscap SystemCapability.ArkUI.ArkUI.Full 3125 * @crossplatform 3126 * @atomicservice 3127 * @since 11 3128 */ 3129 (value?: { fingers?: number; direction?: SwipeDirection; speed?: number }): SwipeGestureInterface; 3130 3131 /** 3132 * Set the options. 3133 * options: The options of the swipe gesture. 3134 * 3135 * @param { SwipeGestureHandlerOptions } options 3136 * @returns { SwipeGestureInterface } 3137 * @syscap SystemCapability.ArkUI.ArkUI.Full 3138 * @crossplatform 3139 * @atomicservice 3140 * @since 15 3141 */ 3142 (options?: SwipeGestureHandlerOptions): SwipeGestureInterface; 3143 3144 /** 3145 * Slide gesture recognition success callback. 3146 * 3147 * @param { function } event 3148 * @returns { SwipeGestureInterface } 3149 * @syscap SystemCapability.ArkUI.ArkUI.Full 3150 * @since 8 3151 */ 3152 /** 3153 * Slide gesture recognition success callback. 3154 * 3155 * @param { function } event 3156 * @returns { SwipeGestureInterface } 3157 * @syscap SystemCapability.ArkUI.ArkUI.Full 3158 * @crossplatform 3159 * @since 10 3160 */ 3161 /** 3162 * Slide gesture recognition success callback. 3163 * 3164 * @param { function } event 3165 * @returns { SwipeGestureInterface } 3166 * @syscap SystemCapability.ArkUI.ArkUI.Full 3167 * @crossplatform 3168 * @atomicservice 3169 * @since 11 3170 */ 3171 onAction(event: (event: GestureEvent) => void): SwipeGestureInterface; 3172} 3173 3174/*** if arkts 1.2 */ 3175/** 3176 * Defines SwipeGesture. 3177 * 3178 * @extends Gesture 3179 * @syscap SystemCapability.ArkUI.ArkUI.Full 3180 * @crossplatform 3181 * @atomicservice 3182 * @since 20 3183 */ 3184export declare class SwipeGesture extends Gesture { 3185 /** 3186 * Set the value. 3187 * 3188 * @param { function } factory 3189 * @param { SwipeGestureHandlerOptions } value 3190 * @returns { SwipeGesture } 3191 * @static 3192 * @syscap SystemCapability.ArkUI.ArkUI.Full 3193 * @crossplatform 3194 * @atomicservice 3195 * @since 20 3196 */ 3197 static $_instantiate(factory: () => SwipeGesture, value?: SwipeGestureHandlerOptions): SwipeGesture 3198 3199 /** 3200 * Slide gesture recognition success callback. 3201 * 3202 * @param { Callback<GestureEvent> } event 3203 * @returns { this } 3204 * @syscap SystemCapability.ArkUI.ArkUI.Full 3205 * @crossplatform 3206 * @atomicservice 3207 * @since 20 3208 */ 3209 onAction(event: Callback<GestureEvent>): this; 3210} 3211/*** endif */ 3212 3213/** 3214 * Defines the PinchGesture interface. 3215 * 3216 * @extends GestureInterface<PinchGestureInterface> 3217 * @interface PinchGestureInterface 3218 * @syscap SystemCapability.ArkUI.ArkUI.Full 3219 * @since 7 3220 */ 3221/** 3222 * Defines the PinchGesture interface. 3223 * 3224 * @extends GestureInterface<PinchGestureInterface> 3225 * @interface PinchGestureInterface 3226 * @syscap SystemCapability.ArkUI.ArkUI.Full 3227 * @crossplatform 3228 * @since 10 3229 */ 3230/** 3231 * Defines PinchGesture interface extends GestureInterface<PinchGestureInterface>. 3232 * 3233 * @extends GestureInterface<PinchGestureInterface> 3234 * @interface PinchGestureInterface 3235 * @syscap SystemCapability.ArkUI.ArkUI.Full 3236 * @crossplatform 3237 * @atomicservice 3238 * @since 11 3239 */ 3240interface PinchGestureInterface extends GestureInterface<PinchGestureInterface> { 3241 /** 3242 * Set the value. 3243 * fingers: Indicates the hand index that triggers the pinchgesture. 3244 * direction: Indicates the direction that triggers the pinchgesture. 3245 * 3246 * @param { object } value 3247 * @returns { PinchGestureInterface } 3248 * @syscap SystemCapability.ArkUI.ArkUI.Full 3249 * @since 7 3250 */ 3251 /** 3252 * Set the value. 3253 * fingers: Indicates the hand index that triggers the pinchgesture. 3254 * direction: Indicates the direction that triggers the pinchgesture. 3255 * 3256 * @param { object } value 3257 * @returns { PinchGestureInterface } 3258 * @syscap SystemCapability.ArkUI.ArkUI.Full 3259 * @crossplatform 3260 * @since 10 3261 */ 3262 /** 3263 * Set the value. 3264 * fingers: Indicates the hand index that triggers the pinchgesture. 3265 * direction: Indicates the direction that triggers the pinchgesture. 3266 * 3267 * @param { object } value 3268 * @returns { PinchGestureInterface } 3269 * @syscap SystemCapability.ArkUI.ArkUI.Full 3270 * @crossplatform 3271 * @atomicservice 3272 * @since 11 3273 */ 3274 (value?: { fingers?: number; distance?: number }): PinchGestureInterface; 3275 3276 /** 3277 * Set the options. 3278 * options: The options of the pinch gesture. 3279 * 3280 * @param { PinchGestureHandlerOptions } options 3281 * @returns { PinchGestureInterface } 3282 * @syscap SystemCapability.ArkUI.ArkUI.Full 3283 * @crossplatform 3284 * @atomicservice 3285 * @since 15 3286 */ 3287 (options?: PinchGestureHandlerOptions): PinchGestureInterface; 3288 3289 /** 3290 * Pan gesture recognition success callback. 3291 * 3292 * @param { function } event 3293 * @returns { PinchGestureInterface } 3294 * @syscap SystemCapability.ArkUI.ArkUI.Full 3295 * @since 7 3296 */ 3297 /** 3298 * Pan gesture recognition success callback. 3299 * 3300 * @param { function } event 3301 * @returns { PinchGestureInterface } 3302 * @syscap SystemCapability.ArkUI.ArkUI.Full 3303 * @crossplatform 3304 * @since 10 3305 */ 3306 /** 3307 * Pan gesture recognition success callback. 3308 * 3309 * @param { function } event 3310 * @returns { PinchGestureInterface } 3311 * @syscap SystemCapability.ArkUI.ArkUI.Full 3312 * @crossplatform 3313 * @atomicservice 3314 * @since 11 3315 */ 3316 onActionStart(event: (event: GestureEvent) => void): PinchGestureInterface; 3317 3318 /** 3319 * Callback when the Pan gesture is moving. 3320 * 3321 * @param { function } event 3322 * @returns { PinchGestureInterface } 3323 * @syscap SystemCapability.ArkUI.ArkUI.Full 3324 * @since 7 3325 */ 3326 /** 3327 * Callback when the Pan gesture is moving. 3328 * 3329 * @param { function } event 3330 * @returns { PinchGestureInterface } 3331 * @syscap SystemCapability.ArkUI.ArkUI.Full 3332 * @crossplatform 3333 * @since 10 3334 */ 3335 /** 3336 * Callback when the Pan gesture is moving. 3337 * 3338 * @param { function } event 3339 * @returns { PinchGestureInterface } 3340 * @syscap SystemCapability.ArkUI.ArkUI.Full 3341 * @crossplatform 3342 * @atomicservice 3343 * @since 11 3344 */ 3345 onActionUpdate(event: (event: GestureEvent) => void): PinchGestureInterface; 3346 3347 /** 3348 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3349 * 3350 * @param { function } event 3351 * @returns { PinchGestureInterface } 3352 * @syscap SystemCapability.ArkUI.ArkUI.Full 3353 * @since 7 3354 */ 3355 /** 3356 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3357 * 3358 * @param { function } event 3359 * @returns { PinchGestureInterface } 3360 * @syscap SystemCapability.ArkUI.ArkUI.Full 3361 * @crossplatform 3362 * @since 10 3363 */ 3364 /** 3365 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3366 * 3367 * @param { function } event 3368 * @returns { PinchGestureInterface } 3369 * @syscap SystemCapability.ArkUI.ArkUI.Full 3370 * @crossplatform 3371 * @atomicservice 3372 * @since 11 3373 */ 3374 onActionEnd(event: (event: GestureEvent) => void): PinchGestureInterface; 3375 3376 /** 3377 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3378 * 3379 * @param { function } event 3380 * @returns { PinchGestureInterface } 3381 * @syscap SystemCapability.ArkUI.ArkUI.Full 3382 * @since 7 3383 */ 3384 /** 3385 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3386 * 3387 * @param { function } event 3388 * @returns { PinchGestureInterface } 3389 * @syscap SystemCapability.ArkUI.ArkUI.Full 3390 * @crossplatform 3391 * @since 10 3392 */ 3393 /** 3394 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3395 * 3396 * @param { function } event 3397 * @returns { PinchGestureInterface } 3398 * @syscap SystemCapability.ArkUI.ArkUI.Full 3399 * @crossplatform 3400 * @atomicservice 3401 * @since 11 3402 */ 3403 onActionCancel(event: () => void): PinchGestureInterface; 3404 /** 3405 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3406 * 3407 * @param { function } event 3408 * @returns { PinchGestureInterface } 3409 * @syscap SystemCapability.ArkUI.ArkUI.Full 3410 * @crossplatform 3411 * @atomicservice 3412 * @since 18 3413 */ 3414 onActionCancel(event: Callback<GestureEvent>): PinchGestureInterface; 3415} 3416 3417/*** if arkts 1.2 */ 3418/** 3419 * Defines PinchGesture. 3420 * 3421 * @extends Gesture 3422 * @syscap SystemCapability.ArkUI.ArkUI.Full 3423 * @crossplatform 3424 * @atomicservice 3425 * @since 20 3426 */ 3427export declare class PinchGesture extends Gesture { 3428 /** 3429 * Set the value. 3430 * 3431 * @param { function } factory 3432 * @param { PinchGestureHandlerOptions } value 3433 * @returns { PinchGesture } 3434 * @static 3435 * @syscap SystemCapability.ArkUI.ArkUI.Full 3436 * @crossplatform 3437 * @atomicservice 3438 * @since 20 3439 */ 3440 static $_instantiate(factory: () => PinchGesture, value?: PinchGestureHandlerOptions): PinchGesture 3441 3442 /** 3443 * Pinch gesture recognition success callback. 3444 * 3445 * @param { Callback<GestureEvent> } event 3446 * @returns { this } 3447 * @syscap SystemCapability.ArkUI.ArkUI.Full 3448 * @crossplatform 3449 * @atomicservice 3450 * @since 20 3451 */ 3452 onActionStart(event: Callback<GestureEvent>): this; 3453 3454 /** 3455 * Callback when the Pinch gesture is moving. 3456 * 3457 * @param { Callback<GestureEvent> } event 3458 * @returns { this } 3459 * @syscap SystemCapability.ArkUI.ArkUI.Full 3460 * @crossplatform 3461 * @atomicservice 3462 * @since 20 3463 */ 3464 onActionUpdate(event: Callback<GestureEvent>): this; 3465 3466 /** 3467 * The Pinch gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3468 * 3469 * @param { Callback<GestureEvent> } event 3470 * @returns { this } 3471 * @syscap SystemCapability.ArkUI.ArkUI.Full 3472 * @crossplatform 3473 * @atomicservice 3474 * @since 20 3475 */ 3476 onActionEnd(event: Callback<GestureEvent>): this; 3477 3478 /** 3479 * The Pinch gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3480 * 3481 * @param { Callback<GestureEvent> } event 3482 * @returns { this } 3483 * @syscap SystemCapability.ArkUI.ArkUI.Full 3484 * @crossplatform 3485 * @atomicservice 3486 * @since 20 3487 */ 3488 onActionCancel(event: Callback<GestureEvent>): this; 3489} 3490/*** endif */ 3491 3492/** 3493 * Defines the RotationGesture interface. 3494 * 3495 * @extends GestureInterface<RotationGestureInterface> 3496 * @interface RotationGestureInterface 3497 * @syscap SystemCapability.ArkUI.ArkUI.Full 3498 * @since 7 3499 */ 3500/** 3501 * Defines the RotationGesture interface. 3502 * 3503 * @extends GestureInterface<RotationGestureInterface> 3504 * @interface RotationGestureInterface 3505 * @syscap SystemCapability.ArkUI.ArkUI.Full 3506 * @crossplatform 3507 * @since 10 3508 */ 3509/** 3510 * Defines RotationGesture interface extends GestureInterface<RotationGestureInterface>. 3511 * 3512 * @extends GestureInterface<RotationGestureInterface> 3513 * @interface RotationGestureInterface 3514 * @syscap SystemCapability.ArkUI.ArkUI.Full 3515 * @crossplatform 3516 * @atomicservice 3517 * @since 11 3518 */ 3519interface RotationGestureInterface extends GestureInterface<RotationGestureInterface> { 3520 /** 3521 * Set the value. 3522 * fingers: Indicates the hand index that triggers the rotationgesture. 3523 * angle: Indicates the angle that triggers the rotationgesture. 3524 * 3525 * @param { object } value 3526 * @returns { RotationGestureInterface } 3527 * @syscap SystemCapability.ArkUI.ArkUI.Full 3528 * @since 7 3529 */ 3530 /** 3531 * Set the value. 3532 * fingers: Indicates the hand index that triggers the rotationgesture. 3533 * angle: Indicates the angle that triggers the rotationgesture. 3534 * 3535 * @param { object } value 3536 * @returns { RotationGestureInterface } 3537 * @syscap SystemCapability.ArkUI.ArkUI.Full 3538 * @crossplatform 3539 * @since 10 3540 */ 3541 /** 3542 * Set the value. 3543 * fingers: Indicates the hand index that triggers the rotationgesture. 3544 * angle: Indicates the angle that triggers the rotationgesture. 3545 * 3546 * @param { object } value 3547 * @returns { RotationGestureInterface } 3548 * @syscap SystemCapability.ArkUI.ArkUI.Full 3549 * @crossplatform 3550 * @atomicservice 3551 * @since 11 3552 */ 3553 (value?: { fingers?: number; angle?: number }): RotationGestureInterface; 3554 3555 /** 3556 * Set the options. 3557 * options: The options of the rotation gesture. 3558 * 3559 * @param { RotationGestureHandlerOptions } options 3560 * @returns { RotationGestureInterface } 3561 * @syscap SystemCapability.ArkUI.ArkUI.Full 3562 * @crossplatform 3563 * @atomicservice 3564 * @since 15 3565 */ 3566 (options?: RotationGestureHandlerOptions): RotationGestureInterface; 3567 3568 /** 3569 * Pan gesture recognition success callback. 3570 * 3571 * @param { function } event 3572 * @returns { RotationGestureInterface } 3573 * @syscap SystemCapability.ArkUI.ArkUI.Full 3574 * @since 7 3575 */ 3576 /** 3577 * Pan gesture recognition success callback. 3578 * 3579 * @param { function } event 3580 * @returns { RotationGestureInterface } 3581 * @syscap SystemCapability.ArkUI.ArkUI.Full 3582 * @crossplatform 3583 * @since 10 3584 */ 3585 /** 3586 * Pan gesture recognition success callback. 3587 * 3588 * @param { function } event 3589 * @returns { RotationGestureInterface } 3590 * @syscap SystemCapability.ArkUI.ArkUI.Full 3591 * @crossplatform 3592 * @atomicservice 3593 * @since 11 3594 */ 3595 onActionStart(event: (event: GestureEvent) => void): RotationGestureInterface; 3596 3597 /** 3598 * Callback when the Pan gesture is moving. 3599 * 3600 * @param { function } event 3601 * @returns { RotationGestureInterface } 3602 * @syscap SystemCapability.ArkUI.ArkUI.Full 3603 * @since 7 3604 */ 3605 /** 3606 * Callback when the Pan gesture is moving. 3607 * 3608 * @param { function } event 3609 * @returns { RotationGestureInterface } 3610 * @syscap SystemCapability.ArkUI.ArkUI.Full 3611 * @crossplatform 3612 * @since 10 3613 */ 3614 /** 3615 * Callback when the Pan gesture is moving. 3616 * 3617 * @param { function } event 3618 * @returns { RotationGestureInterface } 3619 * @syscap SystemCapability.ArkUI.ArkUI.Full 3620 * @crossplatform 3621 * @atomicservice 3622 * @since 11 3623 */ 3624 onActionUpdate(event: (event: GestureEvent) => void): RotationGestureInterface; 3625 3626 /** 3627 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3628 * 3629 * @param { function } event 3630 * @returns { RotationGestureInterface } 3631 * @syscap SystemCapability.ArkUI.ArkUI.Full 3632 * @since 7 3633 */ 3634 /** 3635 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3636 * 3637 * @param { function } event 3638 * @returns { RotationGestureInterface } 3639 * @syscap SystemCapability.ArkUI.ArkUI.Full 3640 * @crossplatform 3641 * @since 10 3642 */ 3643 /** 3644 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3645 * 3646 * @param { function } event 3647 * @returns { RotationGestureInterface } 3648 * @syscap SystemCapability.ArkUI.ArkUI.Full 3649 * @crossplatform 3650 * @atomicservice 3651 * @since 11 3652 */ 3653 onActionEnd(event: (event: GestureEvent) => void): RotationGestureInterface; 3654 3655 /** 3656 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3657 * 3658 * @param { function } event 3659 * @returns { RotationGestureInterface } 3660 * @syscap SystemCapability.ArkUI.ArkUI.Full 3661 * @since 7 3662 */ 3663 /** 3664 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3665 * 3666 * @param { function } event 3667 * @returns { RotationGestureInterface } 3668 * @syscap SystemCapability.ArkUI.ArkUI.Full 3669 * @crossplatform 3670 * @since 10 3671 */ 3672 /** 3673 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3674 * 3675 * @param { function } event 3676 * @returns { RotationGestureInterface } 3677 * @syscap SystemCapability.ArkUI.ArkUI.Full 3678 * @crossplatform 3679 * @atomicservice 3680 * @since 11 3681 */ 3682 onActionCancel(event: () => void): RotationGestureInterface; 3683 /** 3684 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3685 * 3686 * @param { function } event 3687 * @returns { RotationGestureInterface } 3688 * @syscap SystemCapability.ArkUI.ArkUI.Full 3689 * @crossplatform 3690 * @atomicservice 3691 * @since 18 3692 */ 3693 onActionCancel(event: Callback<GestureEvent>): RotationGestureInterface; 3694} 3695 3696/*** if arkts 1.2 */ 3697/** 3698 * Defines RotationGesture. 3699 * 3700 * @extends Gesture 3701 * @syscap SystemCapability.ArkUI.ArkUI.Full 3702 * @crossplatform 3703 * @atomicservice 3704 * @since 20 3705 */ 3706export declare class RotationGesture extends Gesture { 3707 /** 3708 * Set the value. 3709 * 3710 * @param { function } factory 3711 * @param { RotationGestureHandlerOptions } value 3712 * @returns { RotationGesture } 3713 * @static 3714 * @syscap SystemCapability.ArkUI.ArkUI.Full 3715 * @crossplatform 3716 * @atomicservice 3717 * @since 20 3718 */ 3719 static $_instantiate(factory: () => RotationGesture, value?: RotationGestureHandlerOptions): RotationGesture 3720 3721 /** 3722 * Rotation gesture recognition success callback. 3723 * 3724 * @param { Callback<GestureEvent> } event 3725 * @returns { this } 3726 * @syscap SystemCapability.ArkUI.ArkUI.Full 3727 * @crossplatform 3728 * @atomicservice 3729 * @since 20 3730 */ 3731 onActionStart(event: Callback<GestureEvent>): this; 3732 3733 /** 3734 * Callback when the Rotation gesture is moving. 3735 * 3736 * @param { Callback<GestureEvent> } event 3737 * @returns { this } 3738 * @syscap SystemCapability.ArkUI.ArkUI.Full 3739 * @crossplatform 3740 * @atomicservice 3741 * @since 20 3742 */ 3743 onActionUpdate(event: Callback<GestureEvent>): this; 3744 3745 /** 3746 * The Rotation gesture is successfully recognized. When the finger is lifted, the callback is triggered. 3747 * 3748 * @param { Callback<GestureEvent> } event 3749 * @returns { this } 3750 * @syscap SystemCapability.ArkUI.ArkUI.Full 3751 * @crossplatform 3752 * @atomicservice 3753 * @since 20 3754 */ 3755 onActionEnd(event: Callback<GestureEvent>): this; 3756 3757 /** 3758 * The Rotation gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3759 * 3760 * @param { Callback<GestureEvent> } event 3761 * @returns { this } 3762 * @syscap SystemCapability.ArkUI.ArkUI.Full 3763 * @crossplatform 3764 * @atomicservice 3765 * @since 20 3766 */ 3767 onActionCancel(event: Callback<GestureEvent>): this; 3768} 3769/*** endif */ 3770 3771/** 3772 * Defines the GestureGroup interface. 3773 * 3774 * @interface GestureGroupInterface 3775 * @syscap SystemCapability.ArkUI.ArkUI.Full 3776 * @since 7 3777 */ 3778/** 3779 * Defines the GestureGroup interface. 3780 * 3781 * @interface GestureGroupInterface 3782 * @syscap SystemCapability.ArkUI.ArkUI.Full 3783 * @crossplatform 3784 * @since 10 3785 */ 3786/** 3787 * Defines the GestureGroup interface. 3788 * 3789 * @interface GestureGroupInterface 3790 * @syscap SystemCapability.ArkUI.ArkUI.Full 3791 * @crossplatform 3792 * @atomicservice 3793 * @since 11 3794 */ 3795interface GestureGroupInterface { 3796 /** 3797 * Return to Obtain GestureGroup. 3798 * 3799 * @param { GestureMode } mode 3800 * @param { GestureType[] } gesture 3801 * @returns { GestureGroupInterface } 3802 * @syscap SystemCapability.ArkUI.ArkUI.Full 3803 * @since 7 3804 */ 3805 /** 3806 * Return to Obtain GestureGroup. 3807 * 3808 * @param { GestureMode } mode 3809 * @param { GestureType[] } gesture 3810 * @returns { GestureGroupInterface } 3811 * @syscap SystemCapability.ArkUI.ArkUI.Full 3812 * @crossplatform 3813 * @since 10 3814 */ 3815 /** 3816 * Return to Obtain GestureGroup. 3817 * 3818 * @param { GestureMode } mode 3819 * @param { GestureType[] } gesture 3820 * @returns { GestureGroupInterface } 3821 * @syscap SystemCapability.ArkUI.ArkUI.Full 3822 * @crossplatform 3823 * @atomicservice 3824 * @since 11 3825 */ 3826 (mode: GestureMode, ...gesture: GestureType[]): GestureGroupInterface; 3827 3828 /** 3829 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3830 * 3831 * @param { function } event 3832 * @returns { GestureGroupInterface } 3833 * @syscap SystemCapability.ArkUI.ArkUI.Full 3834 * @since 7 3835 */ 3836 /** 3837 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3838 * 3839 * @param { function } event 3840 * @returns { GestureGroupInterface } 3841 * @syscap SystemCapability.ArkUI.ArkUI.Full 3842 * @crossplatform 3843 * @since 10 3844 */ 3845 /** 3846 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 3847 * 3848 * @param { function } event 3849 * @returns { GestureGroupInterface } 3850 * @syscap SystemCapability.ArkUI.ArkUI.Full 3851 * @crossplatform 3852 * @atomicservice 3853 * @since 11 3854 */ 3855 onCancel(event: () => void): GestureGroupInterface; 3856} 3857 3858/*** if arkts 1.2 */ 3859/** 3860 * Defines the GestureGroup. 3861 * 3862 * @syscap SystemCapability.ArkUI.ArkUI.Full 3863 * @crossplatform 3864 * @atomicservice 3865 * @since 20 3866 */ 3867export declare class GestureGroup { 3868 /** 3869 * Return to Obtain GestureGroup. 3870 * 3871 * @param { function } factory 3872 * @param { GestureMode } mode 3873 * @param { GestureType[] } gesture 3874 * @returns { GestureGroup } 3875 * @static 3876 * @syscap SystemCapability.ArkUI.ArkUI.Full 3877 * @crossplatform 3878 * @atomicservice 3879 * @since 20 3880 */ 3881 static $_instantiate(factory: () => GestureGroup, mode: GestureMode, ...gesture: GestureType[]): GestureGroup; 3882 3883 /** 3884 * The Gesture group is successfully recognized and a callback is triggered when the touch cancel event is received. 3885 * 3886 * @param { Callback<void> } event 3887 * @returns { GestureGroup } 3888 * @syscap SystemCapability.ArkUI.ArkUI.Full 3889 * @crossplatform 3890 * @atomicservice 3891 * @since 20 3892 */ 3893 onCancel(event: Callback<void>): GestureGroup; 3894} 3895/*** endif */ 3896 3897/** 3898 * Defines TapGesture Component. 3899 * 3900 * @syscap SystemCapability.ArkUI.ArkUI.Full 3901 * @since 7 3902 */ 3903/** 3904 * Defines TapGesture Component. 3905 * 3906 * @syscap SystemCapability.ArkUI.ArkUI.Full 3907 * @crossplatform 3908 * @since 10 3909 */ 3910/** 3911 * Defines TapGesture Component. 3912 * 3913 * @syscap SystemCapability.ArkUI.ArkUI.Full 3914 * @crossplatform 3915 * @atomicservice 3916 * @since 11 3917 */ 3918declare const TapGesture: TapGestureInterface; 3919 3920/** 3921 * Defines LongPressGesture Component. 3922 * 3923 * @syscap SystemCapability.ArkUI.ArkUI.Full 3924 * @since 7 3925 */ 3926/** 3927 * Defines LongPressGesture Component. 3928 * 3929 * @syscap SystemCapability.ArkUI.ArkUI.Full 3930 * @crossplatform 3931 * @since 10 3932 */ 3933/** 3934 * Defines LongPressGesture Component. 3935 * 3936 * @syscap SystemCapability.ArkUI.ArkUI.Full 3937 * @crossplatform 3938 * @atomicservice 3939 * @since 11 3940 */ 3941declare const LongPressGesture: LongPressGestureInterface; 3942 3943/** 3944 * Defines PanGesture Component. 3945 * 3946 * @syscap SystemCapability.ArkUI.ArkUI.Full 3947 * @since 7 3948 */ 3949/** 3950 * Defines PanGesture Component. 3951 * 3952 * @syscap SystemCapability.ArkUI.ArkUI.Full 3953 * @crossplatform 3954 * @since 10 3955 */ 3956/** 3957 * Defines PanGesture Component. 3958 * 3959 * @syscap SystemCapability.ArkUI.ArkUI.Full 3960 * @crossplatform 3961 * @atomicservice 3962 * @since 11 3963 */ 3964declare const PanGesture: PanGestureInterface; 3965 3966/** 3967 * Defines SwipeGesture Component. 3968 * 3969 * @syscap SystemCapability.ArkUI.ArkUI.Full 3970 * @since 7 3971 */ 3972/** 3973 * Defines SwipeGesture Component. 3974 * 3975 * @syscap SystemCapability.ArkUI.ArkUI.Full 3976 * @crossplatform 3977 * @since 10 3978 */ 3979/** 3980 * Defines SwipeGesture Component. 3981 * 3982 * @syscap SystemCapability.ArkUI.ArkUI.Full 3983 * @crossplatform 3984 * @atomicservice 3985 * @since 11 3986 */ 3987declare const SwipeGesture: SwipeGestureInterface; 3988 3989/** 3990 * Defines PinchGesture Component. 3991 * 3992 * @syscap SystemCapability.ArkUI.ArkUI.Full 3993 * @since 7 3994 */ 3995/** 3996 * Defines PinchGesture Component. 3997 * 3998 * @syscap SystemCapability.ArkUI.ArkUI.Full 3999 * @crossplatform 4000 * @since 10 4001 */ 4002/** 4003 * Defines PinchGesture Component. 4004 * 4005 * @syscap SystemCapability.ArkUI.ArkUI.Full 4006 * @crossplatform 4007 * @atomicservice 4008 * @since 11 4009 */ 4010declare const PinchGesture: PinchGestureInterface; 4011 4012/** 4013 * Defines RotationGesture Component. 4014 * 4015 * @syscap SystemCapability.ArkUI.ArkUI.Full 4016 * @since 7 4017 */ 4018/** 4019 * Defines RotationGesture Component. 4020 * 4021 * @syscap SystemCapability.ArkUI.ArkUI.Full 4022 * @crossplatform 4023 * @since 10 4024 */ 4025/** 4026 * Defines RotationGesture Component. 4027 * 4028 * @syscap SystemCapability.ArkUI.ArkUI.Full 4029 * @crossplatform 4030 * @atomicservice 4031 * @since 11 4032 */ 4033declare const RotationGesture: RotationGestureInterface; 4034 4035/** 4036 * Defines GestureGroup Component. 4037 * 4038 * @syscap SystemCapability.ArkUI.ArkUI.Full 4039 * @since 7 4040 */ 4041/** 4042 * Defines GestureGroup Component. 4043 * 4044 * @syscap SystemCapability.ArkUI.ArkUI.Full 4045 * @crossplatform 4046 * @since 10 4047 */ 4048/** 4049 * Defines GestureGroup Component. 4050 * 4051 * @syscap SystemCapability.ArkUI.ArkUI.Full 4052 * @crossplatform 4053 * @atomicservice 4054 * @since 11 4055 */ 4056declare const GestureGroup: GestureGroupInterface; 4057 4058/** 4059 * Defines the gesture handler. 4060 * 4061 * @implements GestureInterface<T> 4062 * @syscap SystemCapability.ArkUI.ArkUI.Full 4063 * @crossplatform 4064 * @atomicservice 4065 * @since 12 4066 */ 4067declare class GestureHandler<T> implements GestureInterface<T> { 4068 /** 4069 * Set the GestureHandler's tag. 4070 * 4071 * @param { string } tag 4072 * @returns { T } 4073 * @syscap SystemCapability.ArkUI.ArkUI.Full 4074 * @crossplatform 4075 * @atomicservice 4076 * @since 12 4077 */ 4078 tag(tag: string): T; 4079 4080 /** 4081 * Input source type for gesture response. 4082 * 4083 * @param { Array<SourceTool> } types - indicate the allowed input source for gesture to response 4084 * @returns { T } 4085 * @syscap SystemCapability.ArkUI.ArkUI.Full 4086 * @crossplatform 4087 * @atomicservice 4088 * @since 14 4089 */ 4090 allowedTypes(types: Array<SourceTool>): T; 4091} 4092 4093/*** if arkts 1.2 */ 4094/** 4095 * Defines the gesture handler. 4096 * 4097 * @syscap SystemCapability.ArkUI.ArkUI.Full 4098 * @crossplatform 4099 * @atomicservice 4100 * @since 20 4101 */ 4102export declare class GestureHandler { 4103 /** 4104 * Set the GestureHandler's tag. 4105 * 4106 * @param { string } tag 4107 * @returns { this } 4108 * @syscap SystemCapability.ArkUI.ArkUI.Full 4109 * @crossplatform 4110 * @atomicservice 4111 * @since 20 4112 */ 4113 tag(tag: string): this; 4114 4115 /** 4116 * Input source type for gesture response. 4117 * 4118 * @param { Array<SourceTool> } types - indicate the allowed input source for gesture to response 4119 * @returns { this } 4120 * @syscap SystemCapability.ArkUI.ArkUI.Full 4121 * @crossplatform 4122 * @atomicservice 4123 * @since 20 4124 */ 4125 allowedTypes(types: Array<SourceTool>): this; 4126} 4127/*** endif */ 4128 4129/** 4130 * Defines the TapGestureHandler options. 4131 * 4132 * @interface TapGestureHandlerOptions 4133 * @syscap SystemCapability.ArkUI.ArkUI.Full 4134 * @crossplatform 4135 * @atomicservice 4136 * @since 12 4137 */ 4138/** 4139 * Defines the TapGestureHandler options. 4140 * 4141 * @extends BaseHandlerOptions 4142 * @interface TapGestureHandlerOptions 4143 * @syscap SystemCapability.ArkUI.ArkUI.Full 4144 * @crossplatform 4145 * @atomicservice 4146 * @since arkts {'1.1':'15','1.2':'20'} 4147 * @arkts 1.1&1.2 4148 */ 4149interface TapGestureHandlerOptions extends BaseHandlerOptions { 4150 /** 4151 * Indicates the number of consecutive clicks recognized. If the value is less than 1, the default value is used. 4152 * The default value is 1. 4153 * 4154 * @type { ?number } 4155 * @syscap SystemCapability.ArkUI.ArkUI.Full 4156 * @crossplatform 4157 * @atomicservice 4158 * @since arkts {'1.1':'12','1.2':'20'} 4159 * @arkts 1.1&1.2 4160 */ 4161 count?: number; 4162 /** 4163 * Indicates the hand index that triggers the click. If the value is less than 1, the default value is used. 4164 * The default value is 1. 4165 * 4166 * @type { ?number } 4167 * @syscap SystemCapability.ArkUI.ArkUI.Full 4168 * @crossplatform 4169 * @atomicservice 4170 * @since arkts {'1.1':'12','1.2':'20'} 4171 * @arkts 1.1&1.2 4172 */ 4173 fingers?: number; 4174} 4175 4176/** 4177 * Defines the TapGesture handler. 4178 * 4179 * @extends GestureHandler<TapGestureHandler> 4180 * @syscap SystemCapability.ArkUI.ArkUI.Full 4181 * @crossplatform 4182 * @atomicservice 4183 * @since 12 4184 */ 4185declare class TapGestureHandler extends GestureHandler<TapGestureHandler> { 4186 /** 4187 * Constructor parameters. 4188 * 4189 * @param { TapGestureHandlerOptions } options 4190 * @syscap SystemCapability.ArkUI.ArkUI.Full 4191 * @crossplatform 4192 * @atomicservice 4193 * @since 12 4194 */ 4195 constructor(options?: TapGestureHandlerOptions); 4196 /** 4197 * Tap gesture recognition success callback. 4198 * 4199 * @param { Callback<GestureEvent> } event 4200 * @returns { TapGestureHandler } 4201 * @syscap SystemCapability.ArkUI.ArkUI.Full 4202 * @crossplatform 4203 * @atomicservice 4204 * @since 12 4205 */ 4206 onAction(event: Callback<GestureEvent>): TapGestureHandler; 4207} 4208 4209/*** if arkts 1.2 */ 4210/** 4211 * Defines the TapGesture handler. 4212 * 4213 * @extends GestureHandler 4214 * @syscap SystemCapability.ArkUI.ArkUI.Full 4215 * @crossplatform 4216 * @atomicservice 4217 * @since 20 4218 */ 4219export declare class TapGestureHandler extends GestureHandler { 4220 /** 4221 * Constructor parameters. 4222 * 4223 * @param { TapGestureHandlerOptions } options 4224 * @syscap SystemCapability.ArkUI.ArkUI.Full 4225 * @crossplatform 4226 * @atomicservice 4227 * @since 20 4228 */ 4229 constructor(options?: TapGestureHandlerOptions); 4230 /** 4231 * Tap gesture recognition success callback. 4232 * 4233 * @param { Callback<GestureEvent> } event 4234 * @returns { this } 4235 * @syscap SystemCapability.ArkUI.ArkUI.Full 4236 * @crossplatform 4237 * @atomicservice 4238 * @since 20 4239 */ 4240 onAction(event: Callback<GestureEvent>): this; 4241} 4242/*** endif */ 4243 4244/** 4245 * Defines the LongPressGestureHandler options. 4246 * 4247 * @interface LongPressGestureHandlerOptions 4248 * @syscap SystemCapability.ArkUI.ArkUI.Full 4249 * @crossplatform 4250 * @atomicservice 4251 * @since 12 4252 */ 4253/** 4254 * Defines the LongPressGestureHandler options. 4255 * 4256 * @extends BaseHandlerOptions 4257 * @interface LongPressGestureHandlerOptions 4258 * @syscap SystemCapability.ArkUI.ArkUI.Full 4259 * @crossplatform 4260 * @atomicservice 4261 * @since arkts {'1.1':'15','1.2':'20'} 4262 * @arkts 1.1&1.2 4263 */ 4264interface LongPressGestureHandlerOptions extends BaseHandlerOptions { 4265 /** 4266 * Indicates the hand index that triggers the long press. If the value is less than 1, the default value is used. 4267 * The default value is 1. 4268 * 4269 * @type { ?number } 4270 * @syscap SystemCapability.ArkUI.ArkUI.Full 4271 * @crossplatform 4272 * @atomicservice 4273 * @since arkts {'1.1':'12','1.2':'20'} 4274 * @arkts 1.1&1.2 4275 */ 4276 fingers?: number; 4277 /** 4278 * Indicates whether an event is triggered repeatedly. 4279 * The default value is false. 4280 * 4281 * @type { ?boolean } 4282 * @syscap SystemCapability.ArkUI.ArkUI.Full 4283 * @crossplatform 4284 * @atomicservice 4285 * @since arkts {'1.1':'12','1.2':'20'} 4286 * @arkts 1.1&1.2 4287 */ 4288 repeat?: boolean; 4289 /** 4290 * Indicates minimum press and hold time, in milliseconds. 4291 * The default value is 500ms. 4292 * 4293 * @type { ?number } 4294 * @syscap SystemCapability.ArkUI.ArkUI.Full 4295 * @crossplatform 4296 * @atomicservice 4297 * @since arkts {'1.1':'12','1.2':'20'} 4298 * @arkts 1.1&1.2 4299 */ 4300 duration?: number; 4301} 4302 4303/** 4304 * Defines the LongPressGesture handler. 4305 * 4306 * @extends GestureHandler<LongPressGestureHandler> 4307 * @syscap SystemCapability.ArkUI.ArkUI.Full 4308 * @crossplatform 4309 * @atomicservice 4310 * @since 12 4311 */ 4312declare class LongPressGestureHandler extends GestureHandler<LongPressGestureHandler> { 4313 /** 4314 * Constructor parameters. 4315 * 4316 * @param { LongPressGestureHandlerOptions } options 4317 * @syscap SystemCapability.ArkUI.ArkUI.Full 4318 * @crossplatform 4319 * @atomicservice 4320 * @since 12 4321 */ 4322 constructor(options?: LongPressGestureHandlerOptions); 4323 /** 4324 * LongPress gesture recognition success callback. 4325 * 4326 * @param { Callback<GestureEvent> } event 4327 * @returns { LongPressGestureHandler } 4328 * @syscap SystemCapability.ArkUI.ArkUI.Full 4329 * @crossplatform 4330 * @atomicservice 4331 * @since 12 4332 */ 4333 onAction(event: Callback<GestureEvent>): LongPressGestureHandler; 4334 /** 4335 * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. 4336 * 4337 * @param { Callback<GestureEvent> } event 4338 * @returns { LongPressGestureHandler } 4339 * @syscap SystemCapability.ArkUI.ArkUI.Full 4340 * @crossplatform 4341 * @atomicservice 4342 * @since 12 4343 */ 4344 onActionEnd(event: Callback<GestureEvent>): LongPressGestureHandler; 4345 /** 4346 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 4347 * 4348 * @param { Callback<void> } event 4349 * @returns { LongPressGestureHandler } 4350 * @syscap SystemCapability.ArkUI.ArkUI.Full 4351 * @crossplatform 4352 * @atomicservice 4353 * @since 12 4354 */ 4355 onActionCancel(event: Callback<void>): LongPressGestureHandler; 4356 /** 4357 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 4358 * Add GestureEvent in cancel callback. 4359 * 4360 * @param { Callback<GestureEvent> } event 4361 * @returns { LongPressGestureHandler } 4362 * @syscap SystemCapability.ArkUI.ArkUI.Full 4363 * @crossplatform 4364 * @atomicservice 4365 * @since 18 4366 */ 4367 onActionCancel(event: Callback<GestureEvent>): LongPressGestureHandler; 4368} 4369 4370/*** if arkts 1.2 */ 4371/** 4372 * Defines the LongPressGesture handler. 4373 * 4374 * @extends GestureHandler 4375 * @syscap SystemCapability.ArkUI.ArkUI.Full 4376 * @crossplatform 4377 * @atomicservice 4378 * @since 20 4379 */ 4380export declare class LongPressGestureHandler extends GestureHandler { 4381 /** 4382 * Constructor parameters. 4383 * 4384 * @param { LongPressGestureHandlerOptions } options 4385 * @syscap SystemCapability.ArkUI.ArkUI.Full 4386 * @crossplatform 4387 * @atomicservice 4388 * @since 20 4389 */ 4390 constructor(options?: LongPressGestureHandlerOptions); 4391 /** 4392 * LongPress gesture recognition success callback. 4393 * 4394 * @param { Callback<GestureEvent> } event 4395 * @returns { this } 4396 * @syscap SystemCapability.ArkUI.ArkUI.Full 4397 * @crossplatform 4398 * @atomicservice 4399 * @since 20 4400 */ 4401 onAction(event: Callback<GestureEvent>): this; 4402 /** 4403 * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. 4404 * 4405 * @param { Callback<GestureEvent> } event 4406 * @returns { this } 4407 * @syscap SystemCapability.ArkUI.ArkUI.Full 4408 * @crossplatform 4409 * @atomicservice 4410 * @since 20 4411 */ 4412 onActionEnd(event: Callback<GestureEvent>): this; 4413 /** 4414 * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 4415 * 4416 * @param { Callback<GestureEvent> } event 4417 * @returns { this } 4418 * @syscap SystemCapability.ArkUI.ArkUI.Full 4419 * @crossplatform 4420 * @atomicservice 4421 * @since 20 4422 */ 4423 onActionCancel(event: Callback<GestureEvent>): this; 4424} 4425/*** endif */ 4426 4427/** 4428 * Defines the PanGestureHandler options. 4429 * 4430 * @interface PanGestureHandlerOptions 4431 * @syscap SystemCapability.ArkUI.ArkUI.Full 4432 * @crossplatform 4433 * @atomicservice 4434 * @since 12 4435 */ 4436/** 4437 * Defines the PanGestureHandler options. 4438 * 4439 * @extends BaseHandlerOptions 4440 * @interface PanGestureHandlerOptions 4441 * @syscap SystemCapability.ArkUI.ArkUI.Full 4442 * @crossplatform 4443 * @atomicservice 4444 * @since arkts {'1.1':'15','1.2':'20'} 4445 * @arkts 1.1&1.2 4446 */ 4447interface PanGestureHandlerOptions extends BaseHandlerOptions { 4448 /** 4449 * Indicates the hand index that triggers the pan. If the value is less than 1, the default value is used. 4450 * The default value is 1. 4451 * 4452 * @type { ?number } 4453 * @syscap SystemCapability.ArkUI.ArkUI.Full 4454 * @crossplatform 4455 * @atomicservice 4456 * @since arkts {'1.1':'12','1.2':'20'} 4457 * @arkts 1.1&1.2 4458 */ 4459 fingers?: number; 4460 /** 4461 * Indicates the move direction of the pan gesture. 4462 * The default value is PanDirection.All. 4463 * 4464 * @type { ?PanDirection } 4465 * @syscap SystemCapability.ArkUI.ArkUI.Full 4466 * @crossplatform 4467 * @atomicservice 4468 * @since arkts {'1.1':'12','1.2':'20'} 4469 * @arkts 1.1&1.2 4470 */ 4471 direction?: PanDirection; 4472 /** 4473 * Indicates minimum move distance. 4474 * The default value is 5vp. 4475 * 4476 * @type { ?number } 4477 * @syscap SystemCapability.ArkUI.ArkUI.Full 4478 * @crossplatform 4479 * @atomicservice 4480 * @since arkts {'1.1':'12','1.2':'20'} 4481 * @arkts 1.1&1.2 4482 */ 4483 distance?: number; 4484 /** 4485 * Indicates minimum move distance map. 4486 * 4487 * @type { ?Map<SourceTool, number> } 4488 * @syscap SystemCapability.ArkUI.ArkUI.Full 4489 * @crossplatform 4490 * @atomicservice 4491 * @since 19 4492 */ 4493 distanceMap?: Map<SourceTool, number>; 4494} 4495 4496/** 4497 * Defines the PanGesture handler. 4498 * 4499 * @extends GestureHandler<PanGestureHandler> 4500 * @syscap SystemCapability.ArkUI.ArkUI.Full 4501 * @crossplatform 4502 * @atomicservice 4503 * @since 12 4504 */ 4505declare class PanGestureHandler extends GestureHandler<PanGestureHandler> { 4506 /** 4507 * Constructor parameters. 4508 * 4509 * @param { PanGestureHandlerOptions } options 4510 * @syscap SystemCapability.ArkUI.ArkUI.Full 4511 * @crossplatform 4512 * @atomicservice 4513 * @since 12 4514 */ 4515 constructor(options?: PanGestureHandlerOptions); 4516 /** 4517 * Pan gesture recognition success callback. 4518 * 4519 * @param { Callback<GestureEvent> } event 4520 * @returns { PanGestureHandler } 4521 * @syscap SystemCapability.ArkUI.ArkUI.Full 4522 * @crossplatform 4523 * @atomicservice 4524 * @since 12 4525 */ 4526 onActionStart(event: Callback<GestureEvent>): PanGestureHandler; 4527 /** 4528 * Callback when the Pan gesture is moving. 4529 * 4530 * @param { Callback<GestureEvent> } event 4531 * @returns { PanGestureHandler } 4532 * @syscap SystemCapability.ArkUI.ArkUI.Full 4533 * @crossplatform 4534 * @atomicservice 4535 * @since 12 4536 */ 4537 onActionUpdate(event: Callback<GestureEvent>): PanGestureHandler; 4538 /** 4539 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 4540 * 4541 * @param { Callback<GestureEvent> } event 4542 * @returns { PanGestureHandler } 4543 * @syscap SystemCapability.ArkUI.ArkUI.Full 4544 * @crossplatform 4545 * @atomicservice 4546 * @since 12 4547 */ 4548 onActionEnd(event: Callback<GestureEvent>): PanGestureHandler; 4549 /** 4550 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 4551 * 4552 * @param { Callback<void> } event 4553 * @returns { PanGestureHandler } 4554 * @syscap SystemCapability.ArkUI.ArkUI.Full 4555 * @crossplatform 4556 * @atomicservice 4557 * @since 12 4558 */ 4559 onActionCancel(event: Callback<void>): PanGestureHandler; 4560 /** 4561 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 4562 * Add GestureEvent in cancel callback. 4563 * 4564 * @param { Callback<GestureEvent> } event 4565 * @returns { PanGestureHandler } 4566 * @syscap SystemCapability.ArkUI.ArkUI.Full 4567 * @crossplatform 4568 * @atomicservice 4569 * @since 18 4570 */ 4571 onActionCancel(event: Callback<GestureEvent>): PanGestureHandler; 4572} 4573 4574/*** if arkts 1.2 */ 4575/** 4576 * Defines the PanGesture handler. 4577 * 4578 * @extends GestureHandler 4579 * @syscap SystemCapability.ArkUI.ArkUI.Full 4580 * @crossplatform 4581 * @atomicservice 4582 * @since 20 4583 */ 4584export declare class PanGestureHandler extends GestureHandler { 4585 /** 4586 * Constructor parameters. 4587 * 4588 * @param { PanGestureHandlerOptions } options 4589 * @syscap SystemCapability.ArkUI.ArkUI.Full 4590 * @crossplatform 4591 * @atomicservice 4592 * @since 20 4593 */ 4594 constructor(options?: PanGestureHandlerOptions); 4595 /** 4596 * Pan gesture recognition success callback. 4597 * 4598 * @param { Callback<GestureEvent> } event 4599 * @returns { this } 4600 * @syscap SystemCapability.ArkUI.ArkUI.Full 4601 * @crossplatform 4602 * @atomicservice 4603 * @since 20 4604 */ 4605 onActionStart(event: Callback<GestureEvent>): this; 4606 /** 4607 * Callback when the Pan gesture is moving. 4608 * 4609 * @param { Callback<GestureEvent> } event 4610 * @returns { this } 4611 * @syscap SystemCapability.ArkUI.ArkUI.Full 4612 * @crossplatform 4613 * @atomicservice 4614 * @since 20 4615 */ 4616 onActionUpdate(event: Callback<GestureEvent>): this; 4617 /** 4618 * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. 4619 * 4620 * @param { Callback<GestureEvent> } event 4621 * @returns { this } 4622 * @syscap SystemCapability.ArkUI.ArkUI.Full 4623 * @crossplatform 4624 * @atomicservice 4625 * @since 20 4626 */ 4627 onActionEnd(event: Callback<GestureEvent>): this; 4628 /** 4629 * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 4630 * 4631 * @param { Callback<GestureEvent> } event 4632 * @returns { this } 4633 * @syscap SystemCapability.ArkUI.ArkUI.Full 4634 * @crossplatform 4635 * @atomicservice 4636 * @since 20 4637 */ 4638 onActionCancel(event: Callback<GestureEvent>): this; 4639} 4640/*** endif */ 4641 4642/** 4643 * Defines the SwipeGestureHandler options. 4644 * 4645 * @interface SwipeGestureHandlerOptions 4646 * @syscap SystemCapability.ArkUI.ArkUI.Full 4647 * @crossplatform 4648 * @atomicservice 4649 * @since 12 4650 */ 4651/** 4652 * Defines the SwipeGestureHandler options. 4653 * 4654 * @extends BaseHandlerOptions 4655 * @interface SwipeGestureHandlerOptions 4656 * @syscap SystemCapability.ArkUI.ArkUI.Full 4657 * @crossplatform 4658 * @atomicservice 4659 * @since arkts {'1.1':'15','1.2':'20'} 4660 * @arkts 1.1&1.2 4661 */ 4662interface SwipeGestureHandlerOptions extends BaseHandlerOptions { 4663 /** 4664 * Indicates the hand index that triggers the swipe. If the value is less than 1, the default value is used. 4665 * The default value is 1. 4666 * 4667 * @type { ?number } 4668 * @syscap SystemCapability.ArkUI.ArkUI.Full 4669 * @crossplatform 4670 * @atomicservice 4671 * @since arkts {'1.1':'12','1.2':'20'} 4672 * @arkts 1.1&1.2 4673 */ 4674 fingers?: number; 4675 /** 4676 * Indicates the move direction of the swipe gesture. 4677 * The default value is SwipeDirection.All. 4678 * 4679 * @type { ?SwipeDirection } 4680 * @syscap SystemCapability.ArkUI.ArkUI.Full 4681 * @crossplatform 4682 * @atomicservice 4683 * @since arkts {'1.1':'12','1.2':'20'} 4684 * @arkts 1.1&1.2 4685 */ 4686 direction?: SwipeDirection; 4687 /** 4688 * Indicates minimum move speed. 4689 * The default value is 100vp/s. 4690 * 4691 * @type { ?number } 4692 * @syscap SystemCapability.ArkUI.ArkUI.Full 4693 * @crossplatform 4694 * @atomicservice 4695 * @since arkts {'1.1':'12','1.2':'20'} 4696 * @arkts 1.1&1.2 4697 */ 4698 speed?: number; 4699} 4700 4701/** 4702 * Defines the SwipeGesture handler. 4703 * 4704 * @extends GestureHandler<SwipeGestureHandler> 4705 * @syscap SystemCapability.ArkUI.ArkUI.Full 4706 * @crossplatform 4707 * @atomicservice 4708 * @since 12 4709 */ 4710declare class SwipeGestureHandler extends GestureHandler<SwipeGestureHandler> { 4711 /** 4712 * Constructor parameters. 4713 * 4714 * @param { SwipeGestureHandlerOptions } options 4715 * @syscap SystemCapability.ArkUI.ArkUI.Full 4716 * @crossplatform 4717 * @atomicservice 4718 * @since 12 4719 */ 4720 constructor(options?: SwipeGestureHandlerOptions); 4721 /** 4722 * Swipe gesture recognition success callback. 4723 * 4724 * @param { Callback<GestureEvent> } event 4725 * @returns { SwipeGestureHandler } 4726 * @syscap SystemCapability.ArkUI.ArkUI.Full 4727 * @crossplatform 4728 * @atomicservice 4729 * @since 12 4730 */ 4731 onAction(event: Callback<GestureEvent>): SwipeGestureHandler; 4732} 4733 4734/*** if arkts 1.2 */ 4735/** 4736 * Defines the SwipeGesture handler. 4737 * 4738 * @extends GestureHandler 4739 * @syscap SystemCapability.ArkUI.ArkUI.Full 4740 * @crossplatform 4741 * @atomicservice 4742 * @since 20 4743 */ 4744export declare class SwipeGestureHandler extends GestureHandler { 4745 /** 4746 * Constructor parameters. 4747 * 4748 * @param { SwipeGestureHandlerOptions } options 4749 * @syscap SystemCapability.ArkUI.ArkUI.Full 4750 * @crossplatform 4751 * @atomicservice 4752 * @since 20 4753 */ 4754 constructor(options?: SwipeGestureHandlerOptions); 4755 /** 4756 * Swipe gesture recognition success callback. 4757 * 4758 * @param { Callback<GestureEvent> } event 4759 * @returns { this } 4760 * @syscap SystemCapability.ArkUI.ArkUI.Full 4761 * @crossplatform 4762 * @atomicservice 4763 * @since 20 4764 */ 4765 onAction(event: Callback<GestureEvent>): this; 4766} 4767/*** endif */ 4768 4769/** 4770 * Defines the PinchGestureHandler options. 4771 * 4772 * @interface PinchGestureHandlerOptions 4773 * @syscap SystemCapability.ArkUI.ArkUI.Full 4774 * @crossplatform 4775 * @atomicservice 4776 * @since 12 4777 */ 4778/** 4779 * Defines the PinchGestureHandler options. 4780 * 4781 * @extends BaseHandlerOptions 4782 * @interface PinchGestureHandlerOptions 4783 * @syscap SystemCapability.ArkUI.ArkUI.Full 4784 * @crossplatform 4785 * @atomicservice 4786 * @since arkts {'1.1':'15','1.2':'20'} 4787 * @arkts 1.1&1.2 4788 */ 4789interface PinchGestureHandlerOptions extends BaseHandlerOptions { 4790 /** 4791 * Indicates the hand index that triggers the pinch. If the value is less than 1, the default value is used. 4792 * The default value is 1. 4793 * 4794 * @type { ?number } 4795 * @syscap SystemCapability.ArkUI.ArkUI.Full 4796 * @crossplatform 4797 * @atomicservice 4798 * @since arkts {'1.1':'12','1.2':'20'} 4799 * @arkts 1.1&1.2 4800 */ 4801 fingers?: number; 4802 /** 4803 * Indicates minimum pinch move distance. 4804 * The default value is 5vp. 4805 * 4806 * @type { ?number } 4807 * @syscap SystemCapability.ArkUI.ArkUI.Full 4808 * @crossplatform 4809 * @atomicservice 4810 * @since arkts {'1.1':'12','1.2':'20'} 4811 * @arkts 1.1&1.2 4812 */ 4813 distance?: number; 4814} 4815 4816/** 4817 * Defines the PinchGesture handler. 4818 * 4819 * @extends GestureHandler<PinchGestureHandler> 4820 * @syscap SystemCapability.ArkUI.ArkUI.Full 4821 * @crossplatform 4822 * @atomicservice 4823 * @since 12 4824 */ 4825declare class PinchGestureHandler extends GestureHandler<PinchGestureHandler> { 4826 /** 4827 * Constructor parameters. 4828 * 4829 * @param { PinchGestureHandlerOptions } options 4830 * @syscap SystemCapability.ArkUI.ArkUI.Full 4831 * @crossplatform 4832 * @atomicservice 4833 * @since 12 4834 */ 4835 constructor(options?: PinchGestureHandlerOptions); 4836 /** 4837 * Pinch gesture recognition success callback. 4838 * 4839 * @param { Callback<GestureEvent> } event 4840 * @returns { PinchGestureHandler } 4841 * @syscap SystemCapability.ArkUI.ArkUI.Full 4842 * @crossplatform 4843 * @atomicservice 4844 * @since 12 4845 */ 4846 onActionStart(event: Callback<GestureEvent>): PinchGestureHandler; 4847 /** 4848 * Callback when the Pinch gesture is moving. 4849 * 4850 * @param { Callback<GestureEvent> } event 4851 * @returns { PinchGestureHandler } 4852 * @syscap SystemCapability.ArkUI.ArkUI.Full 4853 * @crossplatform 4854 * @atomicservice 4855 * @since 12 4856 */ 4857 onActionUpdate(event: Callback<GestureEvent>): PinchGestureHandler; 4858 /** 4859 * The Pinch gesture is successfully recognized. When the finger is lifted, the callback is triggered. 4860 * 4861 * @param { Callback<GestureEvent> } event 4862 * @returns { PinchGestureHandler } 4863 * @syscap SystemCapability.ArkUI.ArkUI.Full 4864 * @crossplatform 4865 * @atomicservice 4866 * @since 12 4867 */ 4868 onActionEnd(event: Callback<GestureEvent>): PinchGestureHandler; 4869 /** 4870 * The Pinch gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 4871 * 4872 * @param { Callback<void> } event 4873 * @returns { PinchGestureHandler } 4874 * @syscap SystemCapability.ArkUI.ArkUI.Full 4875 * @crossplatform 4876 * @atomicservice 4877 * @since 12 4878 */ 4879 onActionCancel(event: Callback<void>): PinchGestureHandler; 4880 /** 4881 * The Pinch gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 4882 * Add GestureEvent in cancel callback. 4883 * 4884 * @param { Callback<GestureEvent> } event 4885 * @returns { PinchGestureHandler } 4886 * @syscap SystemCapability.ArkUI.ArkUI.Full 4887 * @crossplatform 4888 * @atomicservice 4889 * @since 18 4890 */ 4891 onActionCancel(event: Callback<GestureEvent>): PinchGestureHandler; 4892} 4893 4894/*** if arkts 1.2 */ 4895/** 4896 * Defines the PinchGesture handler. 4897 * 4898 * @extends GestureHandler 4899 * @syscap SystemCapability.ArkUI.ArkUI.Full 4900 * @crossplatform 4901 * @atomicservice 4902 * @since 20 4903 */ 4904export declare class PinchGestureHandler extends GestureHandler { 4905 /** 4906 * Constructor parameters. 4907 * 4908 * @param { PinchGestureHandlerOptions } options 4909 * @syscap SystemCapability.ArkUI.ArkUI.Full 4910 * @crossplatform 4911 * @atomicservice 4912 * @since 20 4913 */ 4914 constructor(options?: PinchGestureHandlerOptions); 4915 /** 4916 * Pinch gesture recognition success callback. 4917 * 4918 * @param { Callback<GestureEvent> } event 4919 * @returns { this } 4920 * @syscap SystemCapability.ArkUI.ArkUI.Full 4921 * @crossplatform 4922 * @atomicservice 4923 * @since 20 4924 */ 4925 onActionStart(event: Callback<GestureEvent>): this; 4926 /** 4927 * Callback when the Pinch gesture is moving. 4928 * 4929 * @param { Callback<GestureEvent> } event 4930 * @returns { this } 4931 * @syscap SystemCapability.ArkUI.ArkUI.Full 4932 * @crossplatform 4933 * @atomicservice 4934 * @since 20 4935 */ 4936 onActionUpdate(event: Callback<GestureEvent>): this; 4937 /** 4938 * The Pinch gesture is successfully recognized. When the finger is lifted, the callback is triggered. 4939 * 4940 * @param { Callback<GestureEvent> } event 4941 * @returns { this } 4942 * @syscap SystemCapability.ArkUI.ArkUI.Full 4943 * @crossplatform 4944 * @atomicservice 4945 * @since 20 4946 */ 4947 onActionEnd(event: Callback<GestureEvent>): this; 4948 /** 4949 * The Pinch gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 4950 * 4951 * @param { Callback<GestureEvent> } event 4952 * @returns { this } 4953 * @syscap SystemCapability.ArkUI.ArkUI.Full 4954 * @crossplatform 4955 * @atomicservice 4956 * @since 20 4957 */ 4958 onActionCancel(event: Callback<GestureEvent>): this; 4959} 4960/*** endif */ 4961 4962/** 4963 * Defines the RotationGestureHandler options. 4964 * 4965 * @interface RotationGestureHandlerOptions 4966 * @syscap SystemCapability.ArkUI.ArkUI.Full 4967 * @crossplatform 4968 * @atomicservice 4969 * @since 12 4970 */ 4971/** 4972 * Defines the RotationGestureHandler options. 4973 * 4974 * @extends BaseHandlerOptions 4975 * @interface RotationGestureHandlerOptions 4976 * @syscap SystemCapability.ArkUI.ArkUI.Full 4977 * @crossplatform 4978 * @atomicservice 4979 * @since arkts {'1.1':'15','1.2':'20'} 4980 * @arkts 1.1&1.2 4981 */ 4982interface RotationGestureHandlerOptions extends BaseHandlerOptions { 4983 /** 4984 * Indicates the hand index that triggers the rotation. If the value is less than 1, the default value is used. 4985 * The default value is 1. 4986 * 4987 * @type { ?number } 4988 * @syscap SystemCapability.ArkUI.ArkUI.Full 4989 * @crossplatform 4990 * @atomicservice 4991 * @since arkts {'1.1':'12','1.2':'20'} 4992 * @arkts 1.1&1.2 4993 */ 4994 fingers?: number; 4995 /** 4996 * Indicates minimum rotate angle. 4997 * The default value is 1deg. 4998 * 4999 * @type { ?number } 5000 * @syscap SystemCapability.ArkUI.ArkUI.Full 5001 * @crossplatform 5002 * @atomicservice 5003 * @since arkts {'1.1':'12','1.2':'20'} 5004 * @arkts 1.1&1.2 5005 */ 5006 angle?: number; 5007} 5008 5009/** 5010 * Defines the RotationGesture handler. 5011 * 5012 * @extends GestureHandler<RotationGestureHandler> 5013 * @syscap SystemCapability.ArkUI.ArkUI.Full 5014 * @crossplatform 5015 * @atomicservice 5016 * @since 12 5017 */ 5018declare class RotationGestureHandler extends GestureHandler<RotationGestureHandler> { 5019 /** 5020 * Constructor parameters. 5021 * 5022 * @param { RotationGestureHandlerOptions } options 5023 * @syscap SystemCapability.ArkUI.ArkUI.Full 5024 * @crossplatform 5025 * @atomicservice 5026 * @since 12 5027 */ 5028 constructor(options?: RotationGestureHandlerOptions); 5029 /** 5030 * Rotation gesture recognition success callback. 5031 * 5032 * @param { Callback<GestureEvent> } event 5033 * @returns { RotationGestureHandler } 5034 * @syscap SystemCapability.ArkUI.ArkUI.Full 5035 * @crossplatform 5036 * @atomicservice 5037 * @since 12 5038 */ 5039 onActionStart(event: Callback<GestureEvent>): RotationGestureHandler; 5040 /** 5041 * Callback when the Rotation gesture is moving. 5042 * 5043 * @param { Callback<GestureEvent> } event 5044 * @returns { RotationGestureHandler } 5045 * @syscap SystemCapability.ArkUI.ArkUI.Full 5046 * @crossplatform 5047 * @atomicservice 5048 * @since 12 5049 */ 5050 onActionUpdate(event: Callback<GestureEvent>): RotationGestureHandler; 5051 /** 5052 * The Rotation gesture is successfully recognized. When the finger is lifted, the callback is triggered. 5053 * 5054 * @param { Callback<GestureEvent> } event 5055 * @returns { RotationGestureHandler } 5056 * @syscap SystemCapability.ArkUI.ArkUI.Full 5057 * @crossplatform 5058 * @atomicservice 5059 * @since 12 5060 */ 5061 onActionEnd(event: Callback<GestureEvent>): RotationGestureHandler; 5062 /** 5063 * The Rotation gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 5064 * 5065 * @param { Callback<void> } event 5066 * @returns { RotationGestureHandler } 5067 * @syscap SystemCapability.ArkUI.ArkUI.Full 5068 * @crossplatform 5069 * @atomicservice 5070 * @since 12 5071 */ 5072 onActionCancel(event: Callback<void>): RotationGestureHandler; 5073 /** 5074 * The Rotation gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 5075 * Add GestureEvent in cancel callback. 5076 * 5077 * @param { Callback<GestureEvent> } event 5078 * @returns { RotationGestureHandler } 5079 * @syscap SystemCapability.ArkUI.ArkUI.Full 5080 * @crossplatform 5081 * @atomicservice 5082 * @since 18 5083 */ 5084 onActionCancel(event: Callback<GestureEvent>): RotationGestureHandler; 5085} 5086 5087/*** if arkts 1.2 */ 5088/** 5089 * Defines the RotationGesture handler. 5090 * 5091 * @extends GestureHandler 5092 * @syscap SystemCapability.ArkUI.ArkUI.Full 5093 * @crossplatform 5094 * @atomicservice 5095 * @since 20 5096 */ 5097export declare class RotationGestureHandler extends GestureHandler { 5098 /** 5099 * Constructor parameters. 5100 * 5101 * @param { RotationGestureHandlerOptions } options 5102 * @syscap SystemCapability.ArkUI.ArkUI.Full 5103 * @crossplatform 5104 * @atomicservice 5105 * @since 20 5106 */ 5107 constructor(options?: RotationGestureHandlerOptions); 5108 /** 5109 * Rotation gesture recognition success callback. 5110 * 5111 * @param { Callback<GestureEvent> } event 5112 * @returns { this } 5113 * @syscap SystemCapability.ArkUI.ArkUI.Full 5114 * @crossplatform 5115 * @atomicservice 5116 * @since 20 5117 */ 5118 onActionStart(event: Callback<GestureEvent>): this; 5119 /** 5120 * Callback when the Rotation gesture is moving. 5121 * 5122 * @param { Callback<GestureEvent> } event 5123 * @returns { this } 5124 * @syscap SystemCapability.ArkUI.ArkUI.Full 5125 * @crossplatform 5126 * @atomicservice 5127 * @since 20 5128 */ 5129 onActionUpdate(event: Callback<GestureEvent>): this; 5130 /** 5131 * The Rotation gesture is successfully recognized. When the finger is lifted, the callback is triggered. 5132 * 5133 * @param { Callback<GestureEvent> } event 5134 * @returns { this } 5135 * @syscap SystemCapability.ArkUI.ArkUI.Full 5136 * @crossplatform 5137 * @atomicservice 5138 * @since 20 5139 */ 5140 onActionEnd(event: Callback<GestureEvent>): this; 5141 /** 5142 * The Rotation gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 5143 * 5144 * @param { Callback<GestureEvent> } event 5145 * @returns { this } 5146 * @syscap SystemCapability.ArkUI.ArkUI.Full 5147 * @crossplatform 5148 * @atomicservice 5149 * @since 20 5150 */ 5151 onActionCancel(event: Callback<GestureEvent>): this; 5152} 5153/*** endif */ 5154 5155/** 5156 * Defines the GestureGroupGestureHandler options. 5157 * 5158 * @interface GestureGroupGestureHandlerOptions 5159 * @syscap SystemCapability.ArkUI.ArkUI.Full 5160 * @crossplatform 5161 * @atomicservice 5162 * @since arkts {'1.1':'12','1.2':'20'} 5163 * @arkts 1.1&1.2 5164 */ 5165interface GestureGroupGestureHandlerOptions { 5166 /** 5167 * Indicates the mode of gesture group. 5168 * 5169 * @type { GestureMode } 5170 * @syscap SystemCapability.ArkUI.ArkUI.Full 5171 * @crossplatform 5172 * @atomicservice 5173 * @since arkts {'1.1':'12','1.2':'20'} 5174 * @arkts 1.1&1.2 5175 */ 5176 mode: GestureMode; 5177 /** 5178 * Indicates the gestures included in the gesture group. 5179 * 5180 * @type { GestureHandler<TapGestureHandler | LongPressGestureHandler | PanGestureHandler | SwipeGestureHandler | PinchGestureHandler | RotationGestureHandler | GestureGroupHandler>[] } 5181 * @syscap SystemCapability.ArkUI.ArkUI.Full 5182 * @crossplatform 5183 * @atomicservice 5184 * @since 12 5185 */ 5186 gestures: GestureHandler<TapGestureHandler | LongPressGestureHandler | PanGestureHandler | SwipeGestureHandler | PinchGestureHandler | RotationGestureHandler | GestureGroupHandler>[]; 5187 /** 5188 * Indicates the gestures included in the gesture group. 5189 * 5190 * @type { GestureHandler[] } 5191 * @syscap SystemCapability.ArkUI.ArkUI.Full 5192 * @crossplatform 5193 * @atomicservice 5194 * @since 20 5195 * @arkts 1.2 5196 */ 5197 gestures: GestureHandler[]; 5198} 5199 5200/** 5201 * Defines the GestureGroup handler. 5202 * 5203 * @extends GestureHandler<GestureGroupHandler> 5204 * @syscap SystemCapability.ArkUI.ArkUI.Full 5205 * @crossplatform 5206 * @atomicservice 5207 * @since 12 5208 */ 5209declare class GestureGroupHandler extends GestureHandler<GestureGroupHandler> { 5210 /** 5211 * Constructor parameters. 5212 * 5213 * @param { GestureGroupGestureHandlerOptions } options 5214 * @syscap SystemCapability.ArkUI.ArkUI.Full 5215 * @crossplatform 5216 * @atomicservice 5217 * @since 12 5218 */ 5219 constructor(options?: GestureGroupGestureHandlerOptions); 5220 /** 5221 * The GestureGroup gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 5222 * 5223 * @param { Callback<void> } event 5224 * @returns { GestureGroupHandler } 5225 * @syscap SystemCapability.ArkUI.ArkUI.Full 5226 * @crossplatform 5227 * @atomicservice 5228 * @since 12 5229 */ 5230 onCancel(event: Callback<void>): GestureGroupHandler; 5231} 5232 5233/*** if arkts 1.2 */ 5234/** 5235 * Defines the GestureGroup handler. 5236 * 5237 * @extends GestureHandler 5238 * @syscap SystemCapability.ArkUI.ArkUI.Full 5239 * @crossplatform 5240 * @atomicservice 5241 * @since 20 5242 */ 5243export declare class GestureGroupHandler extends GestureHandler { 5244 /** 5245 * Constructor parameters. 5246 * 5247 * @param { GestureGroupGestureHandlerOptions } options 5248 * @syscap SystemCapability.ArkUI.ArkUI.Full 5249 * @crossplatform 5250 * @atomicservice 5251 * @since 20 5252 */ 5253 constructor(options?: GestureGroupGestureHandlerOptions); 5254 /** 5255 * The GestureGroup gesture is successfully recognized and a callback is triggered when the touch cancel event is received. 5256 * 5257 * @param { Callback<void> } event 5258 * @returns { this } 5259 * @syscap SystemCapability.ArkUI.ArkUI.Full 5260 * @crossplatform 5261 * @atomicservice 5262 * @since 20 5263 */ 5264 onCancel(event: Callback<void>): this; 5265} 5266/*** endif */ 5267 5268/** 5269 * Creating an Object 5270 * 5271 * @enum { number } 5272 * @syscap SystemCapability.ArkUI.ArkUI.Full 5273 * @crossplatform 5274 * @atomicservice 5275 * @since arkts {'1.1':'12','1.2':'20'} 5276 * @arkts 1.1&1.2 5277 */ 5278declare enum GesturePriority { 5279 /** 5280 * The normal gesture priority. 5281 * 5282 * @syscap SystemCapability.ArkUI.ArkUI.Full 5283 * @crossplatform 5284 * @atomicservice 5285 * @since arkts {'1.1':'12','1.2':'20'} 5286 * @arkts 1.1&1.2 5287 */ 5288 NORMAL = 0, 5289 /** 5290 * The high gesture priority. 5291 * 5292 * @syscap SystemCapability.ArkUI.ArkUI.Full 5293 * @crossplatform 5294 * @atomicservice 5295 * @since arkts {'1.1':'12','1.2':'20'} 5296 * @arkts 1.1&1.2 5297 */ 5298 PRIORITY = 1, 5299} 5300 5301/** 5302 * Creating an Object 5303 * 5304 * @enum { number } 5305 * @syscap SystemCapability.ArkUI.ArkUI.Full 5306 * @crossplatform 5307 * @atomicservice 5308 * @since arkts {'1.1':'12','1.2':'20'} 5309 * @arkts 1.1&1.2 5310 */ 5311declare enum GestureRecognizerState { 5312 /** 5313 * Ready state. 5314 * 5315 * @syscap SystemCapability.ArkUI.ArkUI.Full 5316 * @crossplatform 5317 * @atomicservice 5318 * @since arkts {'1.1':'12','1.2':'20'} 5319 * @arkts 1.1&1.2 5320 */ 5321 READY = 0, 5322 /** 5323 * Detecting state. 5324 * 5325 * @syscap SystemCapability.ArkUI.ArkUI.Full 5326 * @crossplatform 5327 * @atomicservice 5328 * @since arkts {'1.1':'12','1.2':'20'} 5329 * @arkts 1.1&1.2 5330 */ 5331 DETECTING = 1, 5332 /** 5333 * Pending state. 5334 * 5335 * @syscap SystemCapability.ArkUI.ArkUI.Full 5336 * @crossplatform 5337 * @atomicservice 5338 * @since arkts {'1.1':'12','1.2':'20'} 5339 * @arkts 1.1&1.2 5340 */ 5341 PENDING = 2, 5342 /** 5343 * Blocked state. 5344 * 5345 * @syscap SystemCapability.ArkUI.ArkUI.Full 5346 * @crossplatform 5347 * @atomicservice 5348 * @since arkts {'1.1':'12','1.2':'20'} 5349 * @arkts 1.1&1.2 5350 */ 5351 BLOCKED = 3, 5352 /** 5353 * Successful state. 5354 * 5355 * @syscap SystemCapability.ArkUI.ArkUI.Full 5356 * @crossplatform 5357 * @atomicservice 5358 * @since arkts {'1.1':'12','1.2':'20'} 5359 * @arkts 1.1&1.2 5360 */ 5361 SUCCESSFUL = 4, 5362 /** 5363 * Failed state. 5364 * 5365 * @syscap SystemCapability.ArkUI.ArkUI.Full 5366 * @crossplatform 5367 * @atomicservice 5368 * @since arkts {'1.1':'12','1.2':'20'} 5369 * @arkts 1.1&1.2 5370 */ 5371 FAILED = 5, 5372} 5373 5374/** 5375 * Defines the scrollable target information. 5376 * 5377 * @extends EventTargetInfo 5378 * @syscap SystemCapability.ArkUI.ArkUI.Full 5379 * @crossplatform 5380 * @atomicservice 5381 * @since arkts {'1.1':'12','1.2':'20'} 5382 * @arkts 1.1&1.2 5383 */ 5384declare class ScrollableTargetInfo extends EventTargetInfo { 5385 /** 5386 * Returns whether the scrollable component is at begin. 5387 * 5388 * @returns { boolean } - true is at begin, false is not at begin 5389 * @syscap SystemCapability.ArkUI.ArkUI.Full 5390 * @crossplatform 5391 * @atomicservice 5392 * @since arkts {'1.1':'12','1.2':'20'} 5393 * @arkts 1.1&1.2 5394 */ 5395 isBegin(): boolean; 5396 /** 5397 * Returns whether the scrollable component is at end. 5398 * 5399 * @returns { boolean } - true is at end, false is not at end 5400 * @syscap SystemCapability.ArkUI.ArkUI.Full 5401 * @crossplatform 5402 * @atomicservice 5403 * @since arkts {'1.1':'12','1.2':'20'} 5404 * @arkts 1.1&1.2 5405 */ 5406 isEnd(): boolean; 5407} 5408 5409/** 5410 * Defines the event target information. 5411 * 5412 * @syscap SystemCapability.ArkUI.ArkUI.Full 5413 * @crossplatform 5414 * @atomicservice 5415 * @since arkts {'1.1':'12','1.2':'20'} 5416 * @arkts 1.1&1.2 5417 */ 5418declare class EventTargetInfo { 5419 /** 5420 * Returns the component's inspector id. 5421 * 5422 * @returns { string } - the inspector id of the component 5423 * @syscap SystemCapability.ArkUI.ArkUI.Full 5424 * @crossplatform 5425 * @atomicservice 5426 * @since arkts {'1.1':'12','1.2':'20'} 5427 * @arkts 1.1&1.2 5428 */ 5429 getId(): string; 5430} 5431 5432/** 5433 * Defines the touch recognizer. 5434 * 5435 * @syscap SystemCapability.ArkUI.ArkUI.Full 5436 * @crossplatform 5437 * @atomicservice 5438 * @since 20 5439 */ 5440declare class TouchRecognizer { 5441 /** 5442 * Returns the event target information of the component. 5443 * 5444 * @returns { EventTargetInfo } - the event target information of the component. 5445 * @syscap SystemCapability.ArkUI.ArkUI.Full 5446 * @crossplatform 5447 * @atomicservice 5448 * @since 20 5449 */ 5450 getEventTargetInfo(): EventTargetInfo; 5451 /** 5452 * Dispatch touch cancel to the touch recognizer. 5453 * 5454 * @syscap SystemCapability.ArkUI.ArkUI.Full 5455 * @crossplatform 5456 * @atomicservice 5457 * @since 20 5458 */ 5459 cancelTouch(): void; 5460} 5461 5462/** 5463 * Defines the gesture recognizer. 5464 * 5465 * @syscap SystemCapability.ArkUI.ArkUI.Full 5466 * @crossplatform 5467 * @atomicservice 5468 * @since arkts {'1.1':'12','1.2':'20'} 5469 * @arkts 1.1&1.2 5470 */ 5471declare class GestureRecognizer { 5472 /** 5473 * Returns the gesture's tag. 5474 * 5475 * @returns { string } - the gesture's tag 5476 * @syscap SystemCapability.ArkUI.ArkUI.Full 5477 * @crossplatform 5478 * @atomicservice 5479 * @since arkts {'1.1':'12','1.2':'20'} 5480 * @arkts 1.1&1.2 5481 */ 5482 getTag(): string; 5483 /** 5484 * Returns the gesture's type. 5485 * 5486 * @returns { GestureControl.GestureType } - the gesture's type 5487 * @syscap SystemCapability.ArkUI.ArkUI.Full 5488 * @crossplatform 5489 * @atomicservice 5490 * @since arkts {'1.1':'12','1.2':'20'} 5491 * @arkts 1.1&1.2 5492 */ 5493 getType(): GestureControl.GestureType; 5494 /** 5495 * Returns whether the gesture recognizer is built in recognizer. 5496 * 5497 * @returns { boolean } - true is built in recognizer, false is not built in recognizer 5498 * @syscap SystemCapability.ArkUI.ArkUI.Full 5499 * @crossplatform 5500 * @atomicservice 5501 * @since arkts {'1.1':'12','1.2':'20'} 5502 * @arkts 1.1&1.2 5503 */ 5504 isBuiltIn(): boolean; 5505 /** 5506 * set the enabled state of the gesture recognizer. 5507 * 5508 * @param { boolean } isEnabled - Indicates the enabled state. 5509 * @syscap SystemCapability.ArkUI.ArkUI.Full 5510 * @crossplatform 5511 * @atomicservice 5512 * @since arkts {'1.1':'12','1.2':'20'} 5513 * @arkts 1.1&1.2 5514 */ 5515 setEnabled(isEnabled: boolean): void; 5516 /** 5517 * Returns whether the gesture recognizer is enabled. 5518 * 5519 * @returns { boolean } - true is enabled, false is not enabled 5520 * @syscap SystemCapability.ArkUI.ArkUI.Full 5521 * @crossplatform 5522 * @atomicservice 5523 * @since arkts {'1.1':'12','1.2':'20'} 5524 * @arkts 1.1&1.2 5525 */ 5526 isEnabled(): boolean; 5527 /** 5528 * Returns the gesture recognizer's state. 5529 * 5530 * @returns { GestureRecognizerState } - the gesture recognizer's state 5531 * @syscap SystemCapability.ArkUI.ArkUI.Full 5532 * @crossplatform 5533 * @atomicservice 5534 * @since arkts {'1.1':'12','1.2':'20'} 5535 * @arkts 1.1&1.2 5536 */ 5537 getState(): GestureRecognizerState; 5538 /** 5539 * Returns the event target information of the component. 5540 * 5541 * @returns { EventTargetInfo } - the event target information of the component. 5542 * @syscap SystemCapability.ArkUI.ArkUI.Full 5543 * @crossplatform 5544 * @atomicservice 5545 * @since arkts {'1.1':'12','1.2':'20'} 5546 * @arkts 1.1&1.2 5547 */ 5548 getEventTargetInfo(): EventTargetInfo; 5549 /** 5550 * Returns whether the gesture recognizer is valid. 5551 * 5552 * @returns { boolean } - true is valid, false is invalid 5553 * @syscap SystemCapability.ArkUI.ArkUI.Full 5554 * @crossplatform 5555 * @since arkts {'1.1':'12','1.2':'20'} 5556 * @arkts 1.1&1.2 5557 */ 5558 isValid(): boolean; 5559 /** 5560 * Returns the tap gesture's finger count. 5561 * 5562 * @returns { number } - the finger count of the tap gesture. 5563 * @syscap SystemCapability.ArkUI.ArkUI.Full 5564 * @crossplatform 5565 * @atomicservice 5566 * @since arkts {'1.1':'18','1.2':'20'} 5567 * @arkts 1.1&1.2 5568 */ 5569 getFingerCount(): number; 5570 /** 5571 * Returns the tap gesture's limitFingerCount. 5572 * 5573 * @returns { boolean } - the limitFingerCount of the tap gesture. 5574 * @syscap SystemCapability.ArkUI.ArkUI.Full 5575 * @crossplatform 5576 * @atomicservice 5577 * @since arkts {'1.1':'18','1.2':'20'} 5578 * @arkts 1.1&1.2 5579 */ 5580 isFingerCountLimit(): boolean; 5581 /** 5582 * Prevent the gesture recognizer from participating in this gesture recognition until all fingers are lifted. 5583 * If the system has already made out the result of this gesture recognizer (success and failure), calling this 5584 * function will have no any effect. 5585 * 5586 * [Note]: This method is different from GestureRecognizer.setEnabled(isEnabled: boolean), setEnabled does not 5587 * prevent a gesture recognizer object from participating in the gesture recognition process, but only affects 5588 * whether the gesture's corresponding callback function is executed. 5589 * 5590 * @syscap SystemCapability.ArkUI.ArkUI.Full 5591 * @crossplatform 5592 * @atomicservice 5593 * @since 20 5594 */ 5595 preventBegin(): void; 5596} 5597 5598/** 5599 * Defines the tap gesture recognizer. 5600 * 5601 * @extends GestureRecognizer 5602 * @syscap SystemCapability.ArkUI.ArkUI.Full 5603 * @crossplatform 5604 * @atomicservice 5605 * @since arkts {'1.1':'18','1.2':'20'} 5606 * @arkts 1.1&1.2 5607 */ 5608declare class TapRecognizer extends GestureRecognizer { 5609 /** 5610 * Returns the tap gesture's count. 5611 * 5612 * @returns { number } - the count of the tap gesture. 5613 * @syscap SystemCapability.ArkUI.ArkUI.Full 5614 * @crossplatform 5615 * @atomicservice 5616 * @since arkts {'1.1':'18','1.2':'20'} 5617 * @arkts 1.1&1.2 5618 */ 5619 getTapCount(): number; 5620} 5621 5622/** 5623 * Defines the long press gesture recognizer. 5624 * 5625 * @extends GestureRecognizer 5626 * @syscap SystemCapability.ArkUI.ArkUI.Full 5627 * @crossplatform 5628 * @atomicservice 5629 * @since arkts {'1.1':'18','1.2':'20'} 5630 * @arkts 1.1&1.2 5631 */ 5632declare class LongPressRecognizer extends GestureRecognizer { 5633 /** 5634 * Returns the long press gesture's repeat state. 5635 * 5636 * @returns { boolean } - the repeat state of the long press gesture. 5637 * @syscap SystemCapability.ArkUI.ArkUI.Full 5638 * @crossplatform 5639 * @atomicservice 5640 * @since arkts {'1.1':'18','1.2':'20'} 5641 * @arkts 1.1&1.2 5642 */ 5643 isRepeat(): boolean; 5644 /** 5645 * Returns the long press gesture's duration. 5646 * The unit is ms. 5647 * 5648 * @returns { number } - the duration of the long press gesture. 5649 * @syscap SystemCapability.ArkUI.ArkUI.Full 5650 * @crossplatform 5651 * @atomicservice 5652 * @since arkts {'1.1':'18','1.2':'20'} 5653 * @arkts 1.1&1.2 5654 */ 5655 getDuration(): number; 5656} 5657 5658/** 5659 * Defines the swipe gesture recognizer. 5660 * 5661 * @extends GestureRecognizer 5662 * @syscap SystemCapability.ArkUI.ArkUI.Full 5663 * @crossplatform 5664 * @atomicservice 5665 * @since arkts {'1.1':'18','1.2':'20'} 5666 * @arkts 1.1&1.2 5667 */ 5668declare class SwipeRecognizer extends GestureRecognizer { 5669 /** 5670 * Returns the swipe gesture's speed. 5671 * The unit is vp/s. 5672 * 5673 * @returns { number } - the velocity threshold of the swipe gesture. 5674 * @syscap SystemCapability.ArkUI.ArkUI.Full 5675 * @crossplatform 5676 * @atomicservice 5677 * @since arkts {'1.1':'18','1.2':'20'} 5678 * @arkts 1.1&1.2 5679 */ 5680 getVelocityThreshold(): number; 5681 /** 5682 * Returns the swipe gesture's direction. 5683 * 5684 * @returns { SwipeDirection } - the direction of the swipe gesture. 5685 * @syscap SystemCapability.ArkUI.ArkUI.Full 5686 * @crossplatform 5687 * @atomicservice 5688 * @since arkts {'1.1':'18','1.2':'20'} 5689 * @arkts 1.1&1.2 5690 */ 5691 getDirection(): SwipeDirection; 5692} 5693 5694/** 5695 * Defines the pinch gesture recognizer. 5696 * 5697 * @extends GestureRecognizer 5698 * @syscap SystemCapability.ArkUI.ArkUI.Full 5699 * @crossplatform 5700 * @atomicservice 5701 * @since arkts {'1.1':'18','1.2':'20'} 5702 * @arkts 1.1&1.2 5703 */ 5704declare class PinchRecognizer extends GestureRecognizer { 5705 /** 5706 * Returns the pinch gesture's distance. 5707 * The unit is vp. 5708 * 5709 * @returns { number } - the distance of the pinch gesture. 5710 * @syscap SystemCapability.ArkUI.ArkUI.Full 5711 * @crossplatform 5712 * @atomicservice 5713 * @since arkts {'1.1':'18','1.2':'20'} 5714 * @arkts 1.1&1.2 5715 */ 5716 getDistance(): number; 5717} 5718 5719/** 5720 * Defines the rotation gesture recognizer. 5721 * 5722 * @extends GestureRecognizer 5723 * @syscap SystemCapability.ArkUI.ArkUI.Full 5724 * @crossplatform 5725 * @atomicservice 5726 * @since arkts {'1.1':'18','1.2':'20'} 5727 * @arkts 1.1&1.2 5728 */ 5729declare class RotationRecognizer extends GestureRecognizer { 5730 /** 5731 * Returns the rotation gesture's angle. 5732 * 5733 * @returns { number } - the angle of the rotation gesture. 5734 * @syscap SystemCapability.ArkUI.ArkUI.Full 5735 * @crossplatform 5736 * @atomicservice 5737 * @since arkts {'1.1':'18','1.2':'20'} 5738 * @arkts 1.1&1.2 5739 */ 5740 getAngle(): number; 5741} 5742 5743/** 5744 * Defines the gesture recognizer. 5745 * 5746 * @extends GestureRecognizer 5747 * @syscap SystemCapability.ArkUI.ArkUI.Full 5748 * @crossplatform 5749 * @atomicservice 5750 * @since arkts {'1.1':'12','1.2':'20'} 5751 * @arkts 1.1&1.2 5752 */ 5753declare class PanRecognizer extends GestureRecognizer { 5754 /** 5755 * Returns the the pan gesture options of the recognizer. 5756 * 5757 * @returns { PanGestureOptions } - Pan gesture options 5758 * @syscap SystemCapability.ArkUI.ArkUI.Full 5759 * @crossplatform 5760 * @atomicservice 5761 * @since arkts {'1.1':'12','1.2':'20'} 5762 * @arkts 1.1&1.2 5763 */ 5764 getPanGestureOptions(): PanGestureOptions; 5765 /** 5766 * Returns the pan recognizer's direction attribute. 5767 * 5768 * @returns { PanDirection } - Pan recognizer direction 5769 * @syscap SystemCapability.ArkUI.ArkUI.Full 5770 * @crossplatform 5771 * @atomicservice 5772 * @since 19 5773 */ 5774 getDirection(): PanDirection; 5775 /** 5776 * Returns the pan recognizer's distance. 5777 * The unit is vp. 5778 * 5779 * @returns { number } - the distance of the pan recognizer. 5780 * @syscap SystemCapability.ArkUI.ArkUI.Full 5781 * @crossplatform 5782 * @atomicservice 5783 * @since 19 5784 */ 5785 getDistance(): number; 5786 /** 5787 * Returns the pan recognizer's distance map. 5788 * The unit is vp. 5789 * 5790 * @returns { Map<SourceTool, number> } - the distance map of the pan recognizer. 5791 * @syscap SystemCapability.ArkUI.ArkUI.Full 5792 * @crossplatform 5793 * @atomicservice 5794 * @since 19 5795 */ 5796 getDistanceMap(): Map<SourceTool, number>; 5797} 5798